Get a collection of lists

get/lists
Internal-Use Only

Returns a collection of lists.

Request Samples

1

Response Samples

1{
2 "version": 2,
3 "accept": "application/vnd.sas.listdata.list",
4 "count": 253,
5 "start": 0,
6 "limit": 2,
7 "name": "listResource",
8 "items": [
9 {
10 "id": "9ec45a61-774c-488e-99a0-03dfde70b966",
11 "version": 1,
12 "creationTimeStamp": "2023-02-14T15:57:54.041280Z",
13 "modifiedTimeStamp": "2023-02-14T17:29:57.210467Z",
14 "createdBy": "sasadm",
15 "modifiedBy": "sasadm",
16 "name": "userlist1",
17 "description": "desc",
18 "state": "developing",
19 "isImmutable": false,
20 "hasExpiry": false,
21 "label": "string",
22 "columns": [
23 {
24 "name": "userId",
25 "dataType": "string",
26 "position": 1,
27 "isKey": true,
28 "keyPosition": 1,
29 "dataMask": {
30 "name": "Mask Start",
31 "example": "****1234",
32 "regex": ".(....$)|.",
33 "replace": "*$1"
34 }
35 },
36 {
37 "name": "firstName",
38 "dataType": "string",
39 "position": 2,
40 "isKey": false,
41 "keyPosition": 0
42 },
43 {
44 "name": "lastName",
45 "dataType": "string",
46 "position": 3,
47 "isKey": false,
48 "keyPosition": 0
49 },
50 {
51 "name": "salary",
52 "dataType": "number",
53 "position": 4,
54 "isKey": false,
55 "keyPosition": 0
56 }
57 ],
58 "links": [
59 {
60 "method": "GET",
61 "rel": "up",
62 "href": "/listData/lists",
63 "uri": "/listData/lists",
64 "type": "application/vnd.sas.collection",
65 "itemType": "application/vnd.sas.listdata.list"
66 },
67 {
68 "method": "GET",
69 "rel": "self",
70 "href": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966",
71 "uri": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966",
72 "type": "application/vnd.sas.listdata.list"
73 },
74 {
75 "method": "PUT",
76 "rel": "update",
77 "href": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966",
78 "uri": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966",
79 "type": "application/vnd.sas.listdata.list",
80 "responseType": "application/vnd.sas.listdata.list"
81 },
82 {
83 "method": "GET",
84 "rel": "state",
85 "href": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966/state",
86 "uri": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966/state",
87 "type": "text/plain"
88 },
89 {
90 "method": "GET",
91 "rel": "contents",
92 "href": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966/contents",
93 "uri": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966/contents",
94 "type": "application/vnd.sas.collection",
95 "itemType": "application/json"
96 },
97 {
98 "method": "GET",
99 "rel": "contentsDataset",
100 "href": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966/contents",
101 "uri": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966/contents",
102 "type": "application/vnd.sas.listdata.dataset"
103 },
104 {
105 "method": "PUT",
106 "rel": "updateContents",
107 "href": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966/contents",
108 "uri": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966/contents",
109 "type": "application/vnd.sas.collection",
110 "responseType": "application/vnd.sas.listdata.list",
111 "itemType": "application/json"
112 },
113 {
114 "method": "POST",
115 "rel": "importContents",
116 "href": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966/importJobs",
117 "uri": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966/importJobs",
118 "type": "multipart/form-data",
119 "responseType": "application/vnd.sas.listdata.importjob"
120 },
121 {
122 "method": "POST",
123 "rel": "purgeContents",
124 "href": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966/purgeJobs",
125 "uri": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966/purgeJobs",
126 "responseType": "application/vnd.sas.listdata.purgejob"
127 },
128 {
129 "method": "DELETE",
130 "rel": "delete",
131 "href": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966",
132 "uri": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966"
133 },
134 {
135 "method": "GET",
136 "rel": "alternate",
137 "href": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966",
138 "uri": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966",
139 "type": "application/vnd.sas.summary"
140 },
141 {
142 "method": "GET",
143 "rel": "privilegedContents",
144 "href": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966/privilegedContents",
145 "uri": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966/privilegedContents",
146 "type": "application/vnd.sas.listdata.list"
147 },
148 {
149 "method": "PUT",
150 "rel": "privilegedEdit",
151 "href": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966/privilegedEdit",
152 "uri": "/listData/lists/9ec45a61-774c-488e-99a0-03dfde70b966/privilegedEdit",
153 "type": "application/vnd.sas.listdata.list",
154 "responseType": "application/vnd.sas.listdata.list"
155 }
156 ]
157 },
158 {
159 "id": "d4367763-5c04-40e1-9abd-fde1796bc83c",
160 "version": 1,
161 "creationTimeStamp": "2023-02-14T17:01:38.695035Z",
162 "modifiedTimeStamp": "2023-02-14T19:52:46.714191Z",
163 "createdBy": "sasadm",
164 "modifiedBy": "anonymous",
165 "name": "userlist2",
166 "description": "desc",
167 "state": "developing",
168 "isImmutable": false,
169 "hasExpiry": true,
170 "label": "string",
171 "columns": [
172 {
173 "name": "userId",
174 "dataType": "string",
175 "position": 1,
176 "isKey": true,
177 "keyPosition": 1,
178 "dataMask": {
179 "name": "Mask Start",
180 "example": "****1234",
181 "regex": ".(....$)|.",
182 "replace": "*$1"
183 }
184 },
185 {
186 "name": "firstName",
187 "dataType": "string",
188 "position": 2,
189 "isKey": false,
190 "keyPosition": 0
191 },
192 {
193 "name": "lastName",
194 "dataType": "string",
195 "position": 3,
196 "isKey": false,
197 "keyPosition": 0
198 },
199 {
200 "name": "salary",
201 "dataType": "number",
202 "position": 4,
203 "isKey": false,
204 "keyPosition": 0
205 }
206 ],
207 "links": [
208 {
209 "method": "GET",
210 "rel": "up",
211 "href": "/listData/lists",
212 "uri": "/listData/lists",
213 "type": "application/vnd.sas.collection",
214 "itemType": "application/vnd.sas.listdata.list"
215 },
216 {
217 "method": "GET",
218 "rel": "self",
219 "href": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c",
220 "uri": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c",
221 "type": "application/vnd.sas.listdata.list"
222 },
223 {
224 "method": "PUT",
225 "rel": "update",
226 "href": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c",
227 "uri": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c",
228 "type": "application/vnd.sas.listdata.list",
229 "responseType": "application/vnd.sas.listdata.list"
230 },
231 {
232 "method": "GET",
233 "rel": "state",
234 "href": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c/state",
235 "uri": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c/state",
236 "type": "text/plain"
237 },
238 {
239 "method": "GET",
240 "rel": "contents",
241 "href": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c/contents",
242 "uri": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c/contents",
243 "type": "application/vnd.sas.collection",
244 "itemType": "application/json"
245 },
246 {
247 "method": "GET",
248 "rel": "contentsDataset",
249 "href": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c/contents",
250 "uri": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c/contents",
251 "type": "application/vnd.sas.listdata.dataset"
252 },
253 {
254 "method": "PUT",
255 "rel": "updateContents",
256 "href": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c/contents",
257 "uri": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c/contents",
258 "type": "application/vnd.sas.collection",
259 "responseType": "application/vnd.sas.listdata.list",
260 "itemType": "application/json"
261 },
262 {
263 "method": "POST",
264 "rel": "importContents",
265 "href": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c/importJobs",
266 "uri": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c/importJobs",
267 "type": "multipart/form-data",
268 "responseType": "application/vnd.sas.listdata.importjob"
269 },
270 {
271 "method": "POST",
272 "rel": "purgeContents",
273 "href": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c/purgeJobs",
274 "uri": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c/purgeJobs",
275 "responseType": "application/vnd.sas.listdata.purgejob"
276 },
277 {
278 "method": "DELETE",
279 "rel": "delete",
280 "href": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c",
281 "uri": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c"
282 },
283 {
284 "method": "GET",
285 "rel": "alternate",
286 "href": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c",
287 "uri": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c",
288 "type": "application/vnd.sas.summary"
289 },
290 {
291 "method": "GET",
292 "rel": "privilegedContents",
293 "href": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c/privilegedContents",
294 "uri": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c/privilegedContents",
295 "type": "application/vnd.sas.listdata.list"
296 },
297 {
298 "method": "PUT",
299 "rel": "privilegedEdit",
300 "href": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c/privilegedEdit",
301 "uri": "/listData/lists/d4367763-5c04-40e1-9abd-fde1796bc83c/privilegedEdit",
302 "type": "application/vnd.sas.listdata.list",
303 "responseType": "application/vnd.sas.listdata.list"
304 }
305 ]
306 }
307 ]
308}

Query Parameters

NameTypeRequiredDescription
folderId
string
false

A universally unique identifier for a folder. The maximum number of lists that can be returned from a folder is 100000.

Examples:
"3659ea38-2618-4474-aeac-0bf6cfd3c322"
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

StatusMeaningDescription
200OKThe request succeeded.HeadersSchema
400Bad RequestThe request was invalid.Schema
500Internal Server ErrorThe request could not be fulfilled because of an unexpected server error.Schema