Get the entries for the content of a reference data domain or value list
There are two media types that can be used with the Accept header of the request. The first one is application/vnd.sas.collection. This causes a page of entries in the domain content to be returned. The second one is text/csv. The text/csv follows the RFC 4180 format. This causes all the entries in the domain content to be returned because the response content paging is not supported. Use the paging support parameters start
and limit
when accepting text/csv. The response content is associated with the domain type. The entry of value list is different with a domain.
1{2 "name": "entries",3 "accept": "application/vnd.sas.data.reference.value.list.entry",4 "start": 0,5 "count": 2,6 "limit": 10,7 "items": [8 {9 "key": "v>100",10 "value": "greater than 100",11 "disabled": false,12 "order": 113 },14 {15 "key": "v<100",16 "value": "less than 100",17 "disabled": false,18 "order": 219 },20 {21 "key": "100",22 "value": "equal to 100",23 "disabled": false,24 "order": 325 }26 ],27 "links": [28 {29 "method": "GET",30 "rel": "collection",31 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",32 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",33 "type": "application/vnd.sas.collection",34 "itemType": "application/vnd.sas.data.reference.value.list.entry"35 },36 {37 "method": "GET",38 "rel": "self",39 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries?start=0&limit=10",40 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries?start=0&limit=10",41 "type": "application/vnd.sas.collection",42 "itemType": "application/vnd.sas.data.reference.value.list.entry"43 },44 {45 "method": "GET",46 "rel": "up",47 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/",48 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/",49 "type": "application/vnd.sas.data.reference.value.list.content"50 },51 {52 "method": "POST",53 "rel": "replaceEntries",54 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",55 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",56 "type": "application/vnd.sas.collection",57 "responseType": "application/vnd.sas.collection",58 "itemType": "application/vnd.sas.data.reference.value.list.entry",59 "responseItemType": "application/vnd.sas.data.reference.value.list.entry"60 },61 {62 "method": "DELETE",63 "rel": "deleteEntries",64 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",65 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries"66 },67 {68 "method": "PATCH",69 "rel": "patchEntries",70 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",71 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",72 "type": "application/json-patch",73 "responseType": "application/vnd.sas.collection",74 "responseItemType": "application/vnd.sas.data.reference.value.list.entry"75 }76 ],77 "version": 278}
Name | Type | Required | Description |
---|---|---|---|
contentId | string | true | The identifier of a reference data domain or value list content. |
domainId | string | true | The identifier of a reference data domain or value list. |
Name | Type | Required | Description |
---|---|---|---|
filter | string<filter-criteria> | false | The filter criteria for the returned entries. |
limit | integer | false | The maximum number of items to return on this page. The actual number of returned items might be less if there are no more items in the collection. The default is 10. |
sortBy | string<sort-criteria> | false | The sort criteria for the returned entries. The default sort order is key:ascending. |
start | integer | false | The starting index of the first item on a page. The index is 0-based. The default index is 0. |
Status | Meaning | Description | ||
---|---|---|---|---|
200 | OK | The request succeeded. | Headers | Schema |
400 | Bad Request | The request was invalid. | Schema | |
404 | Not Found | No resource exists at the requested path. | Schema |