REST API for Oracle Cloud Infrastructure Process Automation

List Data Objects

get

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

Lists the data objects for a process instance.

Request

Path Parameters

instanceId(required): string

The id that identifies the process.

Query Parameters

activityInstanceIdIn: string

Restrict the list of data objects that belong to activities with an activity instance id that is in the given set of activity instance ids. This must be a comma-separated list of data types.
definitionId: string

Restrict the result to the data objects that have the given process definition id.
definitionKey: string

Restrict the result to the data objects that have the given process definition key.
executionIdIn: string

Restrict the result to the data objects that have an execution id that is in the set of given execution ids. This must be a comma-separated list of data types.
includeDeleted: boolean

Enables the result to contian data objects that have been deleted during execution.
limit: integer(int32)

Maximum Value: 50

The number of items to return. If parameter is omitted default value 25 is set. If limit <=0 or limit> 50 then upto 50 records are returned

Default Value: 25
offset: integer(int32)

0 based index. The number of items to skip before starting to collect the result set.

Default Value: 0
orderBy: string

This parameter specifies the order by clause. The value must follow the format of fieldName[:(asc/desc)][,fieldName[:(asc/desc)]]*. e.g. variableName:asc. Multiple ordering is not supported. The only supported attribute is variableName
serializeObjectValues: boolean

Enable the data object values for large data objects to be returned. This is defaulted to false to prevent potentially large data from being returned.

Default Value: true
taskIdIn: string

Restrict the list of data objects that belong to user tasks with a task id that is in the set of given task ids. This must be a comma-separated list of data types.
totalResults: boolean

If true return total count of records for given query with filters

Default Value: false
variableId: string

Search for the data object that is identified by the given variable instance id.
variableName: string

Restrict the result to the data objects that have the given variable name.
variableNameLike: string

Restrict the result to the data objects whose name contains the given substring of a variable name.
variableTypeIn: string

Restrict the result to the data objects that are one of the variable data types. This must be a comma-separated list of data types.

Allowed Values: [ "boolean", "bytes", "short", "integer", "long", "double", "date", "stirng", null, "file", "object", "json", "xml" ]
variableValue: string

Restrict the result to primitive data objects with certain values equal to the given variable value.

Header Parameters

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

Match All

Show Source

object CommonModel
object ListPagination

A common structure for helping a client with pagination
object AuditProcessVariables-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "$ref":"#/components/schemas/ListPagination"
        },
        {
            "type":"object",
            "properties":{
                "instanceId":{
                    "type":"string",
                    "description":"The structured process instance ID"
                },
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AuditVariable"
                    }
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Show Source

links: array links

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

Nested Schema : ListPagination

Type: object

A common structure for helping a client with pagination

Show Source

count: integer

The count of elements that are returned in the current this will be equal to or less than the "limit" parameter
limit: integer

The maximum number of elements to be returned. This will correspond to the "limit" query parameter
offset: integer

The index number of the first element for the list. This will correspond to the "offset" query parameter value
totalResults: integer (int64)

The total number of elements in the list for the applied filters - not including the "limit" parameter

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The total number of elements in the list for the applied filters - not including the \"limit\" parameter",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "description":"The index number of the first element for the list. This will correspond to the \"offset\" query parameter value"
        },
        "limit":{
            "type":"integer",
            "description":"The maximum number of elements to be returned. This will correspond to the \"limit\" query parameter"
        },
        "count":{
            "type":"integer",
            "description":"The count of elements that are returned in the current this will be equal to or less than the \"limit\" parameter"
        }
    },
    "description":"A common structure for helping a client with pagination"
}

Nested Schema : AuditProcessVariables-allOf[2]

Type: object

Show Source

instanceId: string

The structured process instance ID
items: array items

{
    "type":"object",
    "properties":{
        "instanceId":{
            "type":"string",
            "description":"The structured process instance ID"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditVariable"
            }
        }
    }
}

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

The variable for a process instance

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

Nested Schema : AuditVariable

The variable for a process instance

Match All

The variable for a process instance

Show Source

object CommonModel
object AuditVariable-allOf[1]

{
    "description":"The variable for a process instance",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "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 : AuditVariable-allOf[1]

Type: object

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.

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

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