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