Package org.bonitasoft.web.client.api

Interface ApplicationApi

All Superinterfaces:
ApiClient.Api
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.12.0") public interface ApplicationApi extends ApiClient.Api

  • Method Details

    • createApplication

      @Deprecated Application createApplication(CreateApplicationRequest body)
      Deprecated.
      Create a living application Create a living application (legacy application or application link). Warning: as of 9.0.0, creating a living application using this API is deprecated.
      Parameters:
      body - Partial living application description (required)
      Returns:
      Application

    • createApplicationWithHttpInfo

      @Deprecated ApiResponse<Application> createApplicationWithHttpInfo(CreateApplicationRequest body)
      Deprecated.
      Create a living application Similar to 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.
      Parameters:
      body - Partial living application description (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • 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)

    • deleteApplicationByIdWithHttpInfo

      ApiResponse<Void> deleteApplicationByIdWithHttpInfo(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
      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

    • getApplicationByIdWithHttpInfo

      ApiResponse<Application> getApplicationByIdWithHttpInfo(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
      Parameters:
      id - ID of application to return (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • importApplication

      @Deprecated void importApplication(String applicationsDataUpload, String importPolicy)
      Deprecated.
      Import a living application Import a single application Warning: as of 9.0.0, importing a living application using this service is deprecated.
      Parameters:
      applicationsDataUpload - Uploaded file (optional)
      importPolicy - Import policy (optional)

    • importApplicationWithHttpInfo

      @Deprecated ApiResponse<Void> importApplicationWithHttpInfo(String applicationsDataUpload, String importPolicy)
      Deprecated.
      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.
      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`, `link` - can search on `token`, `displayName`, `version`, `link` - can filter on `token`, `displayName`, `version`, `link`, `profileId`, `creationDate`, `createdBy`, `updatedBy` , `lastUpdateDate`, `userId`
      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>

    • searchApplicationsWithHttpInfo

      ApiResponse<List<Application>> searchApplicationsWithHttpInfo(Integer p, Integer c, List<String> f, String o, 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`
      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:
      A ApiResponse that wraps the response boyd and the http headers.

    • searchApplications

      List<Application> searchApplications(ApplicationApi.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 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>

    • searchApplicationsWithHttpInfo

      ApiResponse<List<Application>> searchApplicationsWithHttpInfo(ApplicationApi.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
      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

      @Deprecated Application updateApplicationById(String id, ApplicationUpdateRequest applicationUpdateRequest)
      Deprecated.
      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.
      Parameters:
      id - ID of application to return (required)
      applicationUpdateRequest - Partial living application description (required)
      Returns:
      Application

    • updateApplicationByIdWithHttpInfo

      @Deprecated ApiResponse<Application> updateApplicationByIdWithHttpInfo(String id, ApplicationUpdateRequest applicationUpdateRequest)
      Deprecated.
      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.
      Parameters:
      id - ID of application to return (required)
      applicationUpdateRequest - Partial living application description (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • uploadApplication

      @Deprecated String uploadApplication(File file)
      Deprecated.
      Upload a living application Upload application Warning: as of 9.0.0, uploading a living application using the portal is deprecated.
      Parameters:
      file - (optional)
      Returns:
      String

    • uploadApplicationWithHttpInfo

      @Deprecated ApiResponse<String> uploadApplicationWithHttpInfo(File file)
      Deprecated.
      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.
      Parameters:
      file - (optional)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • uploadApplicationConfiguration

      @Deprecated String uploadApplicationConfiguration(File _configuration)
      Deprecated.
      Upload an application configuration file ![edition](https://img.shields.io/badge/edition-entreprise-blue) 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.
      Parameters:
      _configuration - (required)
      Returns:
      String

    • uploadApplicationConfigurationWithHttpInfo

      @Deprecated ApiResponse<String> uploadApplicationConfigurationWithHttpInfo(File _configuration)
      Deprecated.
      Upload an application configuration file Similar to uploadApplicationConfiguration but it also returns the http response headers . ![edition](https://img.shields.io/badge/edition-entreprise-blue) 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.
      Parameters:
      _configuration - (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.