Get the entries for the content of a reference data domain or value list

get/domains/{domainId}/contents/{contentId}/entries

Internal-Use Only

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.

Request Samples

Response Samples

200
application/vnd.sas.collection+json
1{
2  "name": "entries",
3  "accept": "application/vnd.sas.data.reference.domain.entry",
4  "start": 0,
5  "count": 2,
6  "limit": 10,
7  "items": [
8    {
9      "key": "A",
10      "value": "1"
11    },
12    {
13      "key": "B",
14      "value": "2"
15    }
16  ],
17  "links": [
18    {
19      "method": "GET",
20      "rel": "collection",
21      "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
22      "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
23      "type": "application/vnd.sas.collection",
24      "itemType": "application/vnd.sas.data.reference.domain.entry"
25    },
26    {
27      "method": "GET",
28      "rel": "self",
29      "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries?start=0&limit=10",
30      "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries?start=0&limit=10",
31      "type": "application/vnd.sas.collection",
32      "itemType": "application/vnd.sas.data.reference.domain.entry"
33    },
34    {
35      "method": "GET",
36      "rel": "up",
37      "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/",
38      "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/",
39      "type": "application/vnd.sas.data.reference.domain.content"
40    },
41    {
42      "method": "POST",
43      "rel": "replaceEntries",
44      "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
45      "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
46      "type": "application/vnd.sas.collection",
47      "responseType": "application/vnd.sas.collection",
48      "itemType": "application/vnd.sas.data.reference.domain.entry",
49      "responseItemType": "application/vnd.sas.data.reference.domain.entry"
50    },
51    {
52      "method": "DELETE",
53      "rel": "deleteEntries",
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    },
57    {
58      "method": "PATCH",
59      "rel": "patchEntries",
60      "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
61      "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
62      "type": "application/json-patch",
63      "responseType": "application/vnd.sas.collection",
64      "responseItemType": "application/vnd.sas.data.reference.domain.entry"
65    }
66  ],
67  "version": 2
68}

Path Parameters

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.

Query Parameters

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.

Header Parameters

Name	Type	Required	Description
Accept	string	false	Choose the representation of the returned entries. Allowed values: application/vnd.sas.collection+jsontext/csv Default: application/vnd.sas.collection+json

Responses

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