Package org.bonitasoft.web.client.api

Interface ArchivedProcessInstanceApi

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    ArchivedProcessInstanceApi.SearchArchivedProcessInstancesQueryParams
    A convenience class for generating query parameters for the searchArchivedProcessInstances method in a fluent style.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    deleteArchivedProcessInstanceById(String id)
    Delete the ArchivedProcessInstance by ID Delete the single ArchivedProcessInstance for the given ID
    ApiResponse<Void>
    deleteArchivedProcessInstanceByIdWithHttpInfo(String id)
    Delete the ArchivedProcessInstance by ID Similar to deleteArchivedProcessInstanceById but it also returns the http response headers .
    ArchivedProcessInstance
    getArchivedProcessInstanceById(String id)
    Finds the ArchivedProcessInstance by ID Returns the single ArchivedProcessInstance for the given ID
    ApiResponse<ArchivedProcessInstance>
    getArchivedProcessInstanceByIdWithHttpInfo(String id)
    Finds the ArchivedProcessInstance by ID Similar to getArchivedProcessInstanceById but it also returns the http response headers .
    Map<String,Object>
    getContextByArchivedProcessInstanceId(String id)
    Finds the Context by ArchivedProcessInstance ID Returns the Context for the given ArchivedProcessInstance ID
    ApiResponse<Map<String,Object>>
    getContextByArchivedProcessInstanceIdWithHttpInfo(String id)
    Finds the Context by ArchivedProcessInstance ID Similar to getContextByArchivedProcessInstanceId but it also returns the http response headers .
    List<ArchivedProcessInstance>
    searchArchivedProcessInstances(Integer p, Integer c, List<String> f, String o)
    Finds ArchivedProcessInstances Finds archived ProcessInstances (or ProcessInstance) with pagination params and filters You can order on `id`, `processDefinitionId`, `startedBy`, `startedBySubstitute`, `startDate`, `endDate`, `lastUpdate`, `archivedDate`, `sourceObjectId` You can filter on : * `sourceObjectId`: The original process instance ID before the process instance was archived * `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)
    List<ArchivedProcessInstance>
    searchArchivedProcessInstances(ArchivedProcessInstanceApi.SearchArchivedProcessInstancesQueryParams queryParams)
    Finds ArchivedProcessInstances Finds archived ProcessInstances (or ProcessInstance) with pagination params and filters You can order on `id`, `processDefinitionId`, `startedBy`, `startedBySubstitute`, `startDate`, `endDate`, `lastUpdate`, `archivedDate`, `sourceObjectId` You can filter on : * `sourceObjectId`: The original process instance ID before the process instance was archived * `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 searchArchivedProcessInstances method, but with the query parameters collected into a single Map parameter.
    ApiResponse<List<ArchivedProcessInstance>>
    searchArchivedProcessInstancesWithHttpInfo(Integer p, Integer c, List<String> f, String o)
    Finds ArchivedProcessInstances Similar to searchArchivedProcessInstances but it also returns the http response headers .
    ApiResponse<List<ArchivedProcessInstance>>
    searchArchivedProcessInstancesWithHttpInfo(ArchivedProcessInstanceApi.SearchArchivedProcessInstancesQueryParams queryParams)
    Finds ArchivedProcessInstances Finds archived ProcessInstances (or ProcessInstance) with pagination params and filters You can order on `id`, `processDefinitionId`, `startedBy`, `startedBySubstitute`, `startDate`, `endDate`, `lastUpdate`, `archivedDate`, `sourceObjectId` You can filter on : * `sourceObjectId`: The original process instance ID before the process instance was archived * `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 searchArchivedProcessInstances that receives the query parameters as a map, but this one also exposes the Http response headers

  • Method Details

    • deleteArchivedProcessInstanceById

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

    • deleteArchivedProcessInstanceByIdWithHttpInfo

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

    • getArchivedProcessInstanceById

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

    • getArchivedProcessInstanceByIdWithHttpInfo

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

    • getContextByArchivedProcessInstanceId

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

    • getContextByArchivedProcessInstanceIdWithHttpInfo

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

    • searchArchivedProcessInstances

      List<ArchivedProcessInstance> searchArchivedProcessInstances(Integer p, Integer c, List<String> f, String o)
      Finds ArchivedProcessInstances Finds archived ProcessInstances (or ProcessInstance) with pagination params and filters You can order on `id`, `processDefinitionId`, `startedBy`, `startedBySubstitute`, `startDate`, `endDate`, `lastUpdate`, `archivedDate`, `sourceObjectId` You can filter on : * `sourceObjectId`: The original process instance ID before the process instance was archived * `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<ArchivedProcessInstance>

    • searchArchivedProcessInstancesWithHttpInfo

      ApiResponse<List<ArchivedProcessInstance>> searchArchivedProcessInstancesWithHttpInfo(Integer p, Integer c, List<String> f, String o)
      Finds ArchivedProcessInstances Similar to searchArchivedProcessInstances but it also returns the http response headers . Finds archived ProcessInstances (or ProcessInstance) with pagination params and filters You can order on `id`, `processDefinitionId`, `startedBy`, `startedBySubstitute`, `startDate`, `endDate`, `lastUpdate`, `archivedDate`, `sourceObjectId` You can filter on : * `sourceObjectId`: The original process instance ID before the process instance was archived * `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.

    • searchArchivedProcessInstances

      List<ArchivedProcessInstance> searchArchivedProcessInstances(ArchivedProcessInstanceApi.SearchArchivedProcessInstancesQueryParams queryParams)
      Finds ArchivedProcessInstances Finds archived ProcessInstances (or ProcessInstance) with pagination params and filters You can order on `id`, `processDefinitionId`, `startedBy`, `startedBySubstitute`, `startDate`, `endDate`, `lastUpdate`, `archivedDate`, `sourceObjectId` You can filter on : * `sourceObjectId`: The original process instance ID before the process instance was archived * `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 searchArchivedProcessInstances 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 ArchivedProcessInstanceApi.SearchArchivedProcessInstancesQueryParams 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<ArchivedProcessInstance>

    • searchArchivedProcessInstancesWithHttpInfo

      ApiResponse<List<ArchivedProcessInstance>> searchArchivedProcessInstancesWithHttpInfo(ArchivedProcessInstanceApi.SearchArchivedProcessInstancesQueryParams queryParams)
      Finds ArchivedProcessInstances Finds archived ProcessInstances (or ProcessInstance) with pagination params and filters You can order on `id`, `processDefinitionId`, `startedBy`, `startedBySubstitute`, `startDate`, `endDate`, `lastUpdate`, `archivedDate`, `sourceObjectId` You can filter on : * `sourceObjectId`: The original process instance ID before the process instance was archived * `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 searchArchivedProcessInstances 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<ArchivedProcessInstance>