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

OM2M/MembersContent

< OM2M
Revision as of 14:16, 17 April 2014 by Ybanouar.laas.fr (Talk | contribs) (Create a resource in Group members)

MembersContent resource

The membersContent resource does not represent a real resource, it is used to fan-out request to all group members in batch mode. The returned response is a membersContentResponses type, and it is a result of an aggregation of each member response.

MembersContent 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"
    xmlns:xmlmime="http://www.w3.org/2005/05/xmlmime">
    <include schemaLocation="common.xsd" />
    <import namespace="http://www.w3.org/2005/05/xmlmime" schemaLocation="xmlmime.xsd" />
    <element name="membersContentResponses">
        <complexType>
            <sequence>
                <element name="status" minOccurs="0" maxOccurs="unbounded">
                    <complexType>
                            <all>
                                <element name="statusCode" type="string" />
                                <element name="eTag" type="string" minOccurs="0"/>
                                <element name="lastModifiedTime" type="dateTime" minOccurs="0"/>
                                <element name="resultBody" type="xmlmime:base64Binary" minOccurs="0"/>
                                <!-- element name="resultHeaders" type="string" ???? -->
                            </all>
                            <attribute name="id" type="anyURI" />
                    </complexType>
                </element>
            </sequence>
        </complexType>
    </element>
</schema>

Create a resource in Group members

Create a resource in group members

  • Synopsis: POST {Well Known URI of the Service}
  • Request Headers: Authorization, Accept.
  • Request Body: resourceToCreate.
  • Response Headers: Content-Type, Content-Length.
  • Response Message Body: membersContentResponses.
  • Response Status: 201, 402, 404, 501.

Example Request

This example aims to create a contentInstance in contentInstances collection of POST_ALL group members.

POST /scl-id/groups/POST_ALL/membersContent
Host: om2m.laas.fr
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Body:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<om2m:contentInstance xmlns:om2m="http://uri.etsi.org/m2m" xmlns:ns2="http://www.w3.org/2005/05/xmlmime" om2m:id="CI_TEST">
  <om2m:content ns2:contentType="application/xml">PG9iaj4KICA8c3RyIG5hbWU9InR5cGUiIHZhbD0idGVtcGVyYXR1cmUiLz4KICA8c3RyIG5hbWU9InNlbnNvcklkIiB2YWw9InRlbXBlcmF0dXJlXzEiLz4KICA8c3RyIG5hbWU9ImRhdGEiIHZhbD0iMjIiLz4KICA8c3RyIG5hbWU9InVuaXQiIHZhbD0iY2Vsc3VzIi8+CiAgPHN0ciBuYW1lPSJsb2NhdGlvbiIgdmFsPSJob21lIi8+Cjwvb2JqPgo=</om2m:content>
</om2m:contentInstance>

Example Response

HTTP/1.1 201 Created
Content-Type: text/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<om2m:membersContentResponses xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime">
    <om2m:status id="scl-id/applications/APP_0/containers/DATA/contentInstances">
        <om2m:statusCode>STATUS_CREATED</om2m:statusCode>
        <om2m:lastModifiedTime>2014-04-17T20:01:41.477+02:00</om2m:lastModifiedTime>
        <om2m:resultBody>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9InllcyI/Pgo8b20ybTpjb250ZW50SW5zdGFuY2UgeG1sbnM6b20ybT0iaHR0cDovL3VyaS5ldHNpLm9yZy9tMm0iIHhtbG5zOnhtaW1lPSJodHRwOi8vd3d3LnczLm9yZy8yMDA1LzA1L3htbG1pbWUiIG9tMm06aWQ9IkNJX1RFU1QiIGhyZWY9ImdzY2wvYXBwbGljYXRpb25zL0xBTVBfMC9jb250YWluZXJzL0RBVEEvY29udGVudEluc3RhbmNlcy9DSV9URVNUIj4KICAgIDxvbTJtOmNyZWF0aW9uVGltZT4yMDE0LTA0LTE3VDIwOjAxOjQxLjQ3MCswMjowMDwvb20ybTpjcmVhdGlvblRpbWU+CiAgICA8b20ybTpsYXN0TW9kaWZpZWRUaW1lPjIwMTQtMDQtMTdUMjA6MDE6NDEuNDcwKzAyOjAwPC9vbTJtOmxhc3RNb2RpZmllZFRpbWU+CiAgICA8b20ybTpkZWxheVRvbGVyYW5jZT4yMDE0LTA0LTE3VDIzOjIxOjQxLjQ3MCswMjowMDwvb20ybTpkZWxheVRvbGVyYW5jZT4KICAgIDxvbTJtOmNvbnRlbnRTaXplPjE5Nzwvb20ybTpjb250ZW50U2l6ZT4KICAgIDxvbTJtOmNvbnRlbnQgeG1pbWU6Y29udGVudFR5cGU9ImFwcGxpY2F0aW9uL3htbCI+UEc5aWFqNEtJQ0E4YzNSeUlHNWhiV1U5SW5SNWNHVWlJSFpoYkQwaWRHVnRjR1Z5WVhSMWNtVWlMejRLSUNBOGMzUnlJRzVoYldVOUluTmxibk52Y2tsa0lpQjJZV3c5SW5SbGJYQmxjbUYwZFhKbFh6RWlMejRLSUNBOGMzUnlJRzVoYldVOUltUmhkR0VpSUhaaGJEMGlNaklpTHo0S0lDQThjM1J5SUc1aGJXVTlJblZ1YVhRaUlIWmhiRDBpWTJWc2MzVnpJaTgrQ2lBZ1BITjBjaUJ1WVcxbFBTSnNiMk5oZEdsdmJpSWdkbUZzUFNKb2IyMWxJaTgrQ2p3dmIySnFQZ289PC9vbTJtOmNvbnRlbnQ+Cjwvb20ybTpjb250ZW50SW5zdGFuY2U+Cg==</om2m:resultBody>
    </om2m:status>
    <om2m:status id="scl-id/applications/APP_1/containers/DATA/contentInstances">
        <om2m:statusCode>STATUS_CREATED</om2m:statusCode>
        <om2m:lastModifiedTime>2014-04-17T20:01:41.565+02:00</om2m:lastModifiedTime>
        <om2m:resultBody>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9InllcyI/Pgo8b20ybTpjb250ZW50SW5zdGFuY2UgeG1sbnM6b20ybT0iaHR0cDovL3VyaS5ldHNpLm9yZy9tMm0iIHhtbG5zOnhtaW1lPSJodHRwOi8vd3d3LnczLm9yZy8yMDA1LzA1L3htbG1pbWUiIG9tMm06aWQ9IkNJXzgxNDIwNTg5NiIgaHJlZj0iZ3NjbC9hcHBsaWNhdGlvbnMvTEFNUF8xL2NvbnRhaW5lcnMvREFUQS9jb250ZW50SW5zdGFuY2VzL0NJXzgxNDIwNTg5NiI+CiAgICA8b20ybTpjcmVhdGlvblRpbWU+MjAxNC0wNC0xN1QyMDowMTo0MS41NTcrMDI6MDA8L29tMm06Y3JlYXRpb25UaW1lPgogICAgPG9tMm06bGFzdE1vZGlmaWVkVGltZT4yMDE0LTA0LTE3VDIwOjAxOjQxLjU1OCswMjowMDwvb20ybTpsYXN0TW9kaWZpZWRUaW1lPgogICAgPG9tMm06ZGVsYXlUb2xlcmFuY2U+MjAxNC0wNC0xN1QyMzoyMTo0MS41NTcrMDI6MDA8L29tMm06ZGVsYXlUb2xlcmFuY2U+CiAgICA8b20ybTpjb250ZW50U2l6ZT4xOTc8L29tMm06Y29udGVudFNpemU+CiAgICA8b20ybTpjb250ZW50IHhtaW1lOmNvbnRlbnRUeXBlPSJhcHBsaWNhdGlvbi94bWwiPlBHOWlhajRLSUNBOGMzUnlJRzVoYldVOUluUjVjR1VpSUhaaGJEMGlkR1Z0Y0dWeVlYUjFjbVVpTHo0S0lDQThjM1J5SUc1aGJXVTlJbk5sYm5OdmNrbGtJaUIyWVd3OUluUmxiWEJsY21GMGRYSmxYekVpTHo0S0lDQThjM1J5SUc1aGJXVTlJbVJoZEdFaUlIWmhiRDBpTWpJaUx6NEtJQ0E4YzNSeUlHNWhiV1U5SW5WdWFYUWlJSFpoYkQwaVkyVnNjM1Z6SWk4K0NpQWdQSE4wY2lCdVlXMWxQU0pzYjJOaGRHbHZiaUlnZG1Gc1BTSm9iMjFsSWk4K0Nqd3ZiMkpxUGdvPTwvb20ybTpjb250ZW50Pgo8L29tMm06Y29udGVudEluc3RhbmNlPgo=</om2m:resultBody>
    </om2m:status>
</om2m:membersContentResponses>

Retrieve resource from Group members

Retrieve information about a group members

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

Example Request

This example aims to retrieve the latest contentInstance of all groups members.

GET /scl-id/groups/GET_ALL/membersContent
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:membersContentResponses xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime">
    <om2m:status id="gscl/applications/LAMP_0/containers/DATA/contentInstances/latest">
        <om2m:statusCode>STATUS_OK</om2m:statusCode>
        <om2m:lastModifiedTime>2014-04-17T20:09:06.939+02:00</om2m:lastModifiedTime>
        <om2m:resultBody>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9InllcyI/Pgo8b20ybTpjb250ZW50SW5zdGFuY2UgeG1sbnM6b20ybT0iaHR0cDovL3VyaS5ldHNpLm9yZy9tMm0iIHhtbG5zOnhtaW1lPSJodHRwOi8vd3d3LnczLm9yZy8yMDA1LzA1L3htbG1pbWUiIG9tMm06aWQ9IkNJX1RFU1QiIGhyZWY9ImdzY2wvYXBwbGljYXRpb25zL0xBTVBfMC9jb250YWluZXJzL0RBVEEvY29udGVudEluc3RhbmNlcy9DSV9URVNUIj4KICAgIDxvbTJtOmNyZWF0aW9uVGltZT4yMDE0LTA0LTE3VDIwOjAxOjQxLjQ3MCswMjowMDwvb20ybTpjcmVhdGlvblRpbWU+CiAgICA8b20ybTpsYXN0TW9kaWZpZWRUaW1lPjIwMTQtMDQtMTdUMjA6MDE6NDEuNDcwKzAyOjAwPC9vbTJtOmxhc3RNb2RpZmllZFRpbWU+CiAgICA8b20ybTpkZWxheVRvbGVyYW5jZT4yMDE0LTA0LTE3VDIzOjIxOjQxLjQ3MCswMjowMDwvb20ybTpkZWxheVRvbGVyYW5jZT4KICAgIDxvbTJtOmNvbnRlbnRTaXplPjE5Nzwvb20ybTpjb250ZW50U2l6ZT4KICAgIDxvbTJtOmNvbnRlbnQgeG1pbWU6Y29udGVudFR5cGU9ImFwcGxpY2F0aW9uL3htbCI+UEc5aWFqNEtJQ0E4YzNSeUlHNWhiV1U5SW5SNWNHVWlJSFpoYkQwaWRHVnRjR1Z5WVhSMWNtVWlMejRLSUNBOGMzUnlJRzVoYldVOUluTmxibk52Y2tsa0lpQjJZV3c5SW5SbGJYQmxjbUYwZFhKbFh6RWlMejRLSUNBOGMzUnlJRzVoYldVOUltUmhkR0VpSUhaaGJEMGlNaklpTHo0S0lDQThjM1J5SUc1aGJXVTlJblZ1YVhRaUlIWmhiRDBpWTJWc2MzVnpJaTgrQ2lBZ1BITjBjaUJ1WVcxbFBTSnNiMk5oZEdsdmJpSWdkbUZzUFNKb2IyMWxJaTgrQ2p3dmIySnFQZ289PC9vbTJtOmNvbnRlbnQ+Cjwvb20ybTpjb250ZW50SW5zdGFuY2U+Cg==</om2m:resultBody>
    </om2m:status>
    <om2m:status id="gscl/applications/LAMP_1/containers/DATA/contentInstances/latest">
        <om2m:statusCode>STATUS_OK</om2m:statusCode>
        <om2m:lastModifiedTime>2014-04-17T20:09:06.949+02:00</om2m:lastModifiedTime>
        <om2m:resultBody>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9InllcyI/Pgo8b20ybTpjb250ZW50SW5zdGFuY2UgeG1sbnM6b20ybT0iaHR0cDovL3VyaS5ldHNpLm9yZy9tMm0iIHhtbG5zOnhtaW1lPSJodHRwOi8vd3d3LnczLm9yZy8yMDA1LzA1L3htbG1pbWUiIG9tMm06aWQ9IkNJXzgxNDIwNTg5NiIgaHJlZj0iZ3NjbC9hcHBsaWNhdGlvbnMvTEFNUF8xL2NvbnRhaW5lcnMvREFUQS9jb250ZW50SW5zdGFuY2VzL0NJXzgxNDIwNTg5NiI+CiAgICA8b20ybTpjcmVhdGlvblRpbWU+MjAxNC0wNC0xN1QyMDowMTo0MS41NTcrMDI6MDA8L29tMm06Y3JlYXRpb25UaW1lPgogICAgPG9tMm06bGFzdE1vZGlmaWVkVGltZT4yMDE0LTA0LTE3VDIwOjAxOjQxLjU1OCswMjowMDwvb20ybTpsYXN0TW9kaWZpZWRUaW1lPgogICAgPG9tMm06ZGVsYXlUb2xlcmFuY2U+MjAxNC0wNC0xN1QyMzoyMTo0MS41NTcrMDI6MDA8L29tMm06ZGVsYXlUb2xlcmFuY2U+CiAgICA8b20ybTpjb250ZW50U2l6ZT4xOTc8L29tMm06Y29udGVudFNpemU+CiAgICA8b20ybTpjb250ZW50IHhtaW1lOmNvbnRlbnRUeXBlPSJhcHBsaWNhdGlvbi94bWwiPlBHOWlhajRLSUNBOGMzUnlJRzVoYldVOUluUjVjR1VpSUhaaGJEMGlkR1Z0Y0dWeVlYUjFjbVVpTHo0S0lDQThjM1J5SUc1aGJXVTlJbk5sYm5OdmNrbGtJaUIyWVd3OUluUmxiWEJsY21GMGRYSmxYekVpTHo0S0lDQThjM1J5SUc1aGJXVTlJbVJoZEdFaUlIWmhiRDBpTWpJaUx6NEtJQ0E4YzNSeUlHNWhiV1U5SW5WdWFYUWlJSFpoYkQwaVkyVnNjM1Z6SWk4K0NpQWdQSE4wY2lCdVlXMWxQU0pzYjJOaGRHbHZiaUlnZG1Gc1BTSm9iMjFsSWk4K0Nqd3ZiMkpxUGdvPTwvb20ybTpjb250ZW50Pgo8L29tMm06Y29udGVudEluc3RhbmNlPgo=</om2m:resultBody>
    </om2m:status>
</om2m:membersContentResponses>

Back to the top