AARCHMRS Schema 2.7.4

↚ Home

Fields.ReservedInternal object

A ReservedInternal field is a field that is reserved for future use, and converted later into a Reserved field.

object

Properties Type Description
_meta Meta
See Meta for more information.
_type
Enum
Fields.ReservedInternal
rangeset Rangeset
See properties.rangeset in Fields.Field for more information.
reserved_by
  • string
  • null

The name of the person that has reserved this.

reserved_for
  • string
  • null

The profile or extension this field is reserved for.

value Enums.ReservedTypes

A constant value for the the field representing the reserved type.

See Enums.ReservedTypes for more information.
Additional Properties
Allowed
◊ Required
Properties marked with ◊ are required properties.
Examples
{
    "_type": "Fields.ReservedInternal", 
    "rangeset": [
        {
            "_type": "Range", 
            "start": 0, 
            "width": 8
        }
    ], 
    "value": "RES0", 
    "reserved_by": "James bond", 
    "reserved_for": "FEAT_007"
}

Schema http://json-schema.org/draft-04/schema#

{
  "additionalProperties": true,
  "examples": [
    {
      "_type": "Fields.ReservedInternal",
      "rangeset": [
        {
          "_type": "Range",
          "start": 0,
          "width": 8
        }
      ],
      "value": "RES0",
      "reserved_by": "James bond",
      "reserved_for": "FEAT_007"
    }
  ],
  "info": [
    [
      "A ReservedInternal field is a field that is reserved for future use, and converted later",
      "into a Reserved field."
    ]
  ],
  "properties": {
    "_meta": {
      "$ref": "../Meta.json"
    },
    "_type": {
      "enum": [
        "Fields.ReservedInternal"
      ]
    },
    "rangeset": {
      "see": "../Fields/Field.json",
      "$ref": "../Rangeset.json"
    },
    "reserved_by": {
      "info": [
        "The name of the person that has reserved this."
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "reserved_for": {
      "info": [
        "The profile or extension this field is reserved for."
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "value": {
      "info": [
        "A constant value for the the field representing the reserved type."
      ],
      "$ref": "../Enums/ReservedTypes.json"
    }
  },
  "required": [
    "rangeset",
    "value"
  ],
  "title": "ReservedInternal",
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema#"
}