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.
Difference between revisions of "OM2M/Applications"
< OM2M
(Created page with "__TOC__ == Applications resource == The ''Applications'' resource shall contain a collection of ''application'' resources. The ''sclBase/applications'' resource shall conta...") |
(→Applications resource) |
||
(15 intermediate revisions by the same user not shown) | |||
Line 4: | Line 4: | ||
The ''Applications'' resource shall contain a collection of ''application'' resources. | The ''Applications'' resource shall contain a collection of ''application'' resources. | ||
− | + | * '''sclBase/applications''' resource shall contain only ''application'' resources, representing locally registered applications. | |
− | + | * '''sclBase/scls/sclId/applications''' resource shall contain only ''applicationAnnc'' resources, representing remote applications residing on the indicated ''sclId'' that are announced to the local ''sclBase''. | |
{{CTable}} | {{CTable}} | ||
− | | Name || Type || | + | | Name || Type || Multiplicity || Create || Update ||Response |
|- | |- | ||
− | | accessRightID || URI || 0..1 || | + | | [[OM2M/Attributes#AccessRightID|accessRightID]] || URI || 0..1 || N/A || O || O |
|- | |- | ||
− | |creationTime || | + | | [[OM2M/Attributes#CreationTime|creationTime]] || DateTime || 1 || N/A || NP || M |
|- | |- | ||
− | |lastModifiedTime || | + | | [[OM2M/Attributes#LastModifiedTime|lastModifiedTime]] || DateTime || 1 || N/A || NP || M |
+ | |- | ||
+ | | [[OM2M/Application|applicationCollection]] || application || 0..unbounded || N/A || NP || M | ||
+ | |- | ||
+ | | [[OM2M/ApplicationAnnc|applicationAnncCollection]] || applicationAnnc || 0..unbounded || N/A || NP || M | ||
+ | |- | ||
+ | | [[OM2M/Subscriptions|subscriptionsReference]] || subscriptions || 1 || N/A || NP || M | ||
+ | |- | ||
+ | | mgmtObjsReference || AnyURI || 0..1 || N/A || NP || M | ||
|} | |} | ||
− | == Applications | + | == Applications XSD schema == |
+ | |||
+ | <source lang="xml"> | ||
+ | <?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="applications" type="tns:Applications" /> | ||
+ | <complexType name="Applications"> | ||
+ | <all> | ||
+ | <element ref="tns:accessRightID" minOccurs="0" /> | ||
+ | <element ref="tns:creationTime" minOccurs="0" /> | ||
+ | <element ref="tns:lastModifiedTime" minOccurs="0" /> | ||
+ | <!-- subresources --> | ||
+ | <element ref="tns:applicationCollection" minOccurs="0" /> | ||
+ | <element ref="tns:applicationAnncCollection" minOccurs="0" /> | ||
+ | <element ref="tns:subscriptionsReference" minOccurs="0" /> | ||
+ | <element ref="tns:mgmtObjsReference" minOccurs="0" /> | ||
+ | </all> | ||
+ | </complexType> | ||
+ | <element name="applicationCollection" type="tns:NamedReferenceCollection" /> | ||
+ | <element name="applicationAnncCollection" type="tns:NamedReferenceCollection" /> | ||
+ | </schema> | ||
+ | </source> | ||
+ | |||
+ | == Create Applications == | ||
+ | |||
+ | This resource shall not be created via the API, it is created as a part of the parent resource. | ||
+ | |||
+ | == Retrieve Applications == | ||
+ | |||
+ | '''Example Request''' | ||
+ | |||
+ | <pre> | ||
+ | GET /scl-id/applications | ||
+ | Host: om2m.laas.fr | ||
+ | Authorization: Basic xxxxxxxxxxxxxxxxxxx | ||
+ | </pre> | ||
+ | |||
+ | '''Example Response''' | ||
+ | |||
+ | <pre> | ||
+ | HTTP/1.1 200 OK | ||
+ | Content-Type: text/xml | ||
+ | |||
+ | <?xml version="1.0" encoding="UTF-8" standalone="yes"?> | ||
+ | <om2m:applications xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime"> | ||
+ | <om2m:accessRightID>scl-id/accessRights/AR_ADMIN</om2m:accessRightID> | ||
+ | <om2m:creationTime>2014-04-15T20:02:01.530+02:00</om2m:creationTime> | ||
+ | <om2m:lastModifiedTime>2014-04-15T20:04:11.404+02:00</om2m:lastModifiedTime> | ||
+ | <om2m:applicationCollection> | ||
+ | <om2m:namedReference id="LAMP_0">gscl/applications/LAMP_0</om2m:namedReference> | ||
+ | <om2m:namedReference id="LAMP_1">gscl/applications/LAMP_1</om2m:namedReference> | ||
+ | <om2m:namedReference id="LAMP_ALL">gscl/applications/LAMP_ALL</om2m:namedReference> | ||
+ | </om2m:applicationCollection> | ||
+ | <om2m:applicationAnncCollection/> | ||
+ | <om2m:subscriptionsReference>gscl/applications/subscriptions</om2m:subscriptionsReference> | ||
+ | <om2m:mgmtObjsReference>gscl/applications/mgmtObjs</om2m:mgmtObjsReference> | ||
+ | </om2m:applications> | ||
+ | </pre> | ||
+ | |||
+ | == Update Applications == | ||
+ | |||
+ | |||
+ | == Delete Applications == | ||
+ | This resource shall not be deleted via the API. It is deleted when the parent resource is deleted. |
Latest revision as of 05:14, 20 May 2014
Contents
Applications resource
The Applications resource shall contain a collection of application resources.
- sclBase/applications resource shall contain only application resources, representing locally registered applications.
- sclBase/scls/sclId/applications resource shall contain only applicationAnnc resources, representing remote applications residing on the indicated sclId that are announced to the local sclBase.
Name | Type | Multiplicity | Create | Update | Response |
accessRightID | URI | 0..1 | N/A | O | O |
creationTime | DateTime | 1 | N/A | NP | M |
lastModifiedTime | DateTime | 1 | N/A | NP | M |
applicationCollection | application | 0..unbounded | N/A | NP | M |
applicationAnncCollection | applicationAnnc | 0..unbounded | N/A | NP | M |
subscriptionsReference | subscriptions | 1 | N/A | NP | M |
mgmtObjsReference | AnyURI | 0..1 | N/A | NP | M |
Applications XSD schema
<?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="applications" type="tns:Applications" /> <complexType name="Applications"> <all> <element ref="tns:accessRightID" minOccurs="0" /> <element ref="tns:creationTime" minOccurs="0" /> <element ref="tns:lastModifiedTime" minOccurs="0" /> <!-- subresources --> <element ref="tns:applicationCollection" minOccurs="0" /> <element ref="tns:applicationAnncCollection" minOccurs="0" /> <element ref="tns:subscriptionsReference" minOccurs="0" /> <element ref="tns:mgmtObjsReference" minOccurs="0" /> </all> </complexType> <element name="applicationCollection" type="tns:NamedReferenceCollection" /> <element name="applicationAnncCollection" type="tns:NamedReferenceCollection" /> </schema>
Create Applications
This resource shall not be created via the API, it is created as a part of the parent resource.
Retrieve Applications
Example Request
GET /scl-id/applications 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:applications xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime"> <om2m:accessRightID>scl-id/accessRights/AR_ADMIN</om2m:accessRightID> <om2m:creationTime>2014-04-15T20:02:01.530+02:00</om2m:creationTime> <om2m:lastModifiedTime>2014-04-15T20:04:11.404+02:00</om2m:lastModifiedTime> <om2m:applicationCollection> <om2m:namedReference id="LAMP_0">gscl/applications/LAMP_0</om2m:namedReference> <om2m:namedReference id="LAMP_1">gscl/applications/LAMP_1</om2m:namedReference> <om2m:namedReference id="LAMP_ALL">gscl/applications/LAMP_ALL</om2m:namedReference> </om2m:applicationCollection> <om2m:applicationAnncCollection/> <om2m:subscriptionsReference>gscl/applications/subscriptions</om2m:subscriptionsReference> <om2m:mgmtObjsReference>gscl/applications/mgmtObjs</om2m:mgmtObjsReference> </om2m:applications>
Update Applications
Delete Applications
This resource shall not be deleted via the API. It is deleted when the parent resource is deleted.