Get a collection of purge jobs

get/lists/{listId}/purgeJobs

Internal-Use Only

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

Request Samples

Response Samples

200
application/json
1{
2  "version": 2,
3  "accept": "application/vnd.sas.listdata.importjob+json",
4  "count": 1,
5  "start": 0,
6  "limit": 10,
7  "name": "importJobs",
8  "items": [
9    {
10      "id": "importJobId",
11      "state": "running",
12      "...": "see Import Job Schema"
13    }
14  ],
15  "links": [
16    {
17      "href": "...",
18      "method": "...",
19      "rel": "...",
20      "uri": "..."
21    }
22  ]
23}

Path Parameters

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

Query Parameters

Name	Type	Required	Description
filter	string<filter-criteria>	false	The filter criteria for returned items. See Filtering in REST APIs.
limit	integer	false	The maximum number of items to return. The default value is '20'. Examples: 100
sortBy	string<sort-criteria>	false	A sort of the returned items. See Sorting in REST APIs.
start	integer	false	A zero-based offset of the first item to return. The default value is '0'. Examples: 0

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