org.bonitasoft.web.client.api.ApplicationApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of bonita-java-client Show documentation
Show all versions of bonita-java-client Show documentation
Java client for Bonita REST API
The newest version!
/**
* Copyright (C) 2024 BonitaSoft S.A.
* BonitaSoft, 32 rue Gustave Eiffel - 38000 Grenoble
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2.0 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see createApplication but it also returns the http response headers .
* Create a living application (legacy application or application link). Warning: as of 9.0.0, creating a living application using this API is deprecated.
*
* @param body Partial living application description (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
* @deprecated
*/
@Deprecated
@RequestLine("POST /API/living/application")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createApplicationWithHttpInfo(CreateApplicationRequest body);
/**
* Delete a living application by ID
* Delete a single application for the given ID
*
* @param id ID of application to delete (required)
*/
@RequestLine("DELETE /API/living/application/{id}")
@Headers({
"Accept: application/json",
})
void deleteApplicationById(@Param("id") String id);
/**
* Delete a living application by ID
* Similar to deleteApplicationById but it also returns the http response headers .
* Delete a single application for the given ID
*
* @param id ID of application to delete (required)
*/
@RequestLine("DELETE /API/living/application/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteApplicationByIdWithHttpInfo(@Param("id") String id);
/**
* Finds a living application by ID
* Returns a single application for the given ID
*
* @param id ID of application to return (required)
* @return Application
*/
@RequestLine("GET /API/living/application/{id}")
@Headers({
"Accept: application/json",
})
Application getApplicationById(@Param("id") String id);
/**
* Finds a living application by ID
* Similar to getApplicationById but it also returns the http response headers .
* Returns a single application for the given ID
*
* @param id ID of application to return (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/living/application/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse getApplicationByIdWithHttpInfo(@Param("id") String id);
/**
* Import a living application
* Import a single application Warning: as of 9.0.0, importing a living application using this service is deprecated.
*
* @param applicationsDataUpload Uploaded file (optional)
* @param importPolicy Import policy (optional)
* @deprecated
*/
@Deprecated
@RequestLine("POST /services/application/import")
@Headers({
"Content-Type: application/x-www-form-urlencoded",
"Accept: application/json",
})
void importApplication(@Param("applicationsDataUpload") String applicationsDataUpload,
@Param("importPolicy") String importPolicy);
/**
* Import a living application
* Similar to importApplication but it also returns the http response headers .
* Import a single application Warning: as of 9.0.0, importing a living application using this service is deprecated.
*
* @param applicationsDataUpload Uploaded file (optional)
* @param importPolicy Import policy (optional)
* @deprecated
*/
@Deprecated
@RequestLine("POST /services/application/import")
@Headers({
"Content-Type: application/x-www-form-urlencoded",
"Accept: application/json",
})
ApiResponse importApplicationWithHttpInfo(@Param("applicationsDataUpload") String applicationsDataUpload,
@Param("importPolicy") String importPolicy);
/**
* Finds living applications
* Finds living applications with pagination params and filters - can order on `id`,`creationDate`, `createdBy`,
* `profileId`, `token`, `displayName`, `updatedBy`, `lastUpdateDate`, `version`, `link` -
* can search on `token`, `displayName`, `version`, `link` - can filter on `token`, `displayName`,
* `version`, `link`, `profileId`, `creationDate`, `createdBy`, `updatedBy` ,
* `lastUpdateDate`, `userId`
*
* @param p index of the page to display (required)
* @param c maximum number of elements to retrieve (required)
* @param f can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
* @param o can order on attributes (optional)
* @param s can search on attributes (optional)
* @return List<Application>
*/
@RequestLine("GET /API/living/application?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
List searchApplications(@Param("p") Integer p, @Param("c") Integer c, @Param("f") List f,
@Param("o") String o, @Param("s") String s);
/**
* Finds living applications
* Similar to searchApplications but it also returns the http response headers .
* Finds living applications with pagination params and filters - can order on `id`,`creationDate`, `createdBy`,
* `profileId`, `token`, `displayName`, `updatedBy`, `lastUpdateDate`, `version`, `link` -
* can search on `token`, `displayName`, `version`, `link` - can filter on `token`, `displayName`,
* `version`, `link`, `profileId`, `creationDate`, `createdBy`, `updatedBy` ,
* `lastUpdateDate`, `userId`
*
* @param p index of the page to display (required)
* @param c maximum number of elements to retrieve (required)
* @param f can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
* @param o can order on attributes (optional)
* @param s can search on attributes (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/living/application?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchApplicationsWithHttpInfo(@Param("p") Integer p, @Param("c") Integer c,
@Param("f") List f, @Param("o") String o, @Param("s") 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`, `link` -
* can search on `token`, `displayName`, `version`, `link` - can filter on `token`, `displayName`,
* `version`, `link`, `profileId`, `creationDate`, `createdBy`, `updatedBy` ,
* `lastUpdateDate`, `userId`
* 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 {@link SearchApplicationsQueryParams} class that allows for
* building up this map in a fluent style.
*
* @param 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)
*
* @return List<Application>
*/
@RequestLine("GET /API/living/application?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
List searchApplications(@QueryMap(encoded = true) SearchApplicationsQueryParams queryParams);
/**
* Finds living applications
* Finds living applications with pagination params and filters - can order on `id`,`creationDate`, `createdBy`,
* `profileId`, `token`, `displayName`, `updatedBy`, `lastUpdateDate`, `version`, `link` -
* can search on `token`, `displayName`, `version`, `link` - can filter on `token`, `displayName`,
* `version`, `link`, `profileId`, `creationDate`, `createdBy`, `updatedBy` ,
* `lastUpdateDate`, `userId`
* Note, this is equivalent to the other searchApplications that receives the query parameters as a map,
* but this one also exposes the Http response headers
*
* @param 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)
*
* @return List<Application>
*/
@RequestLine("GET /API/living/application?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchApplicationsWithHttpInfo(
@QueryMap(encoded = true) SearchApplicationsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* searchApplications method in a fluent style.
*/
public static class SearchApplicationsQueryParams extends HashMap {
public SearchApplicationsQueryParams p(final Integer value) {
put("p", EncodingUtils.encode(value));
return this;
}
public SearchApplicationsQueryParams c(final Integer value) {
put("c", EncodingUtils.encode(value));
return this;
}
public SearchApplicationsQueryParams f(final List value) {
put("f", EncodingUtils.encodeCollection(value, "multi"));
return this;
}
public SearchApplicationsQueryParams o(final String value) {
put("o", EncodingUtils.encode(value));
return this;
}
public SearchApplicationsQueryParams s(final String value) {
put("s", EncodingUtils.encode(value));
return this;
}
}
/**
* Update a living application by ID
* Update a single application for the given ID (legacy application or application link). Warning: as of 9.0.0, updating a living application using this API is
* deprecated.
*
* @param id ID of application to return (required)
* @param applicationUpdateRequest Partial living application description (required)
* @return Application
* @deprecated
*/
@Deprecated
@RequestLine("PUT /API/living/application/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Application updateApplicationById(@Param("id") String id, ApplicationUpdateRequest applicationUpdateRequest);
/**
* Update a living application by ID
* Similar to updateApplicationById but it also returns the http response headers .
* Update a single application for the given ID (legacy application or application link). Warning: as of 9.0.0, updating a living application using this API is
* deprecated.
*
* @param id ID of application to return (required)
* @param applicationUpdateRequest Partial living application description (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
* @deprecated
*/
@Deprecated
@RequestLine("PUT /API/living/application/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse updateApplicationByIdWithHttpInfo(@Param("id") String id,
ApplicationUpdateRequest applicationUpdateRequest);
/**
* Upload a living application
* Upload application Warning: as of 9.0.0, uploading a living application using the portal is deprecated.
*
* @param file (optional)
* @return String
* @deprecated
*/
@Deprecated
@RequestLine("POST /portal/applicationsUpload")
@Headers({
"Content-Type: multipart/form-data",
"Accept: application/json,text/plain",
})
String uploadApplication(@Param("file") File file);
/**
* Upload a living application
* Similar to uploadApplication but it also returns the http response headers .
* Upload application Warning: as of 9.0.0, uploading a living application using the portal is deprecated.
*
* @param file (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
* @deprecated
*/
@Deprecated
@RequestLine("POST /portal/applicationsUpload")
@Headers({
"Content-Type: multipart/form-data",
"Accept: application/json,text/plain",
})
ApiResponse uploadApplicationWithHttpInfo(@Param("file") File file);
/**
* Upload an application configuration file
*  Upload an application configuration file in the `bconf` format. Warning: as of
* 9.0.0, uploading an application configuration file using this API is deprecated.
*
* @param _configuration (required)
* @return String
* @deprecated
*/
@Deprecated
@RequestLine("POST /APIv2/service/install")
@Headers({
"Content-Type: multipart/form-data",
"Accept: application/json,text/plain",
})
String uploadApplicationConfiguration(@Param("configuration") File _configuration);
/**
* Upload an application configuration file
* Similar to uploadApplicationConfiguration but it also returns the http response headers .
*  Upload an application configuration file in the `bconf` format. Warning: as of
* 9.0.0, uploading an application configuration file using this API is deprecated.
*
* @param _configuration (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
* @deprecated
*/
@Deprecated
@RequestLine("POST /APIv2/service/install")
@Headers({
"Content-Type: multipart/form-data",
"Accept: application/json,text/plain",
})
ApiResponse uploadApplicationConfigurationWithHttpInfo(@Param("configuration") File _configuration);
}