Get a list of pending reviewers for the given stage
get
/access-governance/access-reviews/20250331/campaigns/{campaignId}/stages/{stageId}/reviewers
Request
Path Parameters
-
campaignId(required): string
Unique Campaign identifier.
-
stageId(required): string
The stage identifier for the given campaign.
Query Parameters
-
keywordContains: array[string]
Collection Format:
multi
Maximum Number of Items:5
The list of keywords to filter on -
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. -
sortBy: string
The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.Default Value:
timeCreated
Allowed Values:[ "timeCreated", "displayName" ]
-
sortOrder: string
The sort order to use, either 'ASC' or 'DESC'.Allowed Values:
[ "ASC", "DESC" ]
-
templateId: string
The templateId in the given stage of the campaign.
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
The list of pending reviewers for the given stage.
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.
-
opc-total-items: integer
The total number of items.
Root Schema : StageReviewerSummaryCollection
Type:
object
The list of StageReviewerSummary.
Show Source
-
items(required):
array items
the items.
Nested Schema : items
Type:
array
the items.
Show Source
-
Array of:
object StageReviewerSummary
The pending stage reviewer details.
Nested Schema : StageReviewerSummary
Type:
object
The pending stage reviewer details.
Show Source
-
displayName(required):
string
The display name of the reviewer.
-
email:
string
The email of the reviewer.
-
pendingCount(required):
integer
The pending count of review tasks.
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.
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.
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.
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.
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.
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.
Examples
The following example shows how to retrieve a details for pending reviewers for the given stage. Fetch stage id from the Get Details of a Campaign API. Replace placeholder values with actual values before running the sample command.
cURL Example - Without Query Parameters
curl -i -X GET \
-H "Authorization:Bearer <your access token>" \
'${service-instance-url}/campaigns/${campaignId}/stages/${stageId}/reviewers'
Example of the Response Body
The following example shows the contents of the response body in JSON format
{
"items": [
{
"displayName": "Arthur Jones",
"email": "ARTHUR.JONES@EXMAMPLE.COM",
"pendingCount": 1
}
]
}