Jump to

• Request
• Response

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: string
  Accept-Language header in IETF BCP 47
• oci-original-url: string
  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 : 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 : CommonModel

Type: object

Show Source

• links: array links

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

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 : 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 : 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"
        }
    }
}

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

404 Response

Process instance with given id does not exist.

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 Not found error

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

Back to Top