Jump to

• Request
• Response

List Process Instances

get

/process/api/v1/instances

List process instances user has access to including structured and dynamic processes

Request

Query Parameters

• applicationName: string
  Restrict query to all process instances that belongs given application name
• applicationNameLike: string
  Restrict query to all process instances that belongs given application name like
• applicationVersion: string
  Restrict query to all process instances that belongs given application version
• asMember: boolean
  True when the logged in user is a member.

  Default Value: false

  Example:

  Get instances where I am a member (asMember=true)

• businessKey: array[string]
  Business Key of the Process instance
• businessKeyLike: string
  Business Key of the Process instance
• completedAfter: string
  Restrict to instances that were closed after the given date. The date string must be in the ISO-8601 standard format. Example - 2019-01-23T12:34:56.123456789Z (for UTC), 2019-01-23T12:34:56.123456789+02:30 (with offset)

  Example:

  2021-01-30T08:30:00.000+00.00

• completedBefore: string
  Restrict to instances that were closed before the given date. The date string must be in the ISO-8601 standard format. Example - 2019-01-23T12:34:56.123456789Z (for UTC), 2019-01-23T12:34:56.123456789+02:30 (with offset)

  Example:

  2021-01-30T08:30:00.000+00.00

• createdAfter: string
  Restrict to instances that were created after the given date. The date string must be in the ISO-8601 standard format. Example - 2019-01-23T12:34:56.123456789Z (for UTC), 2019-01-23T12:34:56.123456789+02:30 (with offset)

  Example:

  2021-01-30T08:30:00.000+00.00

• createdBefore: string
  Restrict to instances that were created before the given date. The date string must be in the ISO-8601 standard format. Example - 2019-01-23T12:34:56.123456789Z (for UTC), 2019-01-23T12:34:56.123456789+02:30 (with offset)

  Example:

  2021-01-30T08:30:00.000+00.00

• createdBy(required): string
  Only include process instances that were created by the given user.
• dataManagementState: array[string]
  Data Management State of the instance

  • Allowed Values: [ "RESTORED", "SOFT_DELETED" ]

  [
      "RESTORED",
      "SOFT_DELETED"
  ]

• excludeFaulted: boolean
  Restrict query to all process instances that are in not in faulted state
• instanceId: array[string]
  Filter by process instance Ids
• keyword: string
  Filter instances by keyword. This filters instances by partial matches of the keyword in the instance title
• limit: integer
  Minimum Value: 5

  Maximum Value: 500

  Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

  Default Value: 25
• memberLabel: string
  The label of member. Use with asMember=true.

  Example:

  Get instances where I am owner (asMember=true&memberLabel=Owner) OR get instances where the label is Owner and also jstein is a member(asMember=true&memberLabel=Owner&withMemberIdentityId=<jstein-id>).

• memberPermission: string
  permission level of the member. Used with asMember=true.

  Example:

  Get instances where the permission is MANAGE (asMember=true&memberPermission=MANAGE).

• offset: integer
  Minimum Value: 0

  Pagination of results. Specifies the index of the first result to return.

  Default Value: 0
• orderBy: string
  This query parameter specifies the orderBy clause. Supported sortBy fieldName should be any of: processDefId,processDefKey,startTime,endTime,appName,appVersion,creatorUserId,processName,processTitle, processType,processDesc,businessKey,state The value must follow the format fieldName[:(asc/desc)]. e.g. priority:asc. Multiple ordering is not supported. Default sortOrder is asc if not specified. Default orderBy is startTime:desc
• parentInstanceId: string
  Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance ID.
• processDefinitionId: array[string]
  Filter by process definition ID. Exact match
• processDefinitionKey: array[string]
  Filter by process definition key. Exact match
• processDefinitionKeyNotIn: array[string]
  Exclude instances that belong to a set of process definitions. Must be a comma-separated list of process definition keys.
• processDefinitionName: array[string]
  Filter by the name of the process definition the instances run on.
• processDefinitionNameLike: string
  Filter by process definition names that the parameter is a substring of.
• rootInstanceId: string
  Restrict query to all process instances whose root process instance ID is the given process instance. Takes a process instance ID.
• sortBy: string
  Sort the results by the given set of columns

  Allowed Values: [ "processDefId", "processDefKey", "startTime", "endTime", "appName", "appVersion", "creatorUserId", "processName", "processTitle", "processType", "processDesc", "businessKey", "state" ]
• sortOrder: string
  Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.
• state: array[string]
  Restrict query to all process instances that are in given states. This is a union of all possible states of a Dynamic process and a Structured process. States specific to a Dynamic process are ACTIVE, CLOSED, COMPLETED, SUSPENDED, FAULTED and TERMINATED. States specific to a Structured process are ACTIVE, COMPLETED, SUSPENDED, FAULTED, TERMINATED

  • Allowed Values: [ "ACTIVE", "COMPLETED", "TERMINATED", "SUSPENDED", "FAULTED", "CLOSED" ]

  [
      "ACTIVE",
      "COMPLETED",
      "TERMINATED",
      "SUSPENDED",
      "FAULTED",
      "CLOSED"
  ]

• totalResults: boolean
  Specifies if total number of results need to be returned

  Default Value: false
• type: string
  Filter by the type of the process instance. Exact match. By default, both structured and dynamic process instances will be returned

  Allowed Values: [ "DYNAMIC", "STRUCTURED" ]
• withMemberIdentityId: string
  Member idenitityId. Use with asMember=true.

  Example:

  Get instances where I am a member along with jstein-id (asMember=true&withMemberIdentityId=<jstein-id>).

Header Parameters

• Accept-Language:
  Accept-Language header in IETF BCP 47
• oci-original-url:
  Actual endpoint which customer requested

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : Instances

Type: object

Match All

Show Source

• object allOf BaseInstances
• object Instances-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseInstances"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Instance"
                    }
                }
            }
        }
    ]
}

Nested Schema : BaseInstances

Type: object

Match All

Show Source

• object CommonModel
• object PaginationResponse
  Pagination details

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "$ref":"#/components/schemas/PaginationResponse"
        }
    ]
}

Nested Schema : CommonModel

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : PaginationResponse

Type: object

Pagination details

Show Source

• count: integer
  count of items returned in current result
• hasMore: boolean
  whether there are more pages to fetch
• limit: integer
  max size for the paginated response
• offset: integer
  offset for the paginated response
• totalResults: integer
  total count with the applied filter criteria

{
    "description":"Pagination details",
    "properties":{
        "count":{
            "type":"integer",
            "description":"count of items returned in current result"
        },
        "totalResults":{
            "type":"integer",
            "description":"total count with the applied filter criteria"
        },
        "limit":{
            "type":"integer",
            "description":"max size for the paginated response"
        },
        "offset":{
            "type":"integer",
            "description":"offset for the paginated response"
        },
        "hasMore":{
            "type":"boolean",
            "description":"whether there are more pages to fetch"
        }
    }
}

Nested Schema : Instances-allOf[1]

Type: object

Show Source

• items: array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Instance"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Defines Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Defines Link

Show Source

• code: integer
  Minimum Value: 100

  Maximum Value: 600
• href(required): string
• hreflang: string
• length: integer (int32)
• mediaType: string
• message: string
• rel(required): string
• title: string
• type: string

{
    "type":"object",
    "description":"Defines Link",
    "additionalProperties":false,
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"integer",
            "minimum":100,
            "maximum":600
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Instance

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Instance"
    }
}

Nested Schema : Instance

Type: object

Match All

Show Source

• object allOf BaseInstance
• object Instance-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseInstance"
        },
        {
            "properties":{
                "processType":{
                    "type":"string",
                    "description":"The type of the process instance - STRUCTURED or DYNAMIC"
                },
                "parentProcessInstanceId":{
                    "type":"string",
                    "description":"The ID of the parent process instance if the parent is a structured process"
                },
                "parentDPInstanceId":{
                    "type":"string",
                    "description":"The ID of the parent process instance if the parent is a dynamic process"
                },
                "rootInstanceId":{
                    "type":"string",
                    "description":"The ID of the root process instance. The root process instance could either be a dynamic or a structured\nprocess.\n"
                },
                "applicationVersion":{
                    "type":"string",
                    "description":"The version of the application that this process instance belongs to."
                },
                "hasChildProcesses":{
                    "type":"boolean",
                    "description":"Specifies if the process instance has associated active child process instance(s)."
                }
            }
        }
    ]
}

Nested Schema : BaseInstance

Type: object

Match All

Show Source

• object CommonModel
• object BaseInstance-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The ID of the process instance."
                },
                "processName":{
                    "type":"string",
                    "description":"The name of the process this process instance belongs to."
                },
                "title":{
                    "type":"string",
                    "description":"Title of the instance"
                },
                "description":{
                    "type":"string",
                    "description":"Instance Description"
                },
                "processDefinitionName":{
                    "type":"string",
                    "description":"The name of the process definition that this process instance belongs to."
                },
                "processDefinitionKey":{
                    "type":"string",
                    "description":"The key of the process definition that this process instance belongs to."
                },
                "processDefinitionVersion":{
                    "type":"integer",
                    "description":"The version of the process definition that this process instance belongs to."
                },
                "processDefinitionId":{
                    "type":"string",
                    "description":"The ID of the process definition that this process instance belongs to."
                },
                "businessKey":{
                    "type":"string",
                    "description":"The business key of the process instance"
                },
                "applicationName":{
                    "type":"string",
                    "description":"The name of the application that this process instance belongs to"
                },
                "applicationTitle":{
                    "type":"string",
                    "description":"The title of the application that this process instance belongs to"
                },
                "applicationDescription":{
                    "type":"string",
                    "description":"The description of the application that this process instance belongs to."
                },
                "createTime":{
                    "type":"string",
                    "description":"The time the instance was created. Has the format yyyy-MM-dd'T'HH:mm:ss"
                },
                "updateTime":{
                    "type":"string",
                    "description":"The time the instance was updated. Has the format yyyy-MM-dd'T'HH:mm:ss"
                },
                "endTime":{
                    "type":"string",
                    "description":"The time the instance ended. Has the format yyyy-MM-dd'T'HH:mm:ss"
                },
                "durationInMillis":{
                    "type":"integer",
                    "description":"The time the instance took to finish in milliseconds.",
                    "format":"int64"
                },
                "startActivityId":{
                    "type":"string",
                    "description":"The ID of the initial activity that was executed. For example, a start event."
                },
                "state":{
                    "type":"string",
                    "description":"State of the process instance. This is a union of all possible states of a Dynamic process and a\nStructured process. States specific to a Dynamic process are ACTIVE, CLOSED, COMPLETED and TERMINATED.\nStates specific to a Structured process are ACTIVE, COMPLETED, SUSPENDED, FAULTED, TERMINATED\n",
                    "enum":[
                        "ACTIVE",
                        "COMPLETED",
                        "TERMINATED",
                        "SUSPENDED",
                        "FAULTED",
                        "CLOSED"
                    ]
                },
                "availableActions":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "createdBy":{
                    "$ref":"#/components/schemas/UserOrAppClient"
                }
            }
        }
    ]
}

Nested Schema : BaseInstance-allOf[1]

Type: object

Show Source

• applicationDescription: string
  The description of the application that this process instance belongs to.
• applicationName: string
  The name of the application that this process instance belongs to
• applicationTitle: string
  The title of the application that this process instance belongs to
• availableActions: array availableActions
• businessKey: string
  The business key of the process instance
• createdBy: UserOrAppClient
• createTime: string
  The time the instance was created. Has the format yyyy-MM-dd'T'HH:mm:ss
• description: string
  Instance Description
• durationInMillis: integer (int64)
  The time the instance took to finish in milliseconds.
• endTime: string
  The time the instance ended. Has the format yyyy-MM-dd'T'HH:mm:ss
• id: string
  The ID of the process instance.
• processDefinitionId: string
  The ID of the process definition that this process instance belongs to.
• processDefinitionKey: string
  The key of the process definition that this process instance belongs to.
• processDefinitionName: string
  The name of the process definition that this process instance belongs to.
• processDefinitionVersion: integer
  The version of the process definition that this process instance belongs to.
• processName: string
  The name of the process this process instance belongs to.
• startActivityId: string
  The ID of the initial activity that was executed. For example, a start event.
• state: string
  Allowed Values: [ "ACTIVE", "COMPLETED", "TERMINATED", "SUSPENDED", "FAULTED", "CLOSED" ]

  State of the process instance. This is a union of all possible states of a Dynamic process and a Structured process. States specific to a Dynamic process are ACTIVE, CLOSED, COMPLETED and TERMINATED. States specific to a Structured process are ACTIVE, COMPLETED, SUSPENDED, FAULTED, TERMINATED
• title: string
  Title of the instance
• updateTime: string
  The time the instance was updated. Has the format yyyy-MM-dd'T'HH:mm:ss

{
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the process instance."
        },
        "processName":{
            "type":"string",
            "description":"The name of the process this process instance belongs to."
        },
        "title":{
            "type":"string",
            "description":"Title of the instance"
        },
        "description":{
            "type":"string",
            "description":"Instance Description"
        },
        "processDefinitionName":{
            "type":"string",
            "description":"The name of the process definition that this process instance belongs to."
        },
        "processDefinitionKey":{
            "type":"string",
            "description":"The key of the process definition that this process instance belongs to."
        },
        "processDefinitionVersion":{
            "type":"integer",
            "description":"The version of the process definition that this process instance belongs to."
        },
        "processDefinitionId":{
            "type":"string",
            "description":"The ID of the process definition that this process instance belongs to."
        },
        "businessKey":{
            "type":"string",
            "description":"The business key of the process instance"
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application that this process instance belongs to"
        },
        "applicationTitle":{
            "type":"string",
            "description":"The title of the application that this process instance belongs to"
        },
        "applicationDescription":{
            "type":"string",
            "description":"The description of the application that this process instance belongs to."
        },
        "createTime":{
            "type":"string",
            "description":"The time the instance was created. Has the format yyyy-MM-dd'T'HH:mm:ss"
        },
        "updateTime":{
            "type":"string",
            "description":"The time the instance was updated. Has the format yyyy-MM-dd'T'HH:mm:ss"
        },
        "endTime":{
            "type":"string",
            "description":"The time the instance ended. Has the format yyyy-MM-dd'T'HH:mm:ss"
        },
        "durationInMillis":{
            "type":"integer",
            "description":"The time the instance took to finish in milliseconds.",
            "format":"int64"
        },
        "startActivityId":{
            "type":"string",
            "description":"The ID of the initial activity that was executed. For example, a start event."
        },
        "state":{
            "type":"string",
            "description":"State of the process instance. This is a union of all possible states of a Dynamic process and a\nStructured process. States specific to a Dynamic process are ACTIVE, CLOSED, COMPLETED and TERMINATED.\nStates specific to a Structured process are ACTIVE, COMPLETED, SUSPENDED, FAULTED, TERMINATED\n",
            "enum":[
                "ACTIVE",
                "COMPLETED",
                "TERMINATED",
                "SUSPENDED",
                "FAULTED",
                "CLOSED"
            ]
        },
        "availableActions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "createdBy":{
            "$ref":"#/components/schemas/UserOrAppClient"
        }
    }
}

Nested Schema : Instance-allOf[1]

Type: object

Show Source

• applicationVersion: string
  The version of the application that this process instance belongs to.
• hasChildProcesses: boolean
  Specifies if the process instance has associated active child process instance(s).
• parentDPInstanceId: string
  The ID of the parent process instance if the parent is a dynamic process
• parentProcessInstanceId: string
  The ID of the parent process instance if the parent is a structured process
• processType: string
  The type of the process instance - STRUCTURED or DYNAMIC
• rootInstanceId: string
  The ID of the root process instance. The root process instance could either be a dynamic or a structured process.

{
    "properties":{
        "processType":{
            "type":"string",
            "description":"The type of the process instance - STRUCTURED or DYNAMIC"
        },
        "parentProcessInstanceId":{
            "type":"string",
            "description":"The ID of the parent process instance if the parent is a structured process"
        },
        "parentDPInstanceId":{
            "type":"string",
            "description":"The ID of the parent process instance if the parent is a dynamic process"
        },
        "rootInstanceId":{
            "type":"string",
            "description":"The ID of the root process instance. The root process instance could either be a dynamic or a structured\nprocess.\n"
        },
        "applicationVersion":{
            "type":"string",
            "description":"The version of the application that this process instance belongs to."
        },
        "hasChildProcesses":{
            "type":"boolean",
            "description":"Specifies if the process instance has associated active child process instance(s)."
        }
    }
}

Nested Schema : availableActions

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : UserOrAppClient

Match All

Show Source

• object IdentityCommon
• object Discriminator: type
  Discriminator: { "propertyName":"type" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdentityCommon"
        },
        {
            "type":"object",
            "discriminator":{
                "propertyName":"type"
            },
            "properties":{
                "type":{
                    "type":"string",
                    "enum":[
                        "USER",
                        "APPCLIENT"
                    ]
                }
            }
        }
    ]
}

Nested Schema : Discriminator: type

Type: object

{
    "type":"object",
    "discriminator":{
        "propertyName":"type"
    },
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "USER",
                "APPCLIENT"
            ]
        }
    }
}

Show Source

• type: string
  Allowed Values: [ "USER", "APPCLIENT" ]

{
    "type":"object",
    "discriminator":{
        "propertyName":"type"
    },
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "USER",
                "APPCLIENT"
            ]
        }
    }
}

Nested Schema : IdentityCommon

Type: object

Show Source

• displayName: string
• id: string
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

400 Response

Returned if some query parameters are invalid. For example, if a sortOrder parameter is supplied, but no sortBy.

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

Examples

Select an example Bad request error

401 Response

Unauthorized

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

Examples

Select an example Unauthorized Error

429 Response

Too many requests. Some requests are blocked to prevent the service from going down due to heavy load.

500 Response

Internal server error

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

Examples

Select an example Internal error

503 Response

Too many exceptions or too slow requests

Back to Top