Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "OM2M/Containers"

Line 2: Line 2:
 
== Containers resource ==
 
== Containers resource ==
  
The ''containers'' resource corresponds to a collection of ''container'' and ''containerAnnc'' resources. The firt one corresponds to locally created containers while the second represents remote conatiners residing on the indicated resourceURI that are announced to the local resource.
+
The ''containers'' resource corresponds to a collection of ''container'' and ''containerAnnc'' resources. The first one corresponds to locally created containers while the second represents remote conatiners residing on the indicated resourceURI that are announced to the local resource.
  
 
{{CTable}}
 
{{CTable}}

Revision as of 13:22, 16 April 2014

Containers resource

The containers resource corresponds to a collection of container and containerAnnc resources. The first one corresponds to locally created containers while the second represents remote conatiners residing on the indicated resourceURI that are announced to the local resource.


Name Type Multiplicity Create Update Response
accessRightID URI 1 N/A O O
creationTime DateTime 1 N/A NP M
lastModifiedTime DateTime 1 N/A NP M
containerCollection container 0..unbounded N/A NP M
containerAnncCollection containerAnnc 0..unbounded N/A NP M
locationCollection locationContainer 0..unbounded N/A NP M
locationAnncCollection locationContainerAnnc 0..unbounded N/A NP M
subscriptionsReference AnyURI 1 N/A NP M


Containers 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="containers" type="tns:Containers" />
  <complexType name="Containers">
    <all>
      <element ref="tns:accessRightID" minOccurs="0" />
      <element ref="tns:creationTime" minOccurs="0" />
      <element ref="tns:lastModifiedTime" minOccurs="0" />
      <!-- subresources -->
      <element ref="tns:containerCollection" minOccurs="0" />
      <element ref="tns:containerAnncCollection" minOccurs="0" />
      <element ref="tns:locationContainerCollection" minOccurs="0" />
      <element ref="tns:locationContainerAnncCollection" minOccurs="0" />
      <element ref="tns:subscriptionsReference" minOccurs="0" />
    </all>
  </complexType>
  <element name="containerCollection" type="tns:NamedReferenceCollection" />
  <element name="containerAnncCollection" type="tns:NamedReferenceCollection" />
  <element name="locationContainerCollection" type="tns:NamedReferenceCollection" />
  <element name="locationContainerAnncCollection" type="tns:NamedReferenceCollection" />
</schema>

Retrieve Containers

Retrieve information about accessible resources

  • 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: Containers.
  • Response Status: 200, 402, 404, 501.

Example Request

GET /scl-id/containers
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:containers xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime">
    <om2m:accessRightID>gscl/accessRights/AR_ADMIN</om2m:accessRightID>
    <om2m:creationTime>2014-04-16T15:24:45.763+02:00</om2m:creationTime>
    <om2m:lastModifiedTime>2014-04-16T15:24:45.765+02:00</om2m:lastModifiedTime>
    <om2m:containerCollection/>
    <om2m:containerAnncCollection/>
    <om2m:locationContainerCollection/>
    <om2m:locationContainerAnncCollection/>
    <om2m:subscriptionsReference>gscl/containers/subscriptions</om2m:subscriptionsReference>
</om2m:containers>

Back to the top