Create new reference data domain or value list content with entries

post/domains/{domainId}/contents
Internal-Use Only

The status is used to determine the standing of this content among the collection of contents. If the status is "production", the standing is current. The standing of the current production version is changed to "legacy". For other status values, the standing of the version is future. When the standing of the version is "future", the status is changed to "inactive". In a collection there is at most, one current and one future version at any time.

The major and minor numbers are optional. Here is how the major and minor numbers are used: If both of them are omitted, the server assigns the major number to one and the minor number to zero. If the major number is specified and the minor number is not, the minor number is assigned to zero if the major number is incremented. Otherwise, the minor number is incremented by one. You cannot use a major number that is less than the current major number. If the major number is omitted and the minor is specified, the major number is incremented by one. If both are specified, they are accepted only if the combination of the major and minor numbers is not less than the current combination. The key and value labels are optional.

Request Samples

1

Response Samples

1{
2 "creationTimeStamp": "2022-02-25T13:40:09.565Z",
3 "modifiedTimeStamp": "2022-02-25T13:40:54.026Z",
4 "createdBy": "siduser",
5 "modifiedBy": "siduser",
6 "id": "390be3d6-4320-4cb9-9365-17421a374bee",
7 "label": "lookup1.0",
8 "status": "developing",
9 "keyLabel": "Severity",
10 "valueLabel": "SLA Class",
11 "standing": "inactive",
12 "majorNumber": 1,
13 "minorNumber": 1,
14 "entries": [
15 {
16 "key": "A",
17 "value": "1"
18 },
19 {
20 "key": "B",
21 "value": "2"
22 }
23 ],
24 "links": [
25 {
26 "method": "GET",
27 "rel": "up",
28 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
29 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
30 "type": "application/vnd.sas.collection",
31 "itemType": "application/vnd.sas.data.reference.domain.content"
32 },
33 {
34 "method": "GET",
35 "rel": "self",
36 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee",
37 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee",
38 "type": "application/vnd.sas.data.reference.domain.content.full"
39 },
40 {
41 "method": "GET",
42 "rel": "getEntries",
43 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
44 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
45 "type": "application/vnd.sas.collection",
46 "itemType": "application/vnd.sas.data.reference.domain.entry"
47 },
48 {
49 "method": "POST",
50 "rel": "createEntries",
51 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
52 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
53 "type": "application/vnd.sas.collection",
54 "responseType": "application/vnd.sas.collection",
55 "itemType": "application/vnd.sas.data.reference.domain.entry",
56 "responseItemType": "application/vnd.sas.data.reference.domain.entry"
57 },
58 {
59 "method": "DELETE",
60 "rel": "deleteEntries",
61 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
62 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries"
63 },
64 {
65 "method": "DELETE",
66 "rel": "delete",
67 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee",
68 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee"
69 },
70 {
71 "method": "GET",
72 "rel": "checkouts",
73 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/checkouts",
74 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/checkouts",
75 "type": "application/vnd.sas.collection",
76 "itemType": "application/vnd.sas.summary"
77 }
78 ]
79}

Path Parameters

NameTypeRequiredDescription
domainId
string
true

The identifier for a specific domain or value list.

Query Parameters

NameTypeRequiredDescription
fromRevisionUri
string
false

This value specifies the URI of the domain or value list content that the new domain or value list content is being created from. This property enables the lineage of a domain to be traced. The valid format for this parameter is '/referenceData/domains/${domainId}/contents/${contentId}'.

Request Body

The full version of the domain or value list content. Use only label, status, majorNumber, minorNumber, and entries.

The properties of a domain content and the data stored in the content.

NameTypeRequiredDescription
label
string
false

A text string appropriate for this instance of the domain.

majorNumber
integer
false

The major version number.

minorNumber
integer
false

The minor version number.

status
string
false

The status of this domain instance. Valid values are "developing", "candidate", "activating" and "production". However, "activating" is only a system assignable value.

Allowed values:
developingcandidateactivatingproduction
standing
string
false

The system assigned value for this domain instance. The system assigned values are "inactive", "legacy", "current", or "future". This value compares one instance to another.

Allowed values:
inactivelegacycurrentfuture
activationStatus
string
false

Indicates whether the domain content is being activated, is activated, or could not be activated.

activationError
string
false

When this field is present, the content could not be activated for one or more destinations. This field contains an error message for each of the destination where the content could not be activated.

keyLabel
string
false

The label to be applied to the keys. This property is optional.

valueLabel
string
false

The labels to be applied to the values. This property is optional.

entries
array [Domain Entry]
false

Zero or more domain entries.

Responses

StatusMeaningDescription
201CreatedA new domain or value list content was created.HeadersSchema
400Bad RequestThe request was invalid.Schema
404Not FoundNo domain content exists at the requested path.Schema