Anonymization API - GET job status

Checks the status of an anonymization job. The response contains the percentage of job progress.

The request produces an application/json payload.

GET	Managed https://{your-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs/{requestId} SaaS https://{your-environment-id}.live.dexp.ae/api/v1/anonymize/anonymizationJobs/{requestId}

Authentication

To execute this request, you need the Anonymize user session data for data privacy reasons permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

Parameter	Type	Description	In	Required
requestId	string	The ID of the required anonymization job.	path	required

Response format

Response parameters JSON model

The AnonymizationProgressResult object

Element	Type	Description
progress	integer	The progress of the anonymization job, percent. -1 if the job is waiting for execution.

Element

Type

Description

progress

integer

The progress of the anonymization job, percent.

-1 if the job is waiting for execution.

    
{
  "progress": 50
}

Example

In this example, the request checks the status of the anonymization job with the ID of 7810238295331327902.

The API token is passed in the Authorization header.

The response shows that the job is complete.

Curl

curl -X GET \
    https://mySampleEnv.live.dexp.ae/api/v1/anonymize/anonymizationJobs/7810238295331327902 \
    -H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dexp.ae/api/v1/anonymize/anonymizationJobs/7810238295331327902

Response content

{
  "progress": 100
}

Response code

200