Skip to main content
Jump to: navigation, search

Difference between revisions of "OM2M/ApplicationAnnc"

(Created page with "__TOC__ == ApplicationAnnc resource == == ApplicationAnnc representation == == ApplicationAnnc create == == ApplicationAnnc retrieve == == ApplicationAnnc update == == Applica...")
 
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__TOC__
 
__TOC__
 
== ApplicationAnnc resource ==
 
== ApplicationAnnc resource ==
== ApplicationAnnc representation ==
+
 
 +
This ''ApplicationAnnc'' resource represents an active announcement of a registered application in another SCL. It keeps a link to the original resource.
 +
 
 +
This resource contains sub-resources for containers, groups, accessRights collection resources which enable the creation of these type of resources whith a lifetime and scope associated to the announced parent resource. I.e The Created sub-resources will automatically be deleted when the application is de-announced or at announcement expiration.
 +
{{CTable}}
 +
| Attribute Name || Type || Multiplicity || Create || Update ||Response
 +
|-
 +
| [[OM2M/Attributes#Link|link]] || AnyURI || 1 || M || NP || M
 +
|-
 +
| [[OM2M/Attributes#AccessRightID|accessRightID]] || AnyURI || 0..1 || O || O || O
 +
|-
 +
| [[OM2M/Attributes#SearchStrings|searchStrings]] || searchStrings || 1 || M || M || M
 +
|-
 +
| [[OM2M/Attributes#ExpirationTime|expirationTime]] || DateTime || 1 || O || O || M*
 +
|-
 +
| [[OM2M/Attributes#ID|id]] || NMTOKEN || 1 || O || NP || M*
 +
|-
 +
| [[OM2M/Containers|containersReference]] || AnyURI || 1 || NP || NP || M
 +
|-
 +
| [[OM2M/Groups|groupsReference]] || AnyURI || 1 || NP || NP || M
 +
|-
 +
| [[OM2M/AccessRights|accessRightsReference]] || AnyURI || 1 || NP || NP || M
 +
|}
 +
 
 +
== ApplicationAnnc 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="applicationAnnc" type="tns:ApplicationAnnc" />
 +
  <complexType name="ApplicationAnnc">
 +
    <all>
 +
      <element ref="tns:link" />
 +
      <element ref="tns:accessRightID" minOccurs="0" />
 +
      <element ref="tns:searchStrings" minOccurs="0" />
 +
      <element ref="tns:expirationTime" minOccurs="0" />
 +
      <!-- subresources -->
 +
      <element ref="tns:containersReference" minOccurs="0" />
 +
      <element ref="tns:groupsReference" minOccurs="0" />
 +
      <element ref="tns:accessRightsReference" minOccurs="0" />
 +
    </all>
 +
    <attribute name="id" type="anyURI"/>
 +
  </complexType>
 +
</schema>
 +
</source>
 +
 
 
== ApplicationAnnc create ==
 
== ApplicationAnnc create ==
 +
 +
This resource shall not be created via the API. It is created only as a result of a remote announcable resource announcement.
 +
 
== ApplicationAnnc retrieve ==
 
== ApplicationAnnc retrieve ==
 +
 +
'''Example Request'''
 +
 +
<pre>
 +
GET /scl-id/scls/scl-id2/applications/app-IdAnnc
 +
Host: om2m.laas.fr
 +
Authorization: Basic xxxxxxxxxxxxxxxxxxx
 +
</pre>
 +
 +
'''Example Response'''
 +
 +
<pre>
 +
HTTP/1.1 200 OK
 +
Content-Type: text/xml
 +
Body:
 +
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 +
<om2m:applicationAnnc xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime" id=app-IdAnnc>
 +
    <om2m:accessRightID>scl-id/accessRights/AR_ADMIN</om2m:accessRightID>
 +
    <om2m:searchStrings>
 +
        <om2m:searchString>ResourceType/applicationAnnc</om2m:searchString>
 +
        <om2m:searchString>Resource/1234</om2m:searchString>
 +
    </om2m:searchStrings>
 +
    <om2m:link>scl-id2/applications/app-IdAnnc</om2m:link>
 +
    <om2m:expirationTime>2045-12-25T13:41:01.826+01:00</om2m:expirationTime>
 +
    <om2m:containersReference>scl-id/scls/scl-id2/applications/app-idAnnc/containers</om2m:containersReference>
 +
    <om2m:groupsReference>scl-id/scls/scl-id2/applications/app-IdAnnc/groups</om2m:groupsReference>
 +
    <om2m:accessRightsReference>scl-id/scls/scl-id2/applications/app-IdAnnc/accessRights</om2m:accessRightsReference>
 +
</om2m:applicationAnnc>
 +
</pre>
 +
 
== ApplicationAnnc update ==
 
== ApplicationAnnc update ==
 +
 +
This resource shall not be updated via the API. It is updated only as a result of a remote announcable resource update.
 +
 
== ApplicationAnnc delete ==
 
== ApplicationAnnc delete ==
 +
 +
This resource shall not be deleted via the API. It is deleted only as a result of a remote announcable resource de-announcement.

Latest revision as of 04:42, 20 May 2014

ApplicationAnnc resource

This ApplicationAnnc resource represents an active announcement of a registered application in another SCL. It keeps a link to the original resource.

This resource contains sub-resources for containers, groups, accessRights collection resources which enable the creation of these type of resources whith a lifetime and scope associated to the announced parent resource. I.e The Created sub-resources will automatically be deleted when the application is de-announced or at announcement expiration.

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*
containersReference AnyURI 1 NP NP M
groupsReference AnyURI 1 NP NP M
accessRightsReference AnyURI 1 NP NP M

ApplicationAnnc 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="applicationAnnc" type="tns:ApplicationAnnc" />
  <complexType name="ApplicationAnnc">
    <all>
      <element ref="tns:link" />
      <element ref="tns:accessRightID" minOccurs="0" />
      <element ref="tns:searchStrings" minOccurs="0" />
      <element ref="tns:expirationTime" minOccurs="0" />
      <!-- subresources -->
      <element ref="tns:containersReference" minOccurs="0" />
      <element ref="tns:groupsReference" minOccurs="0" />
      <element ref="tns:accessRightsReference" minOccurs="0" />
    </all>
    <attribute name="id" type="anyURI"/>
  </complexType>
</schema>

ApplicationAnnc create

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

ApplicationAnnc retrieve

Example Request

GET /scl-id/scls/scl-id2/applications/app-IdAnnc
Host: om2m.laas.fr
Authorization: Basic xxxxxxxxxxxxxxxxxxx

Example Response

HTTP/1.1 200 OK
Content-Type: text/xml
Body:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<om2m:applicationAnnc xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime" id=app-IdAnnc>
    <om2m:accessRightID>scl-id/accessRights/AR_ADMIN</om2m:accessRightID>
    <om2m:searchStrings>
        <om2m:searchString>ResourceType/applicationAnnc</om2m:searchString>
        <om2m:searchString>Resource/1234</om2m:searchString>
    </om2m:searchStrings>
    <om2m:link>scl-id2/applications/app-IdAnnc</om2m:link>
    <om2m:expirationTime>2045-12-25T13:41:01.826+01:00</om2m:expirationTime>
    <om2m:containersReference>scl-id/scls/scl-id2/applications/app-idAnnc/containers</om2m:containersReference>
    <om2m:groupsReference>scl-id/scls/scl-id2/applications/app-IdAnnc/groups</om2m:groupsReference>
    <om2m:accessRightsReference>scl-id/scls/scl-id2/applications/app-IdAnnc/accessRights</om2m:accessRightsReference>
</om2m:applicationAnnc>

ApplicationAnnc update

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

ApplicationAnnc 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