Package org.bonitasoft.web.client.api

Interface ProcessSupervisorApi

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

  • Method Details

    • createProcessSupervisor

      ProcessSupervisor createProcessSupervisor(ProcessSupervisor body)
      Create the ProcessSupervisor Create the ProcessSupervisor
      Parameters:
      body - The process definition id and either the user, role and/or group id. (required)
      Returns:
      ProcessSupervisor

    • createProcessSupervisorWithHttpInfo

      ApiResponse<ProcessSupervisor> createProcessSupervisorWithHttpInfo(ProcessSupervisor body)
      Create the ProcessSupervisor Similar to createProcessSupervisor but it also returns the http response headers . Create the ProcessSupervisor
      Parameters:
      body - The process definition id and either the user, role and/or group id. (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • deleteProcessSupervisorById

      void deleteProcessSupervisorById(List<String> requestBody)
      Delete the ProcessSupervisor by ID Delete the ProcessSupervisor for the given compoound IDs You can delete a process supervisor by specifying its compound Id in the body of the request with the following format: `process_id/user_id/role_id/group_id`
      Parameters:
      requestBody - The process definition id and either the user, role and/or group id. (required)

    • deleteProcessSupervisorByIdWithHttpInfo

      ApiResponse<Void> deleteProcessSupervisorByIdWithHttpInfo(List<String> requestBody)
      Delete the ProcessSupervisor by ID Similar to deleteProcessSupervisorById but it also returns the http response headers . Delete the ProcessSupervisor for the given compoound IDs You can delete a process supervisor by specifying its compound Id in the body of the request with the following format: `process_id/user_id/role_id/group_id`
      Parameters:
      requestBody - The process definition id and either the user, role and/or group id. (required)

    • searchProcessSupervisors

      List<ProcessSupervisor> searchProcessSupervisors(Integer p, Integer c, List<String> f, String o, String s)
      Finds ProcessSupervisors Finds ProcessSupervisors with pagination params and filters To filter, you need to specify the `process_id`, and then the `user_id`, `group_id` and `role_id` with one of them (two if you want to filter on group and role) set to `>0` and the other ones set to `-1`. E.g.: `f=process_id%3D8040901857674754544&f=user_id%3D>0&f=group_id%3D-1&f=role_id%3D-1`
      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<ProcessSupervisor>

    • searchProcessSupervisorsWithHttpInfo

      ApiResponse<List<ProcessSupervisor>> searchProcessSupervisorsWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)
      Finds ProcessSupervisors Similar to searchProcessSupervisors but it also returns the http response headers . Finds ProcessSupervisors with pagination params and filters To filter, you need to specify the `process_id`, and then the `user_id`, `group_id` and `role_id` with one of them (two if you want to filter on group and role) set to `>0` and the other ones set to `-1`. E.g.: `f=process_id%3D8040901857674754544&f=user_id%3D>0&f=group_id%3D-1&f=role_id%3D-1`
      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.

    • searchProcessSupervisors

      List<ProcessSupervisor> searchProcessSupervisors(ProcessSupervisorApi.SearchProcessSupervisorsQueryParams queryParams)
      Finds ProcessSupervisors Finds ProcessSupervisors with pagination params and filters To filter, you need to specify the `process_id`, and then the `user_id`, `group_id` and `role_id` with one of them (two if you want to filter on group and role) set to `>0` and the other ones set to `-1`. E.g.: `f=process_id%3D8040901857674754544&f=user_id%3D>0&f=group_id%3D-1&f=role_id%3D-1` Note, this is equivalent to the other searchProcessSupervisors 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 ProcessSupervisorApi.SearchProcessSupervisorsQueryParams 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<ProcessSupervisor>

    • searchProcessSupervisorsWithHttpInfo

      ApiResponse<List<ProcessSupervisor>> searchProcessSupervisorsWithHttpInfo(ProcessSupervisorApi.SearchProcessSupervisorsQueryParams queryParams)
      Finds ProcessSupervisors Finds ProcessSupervisors with pagination params and filters To filter, you need to specify the `process_id`, and then the `user_id`, `group_id` and `role_id` with one of them (two if you want to filter on group and role) set to `>0` and the other ones set to `-1`. E.g.: `f=process_id%3D8040901857674754544&f=user_id%3D>0&f=group_id%3D-1&f=role_id%3D-1` Note, this is equivalent to the other searchProcessSupervisors 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<ProcessSupervisor>