To retrieve running, suspended, completed or aborted processes for a provided process definition id, a provided user or a provided role. Optionally, an organization id could be sent, if processes for a non-active organization should be retrieved. By default, the active organization will be used.

If the isCompleted parameter is set to false, running, active or suspended processes are returned; if set to true, completed or aborted processes are returned. If the parameter is not provided (null), processes associated with a given process definition id are returned, depending on whether the definition is active or historical. Next to a process definition id, active processes can also be fetched for a specific user or role by providing the parameter userId or roleId in the request.

When the query parameter locked=true is sent, a list of locked workflow processes is returned. Locked workflow processes aren't continuing due to e.g. scripting issues or other problems.

When the query parameter interrupted=true is sent, a list of interrupted workflow processes is returned.

For historical and active processes, fetched by a process definition id, paging can be applied with the parameters sortBy, sort, size, lastProcessId, states and nameLike. Paging is not supported for processes for a certain user or role, locked or interrupted processes.

The state property has the following values:

R_WFADM_START (ID = 20)

GET

One and only one of the following query parameters must be set for a request:

• processDefinitionId (String): To fetch active or historical processes for a specific process definition.

• userId (String): To fetch the active processes for a specific user.

• roleId (String): To fetch the active processes for a specific role.

• locked (boolean): To fetch the locked processes. Default: false.

• interrupted (boolean): To fetch the interrupted processes. Default: false.

The following query paramter is optional but can be applied to all of the above mentioned mandatory query parameters:

• organizationId (String): The id of the organization where the forwarded process definition is located

The following query parameters are optional but can only be applied in combination to the mandatory query parameter processDefinitionId:

• isCompleted (Boolean): The parameter specifies whether to return active processes (false), historical processes (true). If it is not provided, the BPM service tries to detect by the given processDefinitionId if it is an active or a historical one. The identification will make the response take more time.

• Paging and sorting query parameters:

  • sortBy (String): By which attribute should be sorted. Available values are: name, startTime and endTime. Default is startTime.

  • sort (String): The sort direction. Available values are: ASC and DESC identically in SQL.

  • size (Integer): The amount of processes which should be returned. If value = zero or if this query parameter is not set, all processes will be returned.

  • lastProcessId (String): For paging the last process Id, which was returned from the last paged result. After this process Id it will then be continued.

  • lastFetchedSortByValue (String): The value of the sortBy column from the last fetched process and lastProcessId. If the process identified by lastProcessId no longer exists, pagination continues based on this value. Please note: If the lastProcessId is no longer existing, enaio server returns results starting with this value because it is not unique. A client must be prepared to filter already existing hitlist results out which it gets again from this endpoint on paging.

  • states (String): A comma separated list of states, the processes must currently have in case to be returned.

  • nameLike (String): A free text string to filter the processes for.

JSON

1.0.0

/api/bpm/processes?processDefinitionId=20852BCD50D0400AA907E420E5E9C18C

/api/bpm/processes?processDefinitionId=20852BCD50D0400AA907E420E5E9C18C&isCompleted=false
/api/bpm/processes?processDefinitionId=3FC25E4A11674367861FD5BB99DBCF01&isCompleted=true

/api/bpm/processes?processDefinitionId=20852BCD50D0400AA907E420E5E9C18C&isCompleted=false&organizationId=8C2CC574556E40298E636278ECA20D7E
/api/bpm/processes?processDefinitionId=3FC25E4A11674367861FD5BB99DBCF01&isCompleted=true&organizationId=8C2CC574556E40298E636278ECA20D7E

/api/bpm/processes?userId=90772ACD43D0400AA911E430E9E9C22A
/api/bpm/processes?roleId=80652DCD67D0400AA912F420E0E9C09E

/api/bpm/processes?locked=true

/api/bpm/processes?interrupted=true