document generated automatically
Global description: Data Resource.Converted for Smart Data Models initiative from original frictionless data
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
areaServed[string]: The geographic area where a service or offered item is provided . Model: https://schema.org/Textbytes[number]: Bytes. The size of this resource in bytesdata[array]: Data. Inline data for this resourcedescription[string]: Description. A text description. Markdown is encouragedencoding[string]: Encoding. The file encoding of this resourceformat[string]: Format. 'csv', 'xls', 'json' are examples of common formats. The file format of this resourcehash[string]: Hash. The MD5 hash of this resource. Indicate other hashing algorithms with the {algorithm}:{hash} formathomepage[string]: Home Page. The home on the web that is related to this data packageid[*]: Unique identifier of the entitylicenses[array]: Licenses. This property is not legally binding and does not guarantee that the package is licensed under the terms defined herein. The license(s) under which the resource is publishedlocation[*]: Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygonmediatype[string]: Media Type. The media type of this resource. Can be any valid media type listed with IANAname[string]: Name. This is ideally a url-usable and human-readable name. Name 'SHOULD' be invariant, meaning it 'SHOULD NOT' change when its parent descriptor is updated. An identifier string. Lower case characters with '.', '_', '-' and '/' are allowedpath[array]: Path. The dereferenced value of each referenced data source in 'path' 'MUST' be commensurate with a native, dereferenced representation of the data the resource describes. For example, in a Tabular Data Resource, this means that the dereferenced value of 'path' 'MUST' be an array. A reference to the data for this resource, as either a path as a string, or an array of paths as strings. of valid URIsprofile[string]: Profile. Every Package and Resource descriptor has a profile. The default profile, if none is declared, is 'data-package' for Package and 'data-resource' for Resource. The profile of this descriptorschema[object]: Schema. A schema for this resourcesources[array]: Sources. . The raw sources for this resourcetitle[string]: Title. A human-readable titletype[string]: NGSI Entity type. It has to be DataResourceFrictionlessData
Required properties
idnametype
This data model comes from the original frictionless data that can be found at https://frictionlessdata.io/. There are a couple of changes. 1) id and type has been made compulsory as required by the NGSI-LD standard 2)structure of the json schema has been adapted to the official format of the Smart Data Models. See contribution manual https://bit.ly/contribution_manual. In order to make it compatible the data property and the source property have been defined as an array of objects. Also the type has been included.
Sorted alphabetically (click for details)
full yaml details
DataResourceFrictionlessData:
description: Data Resource.Converted for Smart Data Models initiative from original frictionless data
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
areaServed:
description: The geographic area where a service or offered item is provided
type: string
x-ngsi:
model: https://schema.org/Text
type: Property
bytes:
description: Bytes. The size of this resource in bytes
type: number
x-ngsi:
type: Property
data:
description: Data. Inline data for this resource
items:
type: object
type: array
x-ngsi:
type: Property
description:
description: Description. A text description. Markdown is encouraged
type: string
x-ngsi:
type: Property
encoding:
description: Encoding. The file encoding of this resource
type: string
x-ngsi:
type: Property
format:
description: 'Format. ''csv'', ''xls'', ''json'' are examples of common formats. The file format of this resource'
type: string
x-ngsi:
type: Property
hash:
description: 'Hash. The MD5 hash of this resource. Indicate other hashing algorithms with the {algorithm}:{hash} format'
pattern: ^([^:]+:[a-fA-F0-9]+|[a-fA-F0-9]{32}|)$
type: string
x-ngsi:
type: Property
homepage:
description: Home Page. The home on the web that is related to this data package
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
licenses:
description: Licenses. This property is not legally binding and does not guarantee that the package is licensed under the terms defined herein. The license(s) under which the resource is published
items:
properties:
name:
type: string
path:
type: string
title:
type: string
type: object
minItems: 1
type: array
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
mediatype:
description: 'Media Type. The media type of this resource. Can be any valid media type listed with [IANA](https://www.iana.org/assignments/media-types/media-types.xhtml)'
type: string
x-ngsi:
type: Property
name:
description: 'Name. This is ideally a url-usable and human-readable name. Name ''SHOULD'' be invariant, meaning it ''SHOULD NOT'' change when its parent descriptor is updated. An identifier string. Lower case characters with ''.'', ''_'', ''-'' and ''/'' are allowed'
type: string
x-ngsi:
type: Property
path:
description: 'Path. The dereferenced value of each referenced data source in ''path'' ''MUST'' be commensurate with a native, dereferenced representation of the data the resource describes. For example, in a *Tabular* Data Resource, this means that the dereferenced value of ''path'' ''MUST'' be an array. A reference to the data for this resource, as either a path as a string, or an array of paths as strings. of valid URIs'
items:
type: string
minItems: 1
type: array
x-ngsi:
type: Property
profile:
description: 'Profile. Every Package and Resource descriptor has a profile. The default profile, if none is declared, is ''data-package'' for Package and ''data-resource'' for Resource. The profile of this descriptor'
type: string
x-ngsi:
type: Property
schema:
description: Schema. A schema for this resource
type: object
x-ngsi:
type: Property
sources:
description: Sources. . The raw sources for this resource
items:
properties:
email:
format: idn-email
type: string
path:
type: string
title:
type: string
type: object
type: array
x-ngsi:
type: Property
title:
description: Title. A human-readable title
type: string
x-ngsi:
type: Property
type:
description: NGSI Entity type. It has to be DataResourceFrictionlessData
enum:
- DataResourceFrictionlessData
type: string
x-ngsi:
type: Property
required:
- name
- 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.FrictionlessData/blob/master/DataResourceFrictionlessData/LICENSE.md
x-model-schema: ""
x-model-tags: SDG
x-version: 0.0.3 Here is an example of a DataResourceFrictionlessData 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:dataresource:AECS:1234",
"type": "DataResourceFrictionlessData",
"bytes": 2082,
"data": [
{},
{}
],
"description": "My favourite data about the solar system.",
"encoding": "utf-8",
"format": "csv",
"hash": "SHA256:5262f12512590031bbcc9a430452bfd75c2791ad6771320bb4b5728bfb78c4d0",
"homepage": "https://smartdatamodels.org",
"licenses": [
{
"name": "CC-BY",
"title": "creative commons attribution",
"path": "https://creativecommons.org/licenses/by/4.0/deed.en"
},
{
"name": "odc-pddl-1.0",
"path": "http://opendatacommons.org/licenses/pddl/",
"title": "Open Data Commons Public Domain Dedication and License v1.0"
}
],
"mediatype": "text/csv",
"name": "solar-system",
"path": [
"http://example.com/solar-system.csv"
],
"profile": "tabular-data-package",
"schema": {},
"sources": [
{
"title": "Venus",
"path": "https://smartdatamodels.org/venus",
"email": "[email protected]"
},
{
"title": "Jupiter",
"path": "https://smartdatamodels.org/jupiter",
"email": "[email protected]"
}
],
"title": "The Solar System"
} Here is an example of a DataResourceFrictionlessData 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:dataresource:AECS:1234",
"type": "DataResourceFrictionlessData",
"bytes": {
"type": "Number",
"value": 2082
},
"data": {
"type": "StructuredValue",
"value": [
{},
{}
]
},
"description": {
"type": "Text",
"value": "My favourite data about the solar system."
},
"encoding": {
"type": "Text",
"value": "utf-8"
},
"format": {
"type": "Text",
"value": "csv"
},
"hash": {
"type": "Text",
"value": "SHA256:5262f12512590031bbcc9a430452bfd75c2791ad6771320bb4b5728bfb78c4d0"
},
"homepage": {
"type": "Text",
"value": "https://smartdatamodels.org"
},
"licenses": {
"type": "StructuredValue",
"value": [
{
"name": "CC-BY",
"title": "creative commons attribution",
"path": "https://creativecommons.org/licenses/by/4.0/deed.en"
},
{
"name": "odc-pddl-1.0",
"path": "http://opendatacommons.org/licenses/pddl/",
"title": "Open Data Commons Public Domain Dedication and License v1.0"
}
]
},
"mediatype": {
"type": "Text",
"value": "text/csv"
},
"name": {
"type": "Text",
"value": "solar-system"
},
"path": {
"type": "StructuredValue",
"value": [
"http://example.com/solar-system.csv"
]
},
"profile": {
"type": "Text",
"value": "tabular-data-package"
},
"schema": {
"type": "StructuredValue",
"value": {}
},
"sources": {
"type": "StructuredValue",
"value": [
{
"title": "Venus",
"path": "https://smartdatamodels.org/venus",
"email": "[email protected]"
},
{
"title": "Jupiter",
"path": "https://smartdatamodels.org/jupiter",
"email": "[email protected]"
}
]
},
"title": {
"type": "Text",
"value": "The Solar System"
}
} Here is an example of a DataResourceFrictionlessData 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:dataresource:AECS:1234",
"type": "DataResourceFrictionlessData",
"bytes": 2082,
"data": [
{},
{}
],
"description": "My favourite data about the solar system.",
"encoding": "utf-8",
"format": "csv",
"hash": "SHA256:5262f12512590031bbcc9a430452bfd75c2791ad6771320bb4b5728bfb78c4d0",
"homepage": "https://smartdatamodels.org",
"licenses": [
{
"name": "CC-BY",
"title": "creative commons attribution",
"path": "https://creativecommons.org/licenses/by/4.0/deed.en"
},
{
"name": "odc-pddl-1.0",
"path": "http://opendatacommons.org/licenses/pddl/",
"title": "Open Data Commons Public Domain Dedication and License v1.0"
}
],
"mediatype": "text/csv",
"name": "solar-system",
"path": [
"http://example.com/solar-system.csv"
],
"profile": "tabular-data-package",
"schema": {},
"sources": [
{
"title": "Venus",
"path": "https://smartdatamodels.org/venus",
"email": "[email protected]"
},
{
"title": "Jupiter",
"path": "https://smartdatamodels.org/jupiter",
"email": "[email protected]"
}
],
"title": "The Solar System",
"@context": [
"https://smartdatamodels.org/context.jsonld",
"https://raw.githubusercontent.com/smart-data-models/dataModel.FrictionlessData/master/context.jsonld"
]
} Here is an example of a DataResourceFrictionlessData 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:dataresource:AECS:1234",
"type": "DataResourceFrictionlessData",
"bytes": {
"type": "Property",
"value": 2082
},
"data": {
"type": "Property",
"value": [
{},
{}
]
},
"description": {
"type": "Property",
"value": "My favourite data about the solar system."
},
"encoding": {
"type": "Property",
"value": "utf-8"
},
"format": {
"type": "Property",
"value": "csv"
},
"hash": {
"type": "Property",
"value": "SHA256:5262f12512590031bbcc9a430452bfd75c2791ad6771320bb4b5728bfb78c4d0"
},
"homepage": {
"type": "Property",
"value": "https://smartdatamodels.org"
},
"licenses": {
"type": "Property",
"value": [
{
"name": "CC-BY",
"title": "creative commons attribution",
"path": "https://creativecommons.org/licenses/by/4.0/deed.en"
},
{
"name": "odc-pddl-1.0",
"path": "http://opendatacommons.org/licenses/pddl/",
"title": "Open Data Commons Public Domain Dedication and License v1.0"
}
]
},
"mediatype": {
"type": "Property",
"value": "text/csv"
},
"name": {
"type": "Property",
"value": "solar-system"
},
"path": {
"type": "Property",
"value": [
"http://example.com/solar-system.csv"
]
},
"profile": {
"type": "Property",
"value": "tabular-data-package"
},
"schema": {
"type": "Property",
"value": {}
},
"sources": {
"type": "Property",
"value": [
{
"title": "Venus",
"path": "https://smartdatamodels.org/venus",
"email": "[email protected]"
},
{
"title": "Jupiter",
"path": "https://smartdatamodels.org/jupiter",
"email": "[email protected]"
}
]
},
"title": {
"type": "Property",
"value": "The Solar System"
},
"@context": [
"https://smartdatamodels.org/context.jsonld",
"https://raw.githubusercontent.com/smart-data-models/dataModel.FrictionlessData/master/context.jsonld"
]
} See FAQ 10 to get an answer on how to deal with magnitude units