Create a new reference data domain or value list

post/domains

Internal-Use Only

The domain or value list is created after a successful post. The child contents collection is empty. All domain or value list names must be unique. Domain or value lists in the same folder must have unique names. Domain or value lists not in any folder must also have unique names.

Request Samples

application/json
1

Response Samples

201
application/json
1{
2  "id": "f8600b44-092c-4095-a560-f4d2b90f1148",
3  "name": "serviceLevel",
4  "description": "The service level designation.",
5  "domainType": "lookup",
6  "checkOut": false,
7  "creationTimeStamp": "2022-02-25T13:39:01.556000Z",
8  "modifiedTimeStamp": "2022-02-25T13:46:07.466000Z",
9  "createdBy": "siduser",
10  "modifiedBy": "siduser",
11  "codeName": "7BQAWRAJFRAJLJLA6TJLSDYRJA",
12  "formatName": "$L7BQAWRAJFRAJLJLA6TJLSDYRJA_K",
13  "packageName": "l7bqawrajfrajljla6tjlsdyrja",
14  "folderType": "folder",
15  "version": 1,
16  "links": [
17    {
18      "method": "GET",
19      "rel": "self",
20      "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148",
21      "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148",
22      "type": "application/vnd.sas.data.reference.domain"
23    },
24    {
25      "method": "GET",
26      "rel": "alternate",
27      "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148",
28      "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148",
29      "type": "application/vnd.sas.summary"
30    },
31    {
32      "method": "PUT",
33      "rel": "update",
34      "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148",
35      "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148",
36      "type": "application/vnd.sas.data.reference.domain",
37      "responseType": "application/vnd.sas.data.reference.domain"
38    },
39    {
40      "method": "DELETE",
41      "rel": "delete",
42      "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148",
43      "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148"
44    },
45    {
46      "method": "GET",
47      "rel": "getContents",
48      "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
49      "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
50      "type": "application/vnd.sas.collection",
51      "itemType": "application/vnd.sas.data.reference.domain.content"
52    },
53    {
54      "method": "POST",
55      "rel": "createContent",
56      "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
57      "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
58      "type": "application/vnd.sas.data.reference.domain.content",
59      "responseType": "application/vnd.sas.data.reference.domain.content"
60    },
61    {
62      "method": "GET",
63      "rel": "currentContents",
64      "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/currentContents",
65      "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/currentContents",
66      "type": "application/vnd.sas.collection",
67      "itemType": "application/vnd.sas.data.reference.domain.content.history"
68    },
69    {
70      "method": "GET",
71      "rel": "currentContentsCompleteHistory",
72      "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/currentContents?scope=all",
73      "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/currentContents?scope=all",
74      "type": "application/vnd.sas.collection",
75      "itemType": "application/vnd.sas.data.reference.domain.content.history"
76    },
77    {
78      "method": "GET",
79      "rel": "up",
80      "href": "/referenceData/domains",
81      "uri": "/referenceData/domains",
82      "type": "application/vnd.sas.collection",
83      "itemType": "application/vnd.sas.data.reference.domain"
84    }
85  ]
86}

Query Parameters

Name	Type	Required	Description
parentFolderUri	string	false	Adds the domain or value list as a member of a folder.

Request Body

The domain representation. Use only the name, description, and domainType.

The properties of a domain.

Name	Type	Required	Description
id	string	false	The system-assigned unique ID for this object.
name	string	false	The name of the domain.
codeName	string	false	The system-assigned encoded version of the name that uses only certain characters from the English alphabet and the Arabic numerals.
formatName	string	false	This is the name of a Cloud Analytic Service format when this domain is published to the Cloud Analytic Service.
packageName	string	false	This is the name of a DS2 package when this domain is published to the Micro Analytic Score service.
domainType	string	false	The type of the domain.The value is "lookup".
description	string	false	The description about the domain.
creationTimeStamp	string<date-time>	false	Timestamp when this domain is created. This field is a derived field and not required for PUT and POST.
modifiedTimeStamp	string<date-time>	false	Timestamp when this domain is last modified. This field is a derived field and not required for PUT and POST.
createdBy	string	false	ID of the user who created this domain. This field is a derived field and not required for PUT and POST.
modifiedBy	string	false	ID of the user who last modified this domain. This field is a derived field and not required for PUT and POST.
checkout	boolean	false	Flag that indicates this domain is a working copy of another domain.
folderType	string	false	Indicates the type of folder where the domain is housed.
links	array [Link]	false	Zero or more link objects.

Responses

Status	Meaning	Description
201	Created	A new domain or value list was created.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
404	Not Found	No resource exists at the requested path.		Schema