Get a purge job

get/lists/{listId}/purgeJobs/{jobId}

Returns a purge job for a specific list. A purge job removes the list's contents.

Request Samples

Response Samples


1{
2  "id": "b791e348-984e-439d-bff4-5b4163d897af",
3  "version": 1,
4  "state": "completed",
5  "creationTimeStamp": "2022-05-31T14:31:57Z",
6  "createdBy": "userA",
7  "completedTimeStamp": "2022-05-31T14:32:57Z",
8  "listId": "3659ea38-2618-4474-aeac-0bf6cfd3c322",
9  "totalErrors": 1,
10  "results": {
11    "recordCount": 100
12  },
13  "errors": [
14    {
15      "message": "string",
16      "id": "string",
17      "errorCode": 0,
18      "httpStatusCode": 0,
19      "details": [
20        "string"
21      ],
22      "remediation": "string",
23      "version": 2
24    }
25  ],
26  "links": [
27    {
28      "href": "...",
29      "method": "...",
30      "rel": "...",
31      "uri": "..."
32    }
33  ]
34}

Path Parameters

Name	Type	Required	Description
jobId	string	true	A universally unique identifier for a purge job.
listId	string	true	A universally unique identifier for a list.

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
403	Forbidden	The user did not have the necessary permissions.		Schema
404	Not Found	No item exists at the requested path.		Schema
500	Internal Server Error	The request could not be fulfilled because of an unexpected server error.		Schema