Developer API for Oracle Cloud Infrastructure Process Automation

List User Task History for Process Instance

get

/process/api/v1/audit/instances/{instanceId}/tasks/{taskId}

Retrieves the history for a particular user task in a process instance.

Request

Path Parameters

instanceId(required): string

The id that identifies the process.
taskId(required): string

The id that identifies the user task.

Header Parameters

Accept-Language: string

Accept-Language header in IETF BCP 47
oci-original-url: string

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

Match All

Show Source

object CommonModel
object AuditTaskWithoutCM
object ListPagination

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "$ref":"#/components/schemas/AuditTaskWithoutCM"
        },
        {
            "$ref":"#/components/schemas/ListPagination"
        },
        {
            "type":"object",
            "properties":{
                "childTasks":{
                    "$ref":"#/components/schemas/ChildTasks"
                },
                "actions":{
                    "$ref":"#/components/schemas/AuditTaskActions"
                },
                "historyDetail":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AuditTaskEvent"
                    }
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Show Source

links: array links

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

Nested Schema : AuditTaskWithoutCM

Type: object

Show Source

activityInstanceId: string

The unique identifier for the User Task activity that is associated to the current task.
applicationName: string

The name of the application to which the process and task belong.
assignedDate: string (date)

Assigned date in the format yyyy-MM-dd'T'HH:mm:ss.
assignee: AuditUser
candidateGroups: array candidateGroups
candidateUsers: array candidateUsers
completedDate: string (date)

Time when the task was deleted or completed in format yyyy-MM-dd'T'HH:mm:ss.
createdBy: UserOrAppClient
createdDate: string (date)

The time the task was created in the format yyyy-MM-dd'T'HH:mm:ss.
description: string

Some text to describe the task.
dpDefinitionId: string

The Dynamic Process reference.
dpExecutionId: string

The Dynamic Process execution reference.
dpInstanceId: string

The unique identifier for the Dynamic Process in whcih the User Task activity has been invoked.
dpName: string

The name of a Dynamic Process to which the task belongs.
dueDate: string (date)

Due date in the format yyyy-MM-dd'T'HH:mm:ss.
duration: number (int64)

The duration of the User Task activity. This will be the difference between the endTime and the startTime.
endTime: string (date)

The date and time stamp as to when the User Task activity execution ended.
expirationDate: string (date)

expiration Date in the format yyyy-MM-dd'T'HH:mm:ss.
externalFormUrl: string

The reference to the external form associated with the task.
formURL: string

The reference to the form associated with the task.
fromUser: string

When a task is reassigned from one user to the other, the source or from user is recorded.
isAdhoc: boolean

Specifies if it is an Adhoc Task or not.
lastAction: object AuditTaskEvent
lastUpdatedDate: string (date)

Last updated date in the format yyyy-MM-dd'T'HH:mm:ss.
outcome: string

The result of a user action will be recorded as an outcome.
parentTaskId: string

Where a User Task is related to other tasks, the reference to the owning task is recorded as the parentTaskId.
priority: integer (int32)

Allowed Values: [ 1, 2, 3 ]

The priority for the task. This is provided as a number between 1 and 3, where 1 is the highest priority.
processDefinitionId: string

The BPMN process definition reference.
processExecutionId: string

The BPMN execution reference.
processInstanceId: string

The unique identifier for the BPMN process in which the User Task activity has been invoked.
processName: string

The name of the BPMN process to which the task belongs.
removalTime: string (date)

The time the historic task instance will be removed.
rootProcessId: string

The unique process instance ID that represents a parent or root identifier for one or more child or called processes.
startTime: string (date)

The date and time stamp as to when the User Task activity was invoked.
state: string

Allowed Values: [ "ASSIGNED", "UNASSIGNED", "WITHDRAWN", "COMPLETED", "DELEGATED", "FAULTED" ]

This defines the current state of the task. It can only be one of five values.
taskId: string

The unique identifier for a task.
title: string

The title that describes the task.

{
    "type":"object",
    "properties":{
        "taskId":{
            "type":"string",
            "description":"The unique identifier for a task."
        },
        "title":{
            "type":"string",
            "description":"The title that describes the task."
        },
        "description":{
            "type":"string",
            "description":"Some text to describe the task."
        },
        "isAdhoc":{
            "type":"boolean",
            "description":"Specifies if it is an Adhoc Task or not."
        },
        "priority":{
            "type":"integer",
            "description":"The priority for the task. This is provided as a number between 1 and 3, where 1 is  the highest priority.",
            "format":"int32",
            "enum":[
                1,
                2,
                3
            ]
        },
        "state":{
            "type":"string",
            "description":"This defines the current state of the task. It can only be one of five values.",
            "enum":[
                "ASSIGNED",
                "UNASSIGNED",
                "WITHDRAWN",
                "COMPLETED",
                "DELEGATED",
                "FAULTED"
            ]
        },
        "assignee":{
            "$ref":"#/components/schemas/AuditUser"
        },
        "outcome":{
            "type":"string",
            "description":"The result of a user action will be recorded as an outcome."
        },
        "fromUser":{
            "type":"string",
            "description":"When a task is reassigned from one user to the other, the source or from user is recorded."
        },
        "createdBy":{
            "$ref":"#/components/schemas/UserOrAppClient"
        },
        "createdDate":{
            "type":"string",
            "description":"The time the task was created in the format yyyy-MM-dd'T'HH:mm:ss.",
            "format":"date"
        },
        "dueDate":{
            "type":"string",
            "description":"Due date in the format yyyy-MM-dd'T'HH:mm:ss.",
            "format":"date"
        },
        "lastUpdatedDate":{
            "type":"string",
            "description":"Last updated date in the format yyyy-MM-dd'T'HH:mm:ss.",
            "format":"date"
        },
        "completedDate":{
            "type":"string",
            "description":"Time when the task was deleted or completed in format yyyy-MM-dd'T'HH:mm:ss.",
            "format":"date"
        },
        "assignedDate":{
            "type":"string",
            "description":"Assigned date in the format yyyy-MM-dd'T'HH:mm:ss.",
            "format":"date"
        },
        "processName":{
            "type":"string",
            "description":"The name of the BPMN process to which the task belongs."
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application to which the process and task belong."
        },
        "activityInstanceId":{
            "type":"string",
            "description":"The unique identifier for the User Task activity that is associated to the current task."
        },
        "processInstanceId":{
            "type":"string",
            "description":"The unique identifier for the BPMN process in which the User Task activity has been invoked."
        },
        "processDefinitionId":{
            "type":"string",
            "description":"The BPMN process definition reference."
        },
        "processExecutionId":{
            "type":"string",
            "description":"The BPMN execution reference."
        },
        "rootProcessId":{
            "type":"string",
            "description":"The unique process instance ID that represents a parent or root identifier for one or more child or called processes."
        },
        "dpName":{
            "type":"string",
            "description":"The name of a Dynamic Process to which the task belongs."
        },
        "dpInstanceId":{
            "type":"string",
            "description":"The unique identifier for the Dynamic Process in whcih the User Task activity has been invoked."
        },
        "dpDefinitionId":{
            "type":"string",
            "description":"The Dynamic Process reference."
        },
        "dpExecutionId":{
            "type":"string",
            "description":"The Dynamic Process execution reference."
        },
        "startTime":{
            "type":"string",
            "description":"The date and time stamp as to when the User Task activity was invoked.",
            "format":"date"
        },
        "endTime":{
            "type":"string",
            "description":"The date and time stamp as to when the User Task activity execution ended.",
            "format":"date"
        },
        "duration":{
            "type":"number",
            "description":"The duration of the User Task activity. This will be the difference between the endTime and the startTime.",
            "format":"int64"
        },
        "parentTaskId":{
            "type":"string",
            "description":"Where a User Task is related to other tasks, the reference to the owning task is recorded as the parentTaskId."
        },
        "removalTime":{
            "type":"string",
            "description":"The time the historic task instance will be removed.",
            "format":"date"
        },
        "formURL":{
            "type":"string",
            "description":"The reference to the form associated with the task."
        },
        "externalFormUrl":{
            "type":"string",
            "description":"The reference to the external form associated with the task."
        },
        "candidateUsers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditUser"
            }
        },
        "candidateGroups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditGroup"
            }
        },
        "lastAction":{
            "$ref":"#/components/schemas/AuditTaskEvent"
        },
        "expirationDate":{
            "type":"string",
            "description":"expiration Date in 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 : AuditTaskDetail-allOf[3]

Type: object

Show Source

actions: object AuditTaskActions
childTasks: object ChildTasks
historyDetail: array historyDetail

{
    "type":"object",
    "properties":{
        "childTasks":{
            "$ref":"#/components/schemas/ChildTasks"
        },
        "actions":{
            "$ref":"#/components/schemas/AuditTaskActions"
        },
        "historyDetail":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditTaskEvent"
            }
        }
    }
}

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

Type: array

Show Source

Array of: AuditGroup

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

Nested Schema : candidateUsers

Type: array

Show Source

Array of: AuditUser

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

Nested Schema : UserOrAppClient

Match All

Show Source

object IdentityCommon
object Discriminator: type

Discriminator: { "propertyName":"type" }

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

Nested Schema : AuditTaskEvent

Type: object

Show Source

action: string

The action performed by the user.
actionType: string

Allowed Values: [ "SYSTEM_ACTION", "CUSTOM_ACTION" ]

The type of action where the action can come in different forms such as the response to a task. This can be a System action or a Custom action.
candidateGroups: array candidateGroups
candidateUsers: array candidateUsers
comment: string

Reference ID to the comment.
commentText: string

Comment message.
fromUser: string

The source user when an action involves passing responsiblity from one user to another
message: string

Rendered text based on the user, action and comment - for display purposes
outcome: string

The outcome of the task event if the task
performer: string

The user or group responsible for the action
properties: array properties
timestamp: string (date)

The date and time at which the action occurred
toUser: string

The target user when an action involves passing responsibility from one user to another

{
    "type":"object",
    "properties":{
        "performer":{
            "type":"string",
            "description":"The user or group responsible for the action"
        },
        "fromUser":{
            "type":"string",
            "description":"The source user when an action involves passing responsiblity from one user to another"
        },
        "toUser":{
            "type":"string",
            "description":"The target user when an action involves passing responsibility from one user to another"
        },
        "timestamp":{
            "type":"string",
            "description":"The date and time at which the action occurred",
            "format":"date"
        },
        "actionType":{
            "type":"string",
            "description":"The type of action where the action can come in different forms such as the response to a task. This can be a System action or a Custom action.",
            "enum":[
                "SYSTEM_ACTION",
                "CUSTOM_ACTION"
            ]
        },
        "action":{
            "type":"string",
            "description":"The action performed by the user."
        },
        "outcome":{
            "type":"string",
            "description":"The outcome of the task event if the task"
        },
        "message":{
            "type":"string",
            "description":"Rendered text based on the user, action and comment - for display purposes"
        },
        "comment":{
            "type":"string",
            "description":"Reference ID to the comment."
        },
        "commentText":{
            "type":"string",
            "description":"Comment message."
        },
        "candidateUsers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditUser"
            }
        },
        "candidateGroups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditGroup"
            }
        },
        "properties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditEventProperty"
            }
        }
    }
}

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

Match All

Show Source

allOf Identity
object AuditGroup-allOf[1]

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

Nested Schema : AuditGroup-allOf[1]

Type: object

Nested Schema : Discriminator: type

Type: object

{
    "type":"object",
    "discriminator":{
        "propertyName":"type"
    },
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "USER",
                "APPCLIENT"
            ]
        }
    }
}

Show Source

type: string

Allowed Values: [ "USER", "APPCLIENT" ]

{
    "type":"object",
    "discriminator":{
        "propertyName":"type"
    },
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "USER",
                "APPCLIENT"
            ]
        }
    }
}

Nested Schema : candidateGroups

Type: array

Show Source

Array of: AuditGroup

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

Nested Schema : candidateUsers

Type: array

Show Source

Array of: AuditUser

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

Nested Schema : properties

Type: array

Show Source

Array of: object AuditEventProperty

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

Nested Schema : AuditEventProperty

Type: object

Show Source

name: string

The name of the property associated with the user operation
value: object value

The value of the property

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the property associated with the user operation"
        },
        "value":{
            "type":"object",
            "properties":{
            },
            "description":"The value of the property"
        }
    }
}

Nested Schema : value

Type: object

The value of the property

Show Source

{
    "type":"object",
    "properties":{
    },
    "description":"The value of the property"
}

Nested Schema : AuditTaskActions

Type: object

Show Source

custom: array custom
system: array system

{
    "type":"object",
    "properties":{
        "system":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditTaskAction"
            }
        },
        "custom":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditTaskAction"
            }
        }
    }
}

Nested Schema : ChildTasks

Type: object

Show Source

childTasksDetails: array childTasksDetails
totalCount: integer (int32)

The number of total child adhoc tasks

{
    "type":"object",
    "properties":{
        "totalCount":{
            "type":"integer",
            "description":"The number of total child adhoc tasks",
            "format":"int32"
        },
        "childTasksDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ChildTasksDetails"
            }
        }
    }
}

Nested Schema : historyDetail

Type: array

Show Source

Array of: object AuditTaskEvent

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

Nested Schema : custom

Type: array

Show Source

Array of: object AuditTaskAction

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

Nested Schema : system

Type: array

Show Source

Array of: object AuditTaskAction

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

Nested Schema : AuditTaskAction

Type: object

Show Source

actionId: string

The unique identifier for the action.
title: string

The title of the action.

{
    "type":"object",
    "properties":{
        "title":{
            "type":"string",
            "description":"The title of the action."
        },
        "actionId":{
            "type":"string",
            "description":"The unique identifier for the action."
        }
    }
}

Nested Schema : childTasksDetails

Type: array

Show Source

Array of: object ChildTasksDetails

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

Nested Schema : ChildTasksDetails

Type: object

Show Source

links: object AuditChildAdhocTaskLinks

Contains links to the audit of adhoc child task, and to the child adhoc task itself
title: string

Title of the adhoc task.

{
    "type":"object",
    "properties":{
        "title":{
            "type":"string",
            "description":"Title of the adhoc task."
        },
        "links":{
            "$ref":"#/components/schemas/AuditChildAdhocTaskLinks"
        }
    }
}

Nested Schema : AuditChildAdhocTaskLinks

Type: object

Contains links to the audit of adhoc child task, and to the child adhoc task itself

Show Source

href(required): string
taskDetails(required): string

{
    "type":"object",
    "description":"Contains links to the audit of adhoc child task, and to the child adhoc task itself",
    "required":[
        "href",
        "taskDetails"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "taskDetails":{
            "type":"string"
        }
    }
}

Examples

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: Retrieve the history of user task 6789vghjk in a process instance 3456dasds4567d678

The following example shows how to retrieve the history of user task in 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.

In addition to task ID and process nstance ID, you have to provide the accepted language and the OCI original URL details.

curl -X 'GET' \
      'https://<OIC URL>/process/api/v1/audit/instances/3456dasds4567d678/tasks/6789vghjk' \
      -H 'accept: application/json' \   -H 'Accept-Language: English' \   -H 'oci-original-url:
      www.oracle.com'