Skip to content
Okta Identity Governance
/
End user APIs
/
/
Retrieve the status of a...

Retrieve the status of a bulk-review submission

Request

OAuth 2.0 scope:
  • okta.governance.reviewer.read

Retrieves the job status of a bulk-review submission. Use this request to monitor the status of a bulk-review submission.

Path
campaignIdstringrequired

Unique identifier for the campaign

jobIdstringrequired

Unique identifier for the job

GET
/governance/api/v1/my/campaigns/{campaignId}/reviews/bulk-decisions/jobs/{jobId}
curl -i -X GET \
  'https://okta-subdomain.pixtulate.com/governance/api/v1/my/campaigns/{campaignId}/reviews/bulk-decisions/jobs/{jobId}'

Responses

Response for the bulk-review submission job

Headers
X-Rate-Limit-Limitinteger, >= 1required

The rate-limit ceiling for the current request

Example:60
X-Rate-Limit-Remaininginteger, >= 0required

The number of requests left for the current rate-limit window

Example:60
X-Rate-Limit-Resetinteger, >= 0required

The time when the rate limit resets, specified in UTC epoch time (in seconds)

Example:1609459200
Bodyapplication/json
idstring, [ 1 .. 20 ] charactersrequired

The id of the job

statusstring(bulk-review-decision-status-type)required

The bulk-review submission request status

Enum ValueDescription
ACCEPTED

Bulk-review decision submission has been accepted and is pending processing

IN_PROGRESS

Bulk-review decision submission is processing

COMPLETED

Bulk-review decision submission was processed and completed successfully

ERROR

Bulk-review decision submission ended with errors

errorsArray of objects, [ 0 .. 50 ] characters(error)

A list of errors encountered while processing the bulk review submission job

eligibleReviewRecordCountinteger, (int32)required

The number of eligible reviews in the submission

Response
Accepted response to bulk review decision.
{
  "id": "aae3l2XZ300xRq1rV0g3",
  "status": "COMPLETED",
  "eligibleReviewRecordCount": 100,
  "_links": {
    "self": { … },
    "reviewRecordsProcessed": { … }
  }
}