{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

• @baseType: string
  Read Only: true

  Allowed Values: [ "PhysicalResource", "LogicalResource" ]

  The list of valid values for the type of base resource.
• @type: string
  Allowed Values: [ "DeviceInterface", "Equipment", "EquipmentHolder", "LogicalDevice", "LogicalDeviceAccount", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPNetwork", "IPSubnet", "NetworkAddressDomain", "FlowIdentifier", "CustomObject", "CustomNetworkAddress", "Pipe", "PipeTerminationPoint", "Connectivity" ]

  The list of valid values for the resource type.
• category: string
  The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource.
• description: string
  A free-text description for the resource.
• endOperatingDate: string (date-time)
  The date and time when the resource is no longer effective.
• externalIdentity: object externalIdentity
  Read Only: true

  The external identity details for the federated resource.
• href: string (uri)
  Read Only: true

  The URI for the resource class.
• id: string
  The ID of the resource.
• lifecycleState: string
  Allowed Values: [ "END_OF_LIFE", "INSTALLED", "PENDING_INSTALL", "PENDING_REMOVE", "PENDING_UNAVAILABLE", "PENDING_AVAILABLE", "PLANNED", "UNAVAILABLE", "PENDING_DISCONNECT", "DISCONNECTED", "IN_DESIGN" ]

  The list of valid values for inventory state.
• lifecycleSubState: string
  Allowed Values: [ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]

  The list of valid values for assignment state.
• name: string
  The name of the resource.
• place: array place
  The list of associated geographic places.
• resourceCharacteristic: array resourceCharacteristic
  The list of characteristics for the resource.
• resourceRelationship: array resourceRelationship
  The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc.
• resourceSpecification: object Specification
  A specification.
• resourceStatus: string
  Allowed Values: [ "Standby", "Alarm", "Available", "Reserved", "Unknown", "Suspended" ]

  The list of valid values for resource status type, which indicates if entity has reservations.
• resourceVersion: string
  Read Only: true

  A field that identifies the version of a resource instance.
• startOperatingDate: string (date-time)
  Read Only: true

  The starting date and time when the resource becomes effective.

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

• object ExternalIdentity
  An external identity.

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ExternalIdentity"
        }
    ],
    "description":"The external identity details for the federated resource.",
    "readOnly":true
}

• Array of: object PlaceRef
  A place to associate with the resource/service.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PlaceRef"
    },
    "description":"The list of associated geographic places."
}

• Array of: object Characteristic
  A characteristic of an object or entity represented by a name-value pair.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Characteristic"
    },
    "description":"The list of characteristics for the resource."
}

• Array of: object ResourceRelationship
  A relationship to a resource.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceRelationship"
    },
    "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
}

• autoGenId: boolean
  The boolean value to indicate if id has to be auto-generated or entered manually by user.
• characteristics: array characteristics
  List of characteristics including hard attributes defined for the specification. Currently characteristics will be displayed only for Network/Pipe/PL/LD/PD/Equipment required for NPD. Only available hard attributes as per design studio layout are displayed.
• description: string
  Details about the specification.
• displayName: string
  The display name of the specification.
• endDate: string (date-time)
  The date and time when the specification ends.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• href: string (uri)
  The URI for the specification.
• id(required): string
  The ID of the specification, which is the same as the name of the specification.
• name: string
  The name of the specification.
• pageEditLayout: object PageLayout
  Layout information for Create and Edit Pages
• startDate: string (date-time)
  The date and time when the specification starts.
• version: string
  The version of the specification, which is always 1.

{
    "type":"object",
    "description":"A specification.",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the specification, which is the same as the name of the specification."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the specification."
        },
        "name":{
            "type":"string",
            "description":"The name of the specification."
        },
        "displayName":{
            "type":"string",
            "description":"The display name of the specification."
        },
        "description":{
            "type":"string",
            "description":"Details about the specification."
        },
        "version":{
            "type":"string",
            "description":"The version of the specification, which is always <b>1</b>."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the specification starts."
        },
        "endDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the specification ends."
        },
        "autoGenId":{
            "type":"boolean",
            "description":"The boolean value to indicate if id has to be auto-generated or entered manually by user."
        },
        "characteristics":{
            "type":"array",
            "description":"List of characteristics including hard attributes defined for the specification. Currently characteristics will be displayed only for Network/Pipe/PL/LD/PD/Equipment required for NPD. Only available hard attributes as per design studio layout are displayed.",
            "items":{
                "$ref":"#/components/schemas/CharacteristicSpecification"
            }
        },
        "pageEditLayout":{
            "$ref":"#/components/schemas/PageLayout"
        }
    }
}

• externalArrangement: string
  Allowed Values: [ "LEASED_IN", "FEDERATED", "LEASED_OUT", "SHARED" ]

  The type of federation model between UIM and the external party for the given entity.
• externalManagementDomain: string
  The external system, domain name, party, or participant in a federation solution.
• externalName: string
  The business-meaningful name of the business entity.
• externalObjectId: string
  The ID for a business entity.

{
    "type":"object",
    "description":"An external identity.",
    "properties":{
        "externalObjectId":{
            "type":"string",
            "description":"The ID for a business entity."
        },
        "externalName":{
            "type":"string",
            "description":"The business-meaningful name of the business entity."
        },
        "externalManagementDomain":{
            "type":"string",
            "description":"The external system, domain name, party, or participant in a federation solution."
        },
        "externalArrangement":{
            "type":"string",
            "description":"The type of federation model between UIM and the external party for the given entity.",
            "enum":[
                "LEASED_IN",
                "FEDERATED",
                "LEASED_OUT",
                "SHARED"
            ]
        }
    }
}

• @referredType: string
  Allowed Values: [ "GeographicAddress", "GeographicLocation", "GeographicSite", "PropertyLocation", "NetworkEntityCode" ]

  The list of valid values for place referred type.
• href: string (uri)
  The URI for the place.
• id: string
  The ID of the place.
• name: string
  The name of the place.
• referrerRole: string
  The role of the associated resource.
• role: string
  The role of the place.

{
    "type":"object",
    "description":"A place to associate with the resource/service.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the place."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the place."
        },
        "name":{
            "type":"string",
            "description":"The name of the place."
        },
        "@referredType":{
            "$ref":"#/components/schemas/PlaceReferredTypeEnum"
        },
        "role":{
            "type":"string",
            "description":"The role of the place."
        },
        "referrerRole":{
            "type":"string",
            "description":"The role of the associated resource."
        }
    }
}

• @schemaLocation: string (uri)
  The URI for the JSON Schema file that defines additional attributes and relationships.
• @type: string
  The entity type of the object. This is useful for EntityLink characters and when the value is set with an actual object and the valueType is an object.
• code: string
  The enumeration code in case of enum type characteristics.
• displayName: string
  The display label of the charatcteristic.
• name(required): string
  The name of the characteristic.
• value(required): object value
  The value of the characteristic.
• valueType: string
  Allowed Values: [ "ALPHANUMERIC", "NUMERIC", "BOOLEAN", "DATE", "OBJECT", "URL" ]

  The data type for the characteristics's value.

{
    "type":"object",
    "description":"A characteristic of an object or entity represented by a name-value pair.",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the characteristic."
        },
        "displayName":{
            "type":"string",
            "description":"The display label of the charatcteristic."
        },
        "valueType":{
            "type":"string",
            "description":"The data type for the characteristics's value.",
            "enum":[
                "ALPHANUMERIC",
                "NUMERIC",
                "BOOLEAN",
                "DATE",
                "OBJECT",
                "URL"
            ]
        },
        "code":{
            "type":"string",
            "description":"The enumeration code in case of enum type characteristics."
        },
        "value":{
            "type":"object",
            "description":"The value of the characteristic."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI for the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The entity type of the object. This is useful for EntityLink characters and when the value is set with an actual object and the <b>valueType</b> is an object."
        }
    }
}

• fromRole: string
  The role name for the from-resource. Applies only to INVOLVE relationship types.
• relationshipType: string
  Allowed Values: [ "ASSOCIATES", "MAPPEDTO", "PARENT", "CHILD", "INVOLVE", "ASSIGN", "CONSUMER" ]

  The list of valid values for relationship type.
• resourceRef: object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• toRole: string
  The role name for the to-resource. Applies only to INVOLVE relationship types.

{
    "type":"object",
    "description":"A relationship to a resource.",
    "properties":{
        "relationshipType":{
            "$ref":"#/components/schemas/RelationshipTypeEnum"
        },
        "resourceRef":{
            "$ref":"#/components/schemas/ResourceBase"
        },
        "fromRole":{
            "type":"string",
            "description":"The role name for the from-resource. Applies only to INVOLVE relationship types."
        },
        "toRole":{
            "type":"string",
            "description":"The role name for the to-resource. Applies only to INVOLVE relationship types."
        }
    }
}

• Array of: object CharacteristicSpecification
  A characteristic of an object or entity represented by a name-value pair.

{
    "type":"array",
    "description":"List of characteristics including hard attributes defined for the specification. Currently characteristics will be displayed only for Network/Pipe/PL/LD/PD/Equipment required for NPD. Only available hard attributes as per design studio layout are displayed.",
    "items":{
        "$ref":"#/components/schemas/CharacteristicSpecification"
    }
}

• pageName: string
  Name of the panel chosed in Layout
• sections: array SectionLayoutArr

{
    "type":"object",
    "description":"Layout information for Create and Edit Pages",
    "properties":{
        "pageName":{
            "type":"string",
            "description":"Name of the panel chosed in Layout"
        },
        "sections":{
            "$ref":"#/components/schemas/SectionLayoutArr"
        }
    }
}

• controlType: controlType
• displayName: string
  The display name of the characteristic.
• isHardAttribute: boolean
• isRequired: boolean
  The requirement of the element
• name(required): string
  The name of the characteristic.
• primitiveType: string
  Allowed Values: [ "BOOLEAN", "DATE", "DATETIME", "DECIMAL", "DOUBLE", "FLOAT", "HEXBINARY", "INTEGER", "LONG", "STRING", "TIME" ]

  The data type for the characteristics's value.
• valueChangeListener: boolean
  Indicates if it is parent char and there are dependent chars when value is enterted for this char.

{
    "type":"object",
    "description":"A characteristic of an object or entity represented by a name-value pair.",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the characteristic."
        },
        "isHardAttribute":{
            "type":"boolean"
        },
        "primitiveType":{
            "type":"string",
            "description":"The data type for the characteristics's value.",
            "enum":[
                "BOOLEAN",
                "DATE",
                "DATETIME",
                "DECIMAL",
                "DOUBLE",
                "FLOAT",
                "HEXBINARY",
                "INTEGER",
                "LONG",
                "STRING",
                "TIME"
            ]
        },
        "displayName":{
            "type":"string",
            "description":"The display name of the characteristic."
        },
        "controlType":{
            "oneOf":[
                {
                    "$ref":"#/components/schemas/DropDownCharSpec"
                },
                {
                    "$ref":"#/components/schemas/TextCharSpec"
                },
                {
                    "$ref":"#/components/schemas/URLCharSpec"
                },
                {
                    "$ref":"#/components/schemas/CalendarCharSpec"
                },
                {
                    "$ref":"#/components/schemas/NumericCharSpec"
                },
                {
                    "$ref":"#/components/schemas/CheckboxCharSpec"
                }
            ]
        },
        "isRequired":{
            "type":"boolean",
            "description":"The requirement of the element"
        },
        "valueChangeListener":{
            "type":"boolean",
            "description":"Indicates if it is parent char and there are dependent chars when value is enterted for this char."
        }
    }
}

• object DropDownCharSpec
  List of attributes applicable only if Characteristic is of type dropdown.
• object TextCharSpec
  List of attributes applicable only if Characteristic is of control type text.
• object URLCharSpec
  List of attributes applicable only if Characteristic is of control type URL.
• object CalendarCharSpec
  List of attributes applicable only if Characteristic is of control type Calendar.
• object NumericCharSpec
  List of attributes applicable only if Characteristic is of control type Numeric.
• object CheckboxCharSpec
  List of attributes applicable only if Characteristic is of control type Checkbox.

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/DropDownCharSpec"
        },
        {
            "$ref":"#/components/schemas/TextCharSpec"
        },
        {
            "$ref":"#/components/schemas/URLCharSpec"
        },
        {
            "$ref":"#/components/schemas/CalendarCharSpec"
        },
        {
            "$ref":"#/components/schemas/NumericCharSpec"
        },
        {
            "$ref":"#/components/schemas/CheckboxCharSpec"
        }
    ]
}

• @type: string
  Allowed Values: [ "DropDown", "Text", "URL", "Calendar", "Numeric", "Checkbox" ]

  The list of valid values for the control type.
• defaultValue: string
  The default value from the enumeration options.
• enumerationOptions: array enumerationOptions
  The list of options.
• options: string
  Allowed Values: [ "ENUMERATIONS", "ENTITYLINK", "QUERY" ]

  The dropdown option for the element.
• sort: string
  Allowed Values: [ "ALPHANUMERIC", "NUMERIC" ]

  The sorting order of the enumeration options.

{
    "type":"object",
    "description":"List of attributes applicable only if Characteristic is of type dropdown.",
    "properties":{
        "@type":{
            "$ref":"#/components/schemas/ControlTypeEnum"
        },
        "options":{
            "type":"string",
            "description":"The dropdown option for the element.",
            "enum":[
                "ENUMERATIONS",
                "ENTITYLINK",
                "QUERY"
            ]
        },
        "sort":{
            "type":"string",
            "description":"The sorting order of the enumeration options.",
            "enum":[
                "ALPHANUMERIC",
                "NUMERIC"
            ]
        },
        "enumerationOptions":{
            "type":"array",
            "description":"The list of options.",
            "items":{
                "$ref":"#/components/schemas/Enumerations"
            }
        },
        "defaultValue":{
            "type":"string",
            "description":"The default value from the enumeration options."
        }
    }
}

• @type: string
  Allowed Values: [ "DropDown", "Text", "URL", "Calendar", "Numeric", "Checkbox" ]

  The list of valid values for the control type.
• case: string
  Allowed Values: [ "MIXED", "UPPER", "LOWER" ]

  The case of the characteristic.
• defaultValue: string
  The default value of the characteristic.
• defaultValueLocalized: string
  The localized default value of the characteristic.
• displayMask: string
  The displayMask of the characteristic.
• editMask: string
  The editMask of the characteristic.
• isReadOnly: boolean
  Indicates if element is read only.
• isSensitive: boolean
  Indicates if element is to be hidden.
• maxLength: integer
  The maximum length of the characteristic.
• minLength: integer
  The minimum length of the characteristic.

{
    "type":"object",
    "description":"List of attributes applicable only if Characteristic is of control type text.",
    "properties":{
        "@type":{
            "$ref":"#/components/schemas/ControlTypeEnum"
        },
        "isSensitive":{
            "type":"boolean",
            "description":"Indicates if element is to be hidden."
        },
        "isReadOnly":{
            "type":"boolean",
            "description":"Indicates if element is read only."
        },
        "displayMask":{
            "type":"string",
            "description":"The displayMask of the characteristic."
        },
        "editMask":{
            "type":"string",
            "description":"The editMask of the characteristic."
        },
        "case":{
            "type":"string",
            "description":"The case of the characteristic.",
            "enum":[
                "MIXED",
                "UPPER",
                "LOWER"
            ]
        },
        "minLength":{
            "type":"integer",
            "description":"The minimum length of the characteristic."
        },
        "maxLength":{
            "type":"integer",
            "description":"The maximum length of the characteristic."
        },
        "defaultValue":{
            "type":"string",
            "description":"The default value of the characteristic."
        },
        "defaultValueLocalized":{
            "type":"string",
            "description":"The localized default value of the characteristic."
        }
    }
}

• @type: string
  Allowed Values: [ "DropDown", "Text", "URL", "Calendar", "Numeric", "Checkbox" ]

  The list of valid values for the control type.
• defaultValue: string
  The default value of the URL char
• isReadOnly: boolean
  The readOnly of the URL char

{
    "type":"object",
    "description":"List of attributes applicable only if Characteristic is of control type URL.",
    "properties":{
        "@type":{
            "$ref":"#/components/schemas/ControlTypeEnum"
        },
        "isReadOnly":{
            "type":"boolean",
            "description":"The readOnly of the URL char"
        },
        "defaultValue":{
            "type":"string",
            "description":"The default value of the URL char"
        }
    }
}

• @type: string
  Allowed Values: [ "DropDown", "Text", "URL", "Calendar", "Numeric", "Checkbox" ]

  The list of valid values for the control type.
• defaultValue: string
  The default value of the Calendar char.
• fromDateRange: string
  The end date range of the Calendar char.
• isReadOnly: boolean
  The readOnly of the Calendar char.
• toDateRange: string
  The start date range of the Calendar char.

{
    "type":"object",
    "description":"List of attributes applicable only if Characteristic is of control type Calendar.",
    "properties":{
        "@type":{
            "$ref":"#/components/schemas/ControlTypeEnum"
        },
        "isReadOnly":{
            "type":"boolean",
            "description":"The readOnly of the Calendar char."
        },
        "toDateRange":{
            "type":"string",
            "description":"The start date range of the Calendar char."
        },
        "fromDateRange":{
            "type":"string",
            "description":"The end date range of the Calendar char."
        },
        "defaultValue":{
            "type":"string",
            "description":"The default value of the Calendar char."
        }
    }
}

• @type: string
  Allowed Values: [ "DropDown", "Text", "URL", "Calendar", "Numeric", "Checkbox" ]

  The list of valid values for the control type.
• defaultValue: integer
  The default value of the Numeric char.
• displayMask: string
  The display mask of the Numeric char.
• editMask: string
  The edit mask of the Numeric char.
• isReadOnly: boolean
  The readOnly of the Numeric char.
• isSensitive: boolean
  The sensitive of the Numeric char.
• maxValue: integer
  The maximum value of the Numeric char.
• minValue: integer
  The minimum value of the Numeric char.

{
    "type":"object",
    "description":"List of attributes applicable only if Characteristic is of control type Numeric.",
    "properties":{
        "@type":{
            "$ref":"#/components/schemas/ControlTypeEnum"
        },
        "isSensitive":{
            "type":"boolean",
            "description":"The sensitive of the Numeric char."
        },
        "isReadOnly":{
            "type":"boolean",
            "description":"The readOnly of the Numeric char."
        },
        "displayMask":{
            "type":"string",
            "description":"The display mask of the Numeric char."
        },
        "editMask":{
            "type":"string",
            "description":"The edit mask of the Numeric char."
        },
        "minValue":{
            "type":"integer",
            "description":"The minimum value of the Numeric char."
        },
        "maxValue":{
            "type":"integer",
            "description":"The maximum value of the Numeric char."
        },
        "defaultValue":{
            "type":"integer",
            "description":"The default value of the Numeric char."
        }
    }
}

• @type: string
  Allowed Values: [ "DropDown", "Text", "URL", "Calendar", "Numeric", "Checkbox" ]

  The list of valid values for the control type.
• defaultValue: boolean
  The default value of the Checkbox char.
• isReadOnly: boolean
  The readOnly of the Checkbox char.

{
    "type":"object",
    "description":"List of attributes applicable only if Characteristic is of control type Checkbox.",
    "properties":{
        "@type":{
            "$ref":"#/components/schemas/ControlTypeEnum"
        },
        "isReadOnly":{
            "type":"boolean",
            "description":"The readOnly of the Checkbox char."
        },
        "defaultValue":{
            "type":"boolean",
            "description":"The default value of the Checkbox char."
        }
    }
}

• Array of: object Enumerations

{
    "type":"array",
    "description":"The list of options.",
    "items":{
        "$ref":"#/components/schemas/Enumerations"
    }
}

• code: string
  Key for the enum element.
• default: boolean
  Indicates if the code is default selected attribute in dropdown.
• description: string
  Description for the enum element.
• language: string
  The language of the element.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Key for the enum element."
        },
        "description":{
            "type":"string",
            "description":"Description for the enum element."
        },
        "default":{
            "type":"boolean",
            "description":"Indicates if the code is default selected attribute in dropdown."
        },
        "language":{
            "type":"string",
            "description":"The language of the element."
        }
    }
}

• Array of: object SectionLayout

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SectionLayout"
    }
}

• elements: array elements
  The elements of the section.
• localizedSectionNames: array localizedSectionNames
  The localized name of the section. This is for internal usage.
• localizedSectionToolTip: array localizedSectionToolTip
  Localized Tool Tip of the section. This is for internal usage.
• sectionName: string
  The localized name of the section.
• sectionTooltip: string
  The localized tool tip of the section.

{
    "type":"object",
    "properties":{
        "sectionName":{
            "type":"string",
            "description":"The localized name of the section."
        },
        "sectionTooltip":{
            "type":"string",
            "description":"The localized tool tip of the section."
        },
        "localizedSectionNames":{
            "type":"array",
            "description":"The localized name of the section. This is for internal usage.",
            "items":{
                "$ref":"#/components/schemas/LocalizedSpec"
            }
        },
        "localizedSectionToolTip":{
            "type":"array",
            "description":"Localized Tool Tip of the section. This is for internal usage.",
            "items":{
                "$ref":"#/components/schemas/LocalizedSpec"
            }
        },
        "elements":{
            "type":"array",
            "description":"The elements of the section.",
            "items":{
                "$ref":"#/components/schemas/RowLayoutArr"
            }
        }
    }
}

• Array of: array RowLayoutArr

{
    "type":"array",
    "description":"The elements of the section.",
    "items":{
        "$ref":"#/components/schemas/RowLayoutArr"
    }
}

• Array of: object LocalizedSpec

{
    "type":"array",
    "description":"The localized name of the section. This is for internal usage.",
    "items":{
        "$ref":"#/components/schemas/LocalizedSpec"
    }
}

• Array of: object LocalizedSpec

{
    "type":"array",
    "description":"Localized Tool Tip of the section. This is for internal usage.",
    "items":{
        "$ref":"#/components/schemas/LocalizedSpec"
    }
}

• Array of: object ComponentSpecification

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ComponentSpecification"
    }
}

• case: string
  The case of the element. Possible values are MIXED,UPPER,LOWER.
• defaultValue: string
  The default Value of the element.
• displayMask: string
  The displayMask of the element.
• displayName: string
  The localized display name of the element.
• editMask: string
  The editMask of the element.
• elementName: string
  The name of the hard attribute or char name.
• fromDateRange: string
  The end date Range of the element for Date Chars.
• isExternal: boolean
  Applicable only for URL Chars. Indicates if URL to be opened in new tab.
• isHardAttribute: boolean
  Indicates if element is hard attribute or not.
• isReadOnly: boolean
  Indicates if element is read only.
• isRequired: boolean
  Indicates if element is required.
• isSensitive: boolean
  Indicates if element has to be hidden.
• localizedDisplayNames: array localizedDisplayNames
  The localized display names of the element. This is for internal usage.
• localizedToolTips: array localizedToolTips
  The localized tool tips of the element. This is for internal usage.
• maxValue: string
  The maximum value of the element.
• minValue: string
  The minimum value of the element.
• sort: string
  Allowed Values: [ "ALPHANUMERIC", "NUMERIC" ]

  Applicable only for Enum chars.
• toDateRange: string
  The start date Range of the element for Date Chars.
• tooltip: string
  The localized tooltip of the element.

{
    "type":"object",
    "properties":{
        "elementName":{
            "type":"string",
            "description":"The name of the hard attribute or char name."
        },
        "isHardAttribute":{
            "type":"boolean",
            "description":"Indicates if element is hard attribute or not."
        },
        "displayName":{
            "type":"string",
            "description":"The localized display name of the element."
        },
        "tooltip":{
            "type":"string",
            "description":"The localized tooltip of the element."
        },
        "localizedDisplayNames":{
            "type":"array",
            "description":"The localized display names of the element. This is for internal usage.",
            "items":{
                "$ref":"#/components/schemas/LocalizedSpec"
            }
        },
        "localizedToolTips":{
            "type":"array",
            "description":"The localized tool tips of the element. This is for internal usage.",
            "items":{
                "$ref":"#/components/schemas/LocalizedSpec"
            }
        },
        "isRequired":{
            "type":"boolean",
            "description":"Indicates if element is required."
        },
        "isSensitive":{
            "type":"boolean",
            "description":"Indicates if element has to be hidden."
        },
        "isExternal":{
            "type":"boolean",
            "description":"Applicable only for URL Chars. Indicates if URL to be opened in new tab."
        },
        "isReadOnly":{
            "type":"boolean",
            "description":"Indicates if element is read only."
        },
        "displayMask":{
            "type":"string",
            "description":"The displayMask of the element."
        },
        "editMask":{
            "type":"string",
            "description":"The editMask of the element."
        },
        "case":{
            "type":"string",
            "description":"The case of the element. Possible values are MIXED,UPPER,LOWER."
        },
        "toDateRange":{
            "type":"string",
            "description":"The start date Range of the element for Date Chars."
        },
        "fromDateRange":{
            "type":"string",
            "description":"The end date Range of the element for Date Chars."
        },
        "minValue":{
            "type":"string",
            "description":"The minimum value of the element."
        },
        "maxValue":{
            "type":"string",
            "description":"The maximum value of the element."
        },
        "sort":{
            "type":"string",
            "description":"Applicable only for Enum chars.",
            "enum":[
                "ALPHANUMERIC",
                "NUMERIC"
            ]
        },
        "defaultValue":{
            "type":"string",
            "description":"The default Value of the element."
        }
    }
}

• Array of: object LocalizedSpec

{
    "type":"array",
    "description":"The localized display names of the element. This is for internal usage.",
    "items":{
        "$ref":"#/components/schemas/LocalizedSpec"
    }
}

• Array of: object LocalizedSpec

{
    "type":"array",
    "description":"The localized tool tips of the element. This is for internal usage.",
    "items":{
        "$ref":"#/components/schemas/LocalizedSpec"
    }
}

• language: string
  Language of the element.
• value: string
  Value of the element.

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"Value of the element."
        },
        "language":{
            "type":"string",
            "description":"Language of the element."
        }
    }
}

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}