ONonetrust
Custom Scan

Update Scan Job Status

Use this API to update the custom connecter scan job's status.

put/v1/jobs/{jobId}/status

Request

  • Base URL
    https://localhost:8080/api/data-discovery-bridge
  • URL
    https://localhost:8080/api/data-discovery-bridge/v1/jobs/{jobId}/status
  • Auth
    none declared

Path parameters

jobIdinteger required

The custom connector scan job's identifier. This value can be obtained using the Get List of Scan Jobs API.

Request body

status'CREATED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'PAUSED' required

Status to which the job should be updated.

errorMessagestring

Error message that indicates the reason for using a status of FAILED.

Example request

{
  "status": "IN_PROGRESS",
  "errorMessage": "Connection Error"
}

Response

OK

Changes

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