document generated automatically
Global description: This entity contains a harmonised description of a generic building type. This entity is associated with the vertical segments of smart home, smart cities, industry and related IoT applications. The building type includes a hierarchical structure that allows building types to be grouped in a flexible way.
version: 0.0.3
[*] If there is not a type in an attribute is because it could have several types or different formats/patterns
address[object]: The mailing address . Model: https://schema.org/addressaddressCountry[string]: The country. For example, Spain . Model: https://schema.org/addressCountryaddressLocality[string]: The locality in which the street address is, and which is in the region . Model: https://schema.org/addressLocalityaddressRegion[string]: The region in which the locality is, and which is in the country . Model: https://schema.org/addressRegiondistrict[string]: A district is a type of administrative division that, in some countries, is managed by the local governmentpostOfficeBoxNumber[string]: The post office box number for PO box addresses. For example, 03578 . Model: https://schema.org/postOfficeBoxNumberpostalCode[string]: The postal code. For example, 24004 . Model: https://schema.org/https://schema.org/postalCodestreetAddress[string]: The street address . Model: https://schema.org/streetAddress
alternateName[string]: An alternative name for this itemareaServed[string]: The geographic area where a service or offered item is provided . Model: https://schema.org/TextbuildingTypeChildren[array]: Reference to child building types i.e. immediately below this entity in the hierarchybuildingTypeParent[*]: References any higher level Building Type entities that this type is based ondataProvider[string]: A sequence of characters identifying the provider of the harmonised data entitydateCreated[date-time]: Entity creation timestamp. This will usually be allocated by the storage platformdateModified[date-time]: Timestamp of the last modification of the entity. This will usually be allocated by the storage platformdescription[string]: A description of this itemid[*]: Unique identifier of the entitylocation[*]: Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygonname[string]: The name of this itemowner[array]: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)root[boolean]: A logical indicator that this is the root of a BuildingType hierarchy.True indicates it is the root, false indicates that it is not the rootseeAlso[*]: list of uri pointing to additional resources about the itemsource[string]: 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 objecttype[string]: NGSI Entity identifier. It has to be BuildingType
Required properties
idtype
This data model comes from the original project GSMA IoT project, https://www.gsma.com/iot/iot-big-data/. There are some minor adaptations to meet requirements of smart data models.
Sorted alphabetically (click for details)
full yaml details
BuildingType:
description: 'This entity contains a harmonised description of a generic building type. This entity is associated with the vertical segments of smart home, smart cities, industry and related IoT applications. The building type includes a hierarchical structure that allows building types to be grouped in a flexible way.'
properties:
address:
description: The mailing address
properties:
addressCountry:
description: 'The country. For example, Spain'
type: string
x-ngsi:
model: https://schema.org/addressCountry
type: Property
addressLocality:
description: 'The locality in which the street address is, and which is in the region'
type: string
x-ngsi:
model: https://schema.org/addressLocality
type: Property
addressRegion:
description: 'The region in which the locality is, and which is in the country'
type: string
x-ngsi:
model: https://schema.org/addressRegion
type: Property
district:
description: 'A district is a type of administrative division that, in some countries, is managed by the local government'
type: string
x-ngsi:
type: Property
postOfficeBoxNumber:
description: 'The post office box number for PO box addresses. For example, 03578'
type: string
x-ngsi:
model: https://schema.org/postOfficeBoxNumber
type: Property
postalCode:
description: 'The postal code. For example, 24004'
type: string
x-ngsi:
model: https://schema.org/https://schema.org/postalCode
type: Property
streetAddress:
description: The street address
type: string
x-ngsi:
model: https://schema.org/streetAddress
type: Property
streetNr:
description: Number identifying a specific property on a public street
type: string
x-ngsi:
type: Property
type: object
x-ngsi:
model: https://schema.org/address
type: Property
alternateName:
description: An alternative name for this item
type: string
x-ngsi:
type: Property
areaServed:
description: The geographic area where a service or offered item is provided
type: string
x-ngsi:
model: https://schema.org/Text
type: Property
buildingTypeChildren:
description: Reference to child building types i.e. immediately below this entity in the hierarchy
items:
anyOf:
- description: Identifier format of any NGSI entity
maxLength: 256
minLength: 1
pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$
type: string
x-ngsi:
type: Property
- description: Identifier format of any NGSI entity
format: uri
type: string
x-ngsi:
type: Property
type: array
x-ngsi:
type: Relationship
buildingTypeParent:
anyOf:
- description: Identifier format of any NGSI entity
maxLength: 256
minLength: 1
pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!:\\]+$
type: string
x-ngsi:
type: Property
- description: Identifier format of any NGSI entity
format: uri
type: string
x-ngsi:
type: Property
description: References any higher level Building Type entities that this type is based on
x-ngsi:
type: Relationship
dataProvider:
description: A sequence of characters identifying the provider of the harmonised data entity
type: string
x-ngsi:
type: Property
dateCreated:
description: Entity creation timestamp. This will usually be allocated by the storage platform
format: date-time
type: string
x-ngsi:
type: Property
dateModified:
description: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform
format: date-time
type: string
x-ngsi:
type: Property
description:
description: A description of this item
type: string
x-ngsi:
type: Property
id:
anyOf:
- description: Identifier format of any NGSI entity
maxLength: 256
minLength: 1
pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$
type: string
x-ngsi:
type: Property
- description: Identifier format of any NGSI entity
format: uri
type: string
x-ngsi:
type: Property
description: Unique identifier of the entity
x-ngsi:
type: Property
location:
description: 'Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon'
oneOf:
- description: Geojson reference to the item. Point
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
type: number
minItems: 2
type: array
type:
enum:
- Point
type: string
required:
- type
- coordinates
title: GeoJSON Point
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. LineString
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
type: number
minItems: 2
type: array
minItems: 2
type: array
type:
enum:
- LineString
type: string
required:
- type
- coordinates
title: GeoJSON LineString
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. Polygon
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
items:
type: number
minItems: 2
type: array
minItems: 4
type: array
type: array
type:
enum:
- Polygon
type: string
required:
- type
- coordinates
title: GeoJSON Polygon
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. MultiPoint
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
type: number
minItems: 2
type: array
type: array
type:
enum:
- MultiPoint
type: string
required:
- type
- coordinates
title: GeoJSON MultiPoint
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. MultiLineString
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
items:
type: number
minItems: 2
type: array
minItems: 2
type: array
type: array
type:
enum:
- MultiLineString
type: string
required:
- type
- coordinates
title: GeoJSON MultiLineString
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. MultiLineString
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
items:
items:
type: number
minItems: 2
type: array
minItems: 4
type: array
type: array
type: array
type:
enum:
- MultiPolygon
type: string
required:
- type
- coordinates
title: GeoJSON MultiPolygon
type: object
x-ngsi:
type: GeoProperty
x-ngsi:
type: GeoProperty
name:
description: The name of this item
type: string
x-ngsi:
type: Property
owner:
description: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)
items:
anyOf:
- description: Identifier format of any NGSI entity
maxLength: 256
minLength: 1
pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$
type: string
x-ngsi:
type: Property
- description: Identifier format of any NGSI entity
format: uri
type: string
x-ngsi:
type: Property
description: Unique identifier of the entity
x-ngsi:
type: Property
type: array
x-ngsi:
type: Property
root:
description: 'A logical indicator that this is the root of a BuildingType hierarchy.True indicates it is the root, false indicates that it is not the root'
type: boolean
x-ngsi:
type: Property
seeAlso:
description: list of uri pointing to additional resources about the item
oneOf:
- items:
format: uri
type: string
minItems: 1
type: array
- format: uri
type: string
x-ngsi:
type: Property
source:
description: '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'
type: string
x-ngsi:
type: Property
type:
description: NGSI Entity identifier. It has to be BuildingType
enum:
- BuildingType
type: string
x-ngsi:
type: Property
required:
- id
- type
type: object
x-derived-from: ""
x-disclaimer: 'Redistribution and use in source and binary forms, with or without modification, are permitted provided that the license conditions are met. Copyleft (c) 2022 Contributors to Smart Data Models Program'
x-license-url: https://github.com/smart-data-models/dataModel.Building/blob/master/BuildingType/LICENSE.md
x-model-schema: https://smart-data-models.github.io/dataModel.Building/BuildingType/schema.json
x-model-tags: GSMA
x-version: 0.0.3 Here is an example of a BuildingType in JSON-LD format as key-values. This is compatible with NGSI-v2 when using options=keyValues and returns the context data of an individual entity.
show/hide example
{
"id": "urn:ngsi-ld:BuildingType:57b912ab-eb47-4cd5-bc9d-73abece1f1b3",
"type": "BuildingType",
"source": "https://source.example.com",
"dataProvider": "https://provider.example.com",
"name": "House",
"description": "Standard building type definition for a domestic house",
"root": false,
"buildingTypeParent": "urn:ngsi-ld:BuildingType:4146335f-839f-4ff9-a575-6b4e6232b734",
"buildingTypeChildren": [
"urn:ngsi-ld:BuildingType:e4291e84-58f8-11e8-84c3-77e4f1f8c4f1",
"urn:ngsi-ld:BuildingType:a71c7a08-58f9-11e8-a41e-4bcb7249360e",
"urn:ngsi-ld:BuildingType:afac9bbc-58f9-11e8-b587-1f0d57b81bb4"
]
} Here is an example of a BuildingType in JSON-LD format as normalized. This is compatible with NGSI-v2 when not using options and returns the context data of an individual entity.
show/hide example
{
"id": "urn:ngsi-ld:BuildingType:57b912ab-eb47-4cd5-bc9d-73abece1f1b3",
"type": "BuildingType",
"source": {
"type": "Text",
"value": "https://source.example.com"
},
"dataProvider": {
"type": "Text",
"value": "https://provider.example.com"
},
"name": {
"type": "Text",
"value": "House"
},
"description": {
"type": "Text",
"value": "Standard building type definition for a domestic house"
},
"root": {
"type": "Boolean",
"value": false
},
"buildingTypeParent": {
"type": "Text",
"value": "urn:ngsi-ld:BuildingType:4146335f-839f-4ff9-a575-6b4e6232b734"
},
"buildingTypeChildren": {
"type": "StructuredValue",
"value": [
"urn:ngsi-ld:BuildingType:e4291e84-58f8-11e8-84c3-77e4f1f8c4f1",
"urn:ngsi-ld:BuildingType:a71c7a08-58f9-11e8-a41e-4bcb7249360e",
"urn:ngsi-ld:BuildingType:afac9bbc-58f9-11e8-b587-1f0d57b81bb4"
]
}
} Here is an example of a BuildingType in JSON-LD format as key-values. This is compatible with NGSI-LD when using options=keyValues and returns the context data of an individual entity.
show/hide example
{
"id": "urn:ngsi-ld:BuildingType:57b912ab-eb47-4cd5-bc9d-73abece1f1b3",
"type": "BuildingType",
"buildingTypeChildren": [
"urn:ngsi-ld:BuildingType:e4291e84-58f8-11e8-84c3-77e4f1f8c4f1",
"urn:ngsi-ld:BuildingType:a71c7a08-58f9-11e8-a41e-4bcb7249360e",
"urn:ngsi-ld:BuildingType:afac9bbc-58f9-11e8-b587-1f0d57b81bb4"
],
"buildingTypeParent": "urn:ngsi-ld:BuildingType:4146335f-839f-4ff9-a575-6b4e6232b734",
"dataProvider": "https://provider.example.com",
"description": "Standard building type definition for a domestic house",
"name": "House",
"root": false,
"source": "https://source.example.com",
"@context": [
"https://smart-data-models.github.io/dataModel.Building/context.jsonld",
"https://raw.githubusercontent.com/smart-data-models/dataModel.Building/master/context.jsonld"
]
} Here is an example of a BuildingType in JSON-LD format as normalized. This is compatible with NGSI-LD when not using options and returns the context data of an individual entity.
show/hide example
{
"id": "urn:ngsi-ld:BuildingType:57b912ab-eb47-4cd5-bc9d-73abece1f1b3",
"type": "BuildingType",
"buildingTypeChildren": {
"type": "Relationship",
"object": [
"urn:ngsi-ld:BuildingType:e4291e84-58f8-11e8-84c3-77e4f1f8c4f1",
"urn:ngsi-ld:BuildingType:a71c7a08-58f9-11e8-a41e-4bcb7249360e",
"urn:ngsi-ld:BuildingType:afac9bbc-58f9-11e8-b587-1f0d57b81bb4"
]
},
"buildingTypeParent": {
"type": "Relationship",
"object": "urn:ngsi-ld:BuildingType:4146335f-839f-4ff9-a575-6b4e6232b734"
},
"dataProvider": {
"type": "Property",
"value": "https://provider.example.com"
},
"description": {
"type": "Property",
"value": "Standard building type definition for a domestic house"
},
"name": {
"type": "Property",
"value": "House"
},
"root": {
"type": "Property",
"value": false
},
"source": {
"type": "Property",
"value": "https://source.example.com"
},
"@context": [
"https://smart-data-models.github.io/dataModel.Building/context.jsonld",
"https://raw.githubusercontent.com/smart-data-models/dataModel.Building/master/context.jsonld"
]
} See FAQ 10 to get an answer on how to deal with magnitude units