ONonetrust
Custom Index Management

Get Index Creation Status

Use this API to retrieve the current creation status of the custom search index. The response will include details such as the current status, start and end time, and error details if applicable.

get/api/consentmanager/v1/custom-indexes/{runId}/status

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/consentmanager/v1/custom-indexes/{runId}/status
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: CONSENT, CONSENT_READ

Path parameters

runIdstring uuid required

Unique identifier of a custom index creation

Response

Successfully retrieved pipeline run status

status'Submitted' | 'InProgress' | 'Success' | 'Failed' | 'Cancelled' | 'Pending'

Current status of the custom index creation

startTimestring date-time

Timestamp when the of the custom index creation started

endTimestring date-time

Timestamp when the the custom index creation ended.

Example response

{
  "status": "InProgress"
}

Changes

No recorded changes to this operation across all 1 revision of this API.