Oracle Access Governance REST APIs

Get a list of Approval tasks

get

/access-governance/access-controls/20250331/approvals

Returns details of all available approval tasks with support for pagination.

Request

Query Parameters

accessRequestId: string

The access request id to filter on. This parameter is required when assigneeId is not provided.
assigneeId: string

The global id for the assignee to filter on. This parameter is required when an accessRequestId is not provided.
assigneeScope: string

Assignee scope to filter on. 'DIRECT' to filter on the tasks where the assignee id or authenticated user is the direct assignee, or 'INDIRECT' to filter on the tasks where the assignee has indirect approval rights.

Allowed Values: [ "DIRECT", "INDIRECT" ]
dueBefore: string(date-time)

Return only tasks due before the specified date.
instanceTags: array[boolean]

Collection Format: multi

List of tag filters to use. Each position in the array maps to the tag in the InstanceTags enum that is in the same position. Set the value to true to include instances that carry the tag. Set the value to false to exclude instances that carry the tag. Set the value to null in order to not apply the filter.
keywordContains: string

Keyword to use to filter against the names of the requestor and beneficiary.
limit: integer

Minimum Value: 1

Maximum Value: 1000

The maximum number of items to return.

Default Value: 10
page: string

Minimum Length: 1

A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
requestedAfter: string(date-time)

Return only instances created after the specified date.
sortBy: string

The field to sort by. Default sort by is 'dueDate'.

Allowed Values: [ "requestor", "beneficiary", "dueDate", "access" ]
sortOrder: string

The sort order to use, either 'ASC' or 'DESC'.

Allowed Values: [ "ASC", "DESC" ]
status: array[string]
Collection Format: multi

List of task statuses to filter on.
- Allowed Values: [ "PENDING_APPROVAL", "APPROVED", "ASSIGNED", "MODIFIED", "REJECTED", "REMOVED", "DELETED", "INFO_REQUESTED", "EXTENSION_REQUESTED", "ESCALATED", "ERROR", "CANCELLED" ]

Header Parameters

opc-request-id: string

The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Response

Supported Media Types

application/json

200 Response

A page of Task objects.

Headers

opc-next-page: string

For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : TaskCollection

Type: object

Results of a task search.

Show Source

items(required): array items

List of tasks.

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of tasks.",
            "items":{
                "$ref":"#/definitions/Task"
            }
        }
    },
    "description":"Results of a task search."
}

Nested Schema : items

Type: array

List of tasks.

Show Source

Array of: object Task

The details of a process instance task.

{
    "type":"array",
    "description":"List of tasks.",
    "items":{
        "$ref":"#/definitions/Task"
    }
}

Nested Schema : Task

Type: object

The details of a process instance task.

Show Source

assignee: string

User who is assigned to the task.
context: object InstanceContext

Context data pertaining to the process instance.
id(required): string

Unique identifier of the task provided by BPMN provider.
instanceId: string

Process instance ID.
lastAction: object TaskAction

An action which can be performed for a given task.
processId: string

Process definition ID.
requestId: string

Request ID which is generated by the caller.
status: string

Allowed Values: [ "PENDING_APPROVAL", "APPROVED", "ASSIGNED", "MODIFIED", "REJECTED", "REMOVED", "DELETED", "INFO_REQUESTED", "EXTENSION_REQUESTED", "ESCALATED", "ERROR", "CANCELLED" ]

The status of the task.
timeCompleted: string(date-time)

The completion date of the task.
timeCreated: string(date-time)

The creation date of the task.
timeDue: string(date-time)

The due date of the task.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the task provided by BPMN provider."
        },
        "processId":{
            "type":"string",
            "description":"Process definition ID."
        },
        "instanceId":{
            "type":"string",
            "description":"Process instance ID."
        },
        "requestId":{
            "type":"string",
            "description":"Request ID which is generated by the caller."
        },
        "assignee":{
            "type":"string",
            "description":"User who is assigned to the task."
        },
        "status":{
            "type":"string",
            "description":"The status of the task.",
            "enum":[
                "PENDING_APPROVAL",
                "APPROVED",
                "ASSIGNED",
                "MODIFIED",
                "REJECTED",
                "REMOVED",
                "DELETED",
                "INFO_REQUESTED",
                "EXTENSION_REQUESTED",
                "ESCALATED",
                "ERROR",
                "CANCELLED"
            ],
            "x-obmcs-top-level-enum":"#/definitions/TaskStatus"
        },
        "lastAction":{
            "$ref":"#/definitions/TaskAction"
        },
        "context":{
            "$ref":"#/definitions/InstanceContext"
        },
        "timeDue":{
            "type":"string",
            "format":"date-time",
            "description":"The due date of the task."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"The creation date of the task."
        },
        "timeCompleted":{
            "type":"string",
            "format":"date-time",
            "description":"The completion date of the task."
        }
    },
    "description":"The details of a process instance task."
}

Nested Schema : InstanceContext

Type: object

Context data pertaining to the process instance.

Show Source

assignmentAttributes: object assignmentAttributes

Additional Properties Allowed: additionalProperties

Map for additional key, value string pairs.
assignmentDescription: string

Description of the assignment that is being requested.
assignmentName: string

Name of the assignment that is being requested.
assignmentTags: array assignmentTags

Assignment tags.
assignmentType: string

Type of the assignment that is being requested.
beneficiary: string

Display name of the process instance beneficiary.
instanceVariables: array instanceVariables

Client specific context.
justification: string

Reason for the request.
message: string

Correlation message name.
requestor: string

Display name of the process instance requestor.
timeCreated: string(date-time)

The creation date of the process instance.
timeOfExpiration: string(date-time)

Assignment expiration date if approval is granted.
timers: array timers

Timers to update.

{
    "type":"object",
    "properties":{
        "requestor":{
            "type":"string",
            "description":"Display name of the process instance requestor."
        },
        "beneficiary":{
            "type":"string",
            "description":"Display name of the process instance beneficiary."
        },
        "assignmentName":{
            "type":"string",
            "description":"Name of the assignment that is being requested."
        },
        "assignmentType":{
            "type":"string",
            "description":"Type of the assignment that is being requested."
        },
        "assignmentDescription":{
            "type":"string",
            "description":"Description of the assignment that is being requested."
        },
        "assignmentAttributes":{
            "type":"object",
            "description":"Map for additional key, value string pairs.",
            "additionalProperties":{
                "type":"object",
                "properties":{
                }
            }
        },
        "assignmentTags":{
            "type":"array",
            "description":"Assignment tags.",
            "items":{
                "type":"string",
                "enum":[
                    "SOD_VIOLATIONS",
                    "EXPIRES_SOON",
                    "EXTENSION_REQUEST"
                ],
                "x-obmcs-top-level-enum":"#/definitions/InstanceTags"
            }
        },
        "timeOfExpiration":{
            "type":"string",
            "format":"date-time",
            "description":"Assignment expiration date if approval is granted."
        },
        "justification":{
            "type":"string",
            "description":"Reason for the request."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"The creation date of the process instance."
        },
        "instanceVariables":{
            "type":"array",
            "description":"Client specific context.",
            "items":{
                "$ref":"#/definitions/InstanceVariable"
            }
        },
        "message":{
            "type":"string",
            "description":"Correlation message name."
        },
        "timers":{
            "type":"array",
            "description":"Timers to update.",
            "items":{
                "$ref":"#/definitions/InstanceTimer"
            }
        }
    },
    "description":"Context data pertaining to the process instance."
}

Nested Schema : TaskAction

Type: object

An action which can be performed for a given task.

Show Source

action(required): string

Allowed Values: [ "REQUEST_INFO", "PROVIDE_INFO", "APPROVE", "MODIFY", "REASSIGN", "ASSIGN", "REMOVE", "REJECT", "CANCEL" ]

The action type.
comment: string

Reason for the action.
id: string

Unique identifier of the task action.
parentId: string

Identifier of the parent action, if one exists.
timeCreated: string(date-time)

The creation date of the task.
user: string

User who is performing the action.

{
    "type":"object",
    "required":[
        "action"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the task action."
        },
        "parentId":{
            "type":"string",
            "description":"Identifier of the parent action, if one exists."
        },
        "action":{
            "type":"string",
            "description":"The action type.",
            "enum":[
                "REQUEST_INFO",
                "PROVIDE_INFO",
                "APPROVE",
                "MODIFY",
                "REASSIGN",
                "ASSIGN",
                "REMOVE",
                "REJECT",
                "CANCEL"
            ],
            "x-obmcs-top-level-enum":"#/definitions/TaskActionType"
        },
        "user":{
            "type":"string",
            "description":"User who is performing the action."
        },
        "comment":{
            "type":"string",
            "description":"Reason for the action."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"The creation date of the task."
        }
    },
    "description":"An action which can be performed for a given task."
}

Nested Schema : assignmentAttributes

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

{
    "type":"object",
    "description":"Map for additional key, value string pairs.",
    "additionalProperties":{
        "type":"object",
        "properties":{
        }
    }
}

Map for additional key, value string pairs.

Nested Schema : assignmentTags

Type: array

Assignment tags.

Show Source

Array of: string

Allowed Values: [ "SOD_VIOLATIONS", "EXPIRES_SOON", "EXTENSION_REQUEST" ]

{
    "type":"array",
    "description":"Assignment tags.",
    "items":{
        "type":"string",
        "enum":[
            "SOD_VIOLATIONS",
            "EXPIRES_SOON",
            "EXTENSION_REQUEST"
        ],
        "x-obmcs-top-level-enum":"#/definitions/InstanceTags"
    }
}

Nested Schema : instanceVariables

Type: array

Client specific context.

Show Source

Array of: object InstanceVariable

Variable of process instance

{
    "type":"array",
    "description":"Client specific context.",
    "items":{
        "$ref":"#/definitions/InstanceVariable"
    }
}

Nested Schema : timers

Type: array

Timers to update.

Show Source

Array of: object InstanceTimer

Timers of process instance

{
    "type":"array",
    "description":"Timers to update.",
    "items":{
        "$ref":"#/definitions/InstanceTimer"
    }
}

Nested Schema : additionalProperties

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : InstanceVariable

Type: object

Variable of process instance

Show Source

name: string

variable name
value: object value

value assigned to the variable
valuetype: string

The value type of the variable. It can be string, boolean, integer, long , double

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"variable name"
        },
        "value":{
            "type":"object",
            "description":"value assigned to the variable",
            "properties":{
            }
        },
        "valuetype":{
            "type":"string",
            "description":"The value type of the variable. It can be string, boolean, integer, long , double"
        }
    },
    "description":"Variable of process instance"
}

Nested Schema : value

Type: object

value assigned to the variable

Show Source

{
    "type":"object",
    "description":"value assigned to the variable",
    "properties":{
    }
}

Nested Schema : InstanceTimer

Type: object

Timers of process instance

Show Source

id: string

Timer id
value: string

Timer value

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Timer id"
        },
        "value":{
            "type":"string",
            "description":"Timer value"
        }
    },
    "description":"Timers of process instance"
}

400 Response

Bad Request

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

401 Response

Unauthorized

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

404 Response

Not Found

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

429 Response

Too Many Requests

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

500 Response

Internal Server Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Default Response

Unknown Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Examples

The following example shows how to retrieve a list of approval tasks. You need to pass either accessRequestId or assigneeId of an identity.

cURL Request Example

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 '${service-instance-url}/access-governance/access-controls/${version}/approvals?accessRequestId=${accessRequestId}'

Example of the Response Code

{
    "items": [
        {
            "id": "d7ca932f-xxxx-xxxx-a4f0-ce0355309ad8",
            "processId": "user",
            "instanceId": "ae3a3688-xxxx-4503-bdea-67ea8404114b:d7937d92-xxxx-xxxx-a4f0-ce0355309ad8",
            "requestId": "d2756914-xxxx-xxxx-bd2a-a31f131ce533",
            "assignee": "Betty Cook",
            "status": "PENDING_APPROVAL",
            "lastAction": null,
            "context": {
                "requestor": "Amel Maclead",
                "beneficiary": "Bill Clark",
                "assignmentName": "Database Basic Access Privilege",
                "assignmentType": "ACCESS_BUNDLE",
                "assignmentDescription": null,
                "assignmentAttributes": null,
                "assignmentTags": [],
                "timeOfExpiration": null,
                "justification": "Database Basic Privilege Approvals Request",
                "timeCreated": "2025-04-21T21:51:53.008Z",
                "instanceVariables": null,
                "message": null,
                "timers": null
            },
            "timeDue": "2025-04-28T21:51:55.953Z",
            "timeCreated": "2025-04-21T21:51:55.952Z",
            "timeCompleted": null
        }
    ]
}