ETSI GS CIM 009 V1.4.2 (2021-04)

Context Information Management (CIM); NGSI-LD API

RGS/CIM-0009v142

General Information

• Status: Not Published
• Technical Committee: CIM - cross-cutting Context Information Management
• Current Stage: 12 - Completion
• Due Date: 28-Apr-2021
• Completion Date: 23-Apr-2021

Standards Content (Sample)

ETSI GS CIM 009 V1.4.2 (2021-04)






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.4.2 (2021-04)
Reference
RGS/CIM-0009v142
Keywords
API, architecture, GAP, information model,
interoperability, smart city, WoT
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: [phone]  Fax: [phone]
Siret N° 348 623 562 00017 - APE 7112B
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° w061004871
Important notice
The present document can be downloaded from:
http://www.etsi.org/standards-search
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
https://portal.etsi.org/TB/ETSIDeliverableStatus.aspx
If you find errors in the present document, please send your comment to one of the following services:
https://portal.etsi.org/People/CommiteeSupportStaff.aspx
Notice of disclaimer & limitation of liability
The information provided in the present deliverable is directed solely to professionals who have the appropriate degree of
experience to understand and interpret its content in accordance with generally accepted engineering or
other professional standard and applicable regulations.
No recommendation as to products and services or vendors is made or should be implied.
No representation or warranty is made that this deliverable is technically accurate or sufficient or conforms to any law
and/or governmental rule and/or regulation and further, no representation or warranty is made of merchantability or
fitness for any particular purpose or against infringement of intellectual property rights.
In no event shall ETSI be held liable for loss of profits or any other incidental or consequential damages.
Any software contained in this deliverable is provided "AS IS" with no warranties, express or implied, including but not
limited to, the warranties of merchantability, fitness for a particular purpose and non-infringement of intellectual property
rights and ETSI shall not be held liable in any event for any damages whatsoever (including, without limitation, damages
for loss of profits, business interruption, loss of information, or any other pecuniary loss) arising out of or related to the
use of or inability to use the software.
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 2021.
All rights reserved.
ETSI

---------------------- Page: 2 ----------------------
3 ETSI GS CIM 009 V1.4.2 (2021-04)
Contents
Intellectual Property Rights . 14
Foreword . 14
Modal verbs terminology . 14
Executive summary . 14
Introduction . 15
1 Scope . 16
2 References . 16
2.1 Normative references . 16
2.2 Informative references . 18
3 Definition of terms, symbols and abbreviations . 20
3.1 Terms . 20
3.2 Symbols . 22
3.3 Abbreviations . 22
4 Context Information Management Framework . 23
4.1 Introduction . 23
4.2 NGSI-LD Information Model. 23
4.2.1 Introduction. 23
4.2.2 NGSI-LD Meta Model . 24
4.2.3 Cross Domain Ontology . 25
4.2.4 NGSI-LD domain-specific models and instantiation . 26
4.2.5 UML representation . 26
4.3 NGSI-LD Architectural Considerations . 27
4.3.1 Introduction. 27
4.3.2 Centralized architecture . 27
4.3.3 Distributed architecture . 28
4.3.4 Federated architecture . 29
4.4 Core NGSI-LD @context . 30
4.5 NGSI-LD Data Representation. 30
4.5.1 NGSI-LD Entity Representation . 30
4.5.2 NGSI-LD Property Representation . 31
4.5.3 NGSI-LD Relationship Representation . 32
4.5.4 Simplified Representation . 32
4.5.5 Multi-Attribute Support . 33
4.5.6 Temporal Representation of an Entity . 33
4.5.7 Temporal Representation of a Property . 33
4.5.8 Temporal Representation of a Relationship . 33
4.5.9 Simplified Temporal Representation of an Entity . 34
4.5.10 Entity Type List Representation . 34
4.5.11 Detailed Entity Type List Representation . 34
4.5.12 Entity Type Information Representation. 35
4.5.13 Attribute List Representation . 35
4.5.14 Detailed Attribute List Representation . 35
4.5.15 Attribute Information Representation . 35
4.5.16 GeoJSON Representation of Entities . 36
4.5.16.0 Foreword . 36
4.5.16.1 Top-level "geometry" field selection algorithm . 36
4.5.16.2 GeoJSON Representation of an individual Entity . 36
4.5.16.3 GeoJSON Representation of Multiple Entities . 37
4.5.17 Simplified GeoJSON Representation of Entities . 37
4.5.17.0 Foreword . 37
4.5.17.1 Simplified GeoJSON Representation of an individual Entity . 37
4.5.17.2 Simplified GeoJSON Representation of multiple Entities . 38
4.5.18 NGSI-LD LanguageProperty Representation . 38
ETSI

---------------------- Page: 3 ----------------------
4 ETSI GS CIM 009 V1.4.2 (2021-04)
4.5.19 Aggregated Temporal Representation of an Entity . 38
4.5.19.0 Foreword . 38
4.5.19.1 Supported behaviours for aggregation functions . 39
4.6 Data Representation Restrictions . 41
4.6.1 Supported text encodings . 41
4.6.2 Supported names . 41
4.6.3 Supported data types for Values . 41
4.6.4 Supported Entity Content . 42
4.6.5 Supported data types for LanguageMaps . 43
4.7 Geospatial Properties . 43
4.7.1 GeoJSON Geometries . 43
4.7.2 Representation of GeoJSON Geometries in JSON-LD . 43
4.8 Temporal Properties . 44
4.9 NGSI-LD Query Language . 44
4.10 NGSI-LD Geoquery Language . 49
4.11 NGSI-LD Temporal Query Language . 51
4.12 NGSI-LD Query Pagination . 52
4.13 Counting the Number of Results . 53
4.14 Supporting Multiple Tenants . 53
4.15 NGSI-LD Language Filter . 53
5 API Operation Definition . 54
5.1 Introduction . 54
5.2 Data Types. 54
5.2.1 Introduction. 54
5.2.2 Common members . 54
5.2.3 @context . 55
5.2.4 Entity . 55
5.2.5 Property . 55
5.2.6 Relationship . 56
5.2.7 GeoProperty . 56
5.2.8 EntityInfo . 57
5.2.9 CsourceRegistration . 57
5.2.10 RegistrationInfo . 59
5.2.11 TimeInterval . 60
5.2.12 Subscription . 60
5.2.13 GeoQuery . 61
5.2.14 NotificationParams . 62
5.2.14.1 NotificationParams data type definition . 62
5.2.14.2 Additional members . 62
5.2.15 Endpoint . 63
5.2.16 BatchOperationResult . 63
5.2.17 BatchEntityError . 64
5.2.18 UpdateResult. 64
5.2.19 NotUpdatedDetails. 64
5.2.20 EntityTemporal . 64
5.2.21 TemporalQuery . 65
5.2.22 KeyValuePair . 65
5.2.23 Query . 65
5.2.24 EntityTypeList . 66
5.2.25 EntityType . 66
5.2.26 EntityTypeInfo . 67
5.2.27 AttributeList . 67
5.2.28 Attribute . 67
5.2.29 Feature . 68
5.2.30 FeatureCollection . 68
5.2.31 FeatureProperties . 69
5.2.32 LanguageProperty . 69
5.3 Notification data types . 69
5.3.1 Notification . 69
5.3.2 CsourceNotification . 70
5.3.3 TriggerReasonEnumeration . 71
ETSI

---------------------- Page: 4 ----------------------
5 ETSI GS CIM 009 V1.4.2 (2021-04)
5.4 NGSI-LD Fragments . 71
5.5 Common Behaviours . 72
5.5.1 Introduction. 72
5.5.2 Error types . 72
5.5.3 Error response payload body . 72
5.5.4 General NGSI-LD validation . 73
5.5.5 Default @context assignment . 73
5.5.6 Operation execution . 73
5.5.7 Term to URI expansion or compaction . 73
5.5.8 JSON-LD Merge Patch Behaviour . 74
5.5.9 Pagination Behaviour . 74
5.5.10 Multi-Tenant Behaviour . 75
5.6 Context Information Provision . 75
5.6.1 Create Entity . 75
5.6.1.1 Description . 75
5.6.1.2 Use case diagram . 75
5.6.1.3 Input data . 76
5.6.1.4 Behaviour . 76
5.6.1.5 Output data . 76
5.6.2 Update Entity Attributes . 76
5.6.2.1 Description . 76
5.6.2.2 Use case diagram . 76
5.6.2.3 Input data . 77
5.6.2.4 Behaviour . 77
5.6.2.5 Output data . 77
5.6.3 Append Entity Attributes . 77
5.6.3.1 Description . 77
5.6.3.2 Use case diagram . 77
5.6.3.3 Input data . 78
5.6.3.4 Behaviour . 78
5.6.3.5 Output data . 79
5.6.4 Partial Attribute update . 79
5.6.4.1 Description . 79
5.6.4.2 Use case diagram . 79
5.6.4.3 Input data . 79
5.6.4.4 Behaviour . 80
5.6.4.5 Output data . 80
5.6.5 Delete Entity Attribute . 80
5.6.5.1 Description . 80
5.6.5.2 Use case diagram . 80
5.6.5.3 Input data . 81
5.6.5.4 Behaviour . 81
5.6.5.5 Output data . 81
5.6.6 Delete Entity . 81
5.6.6.1 Description . 81
5.6.6.2 Use case diagram . 81
5.6.6.3 Input data . 82
5.6.6.4 Behaviour .
...