Get a list

get/lists/{listId}

Returns a list.

Request Samples

1

Response Samples

1{
2 "id": "3659ea38-2618-4474-aeac-0bf6cfd3c322",
3 "version": 1,
4 "creationTimeStamp": "2022-03-01T20:18:32Z",
5 "modifiedTimeStamp": "2022-03-01T20:18:32Z",
6 "createdBy": "appUser1",
7 "modifiedBy": "appUser1",
8 "name": "list-a",
9 "description": "The A-list users",
10 "state": "developing",
11 "columns": [
12 {
13 "name": "userId",
14 "dataType": "string",
15 "position": 1,
16 "isKey": true,
17 "keyPosition": 1
18 },
19 {
20 "name": "firstName",
21 "dataType": "string",
22 "position": 2,
23 "isKey": false,
24 "keyPosition": 0
25 },
26 {
27 "name": "lastName",
28 "dataType": "string",
29 "position": 3,
30 "isKey": false,
31 "keyPosition": 0
32 },
33 {
34 "name": "salary",
35 "dataType": "number",
36 "position": 4,
37 "isKey": false,
38 "keyPosition": 0,
39 "dataMask": {
40 "name": "MaskStart",
41 "regex": ".(....$)|.",
42 "replace": "*$1",
43 "example": "****1234"
44 }
45 }
46 ],
47 "label": "corporate marketing",
48 "links": [
49 {
50 "href": "...",
51 "method": "...",
52 "rel": "...",
53 "uri": "..."
54 }
55 ]
56}

Path Parameters

NameTypeRequiredDescription
listId
string
true

A universally unique identifier for a list.

Header Parameters

NameTypeRequiredDescription
Accept
string
false

The desired response type.

Allowed values:
application/jsonapplication/vnd.sas.listdata.list+jsonapplication/vnd.sas.listdata.list+json;version=1application/vnd.sas.listdata.listdetails+jsonapplication/vnd.sas.listdata.listdetails.consumers+jsonapplication/vnd.sas.transfer.object+jsonapplication/vnd.sas.summary+json

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
403Forbidden

The user did not have the necessary permissions.

Schema
404Not Found

No item exists at the requested path.

Schema
500Internal Server Error

The request could not be fulfilled because of an unexpected server error.

Schema