Create a purge job

post/lists/{listId}/purgeJobs

Internal-Use Only

Removes the list's contents.

A purge job does not remove the list or associated jobs. The list's contents are empty if the purge job is successful.

You can create a new purge job only if there are no other import jobs or purge jobs running on that list.

You cannot create a purge job for an immutable list. To reload an immutable list, you must delete the list and then re-create it.

Request Samples

Response Samples

202
application/vnd.sas.listdata.purgejob+json
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
listId	string	true	A universally unique identifier for a purge job.

Responses

Status	Meaning	Description
202	Accepted	The request has been accepted for processing, but the processing has not been completed.	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
409	Conflict	The request could not be completed due to a conflict with an existing resource.		Schema
500	Internal Server Error	The request could not be fulfilled because of an unexpected server error.		Schema