Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
OM2M/Application
Contents
Application resource
This resource represents a registered application.
Name | Type | Multiplicity | Create | Update | Response |
appId | string | 1 | O | NP | M |
accessRightID | URI | 0..1 | O | O | O |
creationTime | Time | 1 | NP | NP | M |
lastModifiedTime | Time | 1 | NP | NP | M |
expirationTime | Time | 1 | O | O | M* |
searchStrings | searchStrings | 1 | O | O | M |
announceTo | URI | 0..unbounded | O | O | M* |
aPoC | URI | 0..1 | O | O | O |
aPoCPaths | URI | 0..1 | O | O | O |
Iocrequester | 0..1 | O | O | O | |
containersReference | collection | 1 | NP | NP | M |
groupsReference | collection | 1 | NP | NP | M |
accessRightsReference | collection | 1 | NP | NP | M |
subscriptionsReference | collection | 1 | NP | NP | M |
notificationChannelsReference | collection | 1 | NP | NP | M |
Application representation
<?xml version="1.0" encoding="UTF-8"?> <schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://uri.etsi.org/m2m" xmlns:tns="http://uri.etsi.org/m2m"> <include schemaLocation="common.xsd" /> <element name="application" type="tns:Application" /> <complexType name="Application"> <all> <element ref="tns:expirationTime" minOccurs="0" /> <element ref="tns:accessRightID" minOccurs="0" /> <element ref="tns:searchStrings" minOccurs="0" /> <element ref="tns:creationTime" minOccurs="0" /> <element ref="tns:lastModifiedTime" minOccurs="0" /> <element ref="tns:announceTo" minOccurs="0" /> <element ref="tns:aPoC" minOccurs="0" /> <element ref="tns:aPoCPaths" minOccurs="0" /> <element ref="tns:locRequestor" minOccurs="0" /> <!-- subresources --> <element ref="tns:containersReference" minOccurs="0" /> <element ref="tns:groupsReference" minOccurs="0" /> <element ref="tns:accessRightsReference" minOccurs="0" /> <element ref="tns:subscriptionsReference" minOccurs="0" /> <element ref="tns:notificationChannelsReference" minOccurs="0" /> </all> <attribute name="appId" type="anyURI"/> </complexType> <element name="applicationStatus" type="tns:ApplicationStatus" /> <element name="aPoC" type="anyURI" /> <element name="aPoCPaths" type="tns:APoCPaths" /> <element name="locRequestor" type="anySimpleType" /> <simpleType name="ApplicationStatus"> <restriction base="string"> <enumeration value="ONLINE"></enumeration> <enumeration value="OFFLINE"></enumeration> <enumeration value="NOT_REACHABLE"></enumeration> </restriction> </simpleType> <complexType name="APoCPaths"> <sequence> <element ref="tns:aPoCPath" minOccurs="0" maxOccurs="unbounded" /> </sequence> </complexType> <element name="aPoCPath" type="tns:APoCPath" /> <complexType name="APoCPath"> <all> <element ref="tns:path"/> <element ref="tns:accessRightID" minOccurs="0" /> <element ref="tns:searchStrings" minOccurs="0" /> </all> </complexType> <element name="path" type="anyURI" /> </schema>
Application resource management
Application Create
Create an application resource
- Synopsis: POST {Well Known URI of the Service}
- Request Headers: Authorization, Accept.
- Request Body: N/A.
- Response Headers: Content-Type, Content-Length.
- Response Message Body: Applications.
- Response Status: 201, 402, 404, 501.
Example Request
POST /scl-id/applications Host: om2m.laas.fr Authorization: Basic xxxxxxxxxxxxxxxxxxx Body: <om2m:application xmlns:om2m="http://uri.etsi.org/m2m" appId="MY_SENSOR"> <om2m:searchStrings> <om2m:searchString>Type/sensor</om2m:searchString> <om2m:searchString>Category/temperature</om2m:searchString> <om2m:searchString>Location/Home</om2m:searchString> </om2m:searchStrings> </om2m:application>
Example Response
HTTP/1.1 201 Created Content-Type: text/xml <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <om2m:application xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime" appId="MY_SENSOR"> <om2m:accessRightID>gscl/accessRights/AR_ADMIN</om2m:accessRightID> <om2m:searchStrings> <om2m:searchString>Type/sensor</om2m:searchString> <om2m:searchString>Category/temperature</om2m:searchString> <om2m:searchString>Location/Home</om2m:searchString> </om2m:searchStrings> <om2m:expirationTime>2045-12-23T16:15:11.981+01:00</om2m:expirationTime> <om2m:creationTime>2014-04-16T15:28:32.981+02:00</om2m:creationTime> <om2m:lastModifiedTime>2014-04-16T15:28:32.981+02:00</om2m:lastModifiedTime> <om2m:announceTo> <om2m:activated>false</om2m:activated> <om2m:global>false</om2m:global> </om2m:announceTo> <om2m:containersReference>gscl/applications/MY_SENSOR/containers</om2m:containersReference> <om2m:groupsReference>gscl/applications/MY_SENSOR/groups</om2m:groupsReference> <om2m:accessRightsReference>gscl/applications/MY_SENSOR/accessRights</om2m:accessRightsReference> <om2m:subscriptionsReference>gscl/applications/MY_SENSOR/subscriptions</om2m:subscriptionsReference> <om2m:notificati
Application Retreive
Retrieve information about an application resource
- Synopsis: GET {Well Known URI of the Service}
- Request Headers: Authorization, Accept.
- Request Body: N/A.
- Response Headers: Content-Type, Content-Length.
- Response Message Body: Applications.
- Response Status: 200, 402, 404, 501.
Example Request
GET /scl-id/applications/app-Id Host: om2m.laas.fr Authorization: Basic xxxxxxxxxxxxxxxxxxx
Example Response
HTTP/1.1 200 OK Content-Type: text/xml <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <om2m:application xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime" appId="MY_SENSOR"> <om2m:accessRightID>gscl/accessRights/AR_ADMIN</om2m:accessRightID> <om2m:searchStrings> <om2m:searchString>Type/sensor</om2m:searchString> <om2m:searchString>Category/temperature</om2m:searchString> <om2m:searchString>Location/Home</om2m:searchString> </om2m:searchStrings> <om2m:expirationTime>2045-12-23T16:15:11.981+01:00</om2m:expirationTime> <om2m:creationTime>2014-04-16T15:28:32.981+02:00</om2m:creationTime> <om2m:lastModifiedTime>2014-04-16T15:28:32.981+02:00</om2m:lastModifiedTime> <om2m:announceTo> <om2m:activated>false</om2m:activated> <om2m:global>false</om2m:global> </om2m:announceTo> <om2m:containersReference>gscl/applications/MY_SENSOR/containers</om2m:containersReference> <om2m:groupsReference>gscl/applications/MY_SENSOR/groups</om2m:groupsReference> <om2m:accessRightsReference>gscl/applications/MY_SENSOR/accessRights</om2m:accessRightsReference> <om2m:subscriptionsReference>gscl/applications/MY_SENSOR/subscriptions</om2m:subscriptionsReference> <om2m:notificationChannelsReference>gscl/applications/MY_SENSOR/notificationChannels</om2m:notificationChannelsReference> </om2m:application>