Retrieve the Process Instance List

get

/ic/api/process/v1/processes

Retrieves process instance list

Request

Query Parameters
  • Assignment Filter. Valid Values: MY_AND_GROUP (default), OWNER, REVIEWER, ADMIN, ALL MY_AND_GROUP -Displays process instances that are assigned to anyone, including you, in the groups you belongs to. OWNER - Displays process instances in which you are owner. REVIEWER -Displays process instances for which you are a reviewer. ADMIN -Displays all process instances for Admin user. This filter is for Admin only. ALL - No filtering for admin context user; display All process instances that are created by you for non admin.
    Default Value: MY_AND_GROUP
  • Canned Process Filter.This filter overrides assignmentFilter. Valid Values:DEFAULT, OWNED_BY_ME, STARTED_BY_ME, REVIEWED_BY_ME, ADMINISTERED_BY_ME. DEFAULT - For non Admin user this equals to OWNED_BY_ME when user is Process Owner else it is STARTED_BY_ME. For loggedIn admin user this equals to ADMINISTERED_BY_ME. OWNED_BY_ME - Displays process instances for user where assignmentFilter = OWNER STARTED_BY_ME - Displays process instances for user where assignmentFilter = ALL and Process Creator is current user REVIEWED_BY_ME - Displays process instances for user where assignmentFilter = REVIEWER ADMINISTERED_BY_ME - Displays process instances for admin user where assignmentFilter = ADMIN
  • Start of due date range in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
  • End of due date range in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
  • Keyword in instance title
  • Maximum number of items per page, default 25
    Default Value: 25
  • Index for the first item on a page of list items
    Default Value: 0
  • Field with which results are to be ordered
  • Collection Format: multi
    Process priority from 1 (highest) to 5 (lowest) or Any (default)
  • Collection Format: multi
    Process instance creator
  • Collection Format: multi
    Process definition ID
  • Collection Format: multi
    Processinstance name
  • Collection Format: multi
    Process instance owner role name and not individual user assigned to that role
  • Collection Format: multi
    Process state. Values: OPEN, ABORTED, CANCELED, FAULTED_RECOVERABLE, ERRORED, COMPLETED, SUSPENDED. Default: OPEN.
    • Default Value: OPEN
      Allowed Values: [ "OPEN", "ABORTED", "CANCELED", "FAULTED_RECOVERABLE", "ERRORED", "COMPLETED", "SUSPENDED" ]
  • Returned items must be created later than the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
  • Total Result - true or false
    Default Value: true
  • Returned items must be created before the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
  • Returned items must be updated later than the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
  • Returned items must be updated before the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
  • View name
Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : Collection
Type: object

400 Response

Bad request

401 Response

Unauthorized

404 Response

Process list not found

500 Response

Internal Server Error
Back to Top