Package org.bonitasoft.web.client.api

Interface ApplicationPageApi

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

  • Method Details

    • createApplicationPage

      @Deprecated ApplicationPage createApplicationPage(ApplicationPageCreateRequest body)
      Deprecated.
      Create an application page Create an application page Warning: as of 9.0.0, creating an application page using this API is deprecated.
      Parameters:
      body - Partial application page description (required)
      Returns:
      ApplicationPage

    • createApplicationPageWithHttpInfo

      @Deprecated ApiResponse<ApplicationPage> createApplicationPageWithHttpInfo(ApplicationPageCreateRequest body)
      Deprecated.
      Create an application page Similar to createApplicationPage but it also returns the http response headers . Create an application page Warning: as of 9.0.0, creating an application page using this API is deprecated.
      Parameters:
      body - Partial application page description (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • deleteApplicationPageById

      void deleteApplicationPageById(String id)
      Delete an application page by ID Delete a single application page for the given ID
      Parameters:
      id - ID of application page to delete (required)

    • deleteApplicationPageByIdWithHttpInfo

      ApiResponse<Void> deleteApplicationPageByIdWithHttpInfo(String id)
      Delete an application page by ID Similar to deleteApplicationPageById but it also returns the http response headers . Delete a single application page for the given ID
      Parameters:
      id - ID of application page to delete (required)

    • getApplicationPageById

      ApplicationPage getApplicationPageById(String id)
      Finds an application page by ID Returns a single application page for the given ID
      Parameters:
      id - ID of application page to return (required)
      Returns:
      ApplicationPage

    • getApplicationPageByIdWithHttpInfo

      ApiResponse<ApplicationPage> getApplicationPageByIdWithHttpInfo(String id)
      Finds an application page by ID Similar to getApplicationPageById but it also returns the http response headers . Returns a single application page for the given ID
      Parameters:
      id - ID of application page to return (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • searchApplicationPages

      List<ApplicationPage> searchApplicationPages(Integer p, Integer c, List<String> f, String o, String s)
      Finds application pages Finds application pages with pagination params and filters - can order on `id`, `token`, `applicationId`, `pageId` - can search on `token` - can filter on `id`, `token`, `applicationId`, `pageId`
      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<ApplicationPage>

    • searchApplicationPagesWithHttpInfo

      ApiResponse<List<ApplicationPage>> searchApplicationPagesWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)
      Finds application pages Similar to searchApplicationPages but it also returns the http response headers . Finds application pages with pagination params and filters - can order on `id`, `token`, `applicationId`, `pageId` - can search on `token` - can filter on `id`, `token`, `applicationId`, `pageId`
      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.

    • searchApplicationPages

      List<ApplicationPage> searchApplicationPages(ApplicationPageApi.SearchApplicationPagesQueryParams queryParams)
      Finds application pages Finds application pages with pagination params and filters - can order on `id`, `token`, `applicationId`, `pageId` - can search on `token` - can filter on `id`, `token`, `applicationId`, `pageId` Note, this is equivalent to the other searchApplicationPages 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 ApplicationPageApi.SearchApplicationPagesQueryParams 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<ApplicationPage>

    • searchApplicationPagesWithHttpInfo

      ApiResponse<List<ApplicationPage>> searchApplicationPagesWithHttpInfo(ApplicationPageApi.SearchApplicationPagesQueryParams queryParams)
      Finds application pages Finds application pages with pagination params and filters - can order on `id`, `token`, `applicationId`, `pageId` - can search on `token` - can filter on `id`, `token`, `applicationId`, `pageId` Note, this is equivalent to the other searchApplicationPages 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<ApplicationPage>