|
GROUP SPECIFICATION
Context Information Management (CIM);
NGSI-LD API
Disclaimer
The present document has been produced and approved by the cross-cutting Context Information Management (CIM) ETSI
Industry Specification Group (ISG) and represents the views of those members who participated in this ISG.
It does not necessarily represent the views of the entire ETSI membership.
---------------------- Page: 1 ----------------------
2 ETSI GS CIM 009 V1.1.1 (2019-01)
Reference
DGS/CIM-009-NGSI-LD-API
Keywords
API, architecture, GAP, information model,
interoperability, smart city
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
The present document can be downloaded from:
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the prevailing version of an ETSI
deliverable is the one made publicly available in PDF format at www.etsi.org/deliver.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
If you find errors in the present document, please send your comment to one of the following services:
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying
and microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.
© ETSI 2019.
All rights reserved.
TM TM TM
DECT , PLUGTESTS , UMTS and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.
TM TM
3GPP and LTE are trademarks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
oneM2M™ logo is a trademark of ETSI registered for the benefit of its Members and
of the oneM2M Partners
GSM and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI
---------------------- Page: 2 ----------------------
3 ETSI GS CIM 009 V1.1.1 (2019-01)
Contents
Intellectual Property Rights . 12
Foreword . 12
Modal verbs terminology . 12
Executive summary . 12
Introduction . 12
1 Scope . 14
2 References . 14
2.1 Normative references . 14
2.2 Informative references . 16
3 Definition of terms, symbols and abbreviations . 17
3.1 Terms . 17
3.2 Symbols . 18
3.3 Abbreviations . 19
4 Context Information Management Framework . 19
4.1 Introduction . 19
4.2 NGSI-LD Information Model. 19
4.2.1 Introduction. 19
4.2.2 NGSI-LD Meta Model . 20
4.2.3 Cross Domain Ontology . 21
4.2.4 NGSI-LD domain-specific models and instantiation . 21
4.2.5 UML representation . 22
4.3 NGSI-LD Architectural considerations . 23
4.3.1 Introduction. 23
4.3.2 Centralized architecture . 23
4.3.3 Distributed architecture . 24
4.3.4 Federated architecture . 25
4.4 Core NGSI-LD @context . 26
4.5 NGSI-LD Data Representation. 26
4.5.1 NGSI-LD Entity Representation . 26
4.5.2 NGSI-LD Property Representation . 27
4.5.3 NGSI-LD Relationship Representation . 27
4.5.4 Simplified Representation . 28
4.5.5 Multi-Attribute Support . 28
4.5.6 Temporal Representation of an Entity . 29
4.5.7 Temporal Representation of a Property . 29
4.5.8 Temporal Representation of a Relationship . 29
4.5.9 Simplified Temporal Representation of an Entity . 29
4.6 Data Representation Restrictions . 30
4.6.1 Supported text encodings . 30
4.6.2 Supported names . 30
4.6.3 Supported data types for Values . 30
4.6.4 Supported Entity Content . 31
4.7 Geospatial Properties . 31
4.7.1 GeoJSON Geometries . 31
4.7.2 Representation of GeoJSON Geometries in JSON-LD . 32
4.8 Temporal properties . 32
4.9 NGSI-LD Query Language . 33
4.10 NGSI-LD Geo-query language . 37
4.11 NGSI-LD Temporal Query language . 38
4.12 NGSI-LD Query pagination . 39
5 API Operation Definition . 40
5.1 Introduction . 40
ETSI
---------------------- Page: 3 ----------------------
4 ETSI GS CIM 009 V1.1.1 (2019-01)
5.2 Data types . 40
5.2.1 Introduction. 40
5.2.2 Common members . 40
5.2.3 @context . 40
5.2.4 Entity . 40
5.2.5 Property . 41
5.2.6 Relationship . 41
5.2.7 GeoProperty . 41
5.2.8 EntityInfo . 42
5.2.9 CsourceRegistration . 42
5.2.10 RegistrationInfo . 44
5.2.11 TimeInterval . 44
5.2.12 Subscription . 44
5.2.13 GeoQuery . 46
5.2.14 NotificationParams . 46
5.2.14.1 NotificationParams data type definition . 46
5.2.14.2 Additional members . 47
5.2.15 Endpoint . 47
5.2.16 BatchOperationResult . 47
5.2.17 BatchEntityError . 48
5.2.18 UpdateResult. 48
5.2.19 UnchangedDetails . 48
5.2.20 EntityTemporal . 48
5.2.21 TemporalQuery . 48
5.3 Notification data types . 49
5.3.1 Notification . 49
5.3.2 CsourceNotification . 49
5.3.3 TriggerReasonEnumeration . 50
5.4 NGSI-LD Fragments . 50
5.5 Common behaviours. 51
5.5.1 Introduction. 51
5.5.2 Error types . 51
5.5.3 Error payloads . 51
5.5.4 JSON-LD validation . 52
5.5.5 Default @context assignment . 52
5.5.6 Operation execution . 52
5.5.7 Term to URI expansion . 52
5.5.8 JSON-LD Merge Patch Behaviour . 53
5.5.9 Pagination Behaviour . 53
5.6 Context Information Provision . 54
5.6.1 Create Entity . 54
5.6.1.1 Description . 54
5.6.1.2 Use case diagram . 54
5.6.1.3 Input data . 54
5.6.1.4 Behaviour . 54
5.6.1.5 Output data . 54
5.6.2 Update Entity Attributes . 55
5.6.2.1 Description . 55
5.6.2.2 Use case diagram . 55
5.6.2.3 Input data . 55
5.6.2.4 Behaviour . 55
5.6.2.5 Output data . 55
5.6.3 Append Entity Attributes . 56
5.6.3.1 Description . 56
5.6.3.2 Use case diagram . 56
5.6.3.3 Input data . 56
5.6.3.4 Behaviour . 56
5.6.3.5 Output data . 57
5.6.4 Partial Attribute update . 57
5.6.4.1 Description . 57
5.6.4.2 Use case diagram . 57
5.6.4.3 Input data . 58
ETSI
---------------------- Page: 4 ----------------------
5 ETSI GS CIM 009 V1.1.1 (2019-01)
5.6.4.4 Behaviour . 58
5.6.4.5 Output data . 58
5.6.5 Delete Entity Attribute . 58
5.6.5.1 Description . 58
5.6.5.2 Use case diagram . 58
5.6.5.3 Input data . 59
5.6.5.4 Behaviour . 59
5.6.5.5 Output data . 59
5.6.6 Delete Entity . 59
5.6.6.1 Description . 59
5.6.6.2 Use case diagram . 59
5.6.6.3 Input data . 60
5.6.6.4 Behaviour . 60
5.6.6.5 Output data . 60
5.6.7 Batch Entity Creation. 60
5.6.7.1 Description . 60
5.6.7.2 Use case diagram . 60
5.6.7.3 Input data . 61
5.6.7.4 Behaviour . 61
5.6.7.5 Output data . 61
5.6.8 Batch Entity Creation or Update (Upsert) . 61
5.6.8.1 Description . 61
5.6.8.2 Use case diagram . 62
5.6.8.3 Input data . 62
5.6.8.4 Behaviour . 62
5.6.8.5 Output data . 63
5.6.9 Batch Entity Update . 63
5.6.9.1 Description . 63
5.6.9.2 Use case diagram . 63
5.6.9.3 Input data . 63
5.6.9.4 Behaviour . 63
5.6.9.5 Output data . 64
5.6.10 Batch Entity Delete . 64
5.6.10.1 Description . 64
5.6.10.2 Use case diagram . 64
5.6.10.3 Input data . 64
5.6.10.4 Behaviour . 64
5.6.10.5 Output data . 65
5.6.11 Create or Update Temporal Representation of an Entity . 65
5.6.11.1 Description . 65
5.6.11.2 Use case diagram . 65
5.6.11.3 Input data . 65
5.6.11.4 Behaviour . 66
5.6.11.5 Output data . 66
5.6.12 Add Attributes to Temporal Representation of an Entity . 66
5.6.12.1 Description . 66
5.6.12.2 Use case diagram . 66
5.6.12.3 Input data . 66
5.6.12.4 Behaviour . 66
5.6.12.5 Output data . 67
5.6.13 Delete Attribute from Temporal Representation of an Entity . 67
5.6.13.1 Description . 67
5.6.13.2 Use case diagram .
...