REST API for Oracle Cloud Infrastructure Process Automation

List Multi-instance Activity Items

get

/process/api/v1/audit/instances/{instanceId}/activities/{multiInstanceActivityId}/items

Retrieves the list of activities that are the result of a multi-instance activity. These activities can include User Tasks with sequential or parallel approval patterns, in-line subprocesses and any activity that supports looping chacteristics

Request

Path Parameters

instanceId(required): string

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

The id that identifies a multi-instance activity i.e an activity with looping chacteristics

Query Parameters

activityId: array[string]

Restrict the query results to the activity instances that are for the given activity id.
activityName: string

Restrict the result to the activity instances that have the given activity name.
activityNameLike: string

Restrict the result to the activity instances that match the given activity name.
activityType: array[string]
Restrict the result to the activity instances that are of the given activity type.
- Allowed Values: [ "multiInstanceBody", "exclusiveGateway", "inclusiveGateway", "parallelGateway", "complexGateway", "eventBasedGateway", "task", "scriptTask", "serviceTask", "businessRuleTask", "manualTask", "userTask", "sendTask", "receiveTask", "subProcess", "adHocSubProcess", "callActivity", "transaction", "boundaryTimer", "boundaryMessage", "boundarySignal", "compensationBoundaryCatch", "boundaryError", "boundaryEscalation", "cancelBoundaryCatch", "boundaryConditional", "startEvent", "startTimerEvent", "messageStartEvent", "signalStartEvent", "escalationStartEvent", "compensationStartEvent", "errorStartEvent", "conditionalStartEvent", "intermediateCatchEvent", "intermediateMessageCatch", "intermediateTimer", "intermediateLinkCatch", "intermediateSignalCatch", "intermediateConditional", "intermediateThrowEvent", "intermediateSignalThrow", "intermediateCompensationThrowEvent", "intermediateMessageThrowEvent", "intermediateNoneThrowEvent", "intermediateEscalationThrowEvent", "errorEndEvent", "cancelEndEvent", "terminateEndEvent", "messageEndEvent", "signalEndEvent", "compensationEndEvent", "escalationEndEvent", "noneEndEvent" ]
```
[
    "multiInstanceBody",
    "exclusiveGateway",
    "inclusiveGateway",
    "parallelGateway",
    "complexGateway",
    "eventBasedGateway",
    "task",
    "scriptTask",
    "serviceTask",
    "businessRuleTask",
    "manualTask",
    "userTask",
    "sendTask",
    "receiveTask",
    "subProcess",
    "adHocSubProcess",
    "callActivity",
    "transaction",
    "boundaryTimer",
    "boundaryMessage",
    "boundarySignal",
    "compensationBoundaryCatch",
    "boundaryError",
    "boundaryEscalation",
    "cancelBoundaryCatch",
    "boundaryConditional",
    "startEvent",
    "startTimerEvent",
    "messageStartEvent",
    "signalStartEvent",
    "escalationStartEvent",
    "compensationStartEvent",
    "errorStartEvent",
    "conditionalStartEvent",
    "intermediateCatchEvent",
    "intermediateMessageCatch",
    "intermediateTimer",
    "intermediateLinkCatch",
    "intermediateSignalCatch",
    "intermediateConditional",
    "intermediateThrowEvent",
    "intermediateSignalThrow",
    "intermediateCompensationThrowEvent",
    "intermediateMessageThrowEvent",
    "intermediateNoneThrowEvent",
    "intermediateEscalationThrowEvent",
    "errorEndEvent",
    "cancelEndEvent",
    "terminateEndEvent",
    "messageEndEvent",
    "signalEndEvent",
    "compensationEndEvent",
    "escalationEndEvent",
    "noneEndEvent"
]
```
assignee: string

Restrict the result to the user task activity instances that are assigned to the given assinee.
callInstId: string

Restrict the result to the list of activities that have a specific called process instance id.
completedAfter: string

Restrict the result to activity instances that were completed after the given date. The date string must be in the ISO-8601 standard format. Example - 2019-01-23T12:34:56.123456789Z (for UTC), 2019-01-23T12:34:56.123456789+02:30 (with offset).
completedBefore: string

Restrict the result to activity instances that were completed before the given date. The date string must be in the ISO-8601 standard format. Example - 2019-01-23T12:34:56.123456789Z (for UTC), 2019-01-23T12:34:56.123456789+02:30 (with offset).
duration: number(Int64)

Restrict the list of activities to those that have the exact duration.

Default Value: 0
durationGraterThan: number(Int64)

Restrict the list of activities to those that have a duration greater than or equal to the specified vale.

Default Value: 0
durationLessThan: number(Int64)

Restrict the list of activities to those that have a duration less than the specified value.

Default Value: 0
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 query parameter specifies the order by clause. The value must follow the format of fieldName[:(asc/desc)][,fieldName[:(asc/desc)]]*. e.g. activityName:asc. Multiple ordering is not supported. Supported attributes include: activityInstanceId, executionId, activityId, activityName, activityType, startTime, endTime and duration
startedAfter: string

Restrict the result to activity instances that were started after the given date. The date string must be in the ISO-8601 standard format. Example - 2019-01-23T12:34:56.123456789Z (for UTC), 2019-01-23T12:34:56.123456789+02:30 (with offset).
startedBefore: string

Restrict the result to activity instances that were started before the given date. The date string must be in the ISO-8601 standard format. Example - 2019-01-23T12:34:56.123456789Z (for UTC), 2019-01-23T12:34:56.123456789+02:30 (with offset).
taskId: array[string]

Restrict the result to the activity instances that are for the given task id or multiple task ids.
totalResults: boolean

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

Default Value: false

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

Match All

Show Source

object CommonModel
object ListPagination

A common structure for helping a client with pagination
object AuditActivityInstanceWithoutCM

The information for a process activity
object AuditInstanceMultiInstanceItems-allOf[3]

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

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

Type: object

The information for a process activity

Show Source

activated: boolean

The flag to indicate if the dynamic process activity has been activated
activityId: string

The unique identifier of the activity in the process.
activityInstanceState: integer

The state of the activity instance.
activityName: string

The display name for the activity.
activityType: string

The activity type for the activity. Typically the activity type corresponds to XML tag used in the BPMN 2.0 process definition file.
activityTypeDetail: object ActivityTypeDetail
alterFlow: boolean

The flag to indicate if the activity has been subject to an alter flow.
alterFlowDetail: object AuditAlterFlowDetail
assignee: AuditUser
calledProcessInstanceId: string

The process instance ID of the called process when the activity. is a BPMN call activity
canceled: boolean

If true, this activity instance is canceled.
completedTime: string (date)

The time the activity was completed.
completeScope: boolean

If true, this activity instance did complete a Process scope.
draft: boolean

The flag to indicate whether the activity has been implemented or is defined as a draft activity
duration: number (int64)

The difference between endTime and startTime.
executionId: string

Execution reference.
id: string

The unique identifier for the audit activity instance.
parentActivityInstanceId: string

The id of the parent activity instance.
processInstanceId: string

The process instance reference.
sequenceCounter: integer

The execution sequence of the activity.
startTime: string (date)

The time the activity was started.
state: string

The decoded state name of the activity instance.
taskId: string

The task ID when the activity is a task.
title: string

The user given title name for the activity.

{
    "description":"The information for a  process activity",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier for the audit activity instance."
        },
        "parentActivityInstanceId":{
            "type":"string",
            "description":"The id of the parent activity instance."
        },
        "processInstanceId":{
            "type":"string",
            "description":"The process instance reference."
        },
        "executionId":{
            "type":"string",
            "description":"Execution reference."
        },
        "activityId":{
            "type":"string",
            "description":"The unique identifier of the activity in the process."
        },
        "taskId":{
            "type":"string",
            "description":"The task ID when the activity is a task."
        },
        "calledProcessInstanceId":{
            "type":"string",
            "description":"The process instance ID of the called process when the activity. is a BPMN call activity"
        },
        "activityName":{
            "type":"string",
            "description":"The display name for the activity."
        },
        "title":{
            "type":"string",
            "description":"The user given title name for the activity."
        },
        "activityType":{
            "type":"string",
            "description":"The activity type for the activity.\nTypically the activity type corresponds to XML tag used in the BPMN 2.0 process definition file."
        },
        "assignee":{
            "$ref":"#/components/schemas/AuditUser"
        },
        "startTime":{
            "type":"string",
            "description":"The time the activity was started.",
            "format":"date"
        },
        "completedTime":{
            "type":"string",
            "description":"The time the activity was completed.",
            "format":"date"
        },
        "duration":{
            "type":"number",
            "description":"The difference between endTime and startTime.",
            "format":"int64"
        },
        "activityInstanceState":{
            "type":"integer",
            "description":"The state of the activity instance."
        },
        "state":{
            "type":"string",
            "description":"The decoded state name of the activity instance."
        },
        "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."
        },
        "sequenceCounter":{
            "type":"integer",
            "description":"The execution sequence of the activity."
        },
        "draft":{
            "type":"boolean",
            "description":"The flag to indicate whether the activity has been implemented or is defined as a draft activity"
        },
        "activated":{
            "type":"boolean",
            "description":"The flag to indicate if the dynamic process activity has been activated"
        },
        "alterFlow":{
            "type":"boolean",
            "description":"The flag to indicate if the activity has been subject to an alter flow."
        },
        "alterFlowDetail":{
            "$ref":"#/components/schemas/AuditAlterFlowDetail"
        },
        "activityTypeDetail":{
            "$ref":"#/components/schemas/ActivityTypeDetail"
        }
    }
}

Nested Schema : AuditInstanceMultiInstanceItems-allOf[3]

Type: object

Show Source

items: array items

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

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

Type: object

Show Source

callActivityDetail: object CallActivityDetail
incidents: array incidents

The list of incidents i.e. exceptions or errors that have occurred for this activity.
inputPayload: array inputPayload

The data object value that is passed into the activity.
multiInstanceActivityDetail: object MultiInstanceActivity
multiInstanceTaskDetail: object MultiInstanceTask
notificationTaskDetail: object NotificationTaskDetail
outputPayload: array outputPayload

The data object value that is at the completion of the activity. For an active activity.
serviceTaskDetail: object ServiceTaskActivity
startEventDetail: object StartEventDetail
subProcessTaskDetail: object SubProcessTask
timerActivityDetail: object TimerActivityDetail
userTaskDetail: AuditTask

{
    "type":"object",
    "properties":{
        "inputPayload":{
            "type":"array",
            "description":"The data object value that is passed into the activity.",
            "items":{
                "$ref":"#/components/schemas/ActivityPayloadInstance"
            }
        },
        "outputPayload":{
            "type":"array",
            "description":"The data object value that is at the completion of the activity. For an active activity.",
            "items":{
                "$ref":"#/components/schemas/ActivityPayloadInstance"
            }
        },
        "incidents":{
            "type":"array",
            "description":"The list of incidents i.e. exceptions or errors that have occurred for this activity.",
            "items":{
                "$ref":"#/components/schemas/AuditIncident"
            }
        },
        "userTaskDetail":{
            "$ref":"#/components/schemas/AuditTask"
        },
        "multiInstanceTaskDetail":{
            "$ref":"#/components/schemas/MultiInstanceTask"
        },
        "multiInstanceActivityDetail":{
            "$ref":"#/components/schemas/MultiInstanceActivity"
        },
        "subProcessTaskDetail":{
            "$ref":"#/components/schemas/SubProcessTask"
        },
        "serviceTaskDetail":{
            "$ref":"#/components/schemas/ServiceTaskActivity"
        },
        "startEventDetail":{
            "$ref":"#/components/schemas/StartEventDetail"
        },
        "notificationTaskDetail":{
            "$ref":"#/components/schemas/NotificationTaskDetail"
        },
        "callActivityDetail":{
            "$ref":"#/components/schemas/CallActivityDetail"
        },
        "timerActivityDetail":{
            "$ref":"#/components/schemas/TimerActivityDetail"
        }
    }
}

Nested Schema : AuditAlterFlowDetail

Type: object

Show Source

activityName: string

The name of the target activity
activityType: string

The type of activity
alteredBy: AuditUser
comment: string

The comment recorded during the alter flow
targetActivityId: string

The activity ID of the target activity
timestamp: string (date)

The time stamp as to when the alter flow occurred.

{
    "type":"object",
    "properties":{
        "targetActivityId":{
            "type":"string",
            "description":"The activity ID of the target activity"
        },
        "activityName":{
            "type":"string",
            "description":"The name of the target activity"
        },
        "activityType":{
            "type":"string",
            "description":"The type of activity"
        },
        "comment":{
            "type":"string",
            "description":"The comment recorded during the alter flow"
        },
        "alteredBy":{
            "$ref":"#/components/schemas/AuditUser"
        },
        "timestamp":{
            "type":"string",
            "format":"date",
            "description":"The time stamp as to when the alter flow occurred."
        }
    }
}

Nested Schema : AuditUser

Match All

Show Source

allOf Identity
object AuditUser-allOf[1]

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

Nested Schema : CallActivityDetail

Type: object

Show Source

calledDpInstanceId: string

The unique identifier of the called dynamic process instance.
calledProcessInstanceId: string

The unique identifier of the called structured process instance.
href: string

The URL to request the audit detail information for the called process instance.

{
    "type":"object",
    "properties":{
        "calledProcessInstanceId":{
            "type":"string",
            "description":"The unique identifier of the called structured process instance."
        },
        "calledDpInstanceId":{
            "type":"string",
            "description":"The unique identifier of the called dynamic process instance."
        },
        "href":{
            "type":"string",
            "description":"The URL to request the audit detail information for the called process instance."
        }
    }
}

Nested Schema : incidents

Type: array

The list of incidents i.e. exceptions or errors that have occurred for this activity.

Show Source

Array of: object AuditIncident

{
    "type":"array",
    "description":"The list of incidents i.e. exceptions or errors that have occurred for this activity.",
    "items":{
        "$ref":"#/components/schemas/AuditIncident"
    }
}

Nested Schema : inputPayload

Type: array

The data object value that is passed into the activity.

Show Source

Array of: object ActivityPayloadInstance

{
    "type":"array",
    "description":"The data object value that is passed into the activity.",
    "items":{
        "$ref":"#/components/schemas/ActivityPayloadInstance"
    }
}

Nested Schema : MultiInstanceActivity

Type: object

Show Source

activityName: string

The name for the multi instance task - taken from the User Task
completedInstanceCount: integer (int64)

The number of sub-activities of a multi-instance task that have been completed
instanceCount: integer (int64)

The number of instances for a multi-instance task
multiInstanceType: string

Allowed Values: [ "NONE", "PARALLEL", "SEQUENTIAL", "STAGE" ]

Indicates what type of multi-instance activity

{
    "type":"object",
    "properties":{
        "activityName":{
            "type":"string",
            "description":"The name for the multi instance task - taken from the User Task"
        },
        "instanceCount":{
            "type":"integer",
            "description":"The number of instances for a multi-instance task",
            "format":"int64"
        },
        "completedInstanceCount":{
            "type":"integer",
            "description":"The number of sub-activities of a multi-instance task that have been completed",
            "format":"int64"
        },
        "multiInstanceType":{
            "type":"string",
            "description":"Indicates what type of multi-instance activity",
            "enum":[
                "NONE",
                "PARALLEL",
                "SEQUENTIAL",
                "STAGE"
            ]
        }
    }
}

Nested Schema : MultiInstanceTask

Type: object

Show Source

activityName: string

The name for the multi instance task - taken from the User Task
approvalPattern: string

Allowed Values: [ "SINGLE", "SEQUENTIAL", "PARALLEL", "MANAGEMENT_CHAIN" ]

The approval pattern for the user task.
assignees: array assignees

The list of assignees for the multi-instance task.
completedInstanceCount: integer (int64)

The number of sub-activities of a multi-instance task that have been completed
finalOutcome: string

The final outcome of the multi-instance task
initialAssignees: array initialAssignees

The initial list of assignees. This can vary from the assignees list during the life of a task
instanceCount: integer (int64)

The number of instances for a multi-instance task
multiInstanceType: string

Allowed Values: [ "NONE", "PARALLEL", "SEQUENTIAL" ]

Indicates type of multi-instance activity
outcomeDerivation: string

The derivation on the outcome for the multi-instance task

{
    "type":"object",
    "properties":{
        "activityName":{
            "type":"string",
            "description":"The name for the multi instance task - taken from the User Task"
        },
        "instanceCount":{
            "type":"integer",
            "description":"The number of instances for a multi-instance task",
            "format":"int64"
        },
        "completedInstanceCount":{
            "type":"integer",
            "description":"The number of sub-activities of a multi-instance task that have been completed",
            "format":"int64"
        },
        "multiInstanceType":{
            "type":"string",
            "description":"Indicates type of multi-instance activity",
            "enum":[
                "NONE",
                "PARALLEL",
                "SEQUENTIAL"
            ]
        },
        "approvalPattern":{
            "type":"string",
            "description":"The approval pattern for the user task.",
            "enum":[
                "SINGLE",
                "SEQUENTIAL",
                "PARALLEL",
                "MANAGEMENT_CHAIN"
            ]
        },
        "finalOutcome":{
            "type":"string",
            "description":"The final outcome of the multi-instance task"
        },
        "outcomeDerivation":{
            "type":"string",
            "description":"The derivation on the outcome for the multi-instance task"
        },
        "initialAssignees":{
            "type":"array",
            "description":"The initial list of assignees. This can vary from the assignees list during the life of a task",
            "items":{
                "$ref":"#/components/schemas/Identity"
            }
        },
        "assignees":{
            "type":"array",
            "description":"The list of assignees for the multi-instance task.",
            "items":{
                "$ref":"#/components/schemas/MultiInstanceAssignee"
            }
        }
    }
}

Nested Schema : NotificationTaskDetail

Type: object

Show Source

messageChannel: string

Allowed Values: [ "EMAIL" ]

The channel by which a notification message can be sent

{
    "type":"object",
    "properties":{
        "messageChannel":{
            "type":"string",
            "description":"The channel by which a notification message can be sent",
            "enum":[
                "EMAIL"
            ]
        }
    }
}

Nested Schema : outputPayload

Type: array

The data object value that is at the completion of the activity. For an active activity.

Show Source

Array of: object ActivityPayloadInstance

{
    "type":"array",
    "description":"The data object value that is at the completion of the activity. For an active activity.",
    "items":{
        "$ref":"#/components/schemas/ActivityPayloadInstance"
    }
}

Nested Schema : ServiceTaskActivity

Type: object

Show Source

connectorRef: string

The reference to the connector for the service task
operation: string

The operation called for the service task
requestResponseDetailsRef: string

The reference to the Request and Response Details API end point.
status: string

Allowed Values: [ "Success", "Failed" ]

Status of the Service Task Invocation

{
    "type":"object",
    "properties":{
        "connectorRef":{
            "type":"string",
            "description":"The reference to the connector for the service task"
        },
        "operation":{
            "type":"string",
            "description":"The operation called for the service task"
        },
        "requestResponseDetailsRef":{
            "type":"string",
            "description":"The reference to the Request and Response Details API end point."
        },
        "status":{
            "type":"string",
            "description":"Status of the Service Task Invocation",
            "enum":[
                "Success",
                "Failed"
            ]
        }
    }
}

Nested Schema : StartEventDetail

Type: object

Show Source

implementation: string

Allowed Values: [ "NONE_START", "FORM_START", "MESSAGE_START", "ERROR_START" ]

The type of start activity is shown here i.e. NONE_START, FORM_START or MESSAGE_START

{
    "type":"object",
    "properties":{
        "implementation":{
            "type":"string",
            "description":"The type of start activity is shown here i.e. NONE_START, FORM_START or MESSAGE_START",
            "enum":[
                "NONE_START",
                "FORM_START",
                "MESSAGE_START",
                "ERROR_START"
            ]
        }
    }
}

Nested Schema : SubProcessTask

Type: object

Show Source

activityName: string

The name for the multi instance task - taken from the User Task
implementation: string

Allowed Values: [ "DEFAULT", "ERROR_SUBPROCESS" ]

The type of subprocess activity is shown here i.e., DEFAULT or ERROR_SUBPROCESS

{
    "type":"object",
    "properties":{
        "activityName":{
            "type":"string",
            "description":"The name for the multi instance task - taken from the User Task"
        },
        "implementation":{
            "type":"string",
            "description":"The type of subprocess activity is shown here i.e., DEFAULT or ERROR_SUBPROCESS",
            "enum":[
                "DEFAULT",
                "ERROR_SUBPROCESS"
            ]
        }
    }
}

Nested Schema : TimerActivityDetail

Type: object

Show Source

retryCount: integer

The number of times the timer activity has encountered a problem and has been retried
timerDueDate: string (date)

The due date for the time.
timerType: string

Shows the type of timer that was implemented i.e. Date, Duration, Cycle etc.

{
    "type":"object",
    "properties":{
        "timerType":{
            "type":"string",
            "description":"Shows the type of timer that was implemented i.e. Date, Duration, Cycle etc."
        },
        "timerDueDate":{
            "type":"string",
            "description":"The due date for the time.",
            "format":"date"
        },
        "retryCount":{
            "type":"integer",
            "description":"The number of times the timer activity has encountered a problem and has been retried"
        }
    }
}

Nested Schema : AuditTask

Match All

Show Source

object CommonModel
object AuditTask-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "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 : AuditIncident

Type: object

Show Source

activityName: string

The display name of the activity for which the incident is created.
createdTime: string (date)

The date and time of incident creation.Has the format yyyy-MM-dd'T'HH:mm:ss.
exceptionTrace: string

The stack trace of the exception corresponding to this incident..
executionId: string

The ID of the execution that created this incident.
id: string

The ID of the incident.
incidentMessage: string

The message of the exception corresponding to this incident.
incidentType: string

Type of the incident.
jobDefinition: string

The jobDefinitionId corresponding to the incident.
processDefinitionId: string

The ID of the process definition that this incident belongs to.
processInstanceId: string

The ID of the process instance that this incident belongs to.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the incident."
        },
        "incidentType":{
            "type":"string",
            "description":"Type of the incident."
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time of incident creation.Has the format yyyy-MM-dd'T'HH:mm:ss.",
            "format":"date"
        },
        "jobDefinition":{
            "type":"string",
            "description":"The jobDefinitionId corresponding to the incident."
        },
        "processDefinitionId":{
            "type":"string",
            "description":"The ID of the process definition that this incident belongs to."
        },
        "processInstanceId":{
            "type":"string",
            "description":"The ID of the process instance that this incident belongs to."
        },
        "executionId":{
            "type":"string",
            "description":"The ID of the execution that created this incident."
        },
        "incidentMessage":{
            "type":"string",
            "description":"The message of the exception corresponding to this incident."
        },
        "exceptionTrace":{
            "type":"string",
            "description":"The stack trace of the exception corresponding to this incident.."
        },
        "activityName":{
            "type":"string",
            "description":"The display name of the activity for which the incident is created."
        }
    }
}

Nested Schema : ActivityPayloadInstance

Type: object

Show Source

name: string

The name of the variable used for an activity payload
value: string

The value of the data object

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the variable used for an activity payload"
        },
        "value":{
            "type":"string",
            "description":"The value of the data object"
        }
    }
}

Nested Schema : assignees

Type: array

The list of assignees for the multi-instance task.

Show Source

Array of: MultiInstanceAssignee

{
    "type":"array",
    "description":"The list of assignees for the multi-instance task.",
    "items":{
        "$ref":"#/components/schemas/MultiInstanceAssignee"
    }
}

Nested Schema : initialAssignees

Type: array

The initial list of assignees. This can vary from the assignees list during the life of a task

Show Source

Array of: Identity

{
    "type":"array",
    "description":"The initial list of assignees. This can vary from the assignees list during the life of a task",
    "items":{
        "$ref":"#/components/schemas/Identity"
    }
}

Nested Schema : MultiInstanceAssignee

Match All

Show Source

allOf Identity
object MultiInstanceAssignee-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Identity"
        },
        {
            "type":"object",
            "properties":{
                "taskId":{
                    "type":"string",
                    "description":"The task identifier to which the user has been assigned"
                },
                "completed":{
                    "type":"boolean",
                    "description":"A flag to indicate if the task is complete"
                }
            }
        }
    ]
}

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 : MultiInstanceAssignee-allOf[1]

Type: object

Show Source

completed: boolean

A flag to indicate if the task is complete
taskId: string

The task identifier to which the user has been assigned

{
    "type":"object",
    "properties":{
        "taskId":{
            "type":"string",
            "description":"The task identifier to which the user has been assigned"
        },
        "completed":{
            "type":"boolean",
            "description":"A flag to indicate if the task is complete"
        }
    }
}

Nested Schema : AuditTask-allOf[1]

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 : 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 : 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 : AuditUser-allOf[1]

Type: object

Nested Schema : items

Type: array

Show Source

Array of: AuditActivityInstance

The information for a process activity

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

Nested Schema : AuditActivityInstance

The information for a process activity

Match All

The information for a process activity

Show Source

object CommonModel
object AuditActivityInstance-allOf[1]

{
    "description":"The information for a  process activity",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The unique identifier for the audit activity instance."
                },
                "parentActivityInstanceId":{
                    "type":"string",
                    "description":"The ID of the parent activity instance."
                },
                "processInstanceId":{
                    "type":"string",
                    "description":"The process instance reference."
                },
                "executionId":{
                    "type":"string",
                    "description":"Execution reference."
                },
                "activityId":{
                    "type":"string",
                    "description":"The unique identifier of the activity in the process."
                },
                "taskId":{
                    "type":"string",
                    "description":"The task ID when the activity is a task."
                },
                "calledProcessInstanceId":{
                    "type":"string",
                    "description":"The process instance ID of the called process when the activity. is a BPMN call activity"
                },
                "activityName":{
                    "type":"string",
                    "description":"The display name for the activity."
                },
                "title":{
                    "type":"string",
                    "description":"The user given title name for the activity."
                },
                "activityType":{
                    "type":"string",
                    "description":"The activity type for the activity.\nTypically the activity type corresponds to XML tag used in the BPMN 2.0 process definition file."
                },
                "assignee":{
                    "$ref":"#/components/schemas/AuditUser"
                },
                "startTime":{
                    "type":"string",
                    "description":"The time the activity was started.",
                    "format":"date"
                },
                "completedTime":{
                    "type":"string",
                    "description":"The time the activity was completed.",
                    "format":"date"
                },
                "duration":{
                    "type":"number",
                    "description":"The difference between endTime and startTime.",
                    "format":"int64"
                },
                "activityInstanceState":{
                    "type":"integer",
                    "description":"The state of the activity instance."
                },
                "state":{
                    "type":"string",
                    "description":"The decoded state name of the activity instance."
                },
                "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."
                },
                "sequenceCounter":{
                    "type":"integer",
                    "description":"The execution sequence of the activity."
                },
                "draft":{
                    "type":"boolean",
                    "description":"The flag to indicate whether the activity has been implemented or is defined as a draft activity"
                },
                "activated":{
                    "type":"boolean",
                    "description":"The flag to indicate if the dynamic process activity has been activated"
                },
                "alterFlow":{
                    "type":"boolean",
                    "description":"The flag to indicate if the activity has been subject to an alter flow."
                },
                "alterFlowDetail":{
                    "$ref":"#/components/schemas/AuditAlterFlowDetail"
                },
                "activityTypeDetail":{
                    "$ref":"#/components/schemas/ActivityTypeDetail"
                }
            }
        }
    ]
}

Nested Schema : AuditActivityInstance-allOf[1]

Type: object

Show Source

activated: boolean

The flag to indicate if the dynamic process activity has been activated
activityId: string

The unique identifier of the activity in the process.
activityInstanceState: integer

The state of the activity instance.
activityName: string

The display name for the activity.
activityType: string

The activity type for the activity. Typically the activity type corresponds to XML tag used in the BPMN 2.0 process definition file.
activityTypeDetail: object ActivityTypeDetail
alterFlow: boolean

The flag to indicate if the activity has been subject to an alter flow.
alterFlowDetail: object AuditAlterFlowDetail
assignee: AuditUser
calledProcessInstanceId: string

The process instance ID of the called process when the activity. is a BPMN call activity
canceled: boolean

If true, this activity instance is canceled.
completedTime: string (date)

The time the activity was completed.
completeScope: boolean

If true, this activity instance did complete a Process scope.
draft: boolean

The flag to indicate whether the activity has been implemented or is defined as a draft activity
duration: number (int64)

The difference between endTime and startTime.
executionId: string

Execution reference.
id: string

The unique identifier for the audit activity instance.
parentActivityInstanceId: string

The ID of the parent activity instance.
processInstanceId: string

The process instance reference.
sequenceCounter: integer

The execution sequence of the activity.
startTime: string (date)

The time the activity was started.
state: string

The decoded state name of the activity instance.
taskId: string

The task ID when the activity is a task.
title: string

The user given title name for the activity.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier for the audit activity instance."
        },
        "parentActivityInstanceId":{
            "type":"string",
            "description":"The ID of the parent activity instance."
        },
        "processInstanceId":{
            "type":"string",
            "description":"The process instance reference."
        },
        "executionId":{
            "type":"string",
            "description":"Execution reference."
        },
        "activityId":{
            "type":"string",
            "description":"The unique identifier of the activity in the process."
        },
        "taskId":{
            "type":"string",
            "description":"The task ID when the activity is a task."
        },
        "calledProcessInstanceId":{
            "type":"string",
            "description":"The process instance ID of the called process when the activity. is a BPMN call activity"
        },
        "activityName":{
            "type":"string",
            "description":"The display name for the activity."
        },
        "title":{
            "type":"string",
            "description":"The user given title name for the activity."
        },
        "activityType":{
            "type":"string",
            "description":"The activity type for the activity.\nTypically the activity type corresponds to XML tag used in the BPMN 2.0 process definition file."
        },
        "assignee":{
            "$ref":"#/components/schemas/AuditUser"
        },
        "startTime":{
            "type":"string",
            "description":"The time the activity was started.",
            "format":"date"
        },
        "completedTime":{
            "type":"string",
            "description":"The time the activity was completed.",
            "format":"date"
        },
        "duration":{
            "type":"number",
            "description":"The difference between endTime and startTime.",
            "format":"int64"
        },
        "activityInstanceState":{
            "type":"integer",
            "description":"The state of the activity instance."
        },
        "state":{
            "type":"string",
            "description":"The decoded state name of the activity instance."
        },
        "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."
        },
        "sequenceCounter":{
            "type":"integer",
            "description":"The execution sequence of the activity."
        },
        "draft":{
            "type":"boolean",
            "description":"The flag to indicate whether the activity has been implemented or is defined as a draft activity"
        },
        "activated":{
            "type":"boolean",
            "description":"The flag to indicate if the dynamic process activity has been activated"
        },
        "alterFlow":{
            "type":"boolean",
            "description":"The flag to indicate if the activity has been subject to an alter flow."
        },
        "alterFlowDetail":{
            "$ref":"#/components/schemas/AuditAlterFlowDetail"
        },
        "activityTypeDetail":{
            "$ref":"#/components/schemas/ActivityTypeDetail"
        }
    }
}

401 Response

Unauthorized

404 Response

The Activity with the given IDs 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 activities of a process instance

The following example shows how to retrieve the list of activities that are the result of a multi-instance activity 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 list of activities that resulted from multi-instance ID 3fa85f64-5717-4562-b3fc-2c963f66afa6 and multiInstanceActivityId 123456-fghj-5678-mk8k-34jgjf977439s1 in ascending order and started before 2024-01-23T12:34:56.

curl -X 'GET' \
      'https://<OIC URL>/process/api/v1/audit/instances/3fa85f64-5717-4562-b3fc-2c963f66afa6/activities/123456-fghj-5678-mk8k-34jgjf977439s1/items?startedBefore=2024-01-23T12%3A34%3A56&duration=10&durationLessThan=0&durationGraterThan=0&orderBy=asc&offset=0&limit=25&totalResults=false'
      \   -H 'accept: application/json'

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
    }
  ],
  "totalResults": 0,
  "offset": 0,
  "limit": 0,
  "count": 0,
  "id": "string",
  "parentActivityInstanceId": "string",
  "processInstanceId": "string",
  "executionId": "string",
  "activityId": "string",
  "taskId": "string",
  "calledProcessInstanceId": "string",
  "activityName": "string",
  "title": "string",
  "activityType": "string",
  "assignee": {
    "id": "string",
    "name": "string",
    "displayName": "string",
    "type": "USER"
  },
  "startTime": "2024-08-12",
  "completedTime": "2024-08-12",
  "duration": 0,
  "activityInstanceState": 0,
  "state": "string",
  "canceled": true,
  "completeScope": true,
  "sequenceCounter": 0,
  "draft": true,
  "activated": true,
  "alterFlow": true,
  "alterFlowDetail": {
    "targetActivityId": "string",
    "activityName": "string",
    "activityType": "string",
    "comment": "string",
    "alteredBy": {
      "id": "string",
      "name": "string",
      "displayName": "string",
      "type": "USER"
    },
    "timestamp": "2024-08-12"
  },
  "activityTypeDetail": {
    "inputPayload": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "outputPayload": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "incidents": [
      {
        "id": "string",
        "incidentType": "string",
        "createdTime": "2024-08-12",
        "jobDefinition": "string",
        "processDefinitionId": "string",
        "processInstanceId": "string",
        "executionId": "string",
        "incidentMessage": "string",
        "exceptionTrace": "string",
        "activityName": "string"
      }
    ],
    "userTaskDetail": {
      "links": [
        {
          "href": "string",
          "hreflang": "string",
          "length": 0,
          "rel": "string",
          "title": "string",
          "type": "string",
          "mediaType": "string",
          "message": "string",
          "code": 600
        }
      ],
      "taskId": "string",
      "title": "string",
      "description": "string",
      "isAdhoc": true,
      "priority": 1,
      "state": "ASSIGNED",
      "assignee": {
        "id": "string",
        "name": "string",
        "displayName": "string",
        "type": "USER"
      },
      "outcome": "string",
      "fromUser": "string",
      "createdBy": {
        "id": "string",
        "name": "string",
        "displayName": "string",
        "type": "USER"
      },
      "createdDate": "2024-08-12",
      "dueDate": "2024-08-12",
      "lastUpdatedDate": "2024-08-12",
      "completedDate": "2024-08-12",
      "assignedDate": "2024-08-12",
      "processName": "string",
      "applicationName": "string",
      "activityInstanceId": "string",
      "processInstanceId": "string",
      "processDefinitionId": "string",
      "processExecutionId": "string",
      "rootProcessId": "string",
      "dpName": "string",
      "dpInstanceId": "string",
      "dpDefinitionId": "string",
      "dpExecutionId": "string",
      "startTime": "2024-08-12",
      "endTime": "2024-08-12",
      "duration": 0,
      "parentTaskId": "string",
      "removalTime": "2024-08-12",
      "formURL": "string",
      "externalFormUrl": "string",
      "candidateUsers": [
        {
          "id": "string",
          "name": "string",
          "displayName": "string",
          "type": "USER"
        }
      ],
      "candidateGroups": [
        {
          "id": "string",
          "name": "string",
          "displayName": "string",
          "type": "USER"
        }
      ],
      "lastAction": {
        "performer": "string",
        "fromUser": "string",
        "toUser": "string",
        "timestamp": "2024-08-12",
        "actionType": "SYSTEM_ACTION",
        "action": "string",
        "outcome": "string",
        "message": "string",
        "comment": "string",
        "candidateUsers": [
          {
            "id": "string",
            "name": "string",
            "displayName": "string",
            "type": "USER"
          }
        ],
        "candidateGroups": [
          {
            "id": "string",
            "name": "string",
            "displayName": "string",
            "type": "USER"
          }
        ],
        "properties": [
          {
            "name": "string",
            "value": {}
          }
        ]
      },
      "expirationDate": "2024-08-12"
    },
    "multiInstanceTaskDetail": {
      "activityName": "string",
      "instanceCount": 0,
      "completedInstanceCount": 0,
      "multiInstanceType": "NONE",
      "approvalPattern": "SINGLE",
      "finalOutcome": "string",
      "outcomeDerivation": "string",
      "initialAssignees": [
        {
          "id": "string",
          "name": "string",
          "displayName": "string",
          "type": "USER"
        }
      ],
      "assignees": [
        {
          "id": "string",
          "name": "string",
          "displayName": "string",
          "type": "USER",
          "taskId": "string",
          "completed": true
        }
      ]
    },
    "multiInstanceActivityDetail": {
      "activityName": "string",
      "instanceCount": 0,
      "completedInstanceCount": 0,
      "multiInstanceType": "NONE"
    },
    "subProcessTaskDetail": {
      "activityName": "string",
      "implementation": "DEFAULT"
    },
    "serviceTaskDetail": {
      "connectorRef": "string",
      "operation": "string",
      "requestResponseDetailsRef": "string",
      "status": "Success"
    },
    "startEventDetail": {
      "implementation": "NONE_START"
    },
    "notificationTaskDetail": {
      "messageChannel": "EMAIL"
    },
    "callActivityDetail": {
      "calledProcessInstanceId": "string",
      "calledDpInstanceId": "string",
      "href": "string"
    },
    "timerActivityDetail": {
      "timerType": "string",
      "timerDueDate": "2024-08-12",
      "retryCount": 0
    }
  },
  "items": [
    {
      "links": [
        {
          "href": "string",
          "hreflang": "string",
          "length": 0,
          "rel": "string",
          "title": "string",
          "type": "string",
          "mediaType": "string",
          "message": "string",
          "code": 600
        }
      ],
      "id": "string",
      "parentActivityInstanceId": "string",
      "processInstanceId": "string",
      "executionId": "string",
      "activityId": "string",
      "taskId": "string",
      "calledProcessInstanceId": "string",
      "activityName": "string",
      "title": "string",
      "activityType": "string",
      "assignee": {
        "id": "string",
        "name": "string",
        "displayName": "string",
        "type": "USER"
      },
      "startTime": "2024-08-12",
      "completedTime": "2024-08-12",
      "duration": 0,
      "activityInstanceState": 0,
      "state": "string",
      "canceled": true,
      "completeScope": true,
      "sequenceCounter": 0,
      "draft": true,
      "activated": true,
      "alterFlow": true,
      "alterFlowDetail": {
        "targetActivityId": "string",
        "activityName": "string",
        "activityType": "string",
        "comment": "string",
        "alteredBy": {
          "id": "string",
          "name": "string",
          "displayName": "string",
          "type": "USER"
        },
        "timestamp": "2024-08-12"
      },
      "activityTypeDetail": {
        "inputPayload": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "outputPayload": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "incidents": [
          {
            "id": "string",
            "incidentType": "string",
            "createdTime": "2024-08-12",
            "jobDefinition": "string",
            "processDefinitionId": "string",
            "processInstanceId": "string",
            "executionId": "string",
            "incidentMessage": "string",
            "exceptionTrace": "string",
            "activityName": "string"
          }
        ],
        "userTaskDetail": {
          "links": [
            {
              "href": "string",
              "hreflang": "string",
              "length": 0,
              "rel": "string",
              "title": "string",
              "type": "string",
              "mediaType": "string",
              "message": "string",
              "code": 600
            }
          ],
          "taskId": "string",
          "title": "string",
          "description": "string",
          "isAdhoc": true,
          "priority": 1,
          "state": "ASSIGNED",
          "assignee": {
            "id": "string",
            "name": "string",
            "displayName": "string",
            "type": "USER"
          },
          "outcome": "string",
          "fromUser": "string",
          "createdBy": {
            "id": "string",
            "name": "string",
            "displayName": "string",
            "type": "USER"
          },
          "createdDate": "2024-08-12",
          "dueDate": "2024-08-12",
          "lastUpdatedDate": "2024-08-12",
          "completedDate": "2024-08-12",
          "assignedDate": "2024-08-12",
          "processName": "string",
          "applicationName": "string",
          "activityInstanceId": "string",
          "processInstanceId": "string",
          "processDefinitionId": "string",
          "processExecutionId": "string",
          "rootProcessId": "string",
          "dpName": "string",
          "dpInstanceId": "string",
          "dpDefinitionId": "string",
          "dpExecutionId": "string",
          "startTime": "2024-08-12",
          "endTime": "2024-08-12",
          "duration": 0,
          "parentTaskId": "string",
          "removalTime": "2024-08-12",
          "formURL": "string",
          "externalFormUrl": "string",
          "candidateUsers": [
            {
              "id": "string",
              "name": "string",
              "displayName": "string",
              "type": "USER"
            }
          ],
          "candidateGroups": [
            {
              "id": "string",
              "name": "string",
              "displayName": "string",
              "type": "USER"
            }
          ],
          "lastAction": {
            "performer": "string",
            "fromUser": "string",
            "toUser": "string",
            "timestamp": "2024-08-12",
            "actionType": "SYSTEM_ACTION",
            "action": "string",
            "outcome": "string",
            "message": "string",
            "comment": "string",
            "candidateUsers": [
              {
                "id": "string",
                "name": "string",
                "displayName": "string",
                "type": "USER"
              }
            ],
            "candidateGroups": [
              {
                "id": "string",
                "name": "string",
                "displayName": "string",
                "type": "USER"
              }
            ],
            "properties": [
              {
                "name": "string",
                "value": {}
              }
            ]
          },
          "expirationDate": "2024-08-12"
        },
        "multiInstanceTaskDetail": {
          "activityName": "string",
          "instanceCount": 0,
          "completedInstanceCount": 0,
          "multiInstanceType": "NONE",
          "approvalPattern": "SINGLE",
          "finalOutcome": "string",
          "outcomeDerivation": "string",
          "initialAssignees": [
            {
              "id": "string",
              "name": "string",
              "displayName": "string",
              "type": "USER"
            }
          ],
          "assignees": [
            {
              "id": "string",
              "name": "string",
              "displayName": "string",
              "type": "USER",
              "taskId": "string",
              "completed": true
            }
          ]
        },
        "multiInstanceActivityDetail": {
          "activityName": "string",
          "instanceCount": 0,
          "completedInstanceCount": 0,
          "multiInstanceType": "NONE"
        },
        "subProcessTaskDetail": {
          "activityName": "string",
          "implementation": "DEFAULT"
        },
        "serviceTaskDetail": {
          "connectorRef": "string",
          "operation": "string",
          "requestResponseDetailsRef": "string",
          "status": "Success"
        },
        "startEventDetail": {
          "implementation": "NONE_START"
        },
        "notificationTaskDetail": {
          "messageChannel": "EMAIL"
        },
        "callActivityDetail": {
          "calledProcessInstanceId": "string",
          "calledDpInstanceId": "string",
          "href": "string"
        },
        "timerActivityDetail": {
          "timerType": "string",
          "timerDueDate": "2024-08-12",
          "retryCount": 0
        }
      }
    }
  ]
}