Get all contents of a reference data domain or value list

get/domains/{domainId}/contents

Internal-Use Only

Returns a collection of information about each content. For each domain content in the collection, when the activationStatus of the content is running, the endpoint takes an additional step to query the results of the asynchronous publishes of the content. The activationStatus field of the content continues to show running if the asynchronous publishes have not all completed.

If all have completed, and if one publish has failed, the status field shows activating, the activationStatus field shows failed and the activationError field shows the cause of the failure. If all publishes have succeeded, the status field shows production, the activationStatus field shows active, and the activationError field is cleared of any text that might have been there before.

Request Samples

Response Samples

200
application/vnd.sas.collection+json
1{
2  "name": "versions",
3  "accept": "application/vnd.sas.data.reference.domain.content",
4  "start": 0,
5  "limit": 10,
6  "count": 3,
7  "items": [
8    {
9      "creationTimeStamp": "2022-02-25T13:39:02.005Z",
10      "modifiedTimeStamp": "2022-02-25T13:41:37.894Z",
11      "createdBy": "siduser",
12      "modifiedBy": "siduser",
13      "id": "ea412e18-02f2-4502-b8c6-4a4f8cad5db4",
14      "label": "lookup1.0",
15      "status": "production",
16      "activationStatus": "active",
17      "keyLabel": "Sev",
18      "valueLabel": "SLA",
19      "links": [
20        {
21          "method": "GET",
22          "rel": "up",
23          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
24          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
25          "type": "application/vnd.sas.collection",
26          "itemType": "application/vnd.sas.data.reference.domain.content"
27        },
28        {
29          "method": "GET",
30          "rel": "self",
31          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/ea412e18-02f2-4502-b8c6-4a4f8cad5db4",
32          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/ea412e18-02f2-4502-b8c6-4a4f8cad5db4",
33          "type": "application/vnd.sas.data.reference.domain.content"
34        },
35        {
36          "method": "GET",
37          "rel": "getEntries",
38          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/ea412e18-02f2-4502-b8c6-4a4f8cad5db4/entries",
39          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/ea412e18-02f2-4502-b8c6-4a4f8cad5db4/entries",
40          "type": "application/vnd.sas.collection",
41          "itemType": "application/vnd.sas.data.reference.domain.entry"
42        },
43        {
44          "method": "POST",
45          "rel": "createEntries",
46          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/ea412e18-02f2-4502-b8c6-4a4f8cad5db4/entries",
47          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/ea412e18-02f2-4502-b8c6-4a4f8cad5db4/entries",
48          "type": "application/vnd.sas.collection",
49          "responseType": "application/vnd.sas.collection",
50          "itemType": "application/vnd.sas.data.reference.domain.entry",
51          "responseItemType": "application/vnd.sas.data.reference.domain.entry"
52        },
53        {
54          "method": "DELETE",
55          "rel": "deleteEntries",
56          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/ea412e18-02f2-4502-b8c6-4a4f8cad5db4/entries",
57          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/ea412e18-02f2-4502-b8c6-4a4f8cad5db4/entries"
58        },
59        {
60          "method": "DELETE",
61          "rel": "delete",
62          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/ea412e18-02f2-4502-b8c6-4a4f8cad5db4",
63          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/ea412e18-02f2-4502-b8c6-4a4f8cad5db4"
64        },
65        {
66          "method": "GET",
67          "rel": "checkouts",
68          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/ea412e18-02f2-4502-b8c6-4a4f8cad5db4/checkouts",
69          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/ea412e18-02f2-4502-b8c6-4a4f8cad5db4/checkouts",
70          "type": "application/vnd.sas.collection",
71          "itemType": "application/vnd.sas.summary"
72        }
73      ],
74      "standing": "current",
75      "majorNumber": 1,
76      "minorNumber": 0
77    },
78    {
79      "creationTimeStamp": "2022-02-25T13:40:09.565Z",
80      "modifiedTimeStamp": "2022-02-25T13:40:54.026Z",
81      "createdBy": "siduser",
82      "modifiedBy": "siduser",
83      "id": "390be3d6-4320-4cb9-9365-17421a374bee",
84      "label": "lookup1.0",
85      "status": "developing",
86      "keyLabel": "Severity",
87      "valueLabel": "SLA Class",
88      "links": [
89        {
90          "method": "GET",
91          "rel": "up",
92          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
93          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
94          "type": "application/vnd.sas.collection",
95          "itemType": "application/vnd.sas.data.reference.domain.content"
96        },
97        {
98          "method": "GET",
99          "rel": "self",
100          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee",
101          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee",
102          "type": "application/vnd.sas.data.reference.domain.content"
103        },
104        {
105          "method": "GET",
106          "rel": "getEntries",
107          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
108          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
109          "type": "application/vnd.sas.collection",
110          "itemType": "application/vnd.sas.data.reference.domain.entry"
111        },
112        {
113          "method": "POST",
114          "rel": "createEntries",
115          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
116          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
117          "type": "application/vnd.sas.collection",
118          "responseType": "application/vnd.sas.collection",
119          "itemType": "application/vnd.sas.data.reference.domain.entry",
120          "responseItemType": "application/vnd.sas.data.reference.domain.entry"
121        },
122        {
123          "method": "DELETE",
124          "rel": "deleteEntries",
125          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
126          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries"
127        },
128        {
129          "method": "DELETE",
130          "rel": "delete",
131          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee",
132          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee"
133        },
134        {
135          "method": "GET",
136          "rel": "checkouts",
137          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/checkouts",
138          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/checkouts",
139          "type": "application/vnd.sas.collection",
140          "itemType": "application/vnd.sas.summary"
141        }
142      ],
143      "standing": "inactive",
144      "majorNumber": 1,
145      "minorNumber": 1
146    },
147    {
148      "creationTimeStamp": "2022-02-25T13:46:07.457Z",
149      "modifiedTimeStamp": "2022-02-25T13:46:07.466Z",
150      "createdBy": "siduser",
151      "modifiedBy": "siduser",
152      "id": "0b242ce4-59dc-4c62-87b6-863ee756531e",
153      "label": "lookup1.0",
154      "status": "developing",
155      "links": [
156        {
157          "method": "GET",
158          "rel": "up",
159          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
160          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
161          "type": "application/vnd.sas.collection",
162          "itemType": "application/vnd.sas.data.reference.domain.content"
163        },
164        {
165          "method": "GET",
166          "rel": "self",
167          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/0b242ce4-59dc-4c62-87b6-863ee756531e",
168          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/0b242ce4-59dc-4c62-87b6-863ee756531e",
169          "type": "application/vnd.sas.data.reference.domain.content"
170        },
171        {
172          "method": "GET",
173          "rel": "getEntries",
174          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/0b242ce4-59dc-4c62-87b6-863ee756531e/entries",
175          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/0b242ce4-59dc-4c62-87b6-863ee756531e/entries",
176          "type": "application/vnd.sas.collection",
177          "itemType": "application/vnd.sas.data.reference.domain.entry"
178        },
179        {
180          "method": "POST",
181          "rel": "createEntries",
182          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/0b242ce4-59dc-4c62-87b6-863ee756531e/entries",
183          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/0b242ce4-59dc-4c62-87b6-863ee756531e/entries",
184          "type": "application/vnd.sas.collection",
185          "responseType": "application/vnd.sas.collection",
186          "itemType": "application/vnd.sas.data.reference.domain.entry",
187          "responseItemType": "application/vnd.sas.data.reference.domain.entry"
188        },
189        {
190          "method": "DELETE",
191          "rel": "deleteEntries",
192          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/0b242ce4-59dc-4c62-87b6-863ee756531e/entries",
193          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/0b242ce4-59dc-4c62-87b6-863ee756531e/entries"
194        },
195        {
196          "method": "POST",
197          "rel": "checkOut",
198          "href": "/jobExecution/jobs",
199          "uri": "/jobExecution/jobs"
200        },
201        {
202          "method": "GET",
203          "rel": "checkouts",
204          "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/0b242ce4-59dc-4c62-87b6-863ee756531e/checkouts",
205          "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/0b242ce4-59dc-4c62-87b6-863ee756531e/checkouts",
206          "type": "application/vnd.sas.collection",
207          "itemType": "application/vnd.sas.summary"
208        }
209      ],
210      "standing": "future",
211      "majorNumber": 1,
212      "minorNumber": 2
213    }
214  ],
215  "links": [
216    {
217      "method": "GET",
218      "rel": "collection",
219      "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
220      "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
221      "type": "application/vnd.sas.collection",
222      "itemType": "application/vnd.sas.data.reference.domain.content"
223    },
224    {
225      "method": "GET",
226      "rel": "self",
227      "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents?filter=eq(domainId,%22f8600b44-092c-4095-a560-f4d2b90f1148%22)&sortBy=creationTimeStamp:ascending&start=0&limit=10",
228      "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents?filter=eq(domainId,%22f8600b44-092c-4095-a560-f4d2b90f1148%22)&sortBy=creationTimeStamp:ascending&start=0&limit=10",
229      "type": "application/vnd.sas.collection",
230      "itemType": "application/vnd.sas.data.reference.domain.content"
231    },
232    {
233      "method": "GET",
234      "rel": "up",
235      "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/",
236      "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/",
237      "type": "application/vnd.sas.data.reference.domain"
238    },
239    {
240      "method": "POST",
241      "rel": "createContent",
242      "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
243      "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
244      "type": "application/vnd.sas.data.reference.domain.content",
245      "responseType": "application/vnd.sas.data.reference.domain.content"
246    }
247  ],
248  "version": 2
249}

Path Parameters

Name	Type	Required	Description
domainId	string	true	The identifier for a specific domain or value list.

Query Parameters

Name	Type	Required	Description
filter	string<filter-criteria>	false	The filter criteria for the returned contents.
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	Sorting criteria for the returned contents. 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<media-type>	false	Used for selecting 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 domain content collection exists at the requested path.		Schema