REST API for Oracle Cloud Infrastructure Process Automation

List History of Process Document

get

/process/api/v1/audit/instances/{instanceId}/documents/{documentId}

Retrieves the history of a single document used within a process instance.

Request

Path Parameters

documentId(required): string

The id for the document
instanceId(required): string

The id that identifies the process.

Query Parameters

limit: integer

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

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

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

Match All

Show Source

object CommonModel
object AuditDocumentWithoutCM
object ListPagination

A common structure for helping a client with pagination
object AuditDocumentDetail-allOf[3]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "$ref":"#/components/schemas/AuditDocumentWithoutCM"
        },
        {
            "$ref":"#/components/schemas/ListPagination"
        },
        {
            "type":"object",
            "properties":{
                "historyDetail":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AuditDocumentEvent"
                    }
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Show Source

links: array links

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

Nested Schema : AuditDocumentWithoutCM

Type: object

Show Source

createdBy: AuditUser
createdDate: string (date)

The date and time at which the document was created i.e. uploaded with the format yyyy-MM-dd'T'HH:mm:ss.
documentId: string

The unique identifier for the document or attachment.
dpInstanceId: string

The instance ID for the related dynamic process instance. This is mutually exclusive to the processInstanceId
fileName: string

The name of the file that was uploaded as a document or attachment.
href: string

The URL pointing pointing to the document or attachment.
lastUpdatedBy: AuditUser
lastUpdatedDate: string (date)

The date and time at which the document was lat updated with the format yyyy-MM-dd'T'HH:mm:ss.
processInstanceId: string

The instance ID for the related BPMN process instance. This is mutually exclusive to the dpInstanceId

{
    "type":"object",
    "properties":{
        "documentId":{
            "type":"string",
            "description":"The unique identifier for the document or attachment."
        },
        "processInstanceId":{
            "type":"string",
            "description":"The instance ID for the related BPMN process instance. This is mutually exclusive to the dpInstanceId"
        },
        "dpInstanceId":{
            "type":"string",
            "description":"The instance ID for the related dynamic process instance. This is mutually exclusive to the processInstanceId"
        },
        "fileName":{
            "type":"string",
            "description":"The name of the file that was uploaded as a document or attachment."
        },
        "href":{
            "type":"string",
            "description":"The URL pointing pointing to the document or attachment."
        },
        "createdBy":{
            "$ref":"#/components/schemas/AuditUser"
        },
        "createdDate":{
            "type":"string",
            "description":"The date and time at which the document was created i.e. uploaded with the format yyyy-MM-dd'T'HH:mm:ss.",
            "format":"date"
        },
        "lastUpdatedBy":{
            "$ref":"#/components/schemas/AuditUser"
        },
        "lastUpdatedDate":{
            "type":"string",
            "description":"The date and time at which the document was lat updated with the format yyyy-MM-dd'T'HH:mm:ss.",
            "format":"date"
        }
    }
}

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 : AuditDocumentDetail-allOf[3]

Type: object

Show Source

historyDetail: array historyDetail

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

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

Match All

Show Source

allOf Identity
object AuditUser-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Identity"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : Identity

Match All

Show Source

object IdentityCommon
object Identity-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdentityCommon"
        },
        {
            "type":"object",
            "properties":{
                "type":{
                    "type":"string",
                    "enum":[
                        "USER",
                        "GROUP",
                        "ROLE"
                    ]
                }
            }
        }
    ]
}

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

Nested Schema : Identity-allOf[1]

Type: object

Show Source

type: string

Allowed Values: [ "USER", "GROUP", "ROLE" ]

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "USER",
                "GROUP",
                "ROLE"
            ]
        }
    }
}

Nested Schema : AuditUser-allOf[1]

Type: object

Nested Schema : historyDetail

Type: array

Show Source

Array of: object AuditDocumentEvent

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

Nested Schema : AuditDocumentEvent

Type: object

Show Source

action: string

Allowed Values: [ "AddDocument", "UpdateDocument", "DeleteDocument" ]
dpInstanceId: string

The identifier of the dynamic process instance.
operationId: string

The identifier for the user operation.
performer: AuditUser
processInstanceId: string

The identifier of the BPMN process instance.
taskId: string

The identifier for the task.
timestamp: string (date)

The timestamp at which the operation took place.

{
    "type":"object",
    "properties":{
        "operationId":{
            "type":"string",
            "description":"The identifier for the user operation."
        },
        "timestamp":{
            "type":"string",
            "description":"The timestamp at which the operation took place.",
            "format":"date"
        },
        "processInstanceId":{
            "type":"string",
            "description":"The identifier of the BPMN process instance."
        },
        "dpInstanceId":{
            "type":"string",
            "description":"The identifier of the dynamic process instance."
        },
        "taskId":{
            "type":"string",
            "description":"The identifier for the task."
        },
        "performer":{
            "$ref":"#/components/schemas/AuditUser"
        },
        "action":{
            "type":"string",
            "enum":[
                "AddDocument",
                "UpdateDocument",
                "DeleteDocument"
            ]
        }
    }
}

201 Response

There are no document for the process instance id

401 Response

Unauthorized

404 Response

The document instance does not exist

429 Response

Too Many Requests

500 Response

internal server error

503 Response

Too Many Exceptions or Too Slow Requests