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/ContainerAnnc"

(ContainerAnnc Resource)
Line 3: Line 3:
 
== ContainerAnnc Resource ==
 
== ContainerAnnc Resource ==
  
This resource represents an active announcement of a container in another SCL. The containerAnnc resource keeps a link to the original resource.  
+
The ContainerAnnc resource represents an active announcement of a container in another SCL. This resource keeps a link to the original resource.  
  
  
Line 44: Line 44:
  
 
== ContainerAnnc retrieve ==
 
== ContainerAnnc retrieve ==
 +
 +
'''Retrieve information about a containerAnnc 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: AccessRightAnnc.
 +
* Response Status: 200, 402, 404, 501.
 +
 +
'''Example Request'''
 +
 +
<pre>
 +
GET /scl-id/scls/scl-id2/containers/containerAnnc
 +
Host: om2m.laas.fr
 +
Authorization: Basic xxxxxxxxxxxxxxxxxxx
 +
</pre>
 +
 +
'''Example Response'''
 +
 +
<pre>
 +
HTTP/1.1 200 OK
 +
Content-Type: text/xml
 +
 +
</pre>
 +
  
  

Revision as of 07:11, 18 April 2014

ContainerAnnc Resource

The ContainerAnnc resource represents an active announcement of a container in another SCL. This resource keeps a link to the original resource.


Attribute Name Type Multiplicity Create Update Response
link AnyURI 1 M NP M
accessRightID AnyURI 0..1 O O O
searchStrings searchStrings 1 M M M
expirationTime DateTime 1 O O M*
id NMTOKEN 1 O NP M*

ContainerAnnc 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="containerAnnc" type="tns:ContainerAnnc" />
  <complexType name="ContainerAnnc">
    <all>
      <element ref="tns:link" />
      <element ref="tns:accessRightID" minOccurs="0" />
      <element ref="tns:searchStrings" minOccurs="0" />
      <element ref="tns:expirationTime" minOccurs="0" />
    </all>
    <attribute ref="tns:id"/>
  </complexType>
</schema>

ContainerAnnc create

This resource shall not be created via the API. It is created only as a result of a remote announcable resource announcement.

ContainerAnnc retrieve

Retrieve information about a containerAnnc 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: AccessRightAnnc.
  • Response Status: 200, 402, 404, 501.

Example Request

GET /scl-id/scls/scl-id2/containers/containerAnnc
Host: om2m.laas.fr
Authorization: Basic xxxxxxxxxxxxxxxxxxx

Example Response

HTTP/1.1 200 OK
Content-Type: text/xml


ContainerAnnc update

This resource shall not be updated via the API. It is updated only as a result of a remote announcable resource update.

ContainerAnnc delete

This resource shall not be deleted via the API. It is deleted only as a result of a remote announcable resource de-announcement.

Back to the top