Package org.bonitasoft.web.client.api

Interface ProcessApi

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

  • Method Details

    • createProcess

      @Deprecated ProcessDefinition createProcess(ProcessCreateRequest body)
      Deprecated.
      Create the Process Create the Process. A process resource is created using the content of a .bar file that has previously been uploaded, using the [processUpload servlet](#operation/uploadProcess), to get the process archive path. Warning: as of 9.0.0, creating a process using this API is deprecated.
      Parameters:
      body - Partial Process description (required)
      Returns:
      ProcessDefinition

    • createProcessWithHttpInfo

      @Deprecated ApiResponse<ProcessDefinition> createProcessWithHttpInfo(ProcessCreateRequest body)
      Deprecated.
      Create the Process Similar to createProcess but it also returns the http response headers . Create the Process. A process resource is created using the content of a .bar file that has previously been uploaded, using the [processUpload servlet](#operation/uploadProcess), to get the process archive path. Warning: as of 9.0.0, creating a process using this API is deprecated.
      Parameters:
      body - Partial Process description (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • deleteProcessById

      void deleteProcessById(String id)
      Delete the Process by ID Delete the single Process for the given ID. **Warning: Beware! Data loss risk!** Deleting a process will automatically delete all its process instances (on-going and archived alike). Thus, the operation may take a long time, and fail if the transaction timeout is not large enough. This feature should only be used on non-production environments. **Please proceed at your own risk.**
      Parameters:
      id - ID of the Process to delete (required)

    • deleteProcessByIdWithHttpInfo

      ApiResponse<Void> deleteProcessByIdWithHttpInfo(String id)
      Delete the Process by ID Similar to deleteProcessById but it also returns the http response headers . Delete the single Process for the given ID. **Warning: Beware! Data loss risk!** Deleting a process will automatically delete all its process instances (on-going and archived alike). Thus, the operation may take a long time, and fail if the transaction timeout is not large enough. This feature should only be used on non-production environments. **Please proceed at your own risk.**
      Parameters:
      id - ID of the Process to delete (required)

    • deleteProcessByIds

      void deleteProcessByIds(List<String> requestBody)
      Delete the Process by IDs Delete Process for the given list of ID. **Warning: Beware! Data loss risk!** Deleting a process will automatically delete all its process instances (on-going and archived alike). Thus, the operation may take a long time, and fail if the transaction timeout is not large enough. This feature should only be used on non-production environments. **Please proceed at your own risk.**
      Parameters:
      requestBody - (optional)

    • deleteProcessByIdsWithHttpInfo

      ApiResponse<Void> deleteProcessByIdsWithHttpInfo(List<String> requestBody)
      Delete the Process by IDs Similar to deleteProcessByIds but it also returns the http response headers . Delete Process for the given list of ID. **Warning: Beware! Data loss risk!** Deleting a process will automatically delete all its process instances (on-going and archived alike). Thus, the operation may take a long time, and fail if the transaction timeout is not large enough. This feature should only be used on non-production environments. **Please proceed at your own risk.**
      Parameters:
      requestBody - (optional)

    • getProcessById

      ProcessDefinition getProcessById(String id)
      Finds the Process by ID Returns the single Process for the given ID
      Parameters:
      id - ID of the Process to return (required)
      Returns:
      ProcessDefinition

    • getProcessByIdWithHttpInfo

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

    • getProcessContractById

      Contract getProcessContractById(String id)
      Finds the Process contract by ID Returns the process contract for the given ID
      Parameters:
      id - ID of the Process to get the contract from (required)
      Returns:
      Contract

    • getProcessContractByIdWithHttpInfo

      ApiResponse<Contract> getProcessContractByIdWithHttpInfo(String id)
      Finds the Process contract by ID Similar to getProcessContractById but it also returns the http response headers . Returns the process contract for the given ID
      Parameters:
      id - ID of the Process to get the contract from (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • getProcessDesignById

      DesignProcessDefinition getProcessDesignById(String id)
      Finds the Process design by ID Returns the single Process design for the given ID
      Parameters:
      id - ID of the Process to get the design from (required)
      Returns:
      DesignProcessDefinition

    • getProcessDesignByIdWithHttpInfo

      ApiResponse<DesignProcessDefinition> getProcessDesignByIdWithHttpInfo(String id)
      Finds the Process design by ID Similar to getProcessDesignById but it also returns the http response headers . Returns the single Process design for the given ID
      Parameters:
      id - ID of the Process to get the design from (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • instanciateProcess

      ProcessInstantiationResponse instanciateProcess(String id, Map<String,Object> body)
      Instanciate the process Instanciate the process with the provided contract values.
      Parameters:
      id - ID of the process to instanciate (required)
      body - A JSON object matching process contract. (required)
      Returns:
      ProcessInstantiationResponse

    • instanciateProcessWithHttpInfo

      ApiResponse<ProcessInstantiationResponse> instanciateProcessWithHttpInfo(String id, Map<String,Object> body)
      Instanciate the process Similar to instanciateProcess but it also returns the http response headers . Instanciate the process with the provided contract values.
      Parameters:
      id - ID of the process to instanciate (required)
      body - A JSON object matching process contract. (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • searchProcesses

      List<ProcessDefinition> searchProcesses(Integer p, Integer c, List<String> f, String o, String s)
      Finds Processes Finds Processes with pagination params and filters - can order (default is ASC) on `name`, `version`, `deploymentDate`, `deployedBy`, `activationState`, `configurationState`, `processId`, `displayName`, `lastUpdateDate`, `categoryId`, `label` - can search on `name`, `displayName` or `version` - can filter on `name`, `version`, `deploymentDate`, `deployedBy`, `activationState` with the value DISABLED or ENABLED, `configurationState` with the value UNRESOLVED, or RESOLVED, `processId`, `displayName`, `lastUpdateDate`, `categoryId`, `label`, `supervisor_id`
      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<ProcessDefinition>

    • searchProcessesWithHttpInfo

      ApiResponse<List<ProcessDefinition>> searchProcessesWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)
      Finds Processes Similar to searchProcesses but it also returns the http response headers . Finds Processes with pagination params and filters - can order (default is ASC) on `name`, `version`, `deploymentDate`, `deployedBy`, `activationState`, `configurationState`, `processId`, `displayName`, `lastUpdateDate`, `categoryId`, `label` - can search on `name`, `displayName` or `version` - can filter on `name`, `version`, `deploymentDate`, `deployedBy`, `activationState` with the value DISABLED or ENABLED, `configurationState` with the value UNRESOLVED, or RESOLVED, `processId`, `displayName`, `lastUpdateDate`, `categoryId`, `label`, `supervisor_id`
      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.

    • searchProcesses

      List<ProcessDefinition> searchProcesses(ProcessApi.SearchProcessesQueryParams queryParams)
      Finds Processes Finds Processes with pagination params and filters - can order (default is ASC) on `name`, `version`, `deploymentDate`, `deployedBy`, `activationState`, `configurationState`, `processId`, `displayName`, `lastUpdateDate`, `categoryId`, `label` - can search on `name`, `displayName` or `version` - can filter on `name`, `version`, `deploymentDate`, `deployedBy`, `activationState` with the value DISABLED or ENABLED, `configurationState` with the value UNRESOLVED, or RESOLVED, `processId`, `displayName`, `lastUpdateDate`, `categoryId`, `label`, `supervisor_id` Note, this is equivalent to the other searchProcesses 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 ProcessApi.SearchProcessesQueryParams 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<ProcessDefinition>

    • searchProcessesWithHttpInfo

      ApiResponse<List<ProcessDefinition>> searchProcessesWithHttpInfo(ProcessApi.SearchProcessesQueryParams queryParams)
      Finds Processes Finds Processes with pagination params and filters - can order (default is ASC) on `name`, `version`, `deploymentDate`, `deployedBy`, `activationState`, `configurationState`, `processId`, `displayName`, `lastUpdateDate`, `categoryId`, `label` - can search on `name`, `displayName` or `version` - can filter on `name`, `version`, `deploymentDate`, `deployedBy`, `activationState` with the value DISABLED or ENABLED, `configurationState` with the value UNRESOLVED, or RESOLVED, `processId`, `displayName`, `lastUpdateDate`, `categoryId`, `label`, `supervisor_id` Note, this is equivalent to the other searchProcesses 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<ProcessDefinition>

    • updateProcessById

      @Deprecated void updateProcessById(String id, ProcessUpdateRequest processUpdateRequest)
      Deprecated.
      Update the Process by ID Update the Process for the given ID Warning: as of 9.0.0, updating a process using this API is deprecated.
      Parameters:
      id - ID of the Process to return (required)
      processUpdateRequest - Partial Process description (required)

    • updateProcessByIdWithHttpInfo

      @Deprecated ApiResponse<Void> updateProcessByIdWithHttpInfo(String id, ProcessUpdateRequest processUpdateRequest)
      Deprecated.
      Update the Process by ID Similar to updateProcessById but it also returns the http response headers . Update the Process for the given ID Warning: as of 9.0.0, updating a process using this API is deprecated.
      Parameters:
      id - ID of the Process to return (required)
      processUpdateRequest - Partial Process description (required)

    • updateProcessConnectorByProcessId

      @Deprecated void updateProcessConnectorByProcessId(String id, String connectorImplId, String connectorImplVersion, UpdateProcessConnectorByProcessIdRequest updateProcessConnectorByProcessIdRequest)
      Deprecated.
      Update the Process Connector by Process ID ![edition](https://img.shields.io/badge/edition-entreprise-blue) Update the ProcessConnector for the given ID Warning: as of 9.0.0, updating a Process Connector using this API is deprecated.
      Parameters:
      id - ID of the process to update (required)
      connectorImplId - ID of the Process Connector implementation to update (required)
      connectorImplVersion - Version of the Process Connector implementation to update (required)
      updateProcessConnectorByProcessIdRequest - Partial ProcessConnector description (required)

    • updateProcessConnectorByProcessIdWithHttpInfo

      @Deprecated ApiResponse<Void> updateProcessConnectorByProcessIdWithHttpInfo(String id, String connectorImplId, String connectorImplVersion, UpdateProcessConnectorByProcessIdRequest updateProcessConnectorByProcessIdRequest)
      Deprecated.
      Update the Process Connector by Process ID Similar to updateProcessConnectorByProcessId but it also returns the http response headers . ![edition](https://img.shields.io/badge/edition-entreprise-blue) Update the ProcessConnector for the given ID Warning: as of 9.0.0, updating a Process Connector using this API is deprecated.
      Parameters:
      id - ID of the process to update (required)
      connectorImplId - ID of the Process Connector implementation to update (required)
      connectorImplVersion - Version of the Process Connector implementation to update (required)
      updateProcessConnectorByProcessIdRequest - Partial ProcessConnector description (required)

    • uploadProcess

      @Deprecated String uploadProcess(File file)
      Deprecated.
      Upload a bar file Upload a bar file Warning: as of 9.0.0, uploading a bar file using the portal is deprecated.
      Parameters:
      file - (optional)
      Returns:
      String

    • uploadProcessWithHttpInfo

      @Deprecated ApiResponse<String> uploadProcessWithHttpInfo(File file)
      Deprecated.
      Upload a bar file Similar to uploadProcess but it also returns the http response headers . Upload a bar file Warning: as of 9.0.0, uploading a bar file using the portal is deprecated.
      Parameters:
      file - (optional)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.