Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "OM2M/Subscriptions"
< OM2M
(Created page with "__TOC__ == Subscriptions resource == The subscriptions resource is a collection of subscription resources, it is a child of a subscribe-able parent. {...") |
(→Subscriptions resource) |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
== Subscriptions resource == | == Subscriptions resource == | ||
| − | The subscriptions resource is a collection of | + | The subscriptions resource is a collection of subscription resources, it is a child of a subscribe-able parent. |
{{CTable}} | {{CTable}} | ||
| Line 11: | Line 11: | ||
|} | |} | ||
| − | == Subscriptions | + | == Subscriptions XSD schema == |
<source lang="xml"> | <source lang="xml"> | ||
| Line 30: | Line 30: | ||
== Create Subscriptions == | == Create Subscriptions == | ||
| − | + | This resource shall not be created via the API, it is created as a part of the parent resource. | |
== Retrieve Subscriptions == | == Retrieve Subscriptions == | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
'''Example Request''' | '''Example Request''' | ||
| Line 67: | Line 58: | ||
== Update Subscriptions == | == Update Subscriptions == | ||
| − | The subscriptions resource | + | The subscriptions resource does not have any updatable attribute. |
== Delete Subscriptions == | == Delete Subscriptions == | ||
| − | + | This resource shall not be deleted via the API. It is deleted when the parent resource is deleted. | |
Latest revision as of 05:12, 20 May 2014
Contents
Subscriptions resource
The subscriptions resource is a collection of subscription resources, it is a child of a subscribe-able parent.
| Attribute Name | Type | Multiplicity | Create | Update | Response |
| subscriptionCollection | NamedReferenceCollection | 0..unbounded | N/A | NP | M |
Subscriptions 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="subscriptions" type="tns:Subscriptions" /> <complexType name="Subscriptions"> <sequence> <!-- subresources --> <element ref="tns:subscriptionCollection" minOccurs="0" /> </sequence> </complexType> <element name="subscriptionCollection" type="tns:NamedReferenceCollection" /> </schema>
Create Subscriptions
This resource shall not be created via the API, it is created as a part of the parent resource.
Retrieve Subscriptions
Example Request
GET /scl-id/applications/subscriptions 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:subscriptions xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime">
<om2m:subscriptionCollection>
<om2m:namedReference id="SUB_357975768">scl-id/applications/subscriptions/SUB_357975768</om2m:namedReference>
</om2m:subscriptionCollection>
</om2m:subscriptions>
Update Subscriptions
The subscriptions resource does not have any updatable attribute.
Delete Subscriptions
This resource shall not be deleted via the API. It is deleted when the parent resource is deleted.