1. REST API for Oracle Cloud Infrastructure Process Automation
  2. Tasks
  3. Audit
  4. Instances
  5. Activities

List Process Activity Instances

get

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

Returns the completed and active activity instances for a process.

Request

Path Parameters
Query Parameters
  • Restrict the result to the activity instances that are for the given activity id or multiple activity ids.
  • Restrict the result to the activity instances that have the given activity name.
  • Restrict the result to the activity instances that match the given activity name.
  • 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" ]
  • Restrict the result to the user task activity instances that are assigned to the given assignee.
  • Restrict the result to the list of activities that have a specific called process instance id.
  • 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).
  • 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).
  • Restrict the list of activities to those that have the exact duration.
    Default Value: 0
  • Restrict the list of activities to those that have a duration greater than or equal to the specified vale.
    Default Value: 0
  • Restrict the list of activities to those that have a duration less than the specified value.
    Default Value: 0
  • 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
  • 0 based index. The number of items to skip before starting to collect the result set.
    Default Value: 0
  • This 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
  • Restrict the result to the list of activities with a specific parent activity instance id.
  • 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).
  • 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).
  • Restrict the result to the activity instances that are for the given task id or multiple task ids.
  • If true return total count of records for given query with filters
    Default Value: false
Header Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : AuditInstanceActivities
Match All
Show Source
Nested Schema : Instance
Type: object
Match All
Show Source
Nested Schema : BaseInstance
Type: object
Match All
Show Source
Nested Schema : CommonModel
Type: object
Show Source
Nested Schema : BaseInstance-allOf[1]
Type: object
Show Source
Nested Schema : Instance-allOf[1]
Type: object
Show Source
Nested Schema : ListPagination
Type: object
A common structure for helping a client with pagination
Show Source
  • The count of elements that are returned in the current this will be equal to or less than the "limit" parameter
  • The maximum number of elements to be returned. This will correspond to the "limit" query parameter
  • The index number of the first element for the list. This will correspond to the "offset" query parameter value
  • The total number of elements in the list for the applied filters - not including the "limit" parameter
Nested Schema : AuditInstanceActivities-allOf[2]
Type: object
Show Source
Nested Schema : availableActions
Type: array
Show Source
Nested Schema : UserOrAppClient
Match All
Show Source
Nested Schema : Discriminator: type
Type: object
Show Source
Nested Schema : IdentityCommon
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested 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: object
Show Source
Nested Schema : ActivityTypeDetail
Type: object
Show Source
Nested Schema : AuditAlterFlowDetail
Type: object
Show Source
Nested Schema : AuditUser
Match All
Show Source
Nested Schema : CallActivityDetail
Type: object
Show Source
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: object
Show Source
Nested Schema : MultiInstanceTask
Type: object
Show Source
Nested Schema : NotificationTaskDetail
Type: object
Show Source
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: object
Show Source
Nested Schema : StartEventDetail
Type: object
Show Source
  • 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: object
Show Source
  • The name for the multi instance task - taken from the User Task
  • Allowed Values: [ "DEFAULT", "ERROR_SUBPROCESS" ]
    The type of subprocess activity is shown here i.e., DEFAULT or ERROR_SUBPROCESS
Nested Schema : TimerActivityDetail
Type: object
Show Source
Nested Schema : AuditTask
Match All
Show Source
Nested Schema : AuditIncident
Type: object
Show Source
Nested Schema : ActivityPayloadInstance
Type: object
Show Source
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 : MultiInstanceAssignee
Match All
Show Source
Nested Schema : Identity
Match All
Show Source
Nested Schema : Identity-allOf[1]
Type: object
Show Source
Nested Schema : MultiInstanceAssignee-allOf[1]
Type: object
Show Source
Nested Schema : AuditTask-allOf[1]
Type: object
Show Source
Nested Schema : candidateGroups
Type: array
Show Source
Nested Schema : candidateUsers
Type: array
Show Source
Nested Schema : AuditTaskEvent
Type: object
Show Source
Nested Schema : AuditGroup
Match All
Show Source
Nested Schema : AuditGroup-allOf[1]
Type: object
Nested Schema : candidateGroups
Type: array
Show Source
Nested Schema : candidateUsers
Type: array
Show Source
Nested Schema : properties
Type: array
Show Source
Nested Schema : AuditEventProperty
Type: object
Show Source
Nested Schema : value
Type: object
The value of the property
Show Source
Nested Schema : AuditUser-allOf[1]
Type: object
Examples

201 Response

There are no activities for the process instance id

401 Response

Unauthorized

404 Response

The process instance does not exist

429 Response

Too Many Requests

500 Response

internal server error

503 Response

Too Many Exceptions or Too Slow Requests
Back to Top