This entity contains a harmonised description of a generic device operation entity. The device operation entity contains dynamic data reported by a device and is therefore applicable to all IoT segments and related IoT applications.
| Attribute Name | Attribute Type | Description | Constraint |
|---|---|---|---|
| id | @id | Provides a unique identifier for an instance of the entity either in the form of a URI (i.e. either a publicly accessible URL or a URN). | Mandatory |
| type | @type | Defines the type of the entity. | Mandatory |
| createdAt | TemporalProperty | Indicates the date/ time that the instance of the entity was created in ISO 8601 format. The value of this will be set by the server when the entity was created. | Mandatory |
| modifiedAt | TemporalProperty | Indicates the date/ time when the entity was last modified in ISO 8601 format. The value of this will be set by the server when the entity was modified, if the entity has not been modified it may have a null value. | Optional |
| source | Property | Specifies the URL to the source of this data (either organisation or where relevant more specific source) | Recommended |
| dataProvider | Property | Specifies the URL to information about the provider of this information | Recommended |
| entityVersion | Property | The entity specification version as a number. A version number of 2.0 or later denotes the entity is represented using NGSI-LD | Recommended |
| device | Relationship | A reference to the associated Device for this device operation. | Mandatory |
| operationType | Property | A choice from an enumerated list including: event, maintenance, fault, installation, upgrade, other. | Recommended |
| description | Property | A description of the operation. | Recommended |
| result | Property | The result of the operation. One of ok, aborted, failed. | Recommended |
| plannedStartAt | DateTime | The planned start date/timestamp for the operation. Note that this is advisory and the actual time the operation starts may be before or after the planned start. |
Mandatory |
| plannedEndAt | DateTime | The planned end date/timestamp for the operation. Note that this is advisory and the actual time the operation finishes may be before or after the planned end. |
Mandatory |
| status | Property | A choice from an enumerated list describing the status. One of: planned, ongoing, finished, scheduled, cancelled. | Recommended |
| operator | Relationship | Reference to the operator conducting the operation | Recommended |
| startedAt | DateTime | Timestamp when the operation actually started to be performed. | Recommended |
| endedAt | DateTime | Timestamp when the operation actually finished. | Recommended |
| reportedAt | DateTime | Timestamp when the event/ fault was reported. | Optional |
| addressedAt | DateTime | The timestamp when an event or fault was addressed or cleared. | Optional |
| startDate | DateTime | The planned start date/timestamp for the operation. Note that this is advisory and the actual time the operation starts may be before or after the planned start. Note this field was defined for use with NGSIv2 and is now deprecated. For new entities and applications replace with plannedStartAt |
Deprecated |
| endDate | DateTime | The planned end date/timestamp for the operation. Note that this is advisory and the actual time the operation finishes may be before or after the planned end. Note this field was defined for use with NGSIv2 and is now deprecated. For new entities and applications replace with plannedEndAt |
Deprecated |
| dateStarted | DateTime | Timestamp when the operation actually started to be performed. Note this field was defined for use with NGSIv2 and is now deprecated. For new entities and applications replace with startedAt |
Deprecated |
| dateFinished | DateTime | Timestamp when the operation actually finished. Note this field was defined for use with NGSIv2 and is now deprecated. For new entities and applications replace with endedAt |
Deprecated |
| dateReported | DateTime | Timestamp when the event/ fault was reported. Note this field was defined for use with NGSIv2 and is now deprecated. For new entities and applications replace with reportedAt |
Deprecated |
| dateAddressed | DateTime | The timestamp when an event or fault was addressed or cleared. Note this field was defined for use with NGSIv2 and is now deprecated. For new entities and applications replace with addressedAt |
Deprecated |
The following NGSI-LD context definition applies to the Device Operation entity
{
"@context": {
"source": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/source",
"dataProvider": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/dataprovider",
"entityVersion": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/entityversion",
"device": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/device",
"operationType": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/operationtype",
"description": "https://schema.org/description",
"result": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/result",
"plannedStartAt": {
"@type": "DateTime",
"@id": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/plannedstartat"
},
"plannedEndAt": {
"@type": "DateTime",
"@id": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/plannedendat"
},
"status": "http://uri.etsi.org/ngsi-ld/status",
"operator": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/operator",
"startedAt": {
"@type": "DateTime",
"@id": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/startedat"
},
"endedAt": {
"@type": "DateTime",
"@id": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/endedat"
},
"reportedAt": {
"@type": "DateTime",
"@id": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/reportedat"
},
"addressedAt": {
"@type": "DateTime",
"@id": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/addressedat"
},
"startDate": {
"@type": "DateTime",
"@id": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/startdate"
},
"endDate": {
"@type": "DateTime",
"@id": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/enddate"
},
"dateStarted": {
"@type": "DateTime",
"@id": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/datestarted"
},
"dateFinished": {
"@type": "DateTime",
"@id": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/datefinished"
},
"dateReported": {
"@type": "DateTime",
"@id": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/datereported"
},
"dateAddressed": {
"@type": "DateTime",
"@id": "https://www.gsma.com/iot/iot-big-data/ngsi-ld/dateaddressed"
}
}
}The following is an example instance of the Device Operation entity
Download example entity definition.
{
"@context": [
"https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/coreContext/ngsi-ld-core-context.json",
"https://raw.githubusercontent.com/GSMADeveloper/NGSI-LD-Entities/master/examples/Device-Operation-context.jsonld"
],
"id": "urn:ngsi-ld:DeviceOperation:27577638-bd8a-4732-b418-fc8b949a0b0f",
"type": "DeviceOperation",
"createdAt": "2017-01-01T01:20:00Z",
"modifiedAt": "2017-05-04T12:30:00Z",
"source": "https://source.example.com",
"dataProvider": "https://provider.example.com",
"entityVersion": 2.0,
"device": {
"type": "Relationship",
"object": "urn:ngsi-ld:Device:2033a7c7-d31b-48e7-91c2-014dc426c29e"
},
"operationType": {
"type": "Property",
"value": [
"fault"
]
},
"description": {
"type": "Property",
"value": "Backup battery needs replacement"
},
"result": {
"type": "Property",
"value": "ok"
},
"plannedStartAt": {
"type": "Property",
"value": "2016-08-22T10:18:16Z"
},
"plannedEndAt": {
"type": "Property",
"value": "2016-08-28T10:18:16Z"
},
"status": {
"type": "Property",
"value": "ongoing"
},
"operator": {
"type": "Relationship",
"object": "urn:ngsi-ld:Person:fe018d4e-46f8-11e8-ae6b-df5577f85836"
},
"startedAt": {
"type": "Property",
"value": "2016-08-22T10:18:16Z"
},
"endedAt": {
"type": "Property",
"value": "2016-08-28T10:18:16Z"
},
"reportedAt": {
"type": "Property",
"value": "2016-08-28T10:18:16Z"
},
"addressedAt": {
"type": "Property",
"value": "2016-08-28T10:18:16Z"
}
}