Package org.bonitasoft.web.client.api

Interface HumanTaskApi

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    HumanTaskApi.SearchHumanTasksQueryParams
    A convenience class for generating query parameters for the searchHumanTasks method in a fluent style.

  • Method Summary

    Modifier and Type
    Method
    Description
    HumanTask
    getHumanTaskById(String id)
    Finds the HumanTask by ID Returns the single HumanTask for the given ID
    ApiResponse<HumanTask>
    getHumanTaskByIdWithHttpInfo(String id)
    Finds the HumanTask by ID Similar to getHumanTaskById but it also returns the http response headers .
    List<HumanTask>
    searchHumanTasks(Integer p, Integer c, List<String> f, String o, String s)
    Finds HumanTasks Finds HumanTasks with pagination params and filters - can order on `name`, `priority`, `dueDate`, `state`, `processDefinitionId`, `processInstanceId`, `parentActivityInstanceId`, `assigneeId`, `parentContainerId`, `displayName`, `reachedStateDate` - can search on any field that can be used to order results - can filter on `assigned_id`, `user_id`, `show_assigned_to_others` (since 2022.2), `state`, `name`, `displayName`, `processDefinitionId`, `caseId`, `rootCaseId`, `parentCaseId`
    List<HumanTask>
    searchHumanTasks(HumanTaskApi.SearchHumanTasksQueryParams queryParams)
    Finds HumanTasks Finds HumanTasks with pagination params and filters - can order on `name`, `priority`, `dueDate`, `state`, `processDefinitionId`, `processInstanceId`, `parentActivityInstanceId`, `assigneeId`, `parentContainerId`, `displayName`, `reachedStateDate` - can search on any field that can be used to order results - can filter on `assigned_id`, `user_id`, `show_assigned_to_others` (since 2022.2), `state`, `name`, `displayName`, `processDefinitionId`, `caseId`, `rootCaseId`, `parentCaseId` Note, this is equivalent to the other searchHumanTasks method, but with the query parameters collected into a single Map parameter.
    ApiResponse<List<HumanTask>>
    searchHumanTasksWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)
    Finds HumanTasks Similar to searchHumanTasks but it also returns the http response headers .
    ApiResponse<List<HumanTask>>
    searchHumanTasksWithHttpInfo(HumanTaskApi.SearchHumanTasksQueryParams queryParams)
    Finds HumanTasks Finds HumanTasks with pagination params and filters - can order on `name`, `priority`, `dueDate`, `state`, `processDefinitionId`, `processInstanceId`, `parentActivityInstanceId`, `assigneeId`, `parentContainerId`, `displayName`, `reachedStateDate` - can search on any field that can be used to order results - can filter on `assigned_id`, `user_id`, `show_assigned_to_others` (since 2022.2), `state`, `name`, `displayName`, `processDefinitionId`, `caseId`, `rootCaseId`, `parentCaseId` Note, this is equivalent to the other searchHumanTasks that receives the query parameters as a map, but this one also exposes the Http response headers
    void
    updateHumanTaskById(String id, HumanTaskUpdateRequest humanTaskUpdateRequest)
    Update the HumanTask by ID Update the HumanTask for the given ID
    ApiResponse<Void>
    updateHumanTaskByIdWithHttpInfo(String id, HumanTaskUpdateRequest humanTaskUpdateRequest)
    Update the HumanTask by ID Similar to updateHumanTaskById but it also returns the http response headers .

  • Method Details

    • getHumanTaskById

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

    • getHumanTaskByIdWithHttpInfo

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

    • searchHumanTasks

      List<HumanTask> searchHumanTasks(Integer p, Integer c, List<String> f, String o, String s)
      Finds HumanTasks Finds HumanTasks with pagination params and filters - can order on `name`, `priority`, `dueDate`, `state`, `processDefinitionId`, `processInstanceId`, `parentActivityInstanceId`, `assigneeId`, `parentContainerId`, `displayName`, `reachedStateDate` - can search on any field that can be used to order results - can filter on `assigned_id`, `user_id`, `show_assigned_to_others` (since 2022.2), `state`, `name`, `displayName`, `processDefinitionId`, `caseId`, `rootCaseId`, `parentCaseId`
      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<HumanTask>

    • searchHumanTasksWithHttpInfo

      ApiResponse<List<HumanTask>> searchHumanTasksWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)
      Finds HumanTasks Similar to searchHumanTasks but it also returns the http response headers . Finds HumanTasks with pagination params and filters - can order on `name`, `priority`, `dueDate`, `state`, `processDefinitionId`, `processInstanceId`, `parentActivityInstanceId`, `assigneeId`, `parentContainerId`, `displayName`, `reachedStateDate` - can search on any field that can be used to order results - can filter on `assigned_id`, `user_id`, `show_assigned_to_others` (since 2022.2), `state`, `name`, `displayName`, `processDefinitionId`, `caseId`, `rootCaseId`, `parentCaseId`
      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.

    • searchHumanTasks

      List<HumanTask> searchHumanTasks(HumanTaskApi.SearchHumanTasksQueryParams queryParams)
      Finds HumanTasks Finds HumanTasks with pagination params and filters - can order on `name`, `priority`, `dueDate`, `state`, `processDefinitionId`, `processInstanceId`, `parentActivityInstanceId`, `assigneeId`, `parentContainerId`, `displayName`, `reachedStateDate` - can search on any field that can be used to order results - can filter on `assigned_id`, `user_id`, `show_assigned_to_others` (since 2022.2), `state`, `name`, `displayName`, `processDefinitionId`, `caseId`, `rootCaseId`, `parentCaseId` Note, this is equivalent to the other searchHumanTasks 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 HumanTaskApi.SearchHumanTasksQueryParams 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<HumanTask>

    • searchHumanTasksWithHttpInfo

      ApiResponse<List<HumanTask>> searchHumanTasksWithHttpInfo(HumanTaskApi.SearchHumanTasksQueryParams queryParams)
      Finds HumanTasks Finds HumanTasks with pagination params and filters - can order on `name`, `priority`, `dueDate`, `state`, `processDefinitionId`, `processInstanceId`, `parentActivityInstanceId`, `assigneeId`, `parentContainerId`, `displayName`, `reachedStateDate` - can search on any field that can be used to order results - can filter on `assigned_id`, `user_id`, `show_assigned_to_others` (since 2022.2), `state`, `name`, `displayName`, `processDefinitionId`, `caseId`, `rootCaseId`, `parentCaseId` Note, this is equivalent to the other searchHumanTasks 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<HumanTask>

    • updateHumanTaskById

      void updateHumanTaskById(String id, HumanTaskUpdateRequest humanTaskUpdateRequest)
      Update the HumanTask by ID Update the HumanTask for the given ID
      Parameters:
      id - ID of the HumanTask to return (required)
      humanTaskUpdateRequest - Fields that can be updated are `assignedId` and `state`. Specify only those fields that you want to change. (required)

    • updateHumanTaskByIdWithHttpInfo

      ApiResponse<Void> updateHumanTaskByIdWithHttpInfo(String id, HumanTaskUpdateRequest humanTaskUpdateRequest)
      Update the HumanTask by ID Similar to updateHumanTaskById but it also returns the http response headers . Update the HumanTask for the given ID
      Parameters:
      id - ID of the HumanTask to return (required)
      humanTaskUpdateRequest - Fields that can be updated are `assignedId` and `state`. Specify only those fields that you want to change. (required)