Get all reference data domains or value lists

get/domains

Internal-Use Only

Returns a collection of information about each domain or value list.

Request Samples

Response Samples

200
application/json
application/vnd.sas.summary+json
1{
2  "name": "domains",
3  "accept": "application/vnd.sas.summary",
4  "start": 0,
5  "count": 4,
6  "items": [
7    {
8      "creationTimeStamp": "2022-02-26T00:55:27.420Z",
9      "modifiedTimeStamp": "2022-02-26T00:55:27.669Z",
10      "createdBy": "siduser",
11      "modifiedBy": "siduser",
12      "id": "a15879f1-c5aa-4ba7-8152-a883c9b868ae",
13      "type": "referenceDataDomain",
14      "name": "CarRate",
15      "links": [
16        {
17          "method": "GET",
18          "rel": "self",
19          "href": "/referenceData/domains/a15879f1-c5aa-4ba7-8152-a883c9b868ae",
20          "uri": "/referenceData/domains/a15879f1-c5aa-4ba7-8152-a883c9b868ae",
21          "type": "application/vnd.sas.data.reference.domain"
22        },
23        {
24          "method": "GET",
25          "rel": "getContents",
26          "href": "/referenceData/domains/a15879f1-c5aa-4ba7-8152-a883c9b868ae/contents",
27          "uri": "/referenceData/domains/a15879f1-c5aa-4ba7-8152-a883c9b868ae/contents",
28          "type": "application/vnd.sas.collection"
29        },
30        {
31          "method": "GET",
32          "rel": "currentContents",
33          "href": "/referenceData/domains/a15879f1-c5aa-4ba7-8152-a883c9b868ae/currentContents",
34          "uri": "/referenceData/domains/a15879f1-c5aa-4ba7-8152-a883c9b868ae/currentContents",
35          "type": "application/vnd.sas.data.reference.domain.content"
36        },
37        {
38          "method": "GET",
39          "rel": "currentContentsCompleteHistory",
40          "href": "/referenceData/domains/a15879f1-c5aa-4ba7-8152-a883c9b868ae/currentContents?scope=all",
41          "uri": "/referenceData/domains/a15879f1-c5aa-4ba7-8152-a883c9b868ae/currentContents?scope=all",
42          "type": "application/vnd.sas.data.reference.domain.content"
43        },
44        {
45          "method": "GET",
46          "rel": "up",
47          "href": "/referenceData/domains",
48          "uri": "/referenceData/domains",
49          "type": "application/vnd.sas.collection",
50          "itemType": "application/vnd.sas.summary"
51        }
52      ],
53      "version": 2
54    },
55    {
56      "creationTimeStamp": "2022-02-25T13:39:01.556Z",
57      "modifiedTimeStamp": "2022-02-25T13:46:07.466Z",
58      "createdBy": "siduser",
59      "modifiedBy": "siduser",
60      "id": "f8600b44-092c-4095-a560-f4d2b90f1148",
61      "type": "referenceDataDomain",
62      "name": "serviceLevel",
63      "links": [
64        {
65          "method": "GET",
66          "rel": "self",
67          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148",
68          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148",
69          "type": "application/vnd.sas.data.reference.domain"
70        },
71        {
72          "method": "GET",
73          "rel": "getContents",
74          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
75          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
76          "type": "application/vnd.sas.collection"
77        },
78        {
79          "method": "GET",
80          "rel": "currentContents",
81          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/currentContents",
82          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/currentContents",
83          "type": "application/vnd.sas.data.reference.domain.content"
84        },
85        {
86          "method": "GET",
87          "rel": "currentContentsCompleteHistory",
88          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/currentContents?scope=all",
89          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/currentContents?scope=all",
90          "type": "application/vnd.sas.data.reference.domain.content"
91        },
92        {
93          "method": "GET",
94          "rel": "up",
95          "href": "/referenceData/domains",
96          "uri": "/referenceData/domains",
97          "type": "application/vnd.sas.collection",
98          "itemType": "application/vnd.sas.summary"
99        }
100      ],
101      "version": 2
102    },
103    {
104      "creationTimeStamp": "2022-02-25T13:14:47.488Z",
105      "modifiedTimeStamp": "2022-02-25T13:14:49.303Z",
106      "createdBy": "sas.decisions",
107      "modifiedBy": "sas.decisions",
108      "id": "0e6fb50d-a5e1-4e5c-a466-19210ba61f2b",
109      "type": "referenceDataDomain",
110      "name": "Subject Level",
111      "description": "",
112      "links": [
113        {
114          "method": "GET",
115          "rel": "self",
116          "href": "/referenceData/domains/0e6fb50d-a5e1-4e5c-a466-19210ba61f2b",
117          "uri": "/referenceData/domains/0e6fb50d-a5e1-4e5c-a466-19210ba61f2b",
118          "type": "application/vnd.sas.data.reference.domain"
119        },
120        {
121          "method": "GET",
122          "rel": "getContents",
123          "href": "/referenceData/domains/0e6fb50d-a5e1-4e5c-a466-19210ba61f2b/contents",
124          "uri": "/referenceData/domains/0e6fb50d-a5e1-4e5c-a466-19210ba61f2b/contents",
125          "type": "application/vnd.sas.collection"
126        },
127        {
128          "method": "GET",
129          "rel": "currentContents",
130          "href": "/referenceData/domains/0e6fb50d-a5e1-4e5c-a466-19210ba61f2b/currentContents",
131          "uri": "/referenceData/domains/0e6fb50d-a5e1-4e5c-a466-19210ba61f2b/currentContents",
132          "type": "application/vnd.sas.data.reference.domain.content"
133        },
134        {
135          "method": "GET",
136          "rel": "currentContentsCompleteHistory",
137          "href": "/referenceData/domains/0e6fb50d-a5e1-4e5c-a466-19210ba61f2b/currentContents?scope=all",
138          "uri": "/referenceData/domains/0e6fb50d-a5e1-4e5c-a466-19210ba61f2b/currentContents?scope=all",
139          "type": "application/vnd.sas.data.reference.domain.content"
140        },
141        {
142          "method": "GET",
143          "rel": "up",
144          "href": "/referenceData/domains",
145          "uri": "/referenceData/domains",
146          "type": "application/vnd.sas.collection",
147          "itemType": "application/vnd.sas.summary"
148        }
149      ],
150      "version": 2
151    },
152    {
153      "creationTimeStamp": "2022-02-25T13:13:25.693Z",
154      "modifiedTimeStamp": "2022-02-25T13:13:38.612Z",
155      "createdBy": "sas.treatmentDefinitions",
156      "modifiedBy": "sas.treatmentDefinitions",
157      "id": "61073d6a-5e2e-4199-a65d-a3622d4705cc",
158      "type": "referenceDataDomain",
159      "name": "Treatment Channels",
160      "description": "",
161      "links": [
162        {
163          "method": "GET",
164          "rel": "self",
165          "href": "/referenceData/domains/61073d6a-5e2e-4199-a65d-a3622d4705cc",
166          "uri": "/referenceData/domains/61073d6a-5e2e-4199-a65d-a3622d4705cc",
167          "type": "application/vnd.sas.data.reference.domain"
168        },
169        {
170          "method": "GET",
171          "rel": "getContents",
172          "href": "/referenceData/domains/61073d6a-5e2e-4199-a65d-a3622d4705cc/contents",
173          "uri": "/referenceData/domains/61073d6a-5e2e-4199-a65d-a3622d4705cc/contents",
174          "type": "application/vnd.sas.collection"
175        },
176        {
177          "method": "GET",
178          "rel": "currentContents",
179          "href": "/referenceData/domains/61073d6a-5e2e-4199-a65d-a3622d4705cc/currentContents",
180          "uri": "/referenceData/domains/61073d6a-5e2e-4199-a65d-a3622d4705cc/currentContents",
181          "type": "application/vnd.sas.data.reference.domain.content"
182        },
183        {
184          "method": "GET",
185          "rel": "currentContentsCompleteHistory",
186          "href": "/referenceData/domains/61073d6a-5e2e-4199-a65d-a3622d4705cc/currentContents?scope=all",
187          "uri": "/referenceData/domains/61073d6a-5e2e-4199-a65d-a3622d4705cc/currentContents?scope=all",
188          "type": "application/vnd.sas.data.reference.domain.content"
189        },
190        {
191          "method": "GET",
192          "rel": "up",
193          "href": "/referenceData/domains",
194          "uri": "/referenceData/domains",
195          "type": "application/vnd.sas.collection",
196          "itemType": "application/vnd.sas.summary"
197        }
198      ],
199      "version": 2
200    }
201  ],
202  "links": [
203    {
204      "method": "GET",
205      "rel": "collection",
206      "href": "/referenceData/domains",
207      "uri": "/referenceData/domains",
208      "type": "application/vnd.sas.collection",
209      "itemType": "application/vnd.sas.summary"
210    },
211    {
212      "method": "GET",
213      "rel": "self",
214      "href": "/referenceData/domains?sortBy=modifiedTimeStamp:descending&start=0&limit=10",
215      "uri": "/referenceData/domains?sortBy=modifiedTimeStamp:descending&start=0&limit=10",
216      "type": "application/vnd.sas.collection",
217      "itemType": "application/vnd.sas.summary"
218    },
219    {
220      "method": "GET",
221      "rel": "up",
222      "href": "/referenceData/",
223      "uri": "/referenceData/",
224      "type": "application/vnd.sas.api"
225    },
226    {
227      "method": "POST",
228      "rel": "createDomain",
229      "href": "/referenceData/domains",
230      "uri": "/referenceData/domains",
231      "type": "application/vnd.sas.data.reference.domain",
232      "responseType": "application/vnd.sas.data.reference.domain"
233    }
234  ],
235  "limit": 10,
236  "version": 2
237}

Query Parameters

Name	Type	Required	Description
parentFolderUri	string	false	The folder where the target domains are located.
filter	string<filter-criteria>	false	The filter criteria for the returned domains.
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	Criteria used for sorting the reference data domains. The default sort order is creationTimeStamp: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-Item	string	false	Select the desired item representation. Allowed values: application/vnd.sas.data.reference.domain+jsonapplication/vnd.sas.data.reference.value.list+jsonapplication/vnd.sas.summary+jsonapplication/vnd.sas.dcm.summary+json Default: application/vnd.sas.summary+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