ETSI title
Intellectual Property Rights
Foreword
Modal verbs terminology
Executive summary
Introduction
1 Scope
2 References
2.1 Normative references
2.2 Informative references
3 Definition of terms, symbols and abbreviations
3.1 Terms
3.2 Symbols
3.3 Abbreviations
4 Context Information Management Framework
4.1 Introduction
4.2 NGSI-LD Information Model
4.2.1 Introduction
4.2.2 NGSI-LD Meta Model
4.2.3 Cross Domain Ontology
4.2.4 NGSI-LD domain-specific models and instantiation
4.2.5 UML representation
4.3 NGSI-LD Architectural Considerations
4.3.1 Introduction
4.3.2 Centralized architecture
4.3.3 Distributed architecture
4.3.4 Federated architecture
4.3.5 NGSI-LD API Structure and Implementation Options
4.3.6 Distributed Operations
4.3.6.1 Introduction
4.3.6.2 Additive Registrations
4.3.6.3 Proxied Registrations
4.3.6.4 Limiting Cascading Distributed Operations
4.3.6.5 Extra information to provide when contacting Context Source
4.3.6.6 Additional pre- and post-processing of extra information when contacting Context Source
4.3.6.7 Querying and Retrieving Distributed Entities as Unitary Operations
4.3.6.8 Backwards compatibility of Context Source payloads
4.4 Core and user NGSI-LD @context
4.5 NGSI-LD Data Representation
4.5.0 Introduction
4.5.1 NGSI-LD Entity Representation
4.5.2 NGSI-LD Property Representations
4.5.2.1 Introduction
4.5.2.2 Normalized NGSI-LD Property
4.5.2.3 Concise NGSI-LD Property
4.5.3 NGSI-LD Relationship Representations
4.5.3.1 Introduction
4.5.3.2 Normalized NGSI-LD Relationship
4.5.3.3 Concise NGSI-LD Relationship
4.5.4 Simplified Representation
4.5.5 Multi-Attribute Support
4.5.5.1 Introduction
4.5.5.2 Processing of Conflicting Transient Entities
4.5.5.3 Processing of Conflicting Attributes
4.5.6 Temporal Representation of an Entity
4.5.7 Temporal Representation of a Property
4.5.8 Temporal Representation of a Relationship
4.5.9 Simplified temporal representation of an Entity
4.5.10 Entity Type List Representation
4.5.11 Detailed Entity Type List Representation
4.5.12 Entity Type Information Representation
4.5.13 Attribute List Representation
4.5.14 Detailed Attribute List Representation
4.5.15 Attribute Information Representation
4.5.16 GeoJSON Representation of Entities
4.5.16.0 Foreword
4.5.16.1 Top-level "geometry" field selection algorithm
4.5.16.2 GeoJSON Representation of an individual Entity
4.5.16.3 GeoJSON Representation of Multiple Entities
4.5.17 Simplified GeoJSON Representation of Entities
4.5.17.0 Foreword
4.5.17.1 Simplified GeoJSON Representation of an individual Entity
4.5.17.2 Simplified GeoJSON Representation of multiple Entities
4.5.18 NGSI-LD LanguageProperty Representations
4.5.18.1 Introduction
4.5.18.2 Normalized NGSI-LD LanguageProperty
4.5.18.3 Concise NGSI-LD LanguageProperty
4.5.19 Aggregated temporal representation of an Entity
4.5.19.0 Foreword
4.5.19.1 Supported behaviours for aggregation functions
4.5.20 NGSI-LD VocabProperty Representations
4.5.20.1 Introduction
4.5.20.2 Normalized NGSI-LD VocabProperty
4.5.20.3 Concise NGSI-LD VocabProperty
4.5.21 NGSI-LD ListProperty Representations
4.5.21.1 Introduction
4.5.21.2 Normalized NGSI-LD ListProperty
4.5.21.3 Concise NGSI-LD ListProperty
4.5.22 NGSI-LD ListRelationship Representations
4.5.22.1 Introduction
4.5.22.2 Normalized NGSI-LD ListRelationship
4.5.22.3 Concise NGSI-LD ListRelationship
4.5.23 NGSI-LD Linked Entity Retrieval
4.5.23.1 Introduction
4.5.23.2 Inline Linked Entity Representation
4.5.23.3 Flattened Linked Entity Representation
4.5.24 NGSI-LD JsonProperty Representations
4.5.24.1 Introduction
4.5.24.2 Normalized NGSI-LD JsonProperty
4.5.24.3 Concise NGSI-LD JsonProperty
4.5.25 NGSI-LD EntityMap Representation
4.6 Data Representation Restrictions
4.6.1 Supported text encodings
4.6.2 Supported names
4.6.3 Supported data types for Values
4.6.4 Supported Content
4.6.5 Supported data types for LanguageMaps
4.6.6 Ordering of Entities in arrays having more than one instance of the same Entity
4.7 Geospatial Properties
4.7.1 GeoJSON Geometries
4.7.2 Representation of GeoJSON Geometries in JSON-LD
4.7.3 Concise NGSI-LD GeoProperty
4.8 Temporal Properties
4.9 NGSI-LD Query Language
4.10 NGSI-LD Geoquery Language
4.11 NGSI-LD Temporal Query Language
4.12 NGSI-LD Pagination
4.13 Counting the Number of Results
4.14 Supporting Multiple Tenants
4.15 NGSI-LD Language Filter
4.16 Supporting Multiple Entity Types
4.17 NGSI-LD Entity Type Selection Language
4.18 NGSI-LD Scopes
4.19 NGSI-LD Scope Query Language
4.20 NGSI-LD Distributed Operation names
4.21 NGSI-LD Attribute Projection Language
4.22 Transient Storage of Entities and Attributes
5 API Operation Definition
5.1 Introduction
5.2 Data Types
5.2.1 Introduction
5.2.2 Common members
5.2.3 @context
5.2.4 Entity
5.2.5 Property
5.2.6 Relationship
5.2.7 GeoProperty
5.2.8 EntityInfo
5.2.9 CSourceRegistration
5.2.10 RegistrationInfo
5.2.11 TimeInterval
5.2.12 Subscription
5.2.13 GeoQuery
5.2.14 NotificationParams
5.2.14.1 NotificationParams data type definition
5.2.14.2 Output only members
5.2.15 Endpoint
5.2.16 BatchOperationResult
5.2.17 BatchEntityError
5.2.18 UpdateResult
5.2.19 NotUpdatedDetails
5.2.20 EntityTemporal
5.2.21 TemporalQuery
5.2.22 KeyValuePair
5.2.23 Query
5.2.24 EntityTypeList
5.2.25 EntityType
5.2.26 EntityTypeInfo
5.2.27 AttributeList
5.2.28 Attribute
5.2.29 Feature
5.2.30 FeatureCollection
5.2.31 FeatureProperties
5.2.32 LanguageProperty
5.2.33 EntitySelector
5.2.34 RegistrationManagementInfo
5.2.35 VocabProperty
5.2.36 ListProperty
5.2.37 ListRelationship
5.2.38 JsonProperty
5.2.39 EntityMap
5.2.40 Context Source Identity
5.3 Notification data types
5.3.1 Notification
5.3.2 CSourceNotification
5.3.3 TriggerReasonEnumeration
5.4 NGSI-LD Fragments
5.5 Common Behaviours
5.5.1 Introduction
5.5.2 Error types
5.5.3 Error response payload body
5.5.4 General NGSI-LD validation
5.5.5 Default @context assignment
5.5.6 Operation execution and generic error handling
5.5.7 Term to URI expansion or compaction
5.5.8 Partial Update Patch Behaviour
5.5.9 Pagination Behaviour
5.5.10 Multi-Tenant Behaviour
5.5.11 More than one instance of the same Entity in an Entity array
5.5.11.0 Foreword
5.5.11.1 Batch Entity Creation case
5.5.11.2 Batch Entity Creation or Update (Upsert) case
5.5.11.3 Batch Entity Update case
5.5.11.4 Batch Entity Delete case
5.5.11.5 Batch Entity Merge case
5.5.12 Merge Patch Behaviour
5.5.13 Limiting operations to local scope
5.5.14 Distributed Transactional Behaviour
5.6 Context Information Provision
5.6.1 Create Entity
5.6.1.1 Description
5.6.1.2 Use case diagram
5.6.1.3 Input data
5.6.1.4 Behaviour
5.6.1.5 Output data
5.6.2 Update Attributes
5.6.2.1 Description
5.6.2.2 Use case diagram
5.6.2.3 Input data
5.6.2.4 Behaviour
5.6.2.5 Output data
5.6.3 Append Attributes
5.6.3.1 Description
5.6.3.2 Use case diagram
5.6.3.3 Input data
5.6.3.4 Behaviour
5.6.3.5 Output data
5.6.4 Partial Attribute update
5.6.4.1 Description
5.6.4.2 Use case diagram
5.6.4.3 Input data
5.6.4.4 Behaviour
5.6.4.5 Output data
5.6.5 Delete Attribute
5.6.5.1 Description
5.6.5.2 Use case diagram
5.6.5.3 Input data
5.6.5.4 Behaviour
5.6.5.5 Output data
5.6.6.1 Description
5.6.6.2 Use case diagram
5.6.6.3 Input data
5.6.6.4 Behaviour
5.6.6.5 Output data
5.6.7 Batch Entity Creation
5.6.7.1 Description
5.6.7.2 Use case diagram
5.6.7.3 Input data
5.6.7.4 Behaviour
5.6.7.5 Output data
5.6.8 Batch Entity Creation or Update (Upsert)
5.6.8.1 Description
5.6.8.2 Use case diagram
5.6.8.3 Input data
5.6.8.4 Behaviour
5.6.8.5 Output data
5.6.9 Batch Entity Update
5.6.9.1 Description
5.6.9.2 Use case diagram
5.6.9.3 Input data
5.6.9.4 Behaviour
5.6.9.5 Output data
5.6.10 Batch Entity Delete
5.6.10.1 Description
5.6.10.2 Use case diagram
5.6.10.3 Input data
5.6.10.4 Behaviour
5.6.10.5 Output data
5.6.11 Create or Update (Upsert) Temporal Evolution of an Entity
5.6.11.1 Description
5.6.11.2 Use case diagram
5.6.11.3 Input data
5.6.11.4 Behaviour
5.6.11.5 Output data
5.6.12 Add Attributes to Temporal Evolution of an Entity
5.6.12.1 Description
5.6.12.2 Use case diagram
5.6.12.3 Input data
5.6.12.4 Behaviour
5.6.12.5 Output data
5.6.13 Delete Attribute from Temporal Evolution of an Entity
5.6.13.1 Description
5.6.13.2 Use case diagram
5.6.13.3 Input data
5.6.13.4 Behaviour
5.6.13.5 Output data
5.6.14 Modify Attribute instance in Temporal Evolution of an Entity
5.6.14.1 Description
5.6.14.2 Use case diagram
5.6.14.3 Input data
5.6.14.4 Behaviour
5.6.14.5 Output data
5.6.15 Delete Attribute instance from Temporal Evolution of an Entity
5.6.15.1 Description
5.6.15.2 Use case diagram
5.6.15.3 Input data
5.6.15.4 Behaviour
5.6.15.5 Output data
5.6.16 Delete Temporal Evolution of an Entity
5.6.16.1 Description
5.6.16.2 Use case diagram
5.6.16.3 Input data
5.6.16.4 Behaviour
5.6.16.5 Output data
5.6.17 Merge Entity
5.6.17.1 Description
5.6.17.2 Use case diagram
5.6.17.3 Input data
5.6.17.4 Behaviour
5.6.17.5 Output data
5.6.18 Replace Entity
5.6.18.1 Description
5.6.18.2 Use case diagram
5.6.18.3 Input data
5.6.18.4 Behaviour
5.6.18.5 Output data
5.6.19 Replace Attribute
5.6.19.1 Description
5.6.19.2 Use case diagram
5.6.19.3 Input data
5.6.19.4 Behaviour
5.6.19.5 Output data
5.6.20 Batch Entity Merge
5.6.20.1 Description
5.6.20.2 Use case diagram
5.6.20.3 Input data
5.6.20.4 Behaviour
5.6.20.5 Output data
5.6.21 Purge Entities
5.6.21.1 Description
5.6.21.2 Use case diagram
5.6.21.3 Input data
5.6.21.4 Behaviour
5.6.21.5 Output data
5.7 Context Information Consumption
5.7.1 Retrieve Entity
5.7.1.1 Description
5.7.1.2 Use case diagram
5.7.1.3 Input data
5.7.1.4 Behaviour
5.7.1.5 Output data
5.7.2 Query Entities
5.7.2.1 Description
5.7.2.2 Use case diagram
5.7.2.3 Input data
5.7.2.4 Behaviour
5.7.2.5 Output data
5.7.3 Retrieve Temporal Evolution of an Entity
5.7.3.1 Description
5.7.3.2 Use case diagram
5.7.3.3 Input data
5.7.3.4 Behaviour
5.7.3.5 Output data
5.7.4 Query Temporal Evolution of Entities
5.7.4.1 Description
5.7.4.2 Use case diagram
5.7.4.3 Input data
5.7.4.4 Behaviour
5.7.4.5 Output Data
5.7.5 Retrieve Available Entity Types
5.7.5.1 Description
5.7.5.2 Use case diagram
5.7.5.3 Input data
5.7.5.4 Behaviour
5.7.5.5 Output data
5.7.6 Retrieve Details of Available Entity Types
5.7.6.1 Description
5.7.6.2 Use case diagram
5.7.6.3 Input data
5.7.6.4 Behaviour
5.7.6.5 Output data
5.7.7 Retrieve Available Entity Type Information
5.7.7.1 Description
5.7.7.2 Use case diagram
5.7.7.3 Input data
5.7.7.4 Behaviour
5.7.7.5 Output data
5.7.8 Retrieve Available Attributes
5.7.8.1 Description
5.7.8.2 Use case diagram
5.7.8.3 Input data
5.7.8.4 Behaviour
5.7.8.5 Output data
5.7.9 Retrieve Details of Available Attributes
5.7.9.1 Description
5.7.9.2 Use case diagram
5.7.9.3 Input data
5.7.9.4 Behaviour
5.7.9.5 Output data
5.7.10 Retrieve Available Attribute Information
5.7.10.1 Description
5.7.10.2 Use case diagram
5.7.10.3 Input data
5.7.10.4 Behaviour
5.7.10.5 Output data
5.7.11 Architecture-related aspects of retrieval of Entity Types and Attributes
5.8 Context Information Subscription
5.8.1 Create Subscription
5.8.1.1 Description
5.8.1.2 Use case diagram
5.8.1.3 Input data
5.8.1.4 Behaviour
5.8.1.5 Output data
5.8.2 Update Subscription
5.8.2.1 Description
5.8.2.2 Use case diagram
5.8.2.3 Input data
5.8.2.4 Behaviour
5.8.2.5 Output data
5.8.3 Retrieve Subscription
5.8.3.1 Description
5.8.3.2 Use case diagram
5.8.3.3 Input data
5.8.3.4 Behaviour
5.8.3.5 Output data
5.8.4 Query Subscriptions
5.8.4.1 Description
5.8.4.2 Use case diagram
5.8.4.3 Input data
5.8.4.4 Behaviour
5.8.4.5 Output data
5.8.5 Delete Subscription
5.8.5.1 Description
5.8.5.2 Use case diagram
5.8.5.3 Input data
5.8.5.4 Behaviour
5.8.5.5 Output data
5.8.6 Notification behaviour
5.9 Context Source Registration
5.9.1 Introduction
5.9.2 Register Context Source
5.9.2.1 Description
5.9.2.2 Use case diagram
5.9.2.3 Input data
5.9.2.4 Behaviour
5.9.2.5 Output data
5.9.3 Update Context Source Registration
5.9.3.1 Description
5.9.3.2 Use case diagram
5.9.3.3 Input data
5.9.3.4 Behaviour
5.9.3.5 Output data
5.9.4 Delete Context Source Registration
5.9.4.1 Description
5.9.4.2 Use case diagram
5.9.4.3 Input data
5.9.4.4 Behaviour
5.9.4.5 Output data
5.10 Context Source Discovery
5.10.1 Retrieve Context Source Registration
5.10.1.1 Description
5.10.1.2 Use case diagram
5.10.1.3 Input data
5.10.1.4 Behaviour
5.10.1.5 Output data
5.10.2 Query Context Source Registrations
5.10.2.1 Description
5.10.2.2 Use case diagram
5.10.2.3 Input data
5.10.2.4 Behaviour
5.10.2.5 Output data
5.11 Context Source Registration Subscription
5.11.1 Introduction
5.11.2 Create Context Source Registration Subscription
5.11.2.1 Description
5.11.2.2 Use case diagram
5.11.2.3 Input data
5.11.2.4 Behaviour
5.11.2.5 Output data
5.11.3 Update Context Source Registration Subscription
5.11.3.1 Description
5.11.3.2 Use case diagram
5.11.3.3 Input data
5.11.3.4 Behaviour
5.11.3.5 Output data
5.11.4 Retrieve Context Source Registration Subscription
5.11.4.1 Description
5.11.4.2 Use case diagram
5.11.4.3 Input data
5.11.4.4 Behaviour
5.11.4.5 Output data
5.11.5 Query Context Source Registration Subscriptions
5.11.5.1 Description
5.11.5.2 Use case diagram
5.11.5.3 Input data
5.11.5.4 Behaviour
5.11.5.5 Output data
5.11.6 Delete Context Source Registration Subscription
5.11.6.1 Description
5.11.6.2 Use case diagram
5.11.6.3 Input data
5.11.6.4 Behaviour
5.11.6.5 Output data
5.11.7 Notification behaviour
5.12
Matching Context Source Registrations
5.13 Storing, Managing and Serving @contexts
5.13.1 Introduction
5.13.2 Add @context
5.13.2.1 Description
5.13.2.2 Use case diagram
5.13.2.3 Input data
5.13.2.4 Behaviour
5.13.2.5 Output data
5.13.3 List @contexts
5.13.3.1 Description
5.13.3.2 Use case diagram
5.13.3.3 Input data
5.13.3.4 Behaviour
5.13.3.5 Output data
5.13.4 Serve @context
5.13.4.1 Description
5.13.4.2 Use case diagram
5.13.4.3 Input data
5.13.4.4 Behaviour
5.13.4.5 Output data
5.13.5 Delete and Reload @context
5.13.5.1 Description
5.13.5.2 Use case diagram
5.13.5.3 Input data
5.13.5.4 Behaviour
5.13.5.5 Output data
5.14 Context Source Entity Mapping
5.14.1 Retrieve EntityMap
5.14.1.1 Description
5.14.1.2 Use case diagram
5.14.1.3 Input data
5.14.1.4 Behaviour
5.14.1.5 Output data
5.14.2 Update EntityMap
5.14.2.1 Description
5.14.2.2 Use case diagram
5.14.2.3 Input data
5.14.2.4 Behaviour
5.14.2.5 Output data
5.14.3 Delete EntityMap
5.14.3.1 Description
5.14.3.2 Use case diagram
5.14.3.3 Input data
5.14.3.4 Behaviour
5.14.3.5 Output data
5.14.4 Create EntityMap for Query Entities
5.14.4.1 Description
5.14.4.2 Use case diagram
5.14.4.3 Input data
5.14.4.4 Behaviour
5.14.4.5 Output data
5.14.5 Create EntityMap for Query Temporal Evolution of Entities
5.14.5.1 Description
5.14.5.2 Use case diagram
5.14.5.3 Input data
5.14.5.4 Behaviour
5.7.4.5 Output Data
5.15 Context Source Identity Information
5.15.1 Retrieve Context Source Identity Information
5.15.1.1 Description
5.15.1.2 Use case diagram
5.15.1.3 Input data
5.15.1.4 Behaviour
5.14.1.5 Output data
6 API HTTP Binding
6.1 Introduction
6.2 Global Definitions and Resource Structure
6.3 Common Behaviours
6.3.1 Introduction
6.3.2 Error Types
6.3.3 Reporting errors
6.3.4 HTTP request preconditions
6.3.5 JSON-LD @context resolution
6.3.6 HTTP response common requirements
6.3.7 Representation of Entities
6.3.8 Notification behaviour
6.3.9 Csource Notification behaviour
6.3.10 Pagination behaviour
6.3.11 Including system Attributes
6.3.12 Simplified or aggregated temporal representation of Entities
6.3.13 Counting number of results
6.3.14 Tenant specification
6.3.15 GeoJSON representation of spatially bound entities
6.3.16 Expiration time for cached @contexts
6.3.17 Distributed Operations Caching and Timeout Behaviour
6.3.18 Limiting Distributed Operations
6.3.19 Extra information to provide when contacting Context Source
6.3.20 Invalid parameters
6.3.21 Optional profile information regarding versioning and datatype conformance
6.4 Resource: entities/
6.4.1 Description
6.4.2 Resource definition
6.4.3 Resource methods
6.4.3.1 POST
6.4.3.2 GET
6.4.3.3 DELETE
6.5 Resource: entities/{entityId}
6.5.1 Description
6.5.2 Resource definition
6.5.3 Resource methods
6.5.3.1 GET
6.5.3.2 DELETE
6.5.3.3 PUT
6.5.3.4 PATCH
6.6 Resource: entities/{entityId}/attrs/
6.6.1 Description
6.6.2 Resource definition
6.6.3 Resource methods
6.6.3.1 POST
6.6.3.2 PATCH
6.7 Resource: entities/{entityId}/attrs/{attrId}
6.7.1 Description
6.7.2 Resource definition
6.7.3 Resource methods
6.7.3.1 PATCH
6.7.3.2 DELETE
6.7.3.3 PUT
6.8 Resource: csourceRegistrations/
6.8.1 Description
6.8.2 Resource definition
6.8.3 Resource methods
6.8.3.1 POST
6.8.3.2 GET
6.9 Resource: csourceRegistrations/{registrationId}
6.9.1 Description
6.9.2 Resource definition
6.9.3 Resource methods
6.9.3.1 GET
6.9.3.2 PATCH
6.9.3.3 DELETE
6.10 Resource: subscriptions/
6.10.1 Description
6.10.2 Resource definition
6.10.3 Resource methods
6.10.3.1 POST
6.10.3.2 GET
6.11 Resource: subscriptions/{subscriptionId}
6.11.1 Description
6.11.2 Resource definition
6.11.3 Resource methods
6.11.3.1 GET
6.11.3.2 PATCH
6.11.3.3 DELETE
6.12 Resource: csourceSubscriptions/
6.12.1 Description
6.12.2 Resource definition
6.12.3 Resource methods
6.12.3.1 POST
6.12.3.2 GET
6.13 Resource: csourceSubscriptions/{subscriptionId}
6.13.1 Description
6.13.2 Resource definition
6.13.3 Resource methods
6.13.3.1 GET
6.13.3.2 PATCH
6.13.3.3 DELETE
6.14 Resource: entityOperations/create
6.14.1 Description
6.14.2 Resource definition
6.14.3 Resource methods
6.14.3.1 POST
6.15 Resource: entityOperations/upsert
6.15.1 Description
6.15.2 Resource definition
6.15.3 Resource methods
6.15.3.1 POST
6.16 Resource: entityOperations/update
6.16.1 Description
6.16.2 Resource definition
6.16.3 Resource methods
6.16.3.1 POST
6.17 Resource: entityOperations/delete
6.17.1 Description
6.17.2 Resource definition
6.17.3 Resource methods
6.17.3.1 POST
6.18 Resource: temporal/entities/
6.18.1 Description
6.18.2 Resource definition
6.18.3 Resource methods
6.18.3.1 POST
6.18.3.2 GET
6.19 Resource: temporal/entities/{entityId}
6.19.1 Description
6.19.2 Resource definition
6.19.3 Resource methods
6.19.3.1 GET
6.19.3.2 DELETE
6.20 Resource: temporal/entities/{entityId}/attrs/
6.20.1 Description
6.20.2 Resource definition
6.20.3 Resource methods
6.20.3.1 POST
6.21 Resource: temporal/entities/{entityId}/attrs/{attrId}
6.21.1 Description
6.21.2 Resource definition
6.21.3 Resource methods
6.21.3.1 DELETE
6.22 Resource: temporal/entities/{entityId}/attrs/{attrId}/ {instanceId}
6.22.1 Description
6.22.2 Resource definition
6.22.3 Resource methods
6.22.3.1 PATCH
6.22.3.2 DELETE
6.23 Resource: entityOperations/query
6.23.1 Description
6.23.2 Resource definition
6.23.3 Resource methods
6.23.3.1 POST
6.24 Resource: temporal/entityOperations/query
6.24.1 Description
6.24.2 Resource definition
6.24.3 Resource methods
6.24.3.1 POST
6.25 Resource: types/
6.25.1 Description
6.25.2 Resource definition
6.25.3 Resource methods
6.25.3.1 GET
6.26 Resource: types/{type}
6.26.1 Description
6.26.2 Resource definition
6.26.3 Resource methods
6.26.3.1 GET
6.27 Resource: attributes/
6.27.1 Description
6.27.2 Resource definition
6.27.3 Resource methods
6.27.3.1 GET
6.28 Resource: attributes/{attrId}
6.28.1 Description
6.28.2 Resource definition
6.28.3 Resource methods
6.28.3.1 GET
6.29 Resource: jsonldContexts/
6.29.1 Description
6.29.2 Resource definition
6.29.3 Resource methods
6.29.3.1 POST
6.29.3.2 GET
6.30 Resource: jsonldContexts/{contextId}
6.30.1 Description
6.30.2 Resource definition
6.30.3 Resource methods
6.30.3.1 GET
6.30.3.2 DELETE
6.31 Resource: entityOperations/merge
6.31.1 Description
6.31.2 Resource definition
6.31.3 Resource methods
6.31.3.1 POST
6.32 Resource: entityMaps/{entityMapId}
6.32.1 Description
6.32.2 Resource definition
6.32.3 Resource methods
6.32.3.1 GET
6.32.3.2 PATCH
6.32.3.3 DELETE
6.33 Resource: info/sourceIdentity
6.33.1 Description
6.33.2 Resource definition
6.33.3 Resource methods
6.33.3.1 GET
6.34 Resource: entityMaps
6.34.1 Description
6.34.2 Resource definition
6.34.3 Resource methods
6.34.3.2 POST
6.35 Resource: temporal/entityMaps
6.35.1 Description
6.35.2 Resource definition
6.35.3 Resource methods
6.35.3.1 GET
6.35.3.2 POST
7 API MQTT Notification Binding
7.1 Introduction
7.2 Notification behaviour
Annex A (normative):
NGSI-LD identifier considerations
A.1 Introduction
A.2 Entity identifiers
A.3 NGSI-LD namespace
Annex B (normative):
Core NGSI-LD @context definition
Annex C (informative):
Examples of using the API
C.1 Introduction
C.2 Entity Representation
C.2.1 Property Graph
C.2.2 Vehicle Entity
C.2.3 Parking Entity
C.2.4 @context
C.3 Context Source Registration
C.4 Context Subscription
C.5 HTTP REST API Examples
C.5.1 Introduction
C.5.2 Create Entity of Type Vehicle
C.5.2.1 HTTP Request
C.5.2.2 HTTP Response
C.5.3 Query Entities
C.5.3.1 Introduction
C.5.3.2 HTTP Request
C.5.3.3 HTTP Response
C.5.4 Query Entities (Pagination)
C.5.4.1 Introduction
C.5.4.2 HTTP Request
C.5.4.3 HTTP Response
C.5.5 Temporal Query
C.5.5.1 Introduction
C.5.5.2 HTTP Request #1
C.5.5.3 HTTP Response #1
C.5.5.3 HTTP Request #2
C.5.5.4 HTTP Response #2
C.5.6 Temporal Query (Simplified Representation)
C.5.6.1 Introduction
C.5.6.2 HTTP Request
C.5.6.3 HTTP Response
C.5.7 Retrieve Available Entity Types
C.5.7.1 Introduction
C.5.7.2 HTTP Request
C.5.7.3 HTTP Response
C.5.8 Retrieve Details of Available Entity Types
C.5.8.1 Introduction
C.5.8.2 HTTP Request
C.5.8.3 HTTP Response
C.5.9 Retrieve Available Entity Type Information
C.5.9.1 Introduction
C.5.9.2 HTTP Request
C.5.9.3 HTTP Response
C.5.10 Retrieve Available Attributes
C.5.10.1 Introduction
C.5.10.2 HTTP Request
C.5.10.3 HTTP Response
C.5.11 Retrieve Details of Available Attributes
C.5.11.1 Introduction
C.5.11.2 HTTP Request
C.5.11.3 HTTP Response
C.5.12 Retrieve Available Attribute Information
C.5.12.1 Introduction
C.5.12.2 HTTP Request
C.5.12.3 HTTP Response
C.5.13 Query Entities (Natural Language Filtering)
C.5.13.1 Introduction
C.5.13.2 HTTP Request
C.5.13.3 HTTP Response
C.5.14 Temporal Query (Aggregated Representation)
C.5.14.1 Introduction
C.5.14.2 HTTP Request
C.5.14.3 HTTP Response
C.5.15 Scope Queries
C.5.15.1 Introduction
C.5.15.2 HTTP Request
C.5.15.3 HTTP Response
C.5.16 Temporal Scope Queries
C.5.16.1 Introduction
C.5.16.2 HTTP Request
C.5.16.3 HTTP Response
C.6 Date Representation
C.7 @context utilization clarifications
C.8 Link header utilization clarifications
C.9 @context processing clarifications
C.10 ValueType datatype utilization clarifications
Annex D (informative):
Transformation Algorithms
D.1 Introduction
D.2 Algorithm for transforming an NGSI-LD Entity into a JSON-LD document (ALG1)
D.3 Algorithm for transforming an NGSI-LD Property into JSON-LD (ALG1.1)
D.4 Algorithm for transforming an NGSI-LD Relationship into JSON-LD (ALG1.2)
Annex E (informative):
RDF-compatible specification of NGSI-LD meta-model
Annex F (informative):
Conventions and syntax guidelines
Annex G (informative):
Localization and Internationalization Support
G.0 Foreword
G.1 Introduction
G.1.0 Foreword
G.1.1 Associating an Entity with a Natural Language
G.1.2 Associating a Property with a Natural Language
G.1.3 Associating as equivalent entity
G.2 Natural Language Collation Support
G.2.0 Foreword
G.2.1 Maintain collations as metadata
G.2.2 Route language sensitive queries via a proxy
G.3 Localization of Dates, Currency formats, etc.
G.3.0 Foreword
G.3.1 Localizing Dates
Annex H (informative):
Suggested actuation workflows
H.1 Actuators and feedback to the consumer
H.2 Architecture for actuation
H.3 Structure of Commands and additional Properties
H.3.0 Introduction
H.3.1 Property for listing available commands
H.3.2 Properties for command endpoints
H.4 Communication model
H.4.1 Possible communication models
H.4.2 Subscription/notification model
H.4.3 Forwarding model
H.5 Implementation of the subscription-based actuation workflow
H.6 Implementation of the registration-based actuation workflow
Annex I (informative):
Change history
History
Annex E (informative):
RDF-compatible specification of NGSI-LD meta-model
The content of this annex is now in ETSI GS CIM 006
[i.8]
.