Package org.bonitasoft.web.client.api

Interface ProcessInstanceApi

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

  • Method Details

    • createProcessInstance

      ProcessInstance createProcessInstance(ProcessInstanceCreateRequest body)
      Create the ProcessInstance ![edition](https://img.shields.io/badge/edition-entreprise-blue) ![edition](https://img.shields.io/badge/edition-community-brightgreen) Create the ProcessInstance This way of creating a process instance using this method will only work for processes in which no contract is defined. To instantiate a process with a contract, check the process instantiation resource documentation.
      Parameters:
      body - **Warning**: The attribute `variables` on the request payload is used to initialize the process variables (not BDM variables). If you want to initialize BDM variables at process instantiation, add a contract on the process and map BDM variables to the contract data. See Start a process using an instantiation contract for usage. (required)
      Returns:
      ProcessInstance

    • createProcessInstanceWithHttpInfo

      ApiResponse<ProcessInstance> createProcessInstanceWithHttpInfo(ProcessInstanceCreateRequest body)
      Create the ProcessInstance Similar to createProcessInstance but it also returns the http response headers . ![edition](https://img.shields.io/badge/edition-entreprise-blue) ![edition](https://img.shields.io/badge/edition-community-brightgreen) Create the ProcessInstance This way of creating a process instance using this method will only work for processes in which no contract is defined. To instantiate a process with a contract, check the process instantiation resource documentation.
      Parameters:
      body - **Warning**: The attribute `variables` on the request payload is used to initialize the process variables (not BDM variables). If you want to initialize BDM variables at process instantiation, add a contract on the process and map BDM variables to the contract data. See Start a process using an instantiation contract for usage. (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • deleteProcessInstanceById

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

    • deleteProcessInstanceByIdWithHttpInfo

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

    • deleteProcessInstanceByIds

      void deleteProcessInstanceByIds(List<String> requestBody)
      Delete the ProcessInstance by batch ![edition](https://img.shields.io/badge/edition-entreprise-blue) ![edition](https://img.shields.io/badge/edition-community-brightgreen) Delete a list of ProcessInstances for the given IDs
      Parameters:
      requestBody - (optional)

    • deleteProcessInstanceByIdsWithHttpInfo

      ApiResponse<Void> deleteProcessInstanceByIdsWithHttpInfo(List<String> requestBody)
      Delete the ProcessInstance by batch Similar to deleteProcessInstanceByIds but it also returns the http response headers . ![edition](https://img.shields.io/badge/edition-entreprise-blue) ![edition](https://img.shields.io/badge/edition-community-brightgreen) Delete a list of ProcessInstances for the given IDs
      Parameters:
      requestBody - (optional)

    • getContextByProcessInstanceId

      Map<String,Object> getContextByProcessInstanceId(String id)
      Finds the Context by ProcessInstance ID Returns the Context for the given ProcessInstance ID
      Parameters:
      id - ID of the ProcessInstance that has the Context to return (required)
      Returns:
      Map<String, Object>

    • getContextByProcessInstanceIdWithHttpInfo

      ApiResponse<Map<String,Object>> getContextByProcessInstanceIdWithHttpInfo(String id)
      Finds the Context by ProcessInstance ID Similar to getContextByProcessInstanceId but it also returns the http response headers . Returns the Context for the given ProcessInstance ID
      Parameters:
      id - ID of the ProcessInstance that has the Context to return (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • getProcessInstanceById

      ProcessInstance getProcessInstanceById(String id, String n)
      Finds the ProcessInstance by ID Returns the single ProcessInstance for the given ID
      Parameters:
      id - ID of the ProcessInstance to return (required)
      n - Count of related resources (optional)
      Returns:
      ProcessInstance

    • getProcessInstanceByIdWithHttpInfo

      ApiResponse<ProcessInstance> getProcessInstanceByIdWithHttpInfo(String id, String n)
      Finds the ProcessInstance by ID Similar to getProcessInstanceById but it also returns the http response headers . Returns the single ProcessInstance for the given ID
      Parameters:
      id - ID of the ProcessInstance to return (required)
      n - Count of related resources (optional)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • getProcessInstanceById

      ProcessInstance getProcessInstanceById(String id, ProcessInstanceApi.GetProcessInstanceByIdQueryParams queryParams)
      Finds the ProcessInstance by ID Returns the single ProcessInstance for the given ID Note, this is equivalent to the other getProcessInstanceById 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 ProcessInstanceApi.GetProcessInstanceByIdQueryParams class that allows for building up this map in a fluent style.
      Parameters:
      id - ID of the ProcessInstance to return (required)
      queryParams - Map of query parameters as name-value pairs

      The following elements may be specified in the query map:

      • n - Count of related resources (optional)
      Returns:
      ProcessInstance

    • getProcessInstanceByIdWithHttpInfo

      ApiResponse<ProcessInstance> getProcessInstanceByIdWithHttpInfo(String id, ProcessInstanceApi.GetProcessInstanceByIdQueryParams queryParams)
      Finds the ProcessInstance by ID Returns the single ProcessInstance for the given ID Note, this is equivalent to the other getProcessInstanceById that receives the query parameters as a map, but this one also exposes the Http response headers
      Parameters:
      id - ID of the ProcessInstance to return (required)
      queryParams - Map of query parameters as name-value pairs

      The following elements may be specified in the query map:

      • n - Count of related resources (optional)
      Returns:
      ProcessInstance

    • searchProcessInstances

      List<ProcessInstance> searchProcessInstances(Integer p, Integer c, List<String> f, String o)
      Finds ProcessInstances Finds ProcessInstances with pagination params and filters You can filter on: * `processDefinitionId`: The process definition ID * `rootCaseId`: the root process instance ID (since version 10.3 - 2025.1) * `name`: the process name * `started_by`: the ID of the user who started the process * `team_manager_id`: allow to retrieve the process instances in which all users with this manager ID ar involved) * `supervisor_id`: allow the retrived the process instances of all processes the user with this ID is supervisor of) beware you cannot use team_manager_id and supervisor_id at the same time * `searchIndex1Value`, `searchIndex2Value`, `searchIndex3Value`, `searchIndex4Value`, `searchIndex5Value`: the value of the corresponding search index (since version 10.3 - 2025.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)
      Returns:
      List<ProcessInstance>

    • searchProcessInstancesWithHttpInfo

      ApiResponse<List<ProcessInstance>> searchProcessInstancesWithHttpInfo(Integer p, Integer c, List<String> f, String o)
      Finds ProcessInstances Similar to searchProcessInstances but it also returns the http response headers . Finds ProcessInstances with pagination params and filters You can filter on: * `processDefinitionId`: The process definition ID * `rootCaseId`: the root process instance ID (since version 10.3 - 2025.1) * `name`: the process name * `started_by`: the ID of the user who started the process * `team_manager_id`: allow to retrieve the process instances in which all users with this manager ID ar involved) * `supervisor_id`: allow the retrived the process instances of all processes the user with this ID is supervisor of) beware you cannot use team_manager_id and supervisor_id at the same time * `searchIndex1Value`, `searchIndex2Value`, `searchIndex3Value`, `searchIndex4Value`, `searchIndex5Value`: the value of the corresponding search index (since version 10.3 - 2025.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)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • searchProcessInstances

      List<ProcessInstance> searchProcessInstances(ProcessInstanceApi.SearchProcessInstancesQueryParams queryParams)
      Finds ProcessInstances Finds ProcessInstances with pagination params and filters You can filter on: * `processDefinitionId`: The process definition ID * `rootCaseId`: the root process instance ID (since version 10.3 - 2025.1) * `name`: the process name * `started_by`: the ID of the user who started the process * `team_manager_id`: allow to retrieve the process instances in which all users with this manager ID ar involved) * `supervisor_id`: allow the retrived the process instances of all processes the user with this ID is supervisor of) beware you cannot use team_manager_id and supervisor_id at the same time * `searchIndex1Value`, `searchIndex2Value`, `searchIndex3Value`, `searchIndex4Value`, `searchIndex5Value`: the value of the corresponding search index (since version 10.3 - 2025.1) Note, this is equivalent to the other searchProcessInstances 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 ProcessInstanceApi.SearchProcessInstancesQueryParams 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)
      Returns:
      List<ProcessInstance>

    • searchProcessInstancesWithHttpInfo

      ApiResponse<List<ProcessInstance>> searchProcessInstancesWithHttpInfo(ProcessInstanceApi.SearchProcessInstancesQueryParams queryParams)
      Finds ProcessInstances Finds ProcessInstances with pagination params and filters You can filter on: * `processDefinitionId`: The process definition ID * `rootCaseId`: the root process instance ID (since version 10.3 - 2025.1) * `name`: the process name * `started_by`: the ID of the user who started the process * `team_manager_id`: allow to retrieve the process instances in which all users with this manager ID ar involved) * `supervisor_id`: allow the retrived the process instances of all processes the user with this ID is supervisor of) beware you cannot use team_manager_id and supervisor_id at the same time * `searchIndex1Value`, `searchIndex2Value`, `searchIndex3Value`, `searchIndex4Value`, `searchIndex5Value`: the value of the corresponding search index (since version 10.3 - 2025.1) Note, this is equivalent to the other searchProcessInstances 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)
      Returns:
      List<ProcessInstance>

    • updateProcessInstanceById

      void updateProcessInstanceById(String id, ProcessInstanceUpdateRequest processInstanceUpdateRequest)
      Update the ProcessInstance by ID Only the state of a ProcessInstance (with the given ID) can be updated in order to cancel it (since version 10.3 - 2025.1).
      Parameters:
      id - ID of the ProcessInstance to update (required)
      processInstanceUpdateRequest - Cancel the ProcessInstance. (required)

    • updateProcessInstanceByIdWithHttpInfo

      ApiResponse<Void> updateProcessInstanceByIdWithHttpInfo(String id, ProcessInstanceUpdateRequest processInstanceUpdateRequest)
      Update the ProcessInstance by ID Similar to updateProcessInstanceById but it also returns the http response headers . Only the state of a ProcessInstance (with the given ID) can be updated in order to cancel it (since version 10.3 - 2025.1).
      Parameters:
      id - ID of the ProcessInstance to update (required)
      processInstanceUpdateRequest - Cancel the ProcessInstance. (required)