REST API for Oracle Cloud Infrastructure Process Automation

List Process Data Object History

get

/process/api/v1/audit/instances/{instanceId}/data-objects/{dataobjectId}

Retrieves the history of a particular data object for a process instance.

Request

Path Parameters

dataobjectId(required): string

The unique identifier for the data object.
instanceId(required): string

The id that identifies the process.

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.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : AuditProcessVariableDetail

Match All

Show Source

object CommonModel
object AuditVariableWithoutCM

The variable for a process instance
object AuditProcessVariableDetail-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "$ref":"#/components/schemas/AuditVariableWithoutCM"
        },
        {
            "type":"object",
            "properties":{
                "variableUpdates":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AuditDetailLog"
                    }
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Show Source

links: array links

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

Nested Schema : AuditVariableWithoutCM

Type: object

The variable for a process instance

Show Source

activityInstanceId: string

The id of the activity instance
createTime: string (date)

The date that the variable was created
errorMessasge: string

If the variable value could not be loaded, this return the error message
executionId: string

Execution reference
id: string

The unique identifier for the audit variable instance
name: string

The name of the variable
processDefinitionId: string

The process definition reference
processDefinitionKey: string

The process definition key reference
processInstanceId: string

The process instance reference
removalTime: string (date)

The time the
rootProcessInstanceId: string

The root process instance reference
state: string

The current state of the variable
taskId: string

The task ID when the activity is a task
typeName: string

The name of the data type of this variable instance
value: string

The current variable value as a String.

{
    "description":"The variable for a process instance",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier for the audit variable instance"
        },
        "processDefinitionKey":{
            "type":"string",
            "description":"The process definition key reference"
        },
        "processDefinitionId":{
            "type":"string",
            "description":"The process definition reference"
        },
        "rootProcessInstanceId":{
            "type":"string",
            "description":"The root process instance reference"
        },
        "processInstanceId":{
            "type":"string",
            "description":"The process instance reference"
        },
        "taskId":{
            "type":"string",
            "description":"The task ID when the activity is a task"
        },
        "executionId":{
            "type":"string",
            "description":"Execution reference"
        },
        "activityInstanceId":{
            "type":"string",
            "description":"The id of the activity instance"
        },
        "name":{
            "type":"string",
            "description":"The name of the variable"
        },
        "typeName":{
            "type":"string",
            "description":"The name of the data type of this variable instance"
        },
        "createTime":{
            "type":"string",
            "description":"The date that the variable was created",
            "format":"date"
        },
        "value":{
            "type":"string",
            "description":"The current variable value as a String."
        },
        "errorMessasge":{
            "type":"string",
            "description":"If the variable value could not be loaded, this return the error message"
        },
        "state":{
            "type":"string",
            "description":"The current state of the variable"
        },
        "removalTime":{
            "type":"string",
            "description":"The time the",
            "format":"date"
        }
    }
}

Nested Schema : AuditProcessVariableDetail-allOf[2]

Type: object

Show Source

variableUpdates: array variableUpdates

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

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

Type: array

Show Source

Array of: AuditDetailLog

The detail log for an activities interaction with a variable

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

Nested Schema : AuditDetailLog

The detail log for an activities interaction with a variable

Match All

The detail log for an activities interaction with a variable

Show Source

object CommonModel
object AuditDetailLog-allOf[1]

{
    "description":"The detail log for an activities interaction with a variable",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The ID for the audit log detail"
                },
                "processDefinitionKey":{
                    "type":"string",
                    "description":"The reference to the BPMN process definition key"
                },
                "processDefinitionId":{
                    "type":"string",
                    "description":"The reference to the BPMN process definition ID"
                },
                "processInstanceId":{
                    "type":"string",
                    "description":"The reference to the structured process instance"
                },
                "activityInstanceId":{
                    "type":"string",
                    "description":"The reference to the activity instance"
                },
                "executionId":{
                    "type":"string",
                    "description":"The reference to the BPMN execution ID for the detail log"
                },
                "dpDefinitionkey":{
                    "type":"string",
                    "description":"The reference to the Dynamic process definition ey"
                },
                "dpDefinitionId":{
                    "type":"string",
                    "description":"The reference to the Dynamic process definition ID"
                },
                "dpInstanceId":{
                    "type":"string",
                    "description":"The reference to the Dynamic process instance"
                },
                "dpExecutionId":{
                    "type":"string",
                    "description":"The reference to the Dynamic execution ID"
                },
                "taskId":{
                    "type":"string",
                    "description":"The reference the task activity ID"
                },
                "userOperationId":{
                    "type":"string",
                    "description":"The user oepration performed in this detail log"
                },
                "timestamp":{
                    "type":"string",
                    "description":"The time stamp when the operation occurred",
                    "format":"date"
                },
                "removalTime":{
                    "type":"string",
                    "description":"The date and time when the operation will will be removed",
                    "format":"date"
                },
                "rootProcessInstanceId":{
                    "type":"string",
                    "description":"The reference to the the root process instance"
                },
                "variableName":{
                    "type":"string",
                    "description":"The name of the updated variable"
                },
                "variableInstanceId":{
                    "type":"string",
                    "description":"The reference to the variable instance"
                },
                "variableValue":{
                    "type":"string",
                    "description":"The variable object value"
                },
                "revision":{
                    "type":"integer",
                    "description":"The revision number for the updated variable"
                },
                "errorMessage":{
                    "type":"string",
                    "description":"The error message if the variable failed to be loaded"
                }
            }
        }
    ]
}

Nested Schema : AuditDetailLog-allOf[1]

Type: object

Show Source

activityInstanceId: string

The reference to the activity instance
dpDefinitionId: string

The reference to the Dynamic process definition ID
dpDefinitionkey: string

The reference to the Dynamic process definition ey
dpExecutionId: string

The reference to the Dynamic execution ID
dpInstanceId: string

The reference to the Dynamic process instance
errorMessage: string

The error message if the variable failed to be loaded
executionId: string

The reference to the BPMN execution ID for the detail log
id: string

The ID for the audit log detail
processDefinitionId: string

The reference to the BPMN process definition ID
processDefinitionKey: string

The reference to the BPMN process definition key
processInstanceId: string

The reference to the structured process instance
removalTime: string (date)

The date and time when the operation will will be removed
revision: integer

The revision number for the updated variable
rootProcessInstanceId: string

The reference to the the root process instance
taskId: string

The reference the task activity ID
timestamp: string (date)

The time stamp when the operation occurred
userOperationId: string

The user oepration performed in this detail log
variableInstanceId: string

The reference to the variable instance
variableName: string

The name of the updated variable
variableValue: string

The variable object value

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID for the audit log detail"
        },
        "processDefinitionKey":{
            "type":"string",
            "description":"The reference to the BPMN process definition key"
        },
        "processDefinitionId":{
            "type":"string",
            "description":"The reference to the BPMN process definition ID"
        },
        "processInstanceId":{
            "type":"string",
            "description":"The reference to the structured process instance"
        },
        "activityInstanceId":{
            "type":"string",
            "description":"The reference to the activity instance"
        },
        "executionId":{
            "type":"string",
            "description":"The reference to the BPMN execution ID for the detail log"
        },
        "dpDefinitionkey":{
            "type":"string",
            "description":"The reference to the Dynamic process definition ey"
        },
        "dpDefinitionId":{
            "type":"string",
            "description":"The reference to the Dynamic process definition ID"
        },
        "dpInstanceId":{
            "type":"string",
            "description":"The reference to the Dynamic process instance"
        },
        "dpExecutionId":{
            "type":"string",
            "description":"The reference to the Dynamic execution ID"
        },
        "taskId":{
            "type":"string",
            "description":"The reference the task activity ID"
        },
        "userOperationId":{
            "type":"string",
            "description":"The user oepration performed in this detail log"
        },
        "timestamp":{
            "type":"string",
            "description":"The time stamp when the operation occurred",
            "format":"date"
        },
        "removalTime":{
            "type":"string",
            "description":"The date and time when the operation will will be removed",
            "format":"date"
        },
        "rootProcessInstanceId":{
            "type":"string",
            "description":"The reference to the the root process instance"
        },
        "variableName":{
            "type":"string",
            "description":"The name of the updated variable"
        },
        "variableInstanceId":{
            "type":"string",
            "description":"The reference to the variable instance"
        },
        "variableValue":{
            "type":"string",
            "description":"The variable object value"
        },
        "revision":{
            "type":"integer",
            "description":"The revision number for the updated variable"
        },
        "errorMessage":{
            "type":"string",
            "description":"The error message if the variable failed to be loaded"
        }
    }
}

201 Response

There are no activities for the process instance id

401 Response

Unauthorized

404 Response

The process instance does not exist

429 Response

Too Many Requests

500 Response

internal server error

503 Response

Too Many Exceptions or Too Slow Requests

Examples

Example: Get the history of a data object

The following example shows how to get the history of a specific data object for a process instance by submitting a GET request on the REST resource using cURL. For more information about cURL, see cURL Access. For more information about endpoint URL structure, see Send Requests.

Retrieve the history of data object 77ydfdf4-5717-4562-87yhu8u7-1duufcelu8ofe for process instance 3fa85f64-5717-4562-b3fc-2c963f66afa6.

curl -X 'GET' \
      'https://<OIC URL>/process/api/v1/audit/instances/3fa85f64-5717-4562-b3fc-2c963f66afa6/data-objects/77ydfdf4-5717-4562-87yhu8u7-1duufcelu8ofe'
      \   -H 'accept: application/json' \   -H 'oci-original-url:
    www.oracle.com'

Example: Format of 200 Operation Successful response

{
  "links": [
    {
      "href": "string",
      "hreflang": "string",
      "length": 0,
      "rel": "string",
      "title": "string",
      "type": "string",
      "mediaType": "string",
      "message": "string",
      "code": 600
    }
  ],
  "id": "string",
  "processDefinitionKey": "string",
  "processDefinitionId": "string",
  "rootProcessInstanceId": "string",
  "processInstanceId": "string",
  "taskId": "string",
  "executionId": "string",
  "activityInstanceId": "string",
  "name": "string",
  "typeName": "string",
  "createTime": "2024-08-12",
  "value": "string",
  "errorMessasge": "string",
  "state": "string",
  "removalTime": "2024-08-12",
  "variableUpdates": [
    {
      "links": [
        {
          "href": "string",
          "hreflang": "string",
          "length": 0,
          "rel": "string",
          "title": "string",
          "type": "string",
          "mediaType": "string",
          "message": "string",
          "code": 600
        }
      ],
      "id": "string",
      "processDefinitionKey": "string",
      "processDefinitionId": "string",
      "processInstanceId": "string",
      "activityInstanceId": "string",
      "executionId": "string",
      "dpDefinitionkey": "string",
      "dpDefinitionId": "string",
      "dpInstanceId": "string",
      "dpExecutionId": "string",
      "taskId": "string",
      "userOperationId": "string",
      "timestamp": "2024-08-12",
      "removalTime": "2024-08-12",
      "rootProcessInstanceId": "string",
      "variableName": "string",
      "variableInstanceId": "string",
      "variableValue": "string",
      "revision": 0,
      "errorMessage": "string"
    }
  ]
}