Package org.bonitasoft.web.client.api

Interface ApplicationApi

All Superinterfaces:

ApiClient.Api

public interface ApplicationApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ApplicationApi.SearchApplicationsQueryParams	A convenience class for generating query parameters for the searchApplications method in a fluent style.

Method Summary

Modifier and Type	Method	Description
Application	createApplication(CreateApplicationRequest body)	Create a living applications Create a living applications
void	deleteApplicationById(String id)	Delete a living application by ID Delete a single application for the given ID
Application	getApplicationById(String id)	Finds a living application by ID Returns a single application for the given ID
void	importApplication(String applicationsDataUpload, String importPolicy)	Import a living application Import a single application
List<Application>	searchApplications(Integer p, Integer c, List<String> f, String o, String s)	Finds living applications Finds living applications with pagination params and filters - can order on `id`,`creationDate`, `createdBy`, `profileId`, `token`, `displayName`, `updatedBy`, `lastUpdateDate`, `version` - can search on `token`, `displayName`, `version` - can filter on `token`, `displayName`, `version`, `profileId`, `creationDate`, `createdBy`, `updatedBy` , `lastUpdateDate`
List<Application>	searchApplications(Map<String,Object> queryParams)	Finds living applications Finds living applications with pagination params and filters - can order on `id`,`creationDate`, `createdBy`, `profileId`, `token`, `displayName`, `updatedBy`, `lastUpdateDate`, `version` - can search on `token`, `displayName`, `version` - can filter on `token`, `displayName`, `version`, `profileId`, `creationDate`, `createdBy`, `updatedBy` , `lastUpdateDate` Note, this is equivalent to the other searchApplications method, but with the query parameters collected into a single Map parameter.
Application	updateApplicationById(String id, ApplicationUpdateRequest applicationUpdateRequest)	Update a living application by ID Update a single application for the given ID
String	uploadApplication(File file)	Upload a living application Upload application
String	uploadApplicationConfiguration(File configuration)	Upload an application configuration file  Upload an application configuration file in the `bconf` format.

Method Detail

createApplication

Application createApplication(CreateApplicationRequest body)

Create a living applications Create a living applications

Parameters:

body - Partial living application description (required)

Returns:

Application

deleteApplicationById

void deleteApplicationById(String id)

Delete a living application by ID Delete a single application for the given ID

Parameters:

id - ID of application to delete (required)

getApplicationById

Application getApplicationById(String id)

Finds a living application by ID Returns a single application for the given ID

Parameters:

id - ID of application to return (required)

Returns:

Application

importApplication

void importApplication(String applicationsDataUpload,
                       String importPolicy)

Import a living application Import a single application

Parameters:

applicationsDataUpload - Uploaded file (optional)

importPolicy - Import policy (optional)

searchApplications

List<Application> searchApplications(Integer p,
                                     Integer c,
                                     List<String> f,
                                     String o,
                                     String s)

Finds living applications Finds living applications with pagination params and filters - can order on `id`,`creationDate`, `createdBy`, `profileId`, `token`, `displayName`, `updatedBy`, `lastUpdateDate`, `version` - can search on `token`, `displayName`, `version` - can filter on `token`, `displayName`, `version`, `profileId`, `creationDate`, `createdBy`, `updatedBy` , `lastUpdateDate`

Parameters:

p - index of the page to display (required)

c - maximum number of elements to retrieve (required)

f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)

o - can order on attributes (optional)

s - can search on attributes (optional)

Returns:

List<Application>

searchApplications

List<Application> searchApplications(Map<String,Object> queryParams)

Finds living applications Finds living applications with pagination params and filters - can order on `id`,`creationDate`, `createdBy`, `profileId`, `token`, `displayName`, `updatedBy`, `lastUpdateDate`, `version` - can search on `token`, `displayName`, `version` - can filter on `token`, `displayName`, `version`, `profileId`, `creationDate`, `createdBy`, `updatedBy` , `lastUpdateDate` Note, this is equivalent to the other searchApplications method, but with the query parameters collected into a single Map parameter. This is convenient for services with optional query parameters, especially when used with the ApplicationApi.SearchApplicationsQueryParams class that allows for building up this map in a fluent style.

Parameters:

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• p - index of the page to display (required)
• c - maximum number of elements to retrieve (required)
• f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
• o - can order on attributes (optional)
• s - can search on attributes (optional)

Returns:

List<Application>

updateApplicationById

Application updateApplicationById(String id,
                                  ApplicationUpdateRequest applicationUpdateRequest)

Update a living application by ID Update a single application for the given ID

Parameters:

id - ID of application to return (required)

applicationUpdateRequest - Partial living application description (required)

Returns:

Application

uploadApplication

String uploadApplication(File file)

Upload a living application Upload application

Parameters:

file - (optional)

Returns:

String

uploadApplicationConfiguration

String uploadApplicationConfiguration(File configuration)

Upload an application configuration file  Upload an application configuration file in the `bconf` format.

Parameters:

configuration - (required)

Returns:

String