ETSI GS CIM 004 V1.1.2 (2020-06)

Context Information Management (CIM); Application Programming Interface (API)

RGS/CIM-0004v112

General Information

• Status: Not Published
• Technical Committee: CIM - cross-cutting Context Information Management
• Current Stage: 12 - Completion
• Due Date: 25-May-2020
• Completion Date: 02-Jun-2020

Standards Content (Sample)

ETSI GS CIM 004 V1.1.2 (2020-06)






GROUP SPECIFICATION
Context Information Management (CIM);
Application Programming Interface (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 004 V1.1.2 (2020-06)



Reference
RGS/CIM-0004v112
Keywords
API, architecture, GAP, information model,
interoperability, smart city

ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

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:
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
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 2020.
All rights reserved.

DECT™, PLUGTESTS™, UMTS™ and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.

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 004 V1.1.2 (2020-06)
Contents
Intellectual Property Rights . 10
Foreword . 10
Modal verbs terminology . 10
Executive summary . 10
Introduction . 10
1 Scope . 12
2 References . 12
2.1 Normative references . 12
2.2 Informative references . 13
3 Definition of terms, symbols and abbreviations . 14
3.1 Terms . 14
3.2 Symbols . 15
3.3 Abbreviations . 16
4 Context Information Management Framework . 16
4.1 Introduction . 16
4.2 NGSI-LD Information Model. 17
4.2.1 Introduction. 17
4.2.2 NGSI-LD Meta Model . 17
4.2.3 Cross Domain Ontology . 18
4.2.4 NGSI-LD domain-specific models and instantiation . 19
4.2.5 UML representation . 20
4.3 NGSI-LD Architectural considerations . 20
4.3.1 Introduction. 20
4.3.2 Centralized architecture . 21
4.3.3 Distributed architecture . 21
4.3.4 Federated architecture . 22
4.4 Core NGSI-LD @context . 23
4.5 NGSI-LD Data Representation. 23
4.5.1 NGSI-LD Entity Representation . 23
4.5.2 NGSI-LD Property Representation . 24
4.5.3 NGSI-LD Relationship Representation . 24
4.5.4 Simplified Representation . 25
4.6 Data Representation Restrictions . 25
4.6.1 Supported text encodings . 25
4.6.2 Supported names . 25
4.6.3 Supported data types for Values . 26
4.6.4 Supported Entity Content . 26
4.7 Geospatial Properties . 27
4.7.1 GeoJSON Geometries . 27
4.7.2 Representation of GeoJSON Geometries in JSON-LD . 27
4.8 Temporal properties . 28
4.9 NGSI-LD Query Language . 28
4.10 NGSI-LD Geo-query language . 31
4.11 NGSI-LD Temporal Query language . 33
5 API Operation Definition . 34
5.1 Introduction . 34
5.2 Data types . 34
5.2.1 Introduction. 34
5.2.2 Common members . 34
5.2.3 @context . 34
5.2.4 Entity . 34
5.2.5 Property . 35
ETSI

---------------------- Page: 3 ----------------------
4 ETSI GS CIM 004 V1.1.2 (2020-06)
5.2.6 Relationship . 35
5.2.7 GeoProperty . 35
5.2.8 EntityInfo . 36
5.2.9 CsourceRegistration . 36
5.2.10 RegistrationInfo . 37
5.2.11 TimeInterval . 37
5.2.12 Subscription . 38
5.2.13 GeoQuery . 39
5.2.14 NotificationParams . 39
5.2.14.1 NotificationParams data type definition . 39
5.2.14.2 Additional members . 39
5.2.15 EndPoint . 40
5.3 Notification data types . 40
5.3.1 Notification . 40
5.3.2 CsourceNotification . 41
5.3.3 TriggerReasonEnumeration . 41
5.4 NGSI-LD Fragments . 41
5.5 Common behaviours. 42
5.5.1 Introduction. 42
5.5.2 Error types . 42
5.5.3 Error payloads . 42
5.5.4 JSON-LD validation . 43
5.5.5 Default @context assignment . 43
5.5.6 Operation execution . 43
5.5.7 Term to URI expansion . 43
5.5.8 JSON-LD Merge Patch Behaviour . 43
5.6 Context Information Provision . 44
5.6.1 Create Entity . 44
5.6.1.1 Description . 44
5.6.1.2 Use case diagram . 44
5.6.1.3 Input data . 44
5.6.1.4 Behaviour . 44
5.6.1.5 Output data . 44
5.6.2 Update Entity Attributes . 44
5.6.2.1 Description . 44
5.6.2.2 Use case diagram . 45
5.6.2.3 Input data . 45
5.6.2.4 Behaviour . 45
5.6.2.5 Output data . 45
5.6.3 Append Entity Attributes . 45
5.6.3.1 Description . 45
5.6.3.2 Use case diagram . 45
5.6.3.3 Input data . 46
5.6.3.4 Behaviour . 46
5.6.3.5 Output data . 46
5.6.4 Partial Attribute update . 47
5.6.4.1 Description . 47
5.6.4.2 Use case diagram . 47
5.6.4.3 Input data . 47
5.6.4.4 Behaviour . 47
5.6.4.5 Output data . 48
5.6.5 Delete Entity Attribute . 48
5.6.5.1 Description . 48
5.6.5.2 Use case diagram . 48
5.6.5.3 Input data . 48
5.6.5.4 Behaviour . 48
5.6.5.5 Output data . 49
5.6.6 Delete Entity . 49
5.6.6.1 Description . 49
5.6.6.2 Use case diagram . 49
5.6.6.3 Input data . 49
5.6.6.4 Behaviour . 49
ETSI

---------------------- Page: 4 ----------------------
5 ETSI GS CIM 004 V1.1.2 (2020-06)
5.6.6.5 Output data . 49
5.7 Context Information Consumption . 50
5.7.1 Retrieve Entity . 50
5.7.1.1 Description . 50
5.7.1.2 Use case diagram . 50
5.7.1.3 Input data . 50
5.7.1.4 Behaviour . 50
5.7.1.5 Output data . 50
5.7.2 Query Entities . 51
5.7.2.1 Description . 51
5.7.2.2 Use case diagram . 51
5.7.2.3 Input data . 51
5.7.2.4 Behaviour . 51
5.7.2.5 Output data . 52
5.8 Context Information Subscription . 52
5.8.1 Create Subscription . 52
5.8.1.1 Description . 52
5.8.1.2 Use case diagram . 52
5.8.1.3 Input data . 52
5.8.1.4 Behaviour . 53
5.8.1.5 Output data . 53
5.8.2 Update Subscription . 53
5.8.2.1 Description . 53
5.8.2.2 Use case diagram . 53
5.8.2.3 Input data . 54
5.8.2.4 Behaviour . 54
5.8.2.5 Output data . 54
5.8.3 Retrieve Subscription . 54
5.8.3.1 Description . 54
5.8.3.2 Use case diagram . 54
5.8.3.3 Input data . 55
5.8.3.4 Behaviour . 55
5.8.3.5 Output data . 55
5.8.4 Query Subscriptions . 55
5.8.4.1 Description . 55
5.8.4.2 Use case diagram . 55
5.8.4.3 Input data . 56
5.8.4.4 Behaviour . 56
5.8.4.5 Output data . 56
5.8.5 Delete Subscription . 56
5.8.5.1 Description . 56
5.8.5.2 Use case diagram . 56
5.8.5.3 Input data . 57
5.8.5.4 Behaviour . 57
5.8.5.5 Output data . 57
5.8.6 Notification behaviour . 57
5.9 Context Source Registration . 58
5.9.1 Introduction. 58
5.9.2 Register Context Source . 58
5.9.2.1 Description . 58
5.9.2.2 Use case diagram . 58
5.9.2.3 Input data .
...