Package org.bonitasoft.web.client.api

Interface ApplicationMenuApi

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

  • Method Details

    • createApplicationMenu

      @Deprecated ApplicationMenu createApplicationMenu(ApplicationMenuCreateRequest applicationMenuCreateRequest)
      Deprecated.
      New application menu item Create an application menu item Warning: as of 9.0.0, creating an application menu item using this API is deprecated.
      Parameters:
      applicationMenuCreateRequest - A partial representation of an application menu in JSON (optional)
      Returns:
      ApplicationMenu

    • createApplicationMenuWithHttpInfo

      @Deprecated ApiResponse<ApplicationMenu> createApplicationMenuWithHttpInfo(ApplicationMenuCreateRequest applicationMenuCreateRequest)
      Deprecated.
      New application menu item Similar to createApplicationMenu but it also returns the http response headers . Create an application menu item Warning: as of 9.0.0, creating an application menu item using this API is deprecated.
      Parameters:
      applicationMenuCreateRequest - A partial representation of an application menu in JSON (optional)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • deleteApplicationMenuById

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

    • deleteApplicationMenuByIdWithHttpInfo

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

    • geApplicationMenuById

      ApplicationMenu geApplicationMenuById(String id)
      Finds a application menu by ID Returns a single application menu for the given ID
      Parameters:
      id - ID of application menu to return (required)
      Returns:
      ApplicationMenu

    • geApplicationMenuByIdWithHttpInfo

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

    • searchApplicationMenus

      List<ApplicationMenu> searchApplicationMenus(Integer p, Integer c, List<String> f, String o, String s)
      Finds application menus Returns application menus with pagination params and filters - can order on `id`, `displayName`, `applicationId`, `applicationPageId`, `menuIndex`, `parentMenuId` - can search on `displayName` - can filter on `id`, `displayName`, `applicationId`, `applicationPageId`, `menuIndex`, `parentMenuId`
      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<ApplicationMenu>

    • searchApplicationMenusWithHttpInfo

      ApiResponse<List<ApplicationMenu>> searchApplicationMenusWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)
      Finds application menus Similar to searchApplicationMenus but it also returns the http response headers . Returns application menus with pagination params and filters - can order on `id`, `displayName`, `applicationId`, `applicationPageId`, `menuIndex`, `parentMenuId` - can search on `displayName` - can filter on `id`, `displayName`, `applicationId`, `applicationPageId`, `menuIndex`, `parentMenuId`
      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.

    • searchApplicationMenus

      List<ApplicationMenu> searchApplicationMenus(ApplicationMenuApi.SearchApplicationMenusQueryParams queryParams)
      Finds application menus Returns application menus with pagination params and filters - can order on `id`, `displayName`, `applicationId`, `applicationPageId`, `menuIndex`, `parentMenuId` - can search on `displayName` - can filter on `id`, `displayName`, `applicationId`, `applicationPageId`, `menuIndex`, `parentMenuId` Note, this is equivalent to the other searchApplicationMenus 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 ApplicationMenuApi.SearchApplicationMenusQueryParams 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<ApplicationMenu>

    • searchApplicationMenusWithHttpInfo

      ApiResponse<List<ApplicationMenu>> searchApplicationMenusWithHttpInfo(ApplicationMenuApi.SearchApplicationMenusQueryParams queryParams)
      Finds application menus Returns application menus with pagination params and filters - can order on `id`, `displayName`, `applicationId`, `applicationPageId`, `menuIndex`, `parentMenuId` - can search on `displayName` - can filter on `id`, `displayName`, `applicationId`, `applicationPageId`, `menuIndex`, `parentMenuId` Note, this is equivalent to the other searchApplicationMenus 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<ApplicationMenu>

    • updateApplicationMenuById

      @Deprecated void updateApplicationMenuById(String id, ApplicationMenuUpdateRequest applicationMenuUpdateRequest)
      Deprecated.
      Update an application menu by ID Update an application menu for the given ID Warning: as of 9.0.0, updating an application menu item using this API is deprecated.
      Parameters:
      id - ID of the application menu to return (required)
      applicationMenuUpdateRequest - Partial application menu description (required)

    • updateApplicationMenuByIdWithHttpInfo

      @Deprecated ApiResponse<Void> updateApplicationMenuByIdWithHttpInfo(String id, ApplicationMenuUpdateRequest applicationMenuUpdateRequest)
      Deprecated.
      Update an application menu by ID Similar to updateApplicationMenuById but it also returns the http response headers . Update an application menu for the given ID Warning: as of 9.0.0, updating an application menu item using this API is deprecated.
      Parameters:
      id - ID of the application menu to return (required)
      applicationMenuUpdateRequest - Partial application menu description (required)