Get Process Activity Instance
get
/process/api/v1/audit/instances/{instanceId}/activities/{activityInstanceId}
Retrieves the details for a specific activity instance that has been executed as part of a process.
Request
Path Parameters
-
activityInstanceId(required): string
The id that identifies an activity instance.
-
instanceId(required): string
The id that identifies the process.
Header Parameters
-
Accept-Language:
Accept-Language header in IETF BCP 47
-
oci-original-url:
Actual endpoint which customer requested
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : AuditActivityInstance
The information for a process activity
Match All
The information for a process activity
The information for a process activity
Show Source
Nested Schema : AuditActivityInstance-allOf[1]
Type:
Show Source
object
-
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.
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
Nested Schema : ActivityTypeDetail
Type:
Show Source
object
-
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
Nested Schema : AuditAlterFlowDetail
Type:
Show Source
object
-
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.
Nested Schema : CallActivityDetail
Type:
Show Source
object
-
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.
Nested Schema : incidents
Type:
array
The list of incidents i.e. exceptions or errors that have occurred for this activity.
Show Source
Nested Schema : inputPayload
Type:
array
The data object value that is passed into the activity.
Show Source
Nested Schema : MultiInstanceActivity
Type:
Show Source
object
-
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
Nested Schema : MultiInstanceTask
Type:
Show Source
object
-
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
Nested Schema : NotificationTaskDetail
Type:
Show Source
object
-
messageChannel: string
Allowed Values:
[ "EMAIL" ]
The channel by which a notification message can be sent
Nested Schema : outputPayload
Type:
array
The data object value that is at the completion of the activity. For an active activity.
Show Source
Nested Schema : ServiceTaskActivity
Type:
Show Source
object
-
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
Nested Schema : StartEventDetail
Type:
Show Source
object
-
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
Nested Schema : SubProcessTask
Type:
Show Source
object
-
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
Nested Schema : TimerActivityDetail
Type:
Show Source
object
-
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.
Nested Schema : AuditIncident
Type:
Show Source
object
-
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.
Nested Schema : ActivityPayloadInstance
Type:
Show Source
object
-
name: string
The name of the variable used for an activity payload
-
value: string
The value of the data object
Nested Schema : assignees
Type:
array
The list of assignees for the multi-instance task.
Show Source
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
Nested Schema : Identity-allOf[1]
Type:
Show Source
object
-
type: string
Allowed Values:
[ "USER", "GROUP", "ROLE" ]
Nested Schema : MultiInstanceAssignee-allOf[1]
Type:
Show Source
object
-
completed: boolean
A flag to indicate if the task is complete
-
taskId: string
The task identifier to which the user has been assigned
Nested Schema : AuditTask-allOf[1]
Type:
Show Source
object
-
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.
Nested Schema : UserOrAppClient
Match All
Show Source
-
object
IdentityCommon
-
object
Discriminator: type
Discriminator:
{ "propertyName":"type" }
Nested Schema : AuditTaskEvent
Type:
Show Source
object
-
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
Nested Schema : AuditGroup-allOf[1]
Type:
object
Nested Schema : Discriminator: type
Type:
Show Source
object
-
type: string
Allowed Values:
[ "USER", "APPCLIENT" ]
Nested Schema : AuditEventProperty
Type:
Show Source
object
-
name: string
The name of the property associated with the user operation
-
value: object
value
The value of the property
Nested Schema : AuditUser-allOf[1]
Type:
object
Examples
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