Jump to

• Request
• Response

Get a Process Execution

get

/process/api/v1/process-executions/{id}

Get a Process execution for a given execution ID. You can use this API function only on structured processes.

Request

Path Parameters

• id(required): string
  Process execution Id

Header Parameters

• 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 : ProcessExecution

Match All

Show Source

• object CommonModel
• object ProcessExecution-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The ID of the process execution instance."
                },
                "processExecutionId":{
                    "type":"string",
                    "description":"The ID of the process execution instance."
                },
                "processInstanceId":{
                    "type":"string",
                    "description":"The ID of the process instance that this execution instance belongs to."
                },
                "assignee":{
                    "type":"string",
                    "description":"The assignee incase the activity is a user task."
                },
                "parentProcessActivityInstanceId":{
                    "type":"string",
                    "description":"The ID of the parent process activity this instance belongs to."
                },
                "activityId":{
                    "type":"string",
                    "description":"The ID of the activity."
                },
                "activityName":{
                    "type":"string",
                    "description":"The name of the activity."
                },
                "activityType":{
                    "type":"string",
                    "description":"The type of the activity."
                },
                "processDefinitionId":{
                    "type":"string",
                    "description":"The ID of the process definition that this process activity instance belongs to."
                },
                "executionId":{
                    "type":"string",
                    "description":"The ID of the execution."
                },
                "taskId":{
                    "type":"string",
                    "description":"Task Id"
                },
                "taskTitle":{
                    "type":"string",
                    "description":"Task Title"
                },
                "bpmnProcessTitle":{
                    "type":"string",
                    "description":"Sructured Process Title"
                },
                "userId":{
                    "type":"string",
                    "description":"The ID of the user this activty instance is assigned to."
                },
                "createTime":{
                    "type":"string",
                    "description":"The time the instance was created. Has the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, Returns date in UTC."
                },
                "endTime":{
                    "type":"string",
                    "description":"The time the instance ended. Has the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, Returns date in UTC."
                },
                "durationInMillis":{
                    "type":"integer",
                    "format":"int64",
                    "description":"The time the instance took to finish (in milliseconds)."
                },
                "required":{
                    "type":"boolean",
                    "description":"If this activity is required"
                },
                "calledProcessInstance":{
                    "type":"string",
                    "description":"The name of the calledProcessInsatnce"
                },
                "state":{
                    "type":"string",
                    "description":"state of the process activity instance",
                    "default":"ACTIVE",
                    "enum":[
                        "AVAILABLE",
                        "ENABLED",
                        "DISABLED",
                        "ACTIVE",
                        "COMPLETED",
                        "TERMINATED",
                        "FAILED",
                        "SUSPENDED"
                    ]
                },
                "availableActions":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "availablePermissions":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "failureMessage":{
                    "type":"string",
                    "description":"This shows failure reasons when activity is in failed state"
                },
                "faultData":{
                    "$ref":"#/components/schemas/FaultData"
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Show Source

• links: array links

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

Nested Schema : ProcessExecution-allOf[1]

Type: object

Show Source

• activityId: string
  The ID of the activity.
• activityName: string
  The name of the activity.
• activityType: string
  The type of the activity.
• assignee: string
  The assignee incase the activity is a user task.
• availableActions: array availableActions
• availablePermissions: array availablePermissions
• bpmnProcessTitle: string
  Sructured Process Title
• calledProcessInstance: string
  The name of the calledProcessInsatnce
• createTime: string
  The time the instance was created. Has the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, Returns date in UTC.
• 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.SSSZ, Returns date in UTC.
• executionId: string
  The ID of the execution.
• failureMessage: string
  This shows failure reasons when activity is in failed state
• faultData: object FaultData
• id: string
  The ID of the process execution instance.
• parentProcessActivityInstanceId: string
  The ID of the parent process activity this instance belongs to.
• processDefinitionId: string
  The ID of the process definition that this process activity instance belongs to.
• processExecutionId: string
  The ID of the process execution instance.
• processInstanceId: string
  The ID of the process instance that this execution instance belongs to.
• required: boolean
  If this activity is required
• state: string
  Default Value: ACTIVE

  Allowed Values: [ "AVAILABLE", "ENABLED", "DISABLED", "ACTIVE", "COMPLETED", "TERMINATED", "FAILED", "SUSPENDED" ]

  state of the process activity instance
• taskId: string
  Task Id
• taskTitle: string
  Task Title
• userId: string
  The ID of the user this activty instance is assigned to.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the process execution instance."
        },
        "processExecutionId":{
            "type":"string",
            "description":"The ID of the process execution instance."
        },
        "processInstanceId":{
            "type":"string",
            "description":"The ID of the process instance that this execution instance belongs to."
        },
        "assignee":{
            "type":"string",
            "description":"The assignee incase the activity is a user task."
        },
        "parentProcessActivityInstanceId":{
            "type":"string",
            "description":"The ID of the parent process activity this instance belongs to."
        },
        "activityId":{
            "type":"string",
            "description":"The ID of the activity."
        },
        "activityName":{
            "type":"string",
            "description":"The name of the activity."
        },
        "activityType":{
            "type":"string",
            "description":"The type of the activity."
        },
        "processDefinitionId":{
            "type":"string",
            "description":"The ID of the process definition that this process activity instance belongs to."
        },
        "executionId":{
            "type":"string",
            "description":"The ID of the execution."
        },
        "taskId":{
            "type":"string",
            "description":"Task Id"
        },
        "taskTitle":{
            "type":"string",
            "description":"Task Title"
        },
        "bpmnProcessTitle":{
            "type":"string",
            "description":"Sructured Process Title"
        },
        "userId":{
            "type":"string",
            "description":"The ID of the user this activty instance is assigned to."
        },
        "createTime":{
            "type":"string",
            "description":"The time the instance was created. Has the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, Returns date in UTC."
        },
        "endTime":{
            "type":"string",
            "description":"The time the instance ended. Has the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, Returns date in UTC."
        },
        "durationInMillis":{
            "type":"integer",
            "format":"int64",
            "description":"The time the instance took to finish (in milliseconds)."
        },
        "required":{
            "type":"boolean",
            "description":"If this activity is required"
        },
        "calledProcessInstance":{
            "type":"string",
            "description":"The name of the calledProcessInsatnce"
        },
        "state":{
            "type":"string",
            "description":"state of the process activity instance",
            "default":"ACTIVE",
            "enum":[
                "AVAILABLE",
                "ENABLED",
                "DISABLED",
                "ACTIVE",
                "COMPLETED",
                "TERMINATED",
                "FAILED",
                "SUSPENDED"
            ]
        },
        "availableActions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "availablePermissions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "failureMessage":{
            "type":"string",
            "description":"This shows failure reasons when activity is in failed state"
        },
        "faultData":{
            "$ref":"#/components/schemas/FaultData"
        }
    }
}

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 : availablePermissions

Type: array

Show Source

• Array of: string

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

Nested Schema : FaultData

Type: object

Show Source

• errorCause: string
  Error Cause
• errorCode: string
  Error Code
• errorMessage: string
  Error Message
• errorStatus: integer
  Error Status

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "description":"Error Message"
        },
        "errorCause":{
            "type":"string",
            "description":"Error Cause"
        },
        "errorStatus":{
            "type":"integer",
            "description":"Error Status"
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        }
    }
}

401 Response

Unauthorized

404 Response

Process execution with given id does not exist.

429 Response

Too many requests

500 Response

Internal server error

503 Response

Too many exceptions or too slow requests

Back to Top