Get a Process Instance
get
/process/api/v1/instances/{id}
Gets the process instance for the given instance Id.
Request
Path Parameters
-
id(required): string
Process Instance 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 TopResponse
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : BaseInstance-allOf[1]
Type:
Show Source
object
-
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
Nested Schema : Instance-allOf[1]
Type:
Show Source
object
-
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.
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
Nested Schema : UserOrAppClient
Match All
Show Source
-
object
IdentityCommon
-
object
Discriminator: type
Discriminator:
{ "propertyName":"type" }
Nested Schema : Discriminator: type
Type:
Show Source
object
-
type: string
Allowed Values:
[ "USER", "APPCLIENT" ]
401 Response
Unauthorized
Examples
404 Response
Process instance with given id does not exist.
Examples
500 Response
Internal server error
Examples