Package org.bonitasoft.web.client.api

Interface CustomUserDefinitionApi

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

  • Method Details

    • createCustomUserDefinition

      CustomUserDefinition createCustomUserDefinition(CustomUserDefinitionCreateRequest body)
      Create the CustomUserDefinition Create the CustomUserDefinition
      Parameters:
      body - Partial CustomUserDefinition description (required)
      Returns:
      CustomUserDefinition

    • createCustomUserDefinitionWithHttpInfo

      ApiResponse<CustomUserDefinition> createCustomUserDefinitionWithHttpInfo(CustomUserDefinitionCreateRequest body)
      Create the CustomUserDefinition Similar to createCustomUserDefinition but it also returns the http response headers . Create the CustomUserDefinition
      Parameters:
      body - Partial CustomUserDefinition description (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • deleteCustomUserDefinitionById

      void deleteCustomUserDefinitionById(String id)
      Delete the CustomUserDefinition by ID Delete the single CustomUserDefinition for the given ID
      Parameters:
      id - ID of the CustomUserDefinition to delete (required)

    • deleteCustomUserDefinitionByIdWithHttpInfo

      ApiResponse<Void> deleteCustomUserDefinitionByIdWithHttpInfo(String id)
      Delete the CustomUserDefinition by ID Similar to deleteCustomUserDefinitionById but it also returns the http response headers . Delete the single CustomUserDefinition for the given ID
      Parameters:
      id - ID of the CustomUserDefinition to delete (required)

    • getCustomUserDefinitionById

      CustomUserDefinition getCustomUserDefinitionById(String id)
      Finds the CustomUserDefinition by ID Returns the single CustomUserDefinition for the given ID
      Parameters:
      id - ID of the CustomUserDefinition to return (required)
      Returns:
      CustomUserDefinition

    • getCustomUserDefinitionByIdWithHttpInfo

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

    • searchCustomUserDefinitions

      List<CustomUserDefinition> searchCustomUserDefinitions(Integer p, Integer c)
      Finds CustomUserDefinitions Finds CustomUserDefinitions. There are no filters, and no search terms. All the definitions are returned.
      Parameters:
      p - index of the page to display (required)
      c - maximum number of elements to retrieve (required)
      Returns:
      List<CustomUserDefinition>

    • searchCustomUserDefinitionsWithHttpInfo

      ApiResponse<List<CustomUserDefinition>> searchCustomUserDefinitionsWithHttpInfo(Integer p, Integer c)
      Finds CustomUserDefinitions Similar to searchCustomUserDefinitions but it also returns the http response headers . Finds CustomUserDefinitions. There are no filters, and no search terms. All the definitions are returned.
      Parameters:
      p - index of the page to display (required)
      c - maximum number of elements to retrieve (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • searchCustomUserDefinitions

      List<CustomUserDefinition> searchCustomUserDefinitions(CustomUserDefinitionApi.SearchCustomUserDefinitionsQueryParams queryParams)
      Finds CustomUserDefinitions Finds CustomUserDefinitions. There are no filters, and no search terms. All the definitions are returned. Note, this is equivalent to the other searchCustomUserDefinitions 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 CustomUserDefinitionApi.SearchCustomUserDefinitionsQueryParams 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)
      Returns:
      List<CustomUserDefinition>

    • searchCustomUserDefinitionsWithHttpInfo

      ApiResponse<List<CustomUserDefinition>> searchCustomUserDefinitionsWithHttpInfo(CustomUserDefinitionApi.SearchCustomUserDefinitionsQueryParams queryParams)
      Finds CustomUserDefinitions Finds CustomUserDefinitions. There are no filters, and no search terms. All the definitions are returned. Note, this is equivalent to the other searchCustomUserDefinitions 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)
      Returns:
      List<CustomUserDefinition>