Smart Data models IoTGateway schema


description of a generic IoTGateway

root allOf GSMA-Commons
Type: object

root allOf item 0 id
Type: object

Property. Unique identifier of the entity

root allOf item 0 id anyOf item 0
Type: string

Property. Identifier format of any NGSI entity

Must match regular expression: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$

Must be at least 1 characters long

Must be at most 256 characters long

root allOf item 0 id anyOf item 1
Type: stringFormat: uri

Property. Identifier format of any NGSI entity

root allOf item 0 dateCreated
Type: stringFormat: date-time

Property. Entity creation timestamp. This will usually be allocated by the storage platform

root allOf item 0 dateModified
Type: stringFormat: date-time

Property. Timestamp of the last modification of the entity. This will usually be allocated by the storage platform

root allOf item 0 source
Type: string

Property. A sequence of characters giving the original source of the entity data as a URL. Recommended to be the fully qualified domain name of the source provider, or the URL to the source object

root allOf item 0 name
Type: string

Property. The name of this item

root allOf item 0 alternateName
Type: string

Property. An alternative name for this item

root allOf item 0 description
Type: string

Property. A description of this item

root allOf item 0 dataProvider
Type: string

Property. A sequence of characters identifying the provider of the harmonised data entity

root allOf item 0 owner
Type: array

Property. A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)

Each item of this array must be:

root allOf item 0 owner EntityIdentifierType
Type: object

Property. Unique identifier of the entity

Same definition as id

root allOf item 0 seeAlso

Property. list of uri pointing to additional resources about the item

root allOf item 0 seeAlso oneOf item 0
Type: array of string

Must contain a minimum of 1 items

Each item of this array must be:

root allOf item 0 seeAlso oneOf item 0 item 0 items
Type: stringFormat: uri
root allOf item 0 seeAlso oneOf item 1
Type: stringFormat: uri
root allOf Location-Commons
Type: object

root allOf item 1 location

GeoProperty. Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon

root allOf item 1 location oneOf GeoJSON Point
Type: object

GeoProperty. Geojson reference to the item. Point

root allOf item 1 location oneOf GeoJSON Point type
Type: enum (of string)

Must be one of:

  • "Point"

root allOf item 1 location oneOf GeoJSON Point coordinates
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Point coordinates coordinates items
Type: number

root allOf item 1 location oneOf GeoJSON Point bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Point bbox bbox items
Type: number
root allOf item 1 location oneOf GeoJSON LineString
Type: object

GeoProperty. Geojson reference to the item. LineString

root allOf item 1 location oneOf GeoJSON LineString type
Type: enum (of string)

Must be one of:

  • "LineString"

root allOf item 1 location oneOf GeoJSON LineString coordinates
Type: array of array

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON LineString coordinates coordinates items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON LineString coordinates coordinates items coordinates items items
Type: number

root allOf item 1 location oneOf GeoJSON LineString bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON LineString bbox bbox items
Type: number
root allOf item 1 location oneOf GeoJSON Polygon
Type: object

GeoProperty. Geojson reference to the item. Polygon

root allOf item 1 location oneOf GeoJSON Polygon type
Type: enum (of string)

Must be one of:

  • "Polygon"

root allOf item 1 location oneOf GeoJSON Polygon coordinates
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Polygon coordinates coordinates items
Type: array of array

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Polygon coordinates coordinates items coordinates items items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Polygon coordinates coordinates items coordinates items items coordinates items items items
Type: number

root allOf item 1 location oneOf GeoJSON Polygon bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Polygon bbox bbox items
Type: number
root allOf item 1 location oneOf GeoJSON MultiPoint
Type: object

GeoProperty. Geojson reference to the item. MultiPoint

root allOf item 1 location oneOf GeoJSON MultiPoint type
Type: enum (of string)

Must be one of:

  • "MultiPoint"

root allOf item 1 location oneOf GeoJSON MultiPoint coordinates
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPoint coordinates coordinates items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPoint coordinates coordinates items coordinates items items
Type: number

root allOf item 1 location oneOf GeoJSON MultiPoint bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPoint bbox bbox items
Type: number
root allOf item 1 location oneOf GeoJSON MultiLineString
Type: object

GeoProperty. Geojson reference to the item. MultiLineString

root allOf item 1 location oneOf GeoJSON MultiLineString type
Type: enum (of string)

Must be one of:

  • "MultiLineString"

root allOf item 1 location oneOf GeoJSON MultiLineString coordinates
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiLineString coordinates coordinates items
Type: array of array

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiLineString coordinates coordinates items coordinates items items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiLineString coordinates coordinates items coordinates items items coordinates items items items
Type: number

root allOf item 1 location oneOf GeoJSON MultiLineString bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiLineString bbox bbox items
Type: number
root allOf item 1 location oneOf GeoJSON MultiPolygon
Type: object

GeoProperty. Geojson reference to the item. MultiLineString

root allOf item 1 location oneOf GeoJSON MultiPolygon type
Type: enum (of string)

Must be one of:

  • "MultiPolygon"

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates coordinates items
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates coordinates items coordinates items items
Type: array of array

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates coordinates items coordinates items items coordinates items items items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates coordinates items coordinates items items coordinates items items items coordinates items items items items
Type: number

root allOf item 1 location oneOf GeoJSON MultiPolygon bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon bbox bbox items
Type: number

root allOf item 1 address
Type: object

Property. The mailing address. Model:'https://schema.org/address'

root allOf item 1 address streetAddress
Type: string

Property. The street address. Model:'https://schema.org/streetAddress'

root allOf item 1 address addressLocality
Type: string

Property. The locality in which the street address is, and which is in the region. Model:'https://schema.org/addressLocality'

root allOf item 1 address addressRegion
Type: string

Property. The region in which the locality is, and which is in the country. Model:'https://schema.org/addressRegion'

root allOf item 1 address addressCountry
Type: string

Property. The country. For example, Spain. Model:'https://schema.org/addressCountry'

root allOf item 1 address postalCode
Type: string

Property. The postal code. For example, 24004. Model:'https://schema.org/https://schema.org/postalCode'

root allOf item 1 address postOfficeBoxNumber
Type: string

Property. The post office box number for PO box addresses. For example, 03578. Model:'https://schema.org/postOfficeBoxNumber'

root allOf item 1 address streetNr
Type: string

Property. Number identifying a specific property on a public street

root allOf item 1 address district
Type: string

Property. A district is a type of administrative division that, in some countries, is managed by the local government

root allOf item 1 areaServed
Type: string

Property. The geographic area where a service or offered item is provided. Model:'https://schema.org/Text'
root allOf item 2
Type: object

root allOf item 2 operatingVoltage
Type: number

Property. Model:'https://schema.org/Number'. Device Voltage

root allOf item 2 currentConsumption
Type: number

Property. Model:'https://schema.org/Number'. corrent onsumption in mA

root allOf item 2 protectionClass
Type: string

Property. Model:'https://schema.org/Text'. protection Class of this Device

root allOf item 2 ioPortsNum
Type: number

Property. Model:'https://schema.org/Number'. Number of IO Ports

root allOf item 2 ioPorts
Type: array of object

Property. Model:'https://schema.org/Text. Array of defined IO Ports

Each item of this array must be:

root allOf item 2 ioPorts ioPorts items
Type: object

root allOf item 2 ioPorts ioPorts items portId
Type: string

Property. Model:'https://schema.org/Text. Port ID

root allOf item 2 ioPorts ioPorts items portType
Type: string

Property. Model:'https://schema.org/Text. Port Type (Input,Output)

root allOf item 2 ioPorts ioPorts items portFunctionality
Type: string

Property. Model:'https://schema.org/Text.

root allOf item 2 ioPorts ioPorts items refEntityId
Type: string

Property. Model:'https://schema.org/Text. Referenz to a Sensor ID

root allOf item 2 interfaces
Type: enum (of string)

Property. Model:'https://schema.org/Text. Type of the Interface

Must be one of:

  • "Ethernet"
  • "IO-Link"

root allOf item 2 intEthMediaTypes
Type: string

Property. Model:'https://schema.org/Text. Ethernet media types

root allOf item 2 intEthTransmissionRate
Type: number

Property. Model:'https://schema.org/Number'. Ethernet Transmission Rate

root allOf item 2 intEthProtocol
Type: string

Property. Model:'https://schema.org/Text. Ethernet Protocol

root allOf item 2 intEthFactorySettings
Type: object

Property. Model:'https://schema.org/Text. Ethernet Factory Settings

root allOf item 2 intEthFactorySettings ipAddress
Type: string

Property. Model:'https://schema.org/Text. IP Address

root allOf item 2 intEthFactorySettings subnetMask
Type: string

Property. Model:'https://schema.org/Text. subnet Mask

root allOf item 2 intEthFactorySettings gatewayIP
Type: string

Property. Model:'https://schema.org/Text. Gateway IP Address

root allOf item 2 intEthFactorySettings macAddress
Type: string

Property. Model:'https://schema.org/Text. macAddress

root allOf item 2 intEthSecureProtocol
Type: string

Property. Model:'https://schema.org/Text. Ethernet Secure Protocol

root allOf item 2 intIOLinkTransmissionType
Type: string

Property. Model:'https://schema.org/Text. IO-Link Transmission Type

root allOf item 2 intIOLinkRevision
Type: string

Property. Model:'https://schema.org/Text. O-Link Revision

root allOf item 2 intIOLinkNumPortsClassA
Type: number

Property. Model:'https://schema.org/Number'. Numbers of Class A Ports

The following properties are required: