Create new reference data domain or value list content

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 is specified and the minor is not, the minor number is assigned to zero if there is an increment in the major number. Otherwise, the minor number is incremented by one. You cannot use a major number that is lower 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, both are accepted only if the combination of the major and minor numbers is not lower 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 "links": [
15 {
16 "method": "GET",
17 "rel": "up",
18 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
19 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents",
20 "type": "application/vnd.sas.collection",
21 "itemType": "application/vnd.sas.data.reference.domain.content"
22 },
23 {
24 "method": "GET",
25 "rel": "self",
26 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee",
27 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee",
28 "type": "application/vnd.sas.data.reference.domain.content"
29 },
30 {
31 "method": "GET",
32 "rel": "getEntries",
33 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
34 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
35 "type": "application/vnd.sas.collection",
36 "itemType": "application/vnd.sas.data.reference.domain.entry"
37 },
38 {
39 "method": "POST",
40 "rel": "createEntries",
41 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
42 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/entries",
43 "type": "application/vnd.sas.collection",
44 "responseType": "application/vnd.sas.collection",
45 "itemType": "application/vnd.sas.data.reference.domain.entry",
46 "responseItemType": "application/vnd.sas.data.reference.domain.entry"
47 },
48 {
49 "method": "DELETE",
50 "rel": "deleteEntries",
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 },
54 {
55 "method": "DELETE",
56 "rel": "delete",
57 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee",
58 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee"
59 },
60 {
61 "method": "GET",
62 "rel": "checkouts",
63 "href": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/checkouts",
64 "uri": "/referenceData/domains/f8600b44-092c-4095-a560-f4d2b90f1148/contents/390be3d6-4320-4cb9-9365-17421a374bee/checkouts",
65 "type": "application/vnd.sas.collection",
66 "itemType": "application/vnd.sas.summary"
67 }
68 ]
69}

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 allows for the lineage of a domain or value list to be traced. The valid format for this parameter is '/referenceData/domains/${domainId}/contents/${contentId}'. The value of the fromRevisionUri is recorded in the sourceDomainRevisionUri member of the content.

inheritContentEntriesUri
string
false

When this parameter is used, the new content is created with entries. This URI identifies the domain or value list content from which the new domain or value list content will inherit entries. The valid format for this parameter is '/referenceData/domains/${domainId}/contents/${contentId}'. An empty value is treated as if the parameter is not used. If this parameter is used together with the fromRevisionUri parameter, their values must be identical. Unlike the fromRevisionUri parameter, the value of the inheritContentEntriesUri is not recorded in the content.

Request Body

Version of the domain or value list content. Use only label, status, majorNumber, and minorNumber.

The properties of a domain 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 instance of the domain. The choices are "developing", "candidate", "activating" and "production". However, "activating" is only a system assignable value.

standing
string
false

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

activationStatus
string
false

Indicates whether the domain content is being activated, is activated, or has failed to be activated.

activationError
string
false

When this field is present, the content has failed to be activated to one or more destination. This field carries error message for each of the failed destination.

keyLabel
string
false

The labels to be applied to the keys.

valueLabel
string
false

The labels to be applied to the values.

Responses

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