Package org.bonitasoft.web.client.api

Interface RoleApi

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

  • Method Details

    • createRole

      Role createRole(RoleCreateRequest body)
      Create the Role Create the Role
      Parameters:
      body - Partial Role description (required)
      Returns:
      Role

    • createRoleWithHttpInfo

      ApiResponse<Role> createRoleWithHttpInfo(RoleCreateRequest body)
      Create the Role Similar to createRole but it also returns the http response headers . Create the Role
      Parameters:
      body - Partial Role description (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • deleteRoleById

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

    • deleteRoleByIdWithHttpInfo

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

    • getRoleById

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

    • getRoleByIdWithHttpInfo

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

    • searchRoles

      List<Role> searchRoles(Integer p, Integer c, List<String> f, String o, String s)
      Finds Roles Finds Roles with pagination params and filters - can order on `id`, `name` and `displayName` - can filter on `name` and `displayName`
      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<Role>

    • searchRolesWithHttpInfo

      ApiResponse<List<Role>> searchRolesWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)
      Finds Roles Similar to searchRoles but it also returns the http response headers . Finds Roles with pagination params and filters - can order on `id`, `name` and `displayName` - can filter on `name` and `displayName`
      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.

    • searchRoles

      List<Role> searchRoles(RoleApi.SearchRolesQueryParams queryParams)
      Finds Roles Finds Roles with pagination params and filters - can order on `id`, `name` and `displayName` - can filter on `name` and `displayName` Note, this is equivalent to the other searchRoles 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 RoleApi.SearchRolesQueryParams 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<Role>

    • searchRolesWithHttpInfo

      ApiResponse<List<Role>> searchRolesWithHttpInfo(RoleApi.SearchRolesQueryParams queryParams)
      Finds Roles Finds Roles with pagination params and filters - can order on `id`, `name` and `displayName` - can filter on `name` and `displayName` Note, this is equivalent to the other searchRoles 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<Role>

    • updateRoleById

      void updateRoleById(String id, RoleUpdateRequest roleUpdateRequest)
      Update the Role by ID Update the Role for the given ID
      Parameters:
      id - ID of the Role to return (required)
      roleUpdateRequest - Partial Role description (required)

    • updateRoleByIdWithHttpInfo

      ApiResponse<Void> updateRoleByIdWithHttpInfo(String id, RoleUpdateRequest roleUpdateRequest)
      Update the Role by ID Similar to updateRoleById but it also returns the http response headers . Update the Role for the given ID
      Parameters:
      id - ID of the Role to return (required)
      roleUpdateRequest - Partial Role description (required)