Unmapped

unmapped

The Unmapped object contains an unmapped datum along with a label and type.

Contents

Attributes

Caption Name Type Is Array Default Description
Caption caption String A short description or label for the unmapped attribute.
Is Array is_array Boolean If true, the value is understood to be an array. Otherwise it is assumed to be a scalar.
Name name String The name of the unmapped attribute. This usually corresponds to a field name in the data provider. If no caption is provided, name will be used as a caption. The name attribute must be unique across all unmapped attributes of a record.
Type type String The type of data that is unmapped.
Value value JSON The unmapped attribute value.

References

Referenced By

Context

Unmapped

JSON

            
{
  "name": "unmapped",
  "caption": "Unmapped",
  "description": "The Unmapped object contains an unmapped datum along with a label and type.",
  "attributes": {
    "type": {
      "requirement": "required",
      "description": "The type of data that is unmapped.",
      "caption": "Type",
      "type": "string_t"
    },
    "name": {
      "requirement": "required",
      "description": "The name of the unmapped attribute. This usually corresponds to a field name in the data provider. If no caption is provided, name will be used as a caption. The name attribute must be unique across all unmapped attributes of a record.",
      "caption": "Name",
      "type": "string_t"
    },
    "value": {
      "requirement": "required",
      "description": "The unmapped attribute value.",
      "type": "json_t",
      "caption": "Value"
    },
    "caption": {
      "requirement": "optional",
      "description": "A short description or label for the unmapped attribute.",
      "caption": "Caption",
      "type": "string_t"
    },
    "is_array": {
      "requirement": "optional",
      "type": "boolean_t",
      "caption": "Is Array",
      "description": "If true, the value is understood to be an array. Otherwise it is assumed to be a scalar."
    }
  },
  "extension": "query"
}