PlatformApi (bonita-java-client 0.0.2 API)

All Superinterfaces:: ApiClient.Api

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public interface PlatformApi
extends ApiClient.Api

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Platform`	`getPlatformById()`	Finds the Platform by ID Returns the current Platform
`void`	`platformLogin(String username, String password, String redirect)`	Platform Login The username and password are in `bonita-platform-community-custom.properties` file.
`void`	`platformLogout()`	Platform Logout
`void`	`updatePlatformById(PlatformUpdateRequest platformUpdateRequest)`	Update the Platform by ID Start or stop the current node, that is, start or stop all services of the current JVM.

- Method Detail
  - getPlatformById
```
Platform getPlatformById()
```
    Finds the Platform by ID Returns the current Platform
    
    Returns:
    
    Platform
  - platformLogin
```
void platformLogin(String username,
                   String password,
                   String redirect)
```
    Platform Login The username and password are in `bonita-platform-community-custom.properties` file.
    
    Parameters:
    
    username - the username (optional)
    
    password - the password (optional)
    
    redirect - \\\"true\\\" or \\\"false\\\". \\\"false\\\" indicates that the service should not redirect to Bonita Portal (after a successful login) or to the login page (after a login failure). (optional)
  - platformLogout
```
void platformLogout()
```
    Platform Logout
  - updatePlatformById
```
void updatePlatformById(PlatformUpdateRequest platformUpdateRequest)
```
    Update the Platform by ID Start or stop the current node, that is, start or stop all services of the current JVM.
    
    Parameters:
    
    platformUpdateRequest - Start or stop all services of the current JVM. (required)