Package org.bonitasoft.web.client.api

Interface ProcessApi

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  ProcessApi.SearchProcessesQueryParams
      A convenience class for generating query parameters for the searchProcesses method in a fluent style.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ProcessDefinition createProcess​(ProcessCreateRequest body)
      Create the Process Create the Process.
      void deleteProcessById​(String id)
      Delete the Process by ID Delete the single Process for the given ID.
      void deleteProcessByIds​(List<String> requestBody)
      Delete the Process by IDs Delete Process for the given list of ID.
      ProcessDefinition getProcessById​(String id)
      Finds the Process by ID Returns the single Process for the given ID
      Contract getProcessContractById​(String id)
      Finds the Process contract by ID Returns the process contract for the given ID
      DesignProcessDefinition getProcessDesignById​(String id)
      Finds the Process design by ID Returns the single Process design for the given ID
      ProcessInstantiationResponse instanciateProcess​(String id, Map<String,​Object> body)
      Instanciate the process Instanciate the process with the provided contract values.
      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`
      List<ProcessDefinition> searchProcesses​(Map<String,​Object> 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.
      void updateProcessById​(String id, ProcessUpdateRequest processUpdateRequest)
      Update the Process by ID Update the Process for the given ID
      String uploadProcess​(File file)
      Upload a bar file Upload a bar file

    • Method Detail

      • createProcess

        ProcessDefinition createProcess​(ProcessCreateRequest body)
        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.
        Parameters:
        body - Partial Process description (required)
        Returns:
        ProcessDefinition

      • 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)

      • 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)

      • 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

      • 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

      • 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

      • 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

      • 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>

      • searchProcesses

        List<ProcessDefinition> searchProcesses​(Map<String,​Object> 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>

      • updateProcessById

        void updateProcessById​(String id,
                       ProcessUpdateRequest processUpdateRequest)
        Update the Process by ID Update the Process for the given ID
        Parameters:
        id - ID of the Process to return (required)
        processUpdateRequest - Partial Process description (required)

      • uploadProcess

        String uploadProcess​(File file)
        Upload a bar file Upload a bar file
        Parameters:
        file - (optional)
        Returns:
        String