Jump to

• Request
• Response

Retrieve the Process Instance List

get

/ic/api/process/v1/processes

Retrieves process instance list

Request

Query Parameters

• assignmentFilter: string
  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
• cannedProcessFilter: string
  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
• dueDateFrom: string
  Start of due date range in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• dueDateTo: string
  End of due date range in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• keyword: string
  Keyword in instance title
• limit: integer(int32)
  Maximum number of items per page, default 25

  Default Value: 25
• offset: integer(int32)
  Index for the first item on a page of list items

  Default Value: 0
• orderBy: string
  Field with which results are to be ordered
• priority: array[string]
  Collection Format: multi

  Process priority from 1 (highest) to 5 (lowest) or Any (default)
• processCreator: array[string]
  Collection Format: multi

  Process instance creator
• processDefId: array[string]
  Collection Format: multi

  Process definition ID
• processDefIdLike: string
  Process definition ID Like
• processName: array[string]
  Collection Format: multi

  Processinstance name
• processOwner: array[string]
  Collection Format: multi

  Process instance owner role name and not individual user assigned to that role
• processState: array[string]
  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" ]

• since: string
  Returned items must be created later than the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• totalResults: boolean
  Total Result - true or false

  Default Value: true
• until: string
  Returned items must be created before the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• updatedSince: string
  Returned items must be updated later than the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• updatedUntil: string
  Returned items must be updated before the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• view: string
  View name

Back to Top

Response

Supported Media Types

• application/json

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