Update Scan Job Status

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

πŸ—’

Things to Know

  • This API is for directly communicating with the on-premises worker node. This API does not communicate with the OneTrust application, hence your hostname will be the hostname of your worker node. For more information, see API Access for Worker Node Management.
  • Status of IN_PROGRESS should be sent to confirm a job has been retrieved and has started to be processed.
  • Status of COMPLETED should be sent once all catalog and classify requests have been successfully sent.
  • Status of FAILED should be sent to denote a problem processing job.
  • For more information on using this API, see Custom Scan using Worker Node APIs.
Path Params
int64
required
β‰₯ 1

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

Body Params
string
enum
required

Status to which the job should be updated.

Allowed:
string

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

Responses
200

OK

Language
URL
Response
Choose an example:
*/*