Jump to

• Request
• Response

Get the Process Instance History

get

/process/api/v1/process-instances/{id}/history

Retrieves the history of a process instance using the instance ID.

Note:

You can use this API only on structured processes.

Request

Path Parameters

• id(required): string
  Process Instance 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 : ProcessInstanceHistory

Match All

Show Source

• object CommonModel
• object ProcessInstanceHistory-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "type":"object",
            "properties":{
                "instanceId":{
                    "type":"string",
                    "description":"Instance Id"
                },
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProcessInstanceHistoryItem"
                    }
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Show Source

• links: array links

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

Nested Schema : ProcessInstanceHistory-allOf[1]

Type: object

Show Source

• instanceId: string
  Instance Id
• items: array items

{
    "type":"object",
    "properties":{
        "instanceId":{
            "type":"string",
            "description":"Instance Id"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessInstanceHistoryItem"
            }
        }
    }
}

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 ProcessInstanceHistoryItem

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

Nested Schema : ProcessInstanceHistoryItem

Type: object

Show Source

• activityId: string
  The ID of the activity that this object is an instance of.
• activityName: string
  The name of the activity that this object is an instance of.
• activityType: string
  The type of the activity that this object is an instance of/
• calledCaseInstanceId: string
  The ID of the called case instance. Is only set if the activity is a call activity and the called instance a case instance.
• calledProcessInstanceId: string
  The ID of the called process instance. Is only set if the activity is a call activity and the called instance a process instance.
• canceled: boolean
  If true, this activity instance is canceled.
• completeScope: boolean
  If true, this activity instance did complete a Process scope.
• durationInMillis: integer (int64)
  The time the instance took to finish (in milliseconds).
• endTime: string (date)
  The time the instance ended. Default format* yyyy-MM-dd'T'HH:mm:ss.SSSZ.
• executionId: string
  The ID of the execution that executed this activity instance.
• id: string
  The ID of the activity instance.
• parentActivityInstanceId: string
  The ID of the parent activity instance, for example a sub process instance.
• processDefinitionId: string
  The ID of the process definition that this activity instance belongs to.
• processDefinitionKey: string
  The key of the process definition that this activity instance belongs to.
• processInstanceId: string
  The ID of the process instance that this activity instance belongs to.
• startTime: string (date)
  The time the instance was started. Default format* yyyy-MM-dd'T'HH:mm:ss.SSSZ.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the activity instance."
        },
        "parentActivityInstanceId":{
            "type":"string",
            "description":"The ID of the parent activity instance, for example a sub process instance."
        },
        "activityId":{
            "type":"string",
            "description":"The ID of the activity that this object is an instance of."
        },
        "activityName":{
            "type":"string",
            "description":"The name of the activity that this object is an instance of."
        },
        "activityType":{
            "type":"string",
            "description":"The type of the activity that this object is an instance of/"
        },
        "processDefinitionKey":{
            "type":"string",
            "description":"The key of the process definition that this activity instance belongs to."
        },
        "processDefinitionId":{
            "type":"string",
            "description":"The ID of the process definition that this activity instance belongs to."
        },
        "processInstanceId":{
            "type":"string",
            "description":"The ID of the process instance that this activity instance belongs to."
        },
        "executionId":{
            "type":"string",
            "description":"The ID of the execution that executed this activity instance."
        },
        "calledProcessInstanceId":{
            "type":"string",
            "description":"The ID of the called process instance. Is only set if the activity is a call activity and the called instance a process instance."
        },
        "calledCaseInstanceId":{
            "type":"string",
            "description":"The ID of the called case instance. Is only set if the activity is a call activity and the called instance a case instance."
        },
        "startTime":{
            "type":"string",
            "description":"The time the instance was started. Default format* yyyy-MM-dd'T'HH:mm:ss.SSSZ.",
            "format":"date"
        },
        "endTime":{
            "type":"string",
            "description":"The time the instance ended. Default format* yyyy-MM-dd'T'HH:mm:ss.SSSZ.",
            "format":"date"
        },
        "durationInMillis":{
            "type":"integer",
            "description":"The time the instance took to finish (in milliseconds).",
            "format":"int64"
        },
        "canceled":{
            "type":"boolean",
            "description":"If true, this activity instance is canceled."
        },
        "completeScope":{
            "type":"boolean",
            "description":"If true, this activity instance did complete a Process scope."
        }
    }
}

401 Response

Unauthorized

404 Response

Process instance 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