Jump to

• Request
• Response

Retrieve the Process Instance List

get

/ic/api/process/v1/processes

Retrieves process instance list

Request

Query Parameters

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

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

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

  Process priority from 1 (highest) to 5 (lowest) or Any (default)

  • [0]: string

  {
      "name":"priority",
      "in":"query",
      "description":"Process priority from 1 (highest) to 5 (lowest) or Any (default)",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• processCreator(optional): array
  Collection Format: multi

  Process instance creator

  • [0]: string

  {
      "name":"processCreator",
      "in":"query",
      "description":"Process instance creator",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• processDefId(optional): array
  Collection Format: multi

  Process definition ID

  • [0]: string

  {
      "name":"processDefId",
      "in":"query",
      "description":"Process definition ID",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• processDefIdLike(optional): string
  Process definition ID Like
• processName(optional): array
  Collection Format: multi

  Processinstance name

  • [0]: string

  {
      "name":"processName",
      "in":"query",
      "description":"Processinstance name",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• processOwner(optional): array
  Collection Format: multi

  Process instance owner role name and not individual user assigned to that role

  • [0]: string

  {
      "name":"processOwner",
      "in":"query",
      "description":"Process instance owner role name and not individual user assigned to that role",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• processState(optional): array
  Collection Format: multi

  Process state. Values: OPEN, ABORTED, CANCELED, FAULTED_RECOVERABLE, ERRORED, COMPLETED, SUSPENDED. Default: OPEN.

  • [0]: string
    Default Value: OPEN

    Allowed Values: [ "OPEN", "ABORTED", "CANCELED", "FAULTED_RECOVERABLE", "ERRORED", "COMPLETED", "SUSPENDED" ]

  {
      "name":"processState",
      "in":"query",
      "description":"Process state. Values: OPEN, ABORTED, CANCELED, FAULTED_RECOVERABLE, ERRORED, COMPLETED, SUSPENDED. Default: OPEN.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string",
          "enum":[
              "OPEN",
              "ABORTED",
              "CANCELED",
              "FAULTED_RECOVERABLE",
              "ERRORED",
              "COMPLETED",
              "SUSPENDED"
          ],
          "default":"OPEN"
      },
      "collectionFormat":"multi"
  }

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

  Default Value: true
• until(optional): string
  Returned items must be created before the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• updatedSince(optional): string
  Returned items must be updated later than the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• updatedUntil(optional): string
  Returned items must be updated before the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
• view(optional): 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