Skip to main content

Data kinds

Created by Initialize Resources.

Data kindPayload shapeCardinalitySchema format
ObservationStructuredSingleJSON Schema
Telemetry EventStructuredStreamJSON Schema
Asset StateStructuredSingleJSON Schema
Tabular RecordsTabularCollectionCSV columns
Generic JSON PayloadStructuredSingleJSON (empty schema)
XML DocumentStructuredSingleXML / XSD (empty)
Avro RecordStructuredSingleAvro (empty)
DocumentTextSingle— (plain text)
Binary BlobBinarySingle—

Observation​

Used by observation pipelines and the Observation dashboard — keep it unchanged.

{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Observation",
"type": "object",
"properties": {
"id": { "type": "string" },
"digitalResourceID": { "type": "string" },
"digitalResourceName": { "type": "string" },
"assetID": { "type": "string" },
"assetName": { "type": "string" },
"dataKindID": { "type": "string" },
"dataKindName": { "type": "string" },
"timestamp": { "type": "string", "format": "date-time" },
"value": { "type": "string" }
},
"required": ["id", "digitalResourceID", "digitalResourceName", "assetID", "assetName",
"dataKindID", "dataKindName", "timestamp", "value"],
"additionalProperties": false
}

Telemetry Event​

{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Telemetry Event",
"type": "object",
"properties": {
"eventTime": { "type": "string", "format": "date-time" },
"assetId": { "type": "string" },
"metric": { "type": "string" },
"value": {},
"unit": { "type": "string" }
},
"required": ["eventTime", "assetId", "metric", "value"],
"additionalProperties": true
}

Asset State​

{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Asset State",
"type": "object",
"properties": {
"timestamp": { "type": "string", "format": "date-time" },
"assetId": { "type": "string" },
"state": { "type": "string" },
"attributes": { "type": "object" }
},
"required": ["timestamp", "assetId", "state"],
"additionalProperties": true
}

Tabular Records​

CSV column definitions:

ColumnTypeRequired
timestampdateyes
asset_idstringyes
valuenumberno