# Fields Definition

This section describes how fields can be defined. It is used in several JSON objects of the platform like Operations Catalog, Device Datamodels, IoT Datastream templates, etc.

# Elements of this definition

type & subtype definition available values

string
  • Subtype:
    • text
    • password
  • Description: Text based value
boolean
  • Subtype:
  • Description: Boolean based value. Exmaples: true or false
string
calendar
  • Subtype:
    • datetime
    • date
    • time
  • Description: Format is described in the ISO 8601 or in http://www.w3.org/TR/NOTE-datetime. Examples: _ datetime: "1997-07-16T19:20:30+01:00" _ date: "1997-07-16" * time: "19:20:30+01:00"
address
  • Subtype:
    • ip
    • ipv4
    • ipv6
    • mac48
  • Description: Network address value
number
  • Subtype:
    • text
    • password
  • Description: Numeric value
enumeration
  • Subtype:
    • string
    • number
  • Description: Choice list values
array
  • Subtype:
    • string
    • number
  • Description: Array of values.
coordinates
  • Subtype:

    • geo
    • geotime
    • geojson
  • Description: Object indicating coordinates and timestamp in geotime subtype. Example:

    _geo (["longitude","latitude"])

    [-3.700345, 40.416691]
    

    geotime

    {
      "timestamp": "1997-07-16T19:20:30+01:00",
      "latitude": 40.416691,
      "longitude": -3.700345
    }
    

    _geojson (described in the RFC 7946. Visithttps://tools.ietf.org/html/rfc7946)

    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [-3.700345, 40.416691]
      },
      "properties": {
        "name": "Madrid-Spain"
      }
    }
    
topology
  • Subtype:

    • path
    • tree (not supported yet)
  • Description: Object indicating relations. See following examples: path

    ["granparent_1", "parent_1"]
    
object
  • Subtype:
    • None
  • Description: Not yet supported. For future uses only

# Atributes of this definition

field definition attributes object

list[]
  • Description: It is an array with the values available when "type": "enumeration"
visible
  • Description: Takes values as true or false and indicates that the field must be visible or not
editable
  • Description: Takes values as true or false and indicates that the field must be editable or not
DETAILS
gte
  • Description: Greater and Equal Than. Used when type or subtype is "number". Indicates the value range the field can take
lte
  • Description: Lower and Equal Than. Used when type or subtype is "number". Indicates the value range the field can take
gt
  • Description: Greater Than. Used when type or subtype is "number". Indicates the value range the field can take
lt
  • Description: Lower Than. Used when type or subtype is "number". Indicates the value range the field can take