Package org.bonitasoft.web.client.api

Interface PlatformApi

All Superinterfaces:

ApiClient.Api

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

Method Summary

Modifier and Type	Method	Description
Platform	getPlatformById()	Finds the Platform by ID Returns the current Platform
ApiResponse<Platform>	getPlatformByIdWithHttpInfo()	Finds the Platform by ID Similar to getPlatformById but it also returns the http response headers .
void	platformLogin(String username, String password, String redirect)	Platform Login The username and password are in `bonita-platform-community-custom.properties` file.
ApiResponse<Void>	platformLoginWithHttpInfo(String username, String password, String redirect)	Platform Login Similar to platformLogin but it also returns the http response headers .
void	platformLogout()	Platform Logout
ApiResponse<Void>	platformLogoutWithHttpInfo()	Platform Logout Similar to platformLogout but it also returns the http response headers .
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.
ApiResponse<Void>	updatePlatformByIdWithHttpInfo(PlatformUpdateRequest platformUpdateRequest)	Update the Platform by ID Similar to updatePlatformById but it also returns the http response headers .

Method Detail

getPlatformById

Platform getPlatformById()

Finds the Platform by ID Returns the current Platform

Returns:

Platform

getPlatformByIdWithHttpInfo

ApiResponse<Platform> getPlatformByIdWithHttpInfo()

Finds the Platform by ID Similar to getPlatformById but it also returns the http response headers . Returns the current Platform

Returns:

A ApiResponse that wraps the response boyd and the http headers.

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)

platformLoginWithHttpInfo

ApiResponse<Void> platformLoginWithHttpInfo(String username,
                                            String password,
                                            String redirect)

Platform Login Similar to platformLogin but it also returns the http response headers . 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

platformLogoutWithHttpInfo

ApiResponse<Void> platformLogoutWithHttpInfo()

Platform Logout Similar to platformLogout but it also returns the http response headers .

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)

updatePlatformByIdWithHttpInfo

ApiResponse<Void> updatePlatformByIdWithHttpInfo(PlatformUpdateRequest platformUpdateRequest)

Update the Platform by ID Similar to updatePlatformById but it also returns the http response headers . 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)