This endpoint allows a user to retrieve the job ID for a scheduled GDPR job.
services/v2/jobs/gdpr/{schedule-job-id}.json
- URL (Path/Query) Params
No query params needed; the schedule-job-id is already a path param.
- Data Params
No data params
Sample Request
Call:
curl -X GET -u : -H "Accept:application/json" -H "Content-Type: application/json" "https://apidocs.cloud.answerhub.com/services/v2/jobs/gdpr/.json" -v
curl
-X GET
-u piero:mypass
-H "Accept:application/json"
-H "Content-Type: application/json" "https://apidocs.cloud.answerhub.com/services/v2/jobs/gdpr/568.json" -v
Expected Responses
- Success Response:
Code: 200
Content: job details
- Success Response (Pending Job):
- See JSON response below in the code samples.
- Success Response (Finished Job):
- See JSON response below in the code samples.
- Error Response:
-
job does not exist, incorrect id: HTTP/1.1 404 Not Found
{"error":"not found"} -
job id was ill-formatted HTTP/1.1 400 Bad Request
{"error":"The provided 'job id' is/are invalid"}
For Permissions, Requirements, and More Detailed Information:
Reference the GDPR Plugin Docs in the Non-Reference portion of the documentation.
Sample Responses
Success Response (Pending Job):
{
"id":568,
"scheduleTime":"10/15/2018 12:15",
"operations":"suspend",
"userId":17,
"status":"PENDING"
}
Success Response (Finished Job):
{
"id":512,
"scheduleTime":"10/05/2018 11:42",
"operations":"anonymize",
"userId":10,
"status":"FINISHED",
"executions":[
{
"userId":10,
"executionStatus":"FINISHED",
"executionURL":"http://apidocs.cloud.answerhub.com/services/v2/users/gdpr/execution/514/status.json"
}
]
}
Error Response For Job Does Not Exist:
{
"error":"not found"
}
Error Response For Job ID Ill-Formatted:
{
"error":"The provided 'job id' is/are invalid"
}