Context Registration Resource /registerContext Generic context registration.The expected request body is an instance of registerContextRequest; the response body is an instance of registerContextResponse. Discovery resource /discoverContextAvailability Generic discovery of context information providers. The expected request body is an instance of discoverContextAvailabilityRequest; the response body is an instance of Availability subscription resource /subscribeContextAvailability Generic subscription to context availability information. The expected request body is an instance of the response body is an instance of Availability subscription update resource Generic update of context availability subscriptions. The expected request body is an instance of the response body is an instance of Availability subscription deletion resource /unsubscribeContextAvailability Generic deletion of context availability subscriptions. The expected request body is an instance of the response body is an instance of
API Operations on Context Management Component Standard NGSI-9 Operation Resources The five resources listed in the table below represent the five operations offered by systems that implement the NGSI-9 Context Management role. Each of these resources allows interaction via http POST. All attempts to interact by other verbs shall result in an HTTP error status 405; the server should then also include the ‘Allow: POST’ field in the response. Convenience Operation Resources The table below gives an overview of the resources for convenience operation and the effects of interacting with them via the standard HTTP verbs GET, PUT, POST, and DELETE. Resource Base URI: HTTP verbs GET PUT POST DELETE Individual context entity Retrieve information on providers of any information the context entity - Register a provider of information the entity - Attribute container of individual context entity Retrieve information on providers of any information about the context entity - Register a provider of information about the entity - Attribute of individual context entity Retrieve information on providers of the attribute - Register a provider of information the attribute - Attribute domain of individual context entity Retrieve information on providers of information attribute values from the domain - Register a provider of information about attributes from the domain - Context entity type Retrieve information on providers of any information about context entities of the type - Register a provider of information about context entitie of the type - }
GET PUT POST DELETE Individual context entity Retrieve all available information about the context entity Replace a number of attribute values Append context attribute values Delete all entity Attribute container of individual context entity Retrieve all available information about context entity Replace a number of attribute values Append context attribute values Delete all entity Attribute of individual context entity Retrieve attribute value(s) and associated metadata - Append context attribute value Delete all attribute values Specific attribute value of individual context entity Retrieve specific attribute Replace attribute value - Delete attribute value Attribute domain of individual context entity Retrieve all attribute information belonging to attribute domain - - - Context entity type Retrieve all available information about all context entities having that entity type - - - Attribute container of entity type Retrieve all available information about all context entities - - - on on
measurement result to an application platform. The simplest elementary actuator is a light switch. We have emphasized potentially because as a result of the light switch being switched on it is not sure that the effect will be that light bulb goes on: only an associated sensor will be able to determine whether it went on or not. Other examples of devices are smart meters, mobile POS devices. More sophisticated devices may have a unique identifier, embedded computing capabilities and local data storage utilities, as well as embedded communication capabilities over short and/or long distances to communicate with IoT backend. Simple devices may not have all these capabilities and they can for instance only disclose the measurement results via mechanical means. In this latter case the further disclosure of the measurement result towards IoT backend requires another kind of device, called IoT Gateway. Association. It is a physical/logical relationship between a device and a or a device and a group of things or a group of devices and a group of things from the perspective of a instance, an
Convenience Operation Resources The table below gives an overview of the resources for convenience operation and the effects of interacting with them via the standard HTTP verbs GET, PUT, POST, and DELETE. Resource Base URI: HTTP verbs GET PUT POST DELETE Individual context entity /contextEntities/{EntityID} Retrieve on providers of any about the context entity - Register a provider of about the entity - Attribute container of individual context entity Retrieve on providers of any about the context entity - Register a provider of about the entity - Attribute of individual context entity Retrieve on providers of the attribute value - Register a provider of about the attribute - Attribute domain of individual context entity Retrieve on providers of about attribute values from the domain - Register a provider of about attributes from the domain - Context entity type Retrieve - Register a provider -
on providers of any context entities of the type of about context entitie of the type Attribute container of entity type Retrieve on providers of any about context entities of the type - Register a provider of about context entitie of the type - Attribute of entity type Retrieve on providers of values of this attribute of context entities of the type - Register a provider of about this attribute of context entities of the type - Attribute domain of entity type Retrieve on providers of attribute values belonging to the specific domain, where the entity is of the specific type - Register a provider of about attributes belonging to the specific domain, where the entity is of the specific type - Availability container - - Create a new -
Availability - - Cancel API operation on Context Consumer Component This section describes the resource that has to be provided by the context consumer in order to receive availability notifications. All attempts to interact with it by other verbs than POST shall result in an HTTP error status 405; the server should then also include the ‘Allow: POST’ field in the response. Resource URI HTTP verbs POST Notify context resource //{notificationURI} Generic availability notification.The expected request body is an instance of notifyContextAvailabilityRequest; the response body is an instance of notifyContextAvailabilityResponse.
root resource GET /{sclBase}/containers/{container} Read the attributes of a container instance and references to its direct resources. PUT /{sclBase}/containers/{container} Update all of the attributes in a container instance. POST /{sclBase}/containers/{container} Create a new container instance resource in a containers collection. DELETE /{sclBase}/containers/{container} Delete the container instance. Content Instance A Content Instance represents a data instance in the container. The content of the instance is opaque to the M2M platform and it might even be encrypted. However, there is meta-data associated with an instance which shall be accessible. Verb URI Description GET /{sclBase}/containers/{container}/contentInstances Read the content of the content instances root resource. This request is used to get a list of data of all instances in the addressed collection.
of the thing, but not in physical contact with it. An example of physical neighborhood is the association of the mobile phone of a subscriber who is caught in a traffic jam with the traffic jam itself: the mobile phone is the device, the traffic jam is the thing and the association means that the mobile phone is in the physical neighborhood of the area inside which the traffic jam is constrained (e.g. within 100 m from the region where the average speed of cars is below 5 km/h). Logical association means that there is a relationship between the device and the thing which is neither fully physical in the sense of attachment or embedding, nor fully physical proximity related. An example of logical association is between the car and the garage door opener of the garage where the car usually parks during the night. IoT gateway. A device that additionally to or instead of sensing/actuating provides and protocol conversion functionalities between devices and IoT backend potentially in any combination of these hosts a number of features of one or several Generic Enablers of the IoT Service Enablement. It
Attribute container of entity type Retrieve information on providers of any information about context entities of the type - Register a provider of information context entitie of the type - Attribute of entity type Retrieve information on providers of values of this attribute of context entities of the type - Register a provider of information about this attribute of context entities of the type - Attribute domain of entity type Retrieve information on providers of attribute values belonging to the specific domain, where the entity is of the specific type - Register a provider of information about attributes belonging to the specific domain, where the entity is of the specific type - Availability container - - Create a new availability subscription - Availability - Update subscription - Cancel API operation on Context Consumer Component This section describes the resource that has to be provided by the context consumer in order to receive availability notifications. All attempts to interact with it by other verbs than POST shall result in an HTTP error status 405; the server should then also include the ‘Allow: POST’ field in the response.
Resource URI HTTP POST Notify context resource //{notificationURI} Generic availability notification.The expected request body is an instance of notifyContextAvailabilityRequest; the response body is an instance of notifyContextAvailabilityResponse.
FI-WARE NGSI-10 Open RESTful API Specification (PRELIMINARY) You can find the content of this chapter as well in the of fi-ware. Introduction to the FI-WARE NGSI 10 API Please the to understand the rights to use FI-WARE Open Specifications. FI-WARE NGSI 10 API Core The FI-WARE version of the OMA NGSI 10 interface is a RESTful API via HTTP. Its purpose is to exchange context information. The three main interaction types are one-time queries for context information subscriptions for context information updates (and the corresponding notifications) unsolicited updates (invoked by context providers) Intended Audience This guide is intended for both developers of GE implementations and IoT Application programmers. For the former, this document specifies the API that has to be implemented in order to ensure interoperability with other GEs from the IoT Chapter of FI-WARE and the Publish/Subscribe Broker GE. For the latter, this document describes how to assemble instances of the FI-WARE IoT Platform. Prerequisites: Throughout this specification it is assumed that the reader is familiar with ReSTful web services HTTP/1.1 XML data serialization formats We also refer the reader to the NGSI-9/10 specification and binding documents for details on the resource structure and message formats. Change history This version of the FI-WARE NGSI-10 Open RESTful API Specification replaces and obsoletes all previous versions. The most recent changes are described in the table below: Revision Date Changes Summary May 14, 2012 1st stable version
Individual context entity Retrieve all available information the context entity Replace a number of attribute values Append context attribute values Delete all entity Attribute container of individual context entity Retrieve all available information about context entity Replace a number of attribute values Append context attribute values Delete all entity Attribute of individual context entity Retrieve attribute value(s) and associated metadata - Append context attribute value Delete all attribute values Specific attribute value of individual context entity Retrieve specific attribute Replace attribute value - Delete attribute Attribute domain of individual context entity Retrieve all attribute information belonging to attribute domain - - - Context entity type Retrieve all available information about all context entities having that entity type - - - Attribute container of entity type Retrieve all available information about all context entities having that entity type - - -