Domain objects

Description

This topic discusses the JSON domain objects as returned by the REST API. Domains specify the set of valid values for a field.

The following domain objects are discussed here:

Range domain

Range domain specifies a range of valid values for a field. The type property for range domains is range.

JSON Response syntax

{
"type" : "range",
"name" : "<domainName>",
"range" : [ <minValue>, <maxValue> ]
}

JSON Response example

{
  "type": "range",
  "name": "Measured Length", 
  "range": [1,10000]
}

Coded value domain

Coded value domain specifies an explicit set of valid values for a field. Each valid value is assigned a unique name. The type property for coded value domains is codedValue.

JSON Response syntax

{
"type" : "codedValue",
"name" : "<domainName>",
"codedValues" : 
[
  { "name" : "<codeName1>", "code" : <code1> },
  { "name" : "<codeName2>", "code" : <code2> }
]
}

JSON Response example

{
 "type": "codedValue",
 "name": "Material",
 "codedValues": 
 [
     {
      "name": "Aluminum",
      "code": "AL"
     },
     {
      "name": "Copper",
      "code": "CU"
     },
     {
      "name": "Steel",
      "code": "STEL"
     },
     {
      "name": "Not Applicable",
      "code": "NA"
     }
  ]
}

Inherited domain

Inherited domains apply to domains on subtypes. It implies that the domain for a field at the subtype level is the same as the domain for the field at the layer level.

JSON Response syntax

{
"type" : "inherited"
}

JSON Response example

{
"type" : "inherited"
}

3/3/2017