Split (1)

train · 201k rows

hash stringlengths 32 32	doc_id stringlengths 7 13	section stringlengths 3 121	content stringlengths 0 2.2M
2bd691fcce98b96819b9b3b005c72741	118 101	7.1.18 M2M Service User Identifier (M2M-User-ID)	A M2M Service User is a stakeholder that is authorized by a M2M Service Subscriber to use M2M Services offered by the M2M Service Subscriber's M2M Service Provider. A M2M-User-ID uniquely identifies a M2M Service User and shall be assigned by a M2M Service Provider. A M2M-User-ID uniquely identifies a M2M Service User within the M2M Service Provider Domain of the M2M Service User. When used in a different M2M Service Provider Domain, a M2M-User-ID shall be extended to make it globally unique by pre-pending the M2M-SP-ID of the M2M Service User's M2M Service Provider.
2bd691fcce98b96819b9b3b005c72741	118 101	7.2 Identifier formats	As a general rule, the identifiers of AEs, CSEs, Service Subscriptions, Service Subscribers, Service Users and resources are globally unique. In order to optimize their use, the identifiers shall be shortened when their scope can be derived from their context of use by the CSEs and the AEs. Such shortened identifiers are defined as 'relative' formats of the identifiers. TheM2M system shall use the identifiers M2M-SP-ID, CSE-ID, App-ID, AE-ID, M2M-Sub-ID, M2M-SS-ID, M2M-User-ID and resource identifiers according to the formats and the rules specified in table 7.2-1. . ETSI ETSI TS 118 101 V4.15.0 (2022-09) 58 (oneM2M TS-0001 version 4.15.0 Release 4) Table 7.2-1: Identifier formats and rules of use Identifier Name Absolute & Format-Designator or Relative & Format-Designator & Context Format Rule of use M2M-SP-ID Absolute M2M-SP-ID The M2M-SP-ID shall conform to the FQDN format defined in the IETF RFC 1035 [i.7] prefixed by '//' The format then has the structure of //{FQDN} Where {FQDN} is a placeholder for the Fully Qualified Domain Name of the M2M Service Provider Domain EXAMPLES: - //www.m2mprovider.com - //globalm2m.org The following two M2M-SP-IDs could be used to separate two service segments: //automotive.m2m.telematics-service-company.com //building-management.m2m.telematics-service-company.com Whenever The M2M-SP-ID is used, only an Absolute format of the M2M-SP-ID defined herein applies. CSE-ID Relative SP-relative-CSE-ID Context: M2MService Provider Domain of the CSE The SP-relative-CSE-ID begins with a slash character '/' and is followed by a sequence of characters that may include any of the unreserved characters defined in clause 2.3 of the IETF RFC 3986 [18]. The SP-relative-CSE-ID is unique within the context of the M2M-SP Domain hosting the CSE. The M2M-SP is assigning the SP-Relative-CSE-ID and is responsible for guaranteeing that the SP-Relative-CSE-ID is unique in the context of the hosting M2M-SP Domain. EXAMPLES: • /123A38ZZY • /CSE090112 • /3ace4fd3 On the Mca and Mcc reference points: to refer to CSEs that are in the same M2M Service Provider Domain of the Receiver CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 59 (oneM2M TS-0001 version 4.15.0 Release 4) Identifier Name Absolute & Format-Designator or Relative & Format-Designator & Context Format Rule of use Absolute Absolute-CSE-ID Concatenation according to the format {M2M-SP-ID}{SP-relative-CSE-ID} where {M2M-SP-ID} and {SP-relative-CSE-ID} are placeholders for the M2M- SP-ID and the SP-relative-CSE-ID format of the CSE-ID, respectively. The Absolute-CSE-ID complies with what is specified in clause 3 of IETF RFC 3986 [18] under "hier-part". EXAMPLES: • //www.m2mprovider.com/C3219 • //m2m.thingscompany.com/ab3f124a On Mca, Mcc and Mcc' reference points: to refer to CSEs that are in different M2M Service Provider Domains. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 60 (oneM2M TS-0001 version 4.15.0 Release 4) Identifier Name Absolute & Format-Designator or Relative & Format-Designator & Context Format Rule of use AE-ID Relative AE-ID-Stem Context: Registrar CSE of the AE or M2MService Provider Domain of the AE The AE-ID-Stem is a sequence of characters that may include any of the unreserved characters defined in clause 2.3 of the IETF RFC 3986 [18]. The first character of the AE-ID-Stem has a specific meaning and its value shall be as follows: 1. Fist character of AE-ID-Stem is 'C' The AE-ID-Stem is assigned by the Registrar CSE of the AE. In this case, the AE-ID-Stem shall be unique within the context of the Registrar CSE of the AE. The Hosting CSE is responsible for guaranteeing that the AE-ID-Stem is unique in the context of the Hosting CSE. EXAMPLES: • C190XX7T • Ca3e3f3ab 2. Fist character of AE-ID-Stem is 'S': The AE-ID-Stem is assigned by the M2M-SP. In this case, the AE-ID- Stem shall be unique within the context of the M2M-SP Domain. The M2M-SP is responsible for guaranteeing that the AE-ID-Stem is unique in the context of the M2M-SP Domain. EXAMPLES: • S190XX7T • Sa3e3f3ab Use of other values for the first character of AE-ID-Stem is reserved. Which of the cases above shall apply will be determined during the AE registration procedure. The details of the process how an AE-ID-Stem unique within the M2M-SP Domain is assigned by the M2M-SP are described in the AE registration procedure description. On the Mca reference point: to refer to AEs that registered to the Receiver CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 61 (oneM2M TS-0001 version 4.15.0 Release 4) Identifier Name Absolute & Format-Designator or Relative & Format-Designator & Context Format Rule of use Relative SP-relative-AE-ID Context: M2M Service Provider Domain of the AE 1. In the case the AE-ID-Stem starts with the letter 'C', the SP-relative-AE- ID is a concatenation according to the format {SP-relative-CSE-ID}/{AE-ID-Stem} where {SP-relative-CSE-ID} and {AE-ID-Stem} are placeholders for the SP-relative-CSE-ID of the Registrar CSE of the AE and the AE-ID-Stem format of the AE-ID, respectively. EXAMPLES: • /CSE090112/C190XX7T • /3ace4fd3/Ca3e3f3ab 2. In the case the AE-ID-Stem starts with the letter 'S', the AE-ID-Stem is unique within the M2M-SP Domain. In that case the SP-relative-AE-ID is a concatenation according to the format /{AE-ID-Stem} where {AE-ID-Stem} is a placeholder for the AE-ID-Stem format of the AE-ID. EXAMPLES: • /S190XX7T • /Sa3e3f3ab The SP-relative-AE-ID begins with a slash character '/', and it complies with what is specified in clause 4.2 of IETF RFC 3986 [18] under "absolute-path reference". On the Mca and Mcc reference points: to refer to AEsin the same M2M Service Provider Domain. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 62 (oneM2M TS-0001 version 4.15.0 Release 4) Identifier Name Absolute & Format-Designator or Relative & Format-Designator & Context Format Rule of use Absolute Absolute-AE-ID The Absolute-AE-ID format of the AE-ID is a concatenation according to the format: {M2M-SP-ID}{SP-relative-AE-ID} where {M2M-SP-ID} and {SP-relative-AE-ID} are placeholders for the M2M-SP-ID and the SP-relative-AE-ID format of the AE-ID, respectively. The absolute AE-ID complies with what is specified in clause 3 of IETF RFC 3986 [18] under "hier-part". EXAMPLES: • //m2m.prov.com/CSE3219/C9886 • //m2m.things.com/ab3f124a/Ca2efb3f4 • //m2m.things.com/S98821 On the Mca, Mcc and Mcc' reference points: to refer to AEs that are in different M2M Service Provider Domains. Resource identifier Relative Unstructured-CSE-relative- Resource-ID Context: CSE hosting the Resource An Unstructured-CSE-relative-Resource-ID is a sequence of characters that may include any of the unreserved characters defined in clause 2.3 of the IETF RFC 3986 [18]. An Unstructured-CSE-relative-Resource-ID is unique in the context of the CSE hosting the resource. The Hosting CSE of the resource is responsible for guaranteeing that Unstructured-CSE-relative Resource-IDs are unique in the context of the Hosting CSE. EXAMPLES: - container123 - a1b2c3d4b0b00f0fa66a123456789abc - xxyz1234 On the Mca and Mcc reference point: to refer to resources that are hosted by the CSE which is the Registrar CSE of the Originator. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 63 (oneM2M TS-0001 version 4.15.0 Release 4) Identifier Name Absolute & Format-Designator or Relative & Format-Designator & Context Format Rule of use Relative Structured-CSE-relative- Resource-ID Context: CSE hosting the resource A Structured-CSE-relative-Resource-ID is a sequence of characters that may include any of the unreserved characters defined in clause 2.3 of the IETF RFC 3986 [18], as well as the slash character. It shall not start with the slash character. A Structured-CSE-relative Resource-ID is unique in the context of the CSE hosting the resource. The structure represents a chain of parent-child- relationships using resource IDs or resource names of parents and resource names of their children for segments that are separated by the '/' character. The first segment is one of the following: A. the resource name of <CSEBase> resource, B. the character "-" (dash) as a shortcut for the resource name of <CSEBase> resource, C. the Unstructured-CSE-relative-Resource-ID of a parent resource on the Hosting CSE. When this is used, the second segment shall be the resourceName of a virtual resource. NOTE: In case of C above, for convenience it is called a hybrid resource identifier. The Hosting CSE of the resource is responsible for guaranteeing that resource names - which are used to construct Structured-CSE-relative- Resource-ID formats - are unique in the context of a set of sibling resources sharing the same parent resource on the Hosting CSE. EXAMPLES: - bigCSE025/mainStreet/house5432/livingRoom/temperature This example is the Structured-CSE-relative-Resource-ID of a <container> resource, where "bigCSE025" is assumed to be the name of the <CSEBase> resource, followed by four "/"-separated segments with names of <container> resources that are nested child resources thereof. On the Mca and Mcc reference point: To refer to resources that are hosted by the CSE receiving a request targeting a resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 64 (oneM2M TS-0001 version 4.15.0 Release 4) Identifier Name Absolute & Format-Designator or Relative & Format-Designator & Context Format Rule of use - CSE-Building-A3/HVAC-AE/WaterTemp/sample0098 This example is the Structured-CSE-relative-Resource-ID of a <contentInstance> resource, where "CSE-Building-A3" is assumed to be the name of the <CSEBase> resource, followed by "/" plus the name "HVAC-AE" of an <AE> child resource, followed by "/" plus the name "WaterTemp" of a <container> child resources, followed by "/" plus the name "sample0098" of a child <contentInstance> resource. - ./HVAC-AE/WaterTemp/sample0098 This example is the Structured-CSE-relative-Resource-ID of a <contentInstance> resource, where the dash symbol "-" is used as a shortcut for the name of the <CSEBase> resource, followed by "/" plus the name "HVAC-AE" of an <AE> child resource, followed by "/" plus the name "WaterTemp" of a <container> child resource, followed by "/" plus the name "sample0098" of a child <contentInstance> resource. - 000AFE030003/sample0098 This example is the Structured-CSE-relative-Resource-ID of a <contentInstance> resource, where "000AFE030003" is assumed to be the Unstructured-CSE-relative-Resource-ID of a <container> resource, followed by "/" plus the name "sample0098" of a child <contentInstance> resource. Relative SP-relative Resource-ID Context: M2MService Provider Domain hosting the resource Concatenation according to the format: {SP-relative-CSE-ID}/{Unstructured-CSE-relative Resource ID} {SP-relative-CSE-ID}/{Structured-CSE-relative Resource ID} where {SP-relative-CSE-ID}, {Unstructured-CSE-relative Resource ID}, {Structured-CSE-relative Resource ID} are placeholders for the SP-relative- CSE-ID format of the CSE-ID and the Unstructured-CSE-relative-Resource- ID or a Structured-CSE-relative-Resource-ID format of the Resource ID, respectively. The SP-relative-Resource-ID begins with a slash character, and it complies with what is specified in clause 4.2 of IETF RFC 3986 [18] under "absolute- path reference". On the Mca and Mcc reference points: to refer to resources that are hosted by the CSE in the same M2M Service Provider Domain as the Originator. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 65 (oneM2M TS-0001 version 4.15.0 Release 4) Identifier Name Absolute & Format-Designator or Relative & Format-Designator & Context Format Rule of use The SP-relative Resource ID is unique in the context of the Service Provider. EXAMPLES: • /CSE987776/a234361 This example is the SP-relative Resource-ID of a resource - not assuming any specific resource type - where the resource is hosted on a CSE with the SP-relative-CSE-ID "/CSE987776" and where the Unstructured-CSE-relative-Resource-ID is "a234361". • /CSE00030F003A/CSE-Building-A3/HVAC- AE/WaterTemp/sample0098 This example is the SP-relative Resource-ID of a <contentInstance> resource, where the targeted resource is hosted on a CSE with the SP-relative-CSE-ID "/CSE00030F003A" and where the CSE-ID is followed by "/" plus the name "CSE-Building-A3" of the <CSEBase> resource, followed by "/" plus the name "HVAC-AE" of an <AE> child resource, followed by "/" plus the name "WaterTemp" of a <container> child resource, followed by "/" plus the name "sample0098" of the targeted child <contentInstance> resource. • /CSE00030F003A/-/HVAC-AE/WaterTemp/sample0098 This example is the SP-relative Resource-ID of a <contentInstance> resource, where the targeted resource is hosted on a CSE with the SP-relative-CSE-ID "/CSE00030F003A" and where the CSE-ID is followed by "/" plus the dash symbol "-" as a shortcut for the name of the <CSEBase> resource, followed by "/" plus the name "HVAC-AE" of an <AE> child resource, followed by "/" plus the name "WaterTemp" of a <container> child resource, followed by "/" plus the name "sample0098" of the targeted child <contentInstance> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 66 (oneM2M TS-0001 version 4.15.0 Release 4) Identifier Name Absolute & Format-Designator or Relative & Format-Designator & Context Format Rule of use • /CSE00030F003A/000AFE030003/sample0098 This example is the SP-relative Resource-ID of a <contentInstance> resource, where the targeted resource is hosted on a CSE with the SP-relative-CSE-ID "/CSE00030F003A" and where the CSE-ID is followed by "/" plus the Unstructured-CSE-relative-Resource-ID "000AFE030003" of a <container> resource, followed by "/" plus the name "sample0098" of the targeted child <contentInstance> resource. Absolute Absolute Resource ID Concatenation according to the format: {M2M-SP-ID}{SP-relative Resource ID} where {M2M-SP-ID} and {SP-relative Resource ID} are placeholders for the M2M-SP-ID and the SP-relative Resource ID format of the Resource ID, respectively. The Absolute-CSE-ID complies with what is specified in clause 3 of IETF RFC 3986 [18] under "hier-part". EXAMPLES: - //www.m2mprovider.com / CSE987776/a234361 This example is the Absolute Resource-ID of a resource - not assuming any specific resource type - where the resource is hosted within the domain of the M2M-Service Provider with the M2M-SP-ID "//www.m2mprovider.com" on a CSE with SP-relative-CSE-ID "/CSE987776" and where the Unstructured-CSE- relative-Resource-ID of the targeted resource is "a234361". - //www.m2mprovider.com /CSE00030F003A/CSE-Building-A3/HVAC- AE/WaterTemp/sample0098 On Mca, Mcc and Mcc' reference points: to refer to resources that are hosted by the CSE in a different M2M Service Provider Domain than the Originator's. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 67 (oneM2M TS-0001 version 4.15.0 Release 4) Identifier Name Absolute & Format-Designator or Relative & Format-Designator & Context Format Rule of use - This example is the Absolute Resource-ID of a <contentInstance> resource, where the targeted resource is hosted within the domain of the M2M-Service Provider with the M2M-SP-ID "//www.m2mprovider.com" on a CSE with the SP- relative-CSE-ID "/CSE00030F003A" and where the CSE-ID is followed by "/" plus the name "CSE-Building-A3" of the <CSEBase> resource, followed by "/" plus the name "HVAC-AE" of an <AE> child resource, followed by "/" plus the name "WaterTemp" of a <container> child resource, followed by "/" plus the name "sample0098" of the targeted child <contentInstance> resource. APP-ID App-ID App-ID is either registered with the M2M App-ID Registration Authority or non-registered. Registered App-IDs shall be in the format: R{authority-ID}.{reverseDNS}.{applicationName} The {reverseDNS} part shall be a string value following 'reverse DNS notation', which is constructed in the reverse order of domain name components (see IETF RFC 1035 [i.7]) Non-registered App-IDs shall be in the format: N{non-registered-App-ID} EXAMPLES: • Ra01.com.company.smartcity • Nk836-t071-fc022 AE Registration Procedure described in clause 10.2.2.2. The first character of the App-ID shall be a capital letter of 'R' for registered and 'N' for non-registered. M2M-Sub-ID Relative SP-relative-M2M-Sub-ID Context: M2M Service Provider Domain of the M2M Service Subscriber The SP-relative-M2M-Sub-ID begins with a slash character '/' and is followed by a sequence of characters that includes any of the unreserved characters defined in clause 2.3 of the IETF RFC 3986 [18]. The SP-relative-M2M-Sub-ID is unique within the context of the M2M Service Provider Domain of the M2M Service Subscriber. The M2M Service Provider assigns the SP-relative-M2M-Sub-ID and is responsible for guaranteeing that it is unique within the context of the M2M Service Proivder's Domain. Example: • /subscription783567 Uniquely identifies a M2M Service Subscription within the M2M Service Provider Domain of the M2M Service Subscriber. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 68 (oneM2M TS-0001 version 4.15.0 Release 4) Identifier Name Absolute & Format-Designator or Relative & Format-Designator & Context Format Rule of use Absolute Absolute-M2M-Sub-ID Concatenation according to the format {M2M-SP-ID}{SP-relative-M2M-Sub-ID} where {M2M-SP-ID} and {SP-relative-M2M-Sub-ID} are placeholders for the M2M-SP-ID and the SP-relative-M2M-Sub-ID format of the M2M-Sub-ID respectively. Uniquely identifies a M2M Service Subscription within a different M2M Service Provider Domain than the M2M Service Subscriber's. M2M-SS-ID Relative SP-relative-M2M-SS-ID Context: M2M Service Provider Domain of the M2M Service Subscriber The SP-relative-M2M-SS-ID begins with a slash character '/' and is followed by a sequence of characters that includes any of the unreserved characters defined in clause 2.3 of the IETF RFC 3986 [18]. The SP-relative-M2M-SS-ID is unique within the context of the M2M Service Provider Domain of the M2M Service Subscriber. The M2M Service Provider assigns the SP-relative-M2M-SS-ID and is responsible for guaranteeing that it is unique in the context of the M2M Service Provider's Domain. EXAMPLES: • /SS123ABC • /7689ayx On the Mca and Mcc reference points: Uniquely identifies a M2M Service Subscriber within the M2M Service Provider Domain of the M2M Service Subscriber. Absolute Absolute-M2M-SS-ID Concatenation according to the format {M2M-SP-ID}{SP-relative-M2M-SS-ID} where {M2M-SP-ID} and {SP-relative- M2M-SS-ID} are placeholders for the M2M-SP-ID and the SP-relative-M2M-SS-ID format of the M2M-SS-ID respectively. On the Mca, Mcc and Mcc' reference points: Uniquely identifies a M2M Service Subscriber within a different M2M Service Provider Domain than the M2M Service Subscriber's. M2M-User-ID Relative SP-relative-M2M-User-ID Context: M2M Service Provider Domain of the M2M Service User The SP-Relative-M2M-User-ID begins with a slash character '/' and is followed by a sequence of characters that includes any of the unreserved characters defined in clause 2.3 of the IETF RFC 3986 [18]. The SP-relative-M2M-User-ID is unique within the context of the M2M Service Provider Domain of the M2M Service User. The M2M Service Provider assigns the SP-Relative-M2M-User-ID and is responsible for guaranteeing that it is unique in the context of the M2M-SP Domain. On the Mca and Mcc reference points: Uniquely identifies a M2M Service User within the M2M Service Provider Domain of the M2M Service User. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 69 (oneM2M TS-0001 version 4.15.0 Release 4) The format (i.e. CSE-relative, SP-relative or absolute) of resource identifier (e.g. the To parameter, accessControlPolicyIDs attribute) shall be correctly set by the Originator in an initial request, while the format of AE-ID or CSE-ID in the From parameter shall be set in a shortest format by the Originator in the initial request and it shall be converted in another format by the Registrar CSE or IN-CSE as the following. When an AE is the Originator, the From parameter shall be in AE-ID-Stem. When the Registrar CSE receives the request, it shall convert the format into SP-relative AE-ID in case the stem is CSE-relative and the To parameter refers to a resource hosted by a different CSE. When an CSE is the Originator, the From parameter shall be in SP-relative CSE-ID. The IN-CSE shall convert the format of the From parameter in a request that is received from SP-relative to absolute if the To parameter refers to a resource is hosted by a CSE in a different M2M Service Provider Domain. Identifier Name Absolute & Format-Designator or Relative & Format-Designator & Context Format Rule of use EXAMPLES: • /supervisor • /homeowner1 Absolute Absolute-M2M-User-ID Concatenation according to the format {M2M-SP-ID}{SP-relative-M2M-User-ID} where {M2M-SP-ID} and {SP-relative- M2M-User-ID} are placeholders for the M2M-SP-ID and the SP-relative-M2M-User-ID format of the M2M-User-ID respectively. On the Mca, Mcc and Mcc' reference points: Uniquely identifies a M2M Service User within a different M2M Service Provider Domain than the M2M Service User's. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 70 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	7.3 M2M Identifiers lifecycle and characteristics	Table 7.3-1: M2M Identifiers lifecycle and characteristics Identifier Assigned by Assigned to Assigned during Lifetime Uniqueness Used during Remarks M2M Service Provider Identifier Out of scope AE, CSE Out of scope Out of scope Global Provisioning Application Entity Identifier AE or Registrar CSE AE AE start-up Application Entity Registration Global • Application Entity Registration • Security Context Establishment • All other operations initiated by the AE Security requirements apply for Security Context Establishment. Application Identifier Out of scope Out of scope Pre-provisioned Out of scope Specific to M2M service deployment - Application Entity registration CSE Identifier M2M SP CSE Security Provisioning Life of the CSE Global • Information flows (clause 10) • Security Context Establishment Security requirements apply for Security Context Establishment. M2M Node Identifier Out of Scope All M2M Nodes Pre-provisioned Life of the M2M Node Global • Device Management Needs to be Read Only. M2M Subscription Identifier M2M SP, Out of Scope Application Entities, and one or more CSEs belonging to the same M2M subscriber At service signup Life of the M2M Service Subscription with the M2M Service Provider Global • Charging and Information Recorded • Role based access control • Authentication Multiple CSEs can be allocated the same M2M Subscription Identifier. M2M Service Profile Identifier M2M SP Every M2M Node At service signup Life of M2M Service Subscriptions with the M2M Service Provider Global for roaming cases otherwise local Information Flows (clause 10) The ID has to be pre-provisioned after signup, but may need to be updated during the subscription lifetime due to changes in the subscribed services. M2M-Request-ID Mcc: CSE Mca: Application Entity A request initiated by an AE or CSE Mcc: When a request is initiated by a CSE, or handling of a request received by a CSE Mca: When a request is initiated by an AE Equal to the lifetime of the Request and its corresponding Response Mcc: Global Mca: Local or global Requests and corresponding responses ETSI ETSI TS 118 101 V4.15.0 (2022-09) 71 (oneM2M TS-0001 version 4.15.0 Release 4) Identifier Assigned by Assigned to Assigned during Lifetime Uniqueness Used during Remarks External Identifier Jointly between the Underlying Network provider and M2M SP M2M Node belonging to a CSE or ADN-AE that wants to utilize services of the Underlying Network Administrative Agreement Life of the CSE or ADN-AE Local or global, decided by the specific Underlying Network provider Requests initiated by a CSE over the Mcn reference point, where applicable. Querying the location information of a remote node from the underlying network. Pre-Provisioned Mode: Made available at the Infrastructure Node. Dynamic Mode: Made available at M2M device. Conveyed to IN- CSE during CSE or AE Registration. Underlying Network Identifier M2M SP Underlying Networks Pre-provisioned Life of the agreement by the M2M SP with the Underlying Network Local to M2M SP domain UL Network selection Trigger Recipient Identifier Execution Environment ASN/MN-CSE or ADN- AE ASN/MN-CSE or ADN- AE start-up or wake- up Life of the CSE or ADN-AE Execution Environment- wide Device Triggering procedures, where applicable Pre-Provisioned Mode: Made available at Infrastructure Node along with M2M- Ext-ID. Dynamic Mode: Made available at M2M device. Conveyed to IN- CSE during CSE or AE Registration along with M2M- Ext-ID. M2M Service Identifier M2M Service Provider, Out of Scope A service defined by the M2M Service Provider which consists of a set of functions defined by the present document Out of Scope Out of Scope Local to the M2M Service Provider For M2M Service Subscription Role-ID M2M Service Provider Application Entities, and one or more CSEs belonging to the same M2M subscriber Out of scope Out of scope Local to M2M SP domain Access Control Policy Token-ID Token Issuer Token Token Assignment Specified by Token Global Dynamic Authorization ETSI ETSI TS 118 101 V4.15.0 (2022-09) 72 (oneM2M TS-0001 version 4.15.0 Release 4) Identifier Assigned by Assigned to Assigned during Lifetime Uniqueness Used during Remarks Local-Token-ID A Hosting CSE making access decisions with the corresponding token Token After Hosting CSE has been provided with Token Specified by Token Local to the Hosting CSE Indirect Dynamic Authorization See clause 11.5.3. M2M Service Subscriber Identifier M2M Service Provider M2M Service Subscriber At service subscriber signup Life of M2M Service Subscription with the M2M Service Provider Local or global. Dependent on M2M service deployment Service Subscriber based operations: • Enrolment • Charging and Information Recording M2M Service User Identifier M2M Service Provider M2M Service User At service user signup Life of M2M Service User with the M2M Service Provider Local or global. Dependent on M2M service deployment Service User based operations: • Access control • Authentication ETSI ETSI TS 118 101 V4.15.0 (2022-09) 73 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	8 Description and Flows of Reference Points	8.1 General Communication Flow Scheme on Mca and Mcc Reference Points
2bd691fcce98b96819b9b3b005c72741	118 101	8.1.0 Overview	Procedures involving CSEs and AEs are driven by the exchange of messages across reference points according to the message flows described in this clause. Depending on the message operation, procedures may manipulate information in a standardized resource structure as described in clause 9. Access and manipulation of the resources is subject to their associated privileges.
2bd691fcce98b96819b9b3b005c72741	118 101	8.1.1 Description	Figure 8.1.1-1 shows the general flow that governs the information exchange within a procedure, which is based on the use of Request and Response messages. The message applies to communications such as: • between an AE and a CSE (Mca reference point); and • among CSEs (Mcc reference point). Such communications can be initiated either by the AEs or by the CSEs depending upon the operation in the Request message. Figure 8.1.1-1: General Flow
2bd691fcce98b96819b9b3b005c72741	118 101	8.1.2 Request	Requests over the Mca and Mcc reference points, from an Originator to a Receiver, shall contain mandatory and may contain optional parameters. Certain parameters may be mandatory or optional depending upon the Requested operation. In this clause, the mandatory parameters are detailed first, followed by those that are operation dependent, and then by those that are optional: • To: Address of the target resource or target attribute for the operation. The To parameter shall conform to clause 9.3.1. NOTE 1: To parameter can be known either by pre-provisioning (clause 11.2) or by discovery (clause 10.2.6 for discovery). Discovery of <CSEBase> resource is not supported in this release of the present document. It is assumed knowledge of <CSEBase> resource is by pre-provisioning only. NOTE 2: The term target resource refers to the resource which is addressed for the specific operation. For example, the To parameter of a Create operation for a resource <example> would be "/m2m.provider.com/exampleBase". The To parameter for the Retrieve operation of the same resource <example> is "/m2m.provider.com/exampleBase/example". ETSI ETSI TS 118 101 V4.15.0 (2022-09) 74 (oneM2M TS-0001 version 4.15.0 Release 4) NOTE 3: For Retrieve operation (clause 10.1.3), the To parameter can be the URI of an attribute to be retrieved. • From: Identifier representing the Originator. The From parameter is used by the Receiver to check the Originator identity for access privilege verification. • Operation: operation to be executed: Create (C), Retrieve (R), Update (U), Delete (D), Notify (N). The Operation parameter shall indicate the operation to be executed at the Receiver: - Create (C): To is the address of the target resource where the new resource (parent resource). - Retrieve (R): an existing To addressable resource is read and provided back to the Originator. - Update (U): the content of an existing To addressable resource is replaced with the new content as in Content parameter. If some attributes in the Content parameter do not exist at the target resource, such attributes are created with the assigned values. If some attributes in the Content parameter are set to NULL, such attributes are deleted from the addressed resource. - Delete (D): an existing To addressable resource and all its sub-resources are deleted from the Resource storage. - Notify (N): information to be sent to the Receiver, processing on the Receiver is not indicated by the Originator. • Request Identifier: request Identifier (see clause 7.1.7). Example usage of request identifier includes enabling the correlation between a Request and one of the many received Responses. Operation dependent Parameters: • Content: resource content to be transferred. The Content parameter shall be present in Request for the following operations: - Create (C): Content is the content of the new resource with the resource type ResourceType. - Update (U): Content is the content to be replaced in an existing resource. For attributes to be updated at the resource, Content includes the names of such attributes with their new values. For attributes to be created at the resource, Content includes names of such attributes with their associated values. For attributes to be deleted at the resource, Content includes the names of such attributes with their value set to NULL. - Notify (N): Content is the notification information. The Content parameter may be present in Request for the following operations: - Retrieve (R): Content is the list of attribute names from the resource that needs to be retrieved. The values associated with the attribute names shall be returned. • Resource Type: type of resource. The ResourceType parameter shall be present in Request for the following operations: - Create (C): Resource Type is the type of the resource to be created. Optional Parameters: • Role IDs: optional, required when role based access control is applied. A list of Role-IDs that are allowed by the service subscription shall be provided otherwise the request is considered not valid. The Role IDs parameter shall be used by the Receiver to check the Access Control privileges of the Originator. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 75 (oneM2M TS-0001 version 4.15.0 Release 4) • Originating Timestamp: optional originating timestamp of when the message was built. Example usage of the originating timestamp includes: to measure and enable operation (e.g. message logging, correlation, message prioritization/scheduling, accept performance requests, charging, etc.), to enable time synchronization and compensation between oneM2M entities, and to measure performance (distribution and processing latency, closed loop latency, SLAs, analytics, etc.). • Request Expiration Timestamp: optional request message expiration timestamp. The Receiver CSE should handle the request before the time expires. If a Receiver CSE receives a request with Request Expiration Timestamp with the value indicating a time in the past, then the request shall be rejected. Example usage of the request expiration timestamp is to indicate when request messages (including delay-tolerant) should expire and to inform message scheduling/prioritization. When a request with set expiration timestamp demands an operation on a Hosting CSE different than the current Receiver CSE, then the current CSE shall keep trying to deliver the Request to the Hosting CSE until the request expiration timestamp time, in line with provisioned policies. • Result Expiration Timestamp: optional result message expiration timestamp. The Receiver CSE should return the result of the request before the time expires. Example usage of the result expiration timestamp: An Originator indicates when result messages (including delay-tolerant) should expire and informs message scheduling/prioritization. It can be used to set the maximum allowed total request/result message sequence round trip deadline. • Response Type: optional response message type: Indicates what type of response shall be sent to the issued request and when the response shall be sent to the Originator: - nonBlockingRequestSynch: In case the request is accepted by the Receiver CSE, the Receiver CSE responds, after acceptance, with an Acknowledgement confirming that the Receiver CSE will further process the request. The Receiver CSE includes in the response to an accepted request a reference that can be used to access the status of the request and the result of the requested operation at a later time. Processing of Non-Blocking Requests is defined in clause 8.2.2 and in particular for the synchronous case in clause 8.2.2.2. - nonBlockingRequestAsynch {optional list of notification targets}: In case the request is accepted by the Receiver CSE, the Receiver CSE shall respond, after acceptance, with an Acknowledgement confirming that the Receiver CSE will further process the request. The result of the requested operation needs to be sent as notification(s) to the notification target(s) provided optionally within this parameter as a list of entities or to the Originator when no notification target list is provided. When an empty notification target list is provided by the Originator, no notification with the result of the requested operation shall be sent at all. Processing of Non-Blocking Requests is defined in clause 8.2.2 and in particular for the asynchronous case in clause 8.2.2.3. - blockingRequest: In case the request is accepted by the Receiver CSE, the Receiver CSE responds with the result of the requested operation after completion of the requested operation. Processing of Blocking Requests is defined in clause 8.2.1. This is the default behaviour when the Response Type parameter is not given the request. - flexBlocking {optional list of notification targets}: When Response Type in the request received by the Receiver CSE is set to flexBlocking, it means that the Originator of the request has the capability to accept the following types of responses: nonBlockingRequestSynch, nonBlockingRequestAsynch and blockingRequest. The Receiver CSE shall make the decision to respond using blocking or non-blocking based on its own local context (memory, processing capability, etc.) if not defined in the resource handling procedure. If the Receiver CSE choose to respond using non-blocking mode or blocking mode, based on the presence of notification targets in the request:  If the notification targets are provided in the request and the Receiver CSE is responding, the Receiver CSE shall choose and respond with nonBlockingRequestAsynch, nonBlockingRequestSynch or blockingRequest mode. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 76 (oneM2M TS-0001 version 4.15.0 Release 4)  If notification targets are not provided, the Receiver CSE shall choose and respond with nonBlockingRequestSynch or blockingRequest mode. - No Response: In case the request is accepted by the Receiver CSE or AE, the Receiver CSE or AE does not respond with the result of the requested operation after completion of the requested operation. Note, in this case the Result Content parameter should not be included in the request. Example usage of the response type set to nonBlockingRequestSynch: An Originator that is optimized to minimize communication time and energy consumption wants to express a Request to the receiver CSE and get an acknowledgement on whether the Request got accepted. After that the Originator may switch into a less power consuming mode and retrieve a Result of the requested Operation at a later time. Further example usage of response type set to nonBlockingRequestSynch: When the result content is extremely large, or when the result consists of multiple content parts from a target group which are to be aggregated asynchronously over time. • Result Content: optional result content: Indicates what are the expected components of the result of the requested operation. This shall be indicated in the Content parameter of the response message. Settings of Result Content depend on the requested operation specified in Operation. This parameter is not applicable when Response Type has a value of No Response. Possible values of Result Content are: - attributes: A representation of the targeted resource including all its attributes shall be returned as content, without the address(es) of the child resource(s) or their descendants. For example, if the request is to retrieve a <container> resource, the address(es) of the <contentInstance> child-resource(s) is not provided. This setting shall be only valid for Create, Retrieve, Update, or Delete operation. If the Originator does not set Result Content parameter in a Create, Retrieve or Update request message, this setting shall be the default value when the Receiver processes the request message. - modified-attributes: This setting shall be only valid for a Create or Update operation. A representation of the targeted resource including only attributes that were added, modified or deleted that were not included in the request Content parameter as well as any attributes which were set to values different from the values specified in the request Content parameter shall be returned as content, without the address(es) of the child resource(s) or their descendants. - hierarchical-address: Representation of the address of the created resource. This setting shall only be valid for a Create operation. The address shall be in hierarchical address scheme. - hierarchical-address+attributes: Representation of the address in hierarchical address scheme and the attributes of the created resource. This setting shall only be valid for a Create operation. - attributes+child-resources: Representation of the requested resource, along with a nested representation of all of its child resource(s), and their descendants (excluding virtual resources), in line with any provided filter criteria as given in the Filter Criteria parameter shall be returned as content. If there is no filter criteria parameter in the request message, then all children/descendants are returned along with their attributes. For example, if the request is to retrieve a <container> resource that only has <contentInstance> children, the attributes of that <container> resource and a representation of all of its <contentInstance> child-resource(s), including their attributes, are provided. The originator may request to limit the maximum number of allowed nesting levels. The originator may also include an offset that indicates the starting point of the direct child resource. The offset shall start at 1. The hosting CSE shall return all direct child resources and their descendants, or up to the maximum nesting level specified in a request subject to maximum size limit that may be imposed by the hosting CSE. The offset, maximum number/size and maximum level shall be specified in Filter Criteria as offset, limit, and level condition, respectively, by the Originator. The hosting CSE shall list parent resources before their children. This means that the originator of the request will not receive a descendant resource without having received its parents. The hosting CSE shall also ensure that proper nesting representation of all the children is incorporated in its listing for parents and children. Nested processing is applicable at every level in the resource tree. If a direct child resource and all its descendants cannot be included in the returned content due to size limitations imposed by the hosting CSE then the direct child resource shall not be included in the response. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 77 (oneM2M TS-0001 version 4.15.0 Release 4) An indication shall be included in the response signalling if the returned content is partial. If the indication is for partial content, the response shall include an offset for the direct child resource where processing can restart for the remaining direct child resources. This shall be only valid for a Retrieve/Delete operation. - child-resources: A nested representation of the resource's child resource(s) their descendants (excluding virtual resources) and their attributes shall be returned as content. The resources that are returned are subject to any filter criteria that are given in the Filter Criteria parameter (if there are no filter criteria then all children and their descendants are returned). The attributes of the parent resource are not returned, but all the attributes of the children are returned. For example, if the request is to retrieve a <container> resource that only has <contentInstance> children, only a representation of all of its <contentInstance> child-resource(s) is provided. The offset, maximum number/size and maximum level shall be specified in Filter Criteria as offset, limit, and level condition, respectively, by the Originator. Processing of direct child resources, size limitations, maximum nesting level, and offset for the starting of direct child resource processing of the attributes+child-resources option shall apply to this option as well. This shall be only valid for a Retrieve/Delete operation. - attributes+child-resource-references: Representation of the requested resource, along with the address(es) of the child resource(s), and their descendants (excluding virtual resources) shall be returned as content. For example, if the request is to retrieve a <container> resource, the <container> resource and the address(es) of the <contentInstance> child-resource(s) are provided. The offset, maximum number/size and maximum level shall be specified in Filter Criteria as offset, limit, and level condition, respectively, by the Originator. Processing of child resources, size limitations, maximum nesting level, and offset for the starting of child resource processing of the attributes+child- resources option shall apply to this option as well. This shall be only valid for a Retrieve/Delete operation. - child-resource-references: Address(es) of the child resources and their descendants (excluding virtual resources), without any representation of the actual requested resource shall be returned as content. For example, if the request is to retrieve a <container> resource, only the address(es) of the <contentInstance> child-resource(s) is provided. The offset, maximum number/size and maximum level shall be specified in Filter Criteria as offset, limit, and level condition, respectively, by the Originator. Processing of child resources, size limitations, maximum nesting level, and offset for the starting of child resource processing of the attributes+child- resources option shall apply to this option as well. This shall be only valid for a Retrieve/Delete operation. This option can be used within the context of resource discovery mechanisms (see clause 10.2.6). - nothing: Nothing shall be returned as operational result content. If the Originator does not set the Result Content parameter in a Delete request message, this setting shall be the default value when the Receiver processes the request message. This setting shall be valid for a Create, Update, Delete, or Notify operation. EXAMPLE: If the request is to delete a resource, this setting indicates that the response shall not include any content. - original-resource: Representation of the original resource pointed by the link attribute in the announced resource shall be returned as content, without the address(es) of the child resource(s). This shall be only valid for a Retrieve operation where the To parameter targets the announced resource. - semantic-content: Representation of semantic information that is the result of a semantic query as indicated by the setting of the Semantic Query Indicator parameter. This shall be only valid for a Retrieve operation with Semantic Query Indicator parameter set. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 78 (oneM2M TS-0001 version 4.15.0 Release 4) - discovery-result-references: For Discovery or IPE On-demand Discovery requests address(es) of discovered resources. For Discovery-based operations address(es) of discovered resources where the requested operation was performed successfully or unsuccessfully (see clause 10.2.6). This shall be only valid when the filterUsage condition of the Filter Criteria parameter is set to 'discovery', 'discoveryBasedOperation' or 'IPEOnDemandDiscovery'. - permissions: Representation of the privileges that the Originator has for the targeted resource and its child and descendant resource(s). The result is a consolidated representation of all the privileges defined in the <accessControlPolicy> resources associated with the targeted resource and its child and descendant resource(s), that have applicability to the Originator, and that the Originator has privileges to access (i.e. Originator has RETRIEVE selfPrivileges for the <accessControlPolicy> resources). The limit Filter Criteria condition may be used to specify the maximum number of resources to include permissions for within the Retrieve response. If the limit Filter Criteria condition is not specified, a default value of 1 shall be used. The level Filter Criteria condition may be used to specify the maximum limit on the depth of child and descendent resources in the resource tree that the Hosting CSE shall retrieve permissions for, starting from the resource targeted by the To parameter which is considered level zero. If the level Filter Criteria condition is not specified, then there is no specified limit on the depth of child and descendent resources. The Hosting CSE may use a limit on the depth of child and descendent resources based on local policy in this case. The offset Filter Criteria condition may be used to specify the number of direct child and descendant resources that a Hosting CSE shall skip over and not include permissions for within a Retrieve response. If the offset Filter Criteria condition is not specified, a default value of 0 shall be used (i.e. no offset). Table 8.1.2-1: Summary of Result Content Values Value Create Retrieve Update Delete Notify Retrieve (filterUsage='discovery') attributes default default default valid n/a n/a modified-attributes valid n/a valid n/a n/a n/a hierarchical-address valid n/a n/a n/a n/a n/a hierarchical- address+attributes valid n/a n/a n/a n/a n/a attributes+child-resources n/a valid n/a valid n/a n/a child-resources n/a valid n/a valid n/a n/a attributes+child-resource- references n/a valid n/a valid n/a n/a child-resource-references n/a valid n/a valid n/a valid nothing valid n/a valid default valid n/a original-resource n/a valid n/a n/a n/a n/a semantic-content n/a valid n/a n/a n/a n/a discovery-result-references Valid (note) Valid (note) Valid (note) Valid (note) n/a Default (note) permissions n/a valid n/a n/a n/a n/a NOTE: Additional conditions apply, see text descriptions. • Result Persistence: optional result persistence: indicates the time for which the response may persist to. The parameter is used in case of non-blocking request where the result attribute of the <request> resource should be kept at the CSE, for example, with the purpose of sharing, tracking and analytics. In the case the response of a request is required to be kept in the CSE, for example the procedures of <request> resource, <delivery> resource and <group> resource, the Result Persistence indicates the time duration for which the CSE keeps the response available after receiving it. Example usage of result persistence includes requesting sufficient persistence for analytics to process the response content aggregated asynchronously over time. If a result expiration time is specified, then the result persistence lasts beyond the result expiration time. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 79 (oneM2M TS-0001 version 4.15.0 Release 4) • Operation Execution Time: optional operation execution time: indicates the time when the specified operation Operation is to be executed by the target CSE. A target CSE shall execute the specified operation of a Request having its operational execution time indicator set, starting at the operational execution time. If the execution time has already passed or if the indicator is not set, then the specified operation shall be immediately executed, unless the request expiration time, if set, has been reached. Example usage of operational execution time includes asynchronous distribution of flows, which are to be executed synchronously at the operational execution time. NOTE 4: Time-based flows could not be supported depending upon time services available at CSEs. • Event Category: optional event category: Indicates the event category that should be used to handle this request. Event categories are impacting how Requests to access remotely hosted resources are processed in the CMDH CSF. Selection and scheduling of connections via CMDH are driven by policies that can differentiate event categories. Example usage of "event category" set to specific value X: When the request is demanding an operation to be executed on a Hosting CSE that is different from the current Receiver CSE, the request may be stored in the current Receiver CSE that is currently processing the request on the way to the Hosting CSE until it is allowed by provisioned policies for that event category X to use a communication link to reach the next CSE on a path to the Hosting CSE or until the request expiration timestamp is expired. The following values for Event Category shall have a specified pre-defined meaning: - Event Category = immediate: Requests of this category shall be sent as soon as possible and shall not be subject to any further CMDH processing, i.e. the request will not be subject to storing in CMDH buffers when communication over an underlying network is possible. In particular, CMDH processing will respect values for Request Expiration Timestamp, Result Expiration Timestamp given in the original request and not fill in any default values if they are missing. - Event Category = bestEffort: Requests of this category can be stored in CMDH buffers at the discretion of the CSE that is processing the request for an arbitrary time and shall be forwarded via Mcc on a best effort basis. The CSE does not assume any responsibility to meet any time limits for delivering the information to the next CSE. Also the maximum amount of buffered requests for this category is at the discretion of the processing CSE. - Event Category = latest:  If this category is used in a request asking for a CRUD operation on a resource, the following shall apply: CRUD requests using this category shall undergo normal CMDH processing as outlined further below in the present document and in ETSI TS 118 104 [3] with a maximum buffer size of one pending request for a specific pair of From and To parameters that appear in the request. If a new request message is received by the CSE with a pair of parameters From and To that has already been buffered for a pending request, the newer request will replace the buffered older request.  If this category is used in a notification request triggered by a subscription, the following shall apply: Notification requests triggered by a subscription using this category shall undergo normal CMDH processing as outlined further below in the present document and in ETSI TS 118 104 [3] with a maximum buffer size of one pending notification request per subscription reference that appears in a notification request. If a new notification request is received by the CSE with a subscription reference that has already been buffered for a pending notification request, the newer request will replace the buffered older request.  If no further CMDH policies are provisioned for this event category, the forwarding process shall follow the 'bestEffort' rules defined above. The M2M Service Provider shall be able to provision CMDH policies describing details for the usage of the specific Underlying Network(s) and the applicable rules as defined in the [cmdhPolicy] resource type for other Event Category values not listed above. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 80 (oneM2M TS-0001 version 4.15.0 Release 4) • Delivery Aggregation: optional delivery aggregation on/off: Use CRUD operations of <delivery> resources to express forwarding of one or more original requests to the same target CSE(s). When this parameter is not given in the request, the default behaviour is determined per the provisioned CMDH policy if available. If there is no such CMDH policy, then the default value is "aggregation off". NOTE 5: Since Delivery Aggregation is optional, there could be a default value to be used when not present in the Request. This parameter could not be exposed to AEs via Mca. Example usage of delivery aggregation set on: The CSE processing a request shall use aggregation of requests to the same target CSE by requesting CREATE of a <delivery> resource on the next CSE on the path to the target CSE. • Group Request Identifier: Identifier added to a request when it is fanned out to each member of the group in order to detect loops and avoid duplicated handling of the operation in cases where there are circular references between groups and where there are common members between groups that have a parent-child relationship. This parameter shall only be added to requests by a Group Hosting CSE, and then only when it is processing requests targeted at a <fanOutPoint> virtual resource that does not already have a Group Request Identifier parameter. A target CSE shall process any Group Request Identifier that it receives as described in clause 10.2.7.1 step 004. • Group Request Target Members: optional group request target members: Indicates subset of members of a group for which fanout is to be executed. Example usage of Group Request Target Members: if fanout operation failed for some of the members then the Originator may use this parameter to execute fanout for failed members of a previous fanout operation. • This shall be only valid for requests targeting the <fanoutPoint> virtual resource. • Group Somecast Target Number: optional group somecast target number: Indicates that this group fanout request is to be fanned out to a specified number of group members which is less than the total number of group members. If this parameter is configured with a value that meets or exceeds the total number of members within the targeted group, then a somecast will not be performed and the request will be fanned out to all group members. • Filter Criteria: optional filter criteria: conditions for filtered operations which are described in table 8.1.2-2. This is used for resource discovery (clause 10.2.6) and general Create, Retrieve, Update, Delete requests (clauses 10.1.3, 10.1.4 and 10.1.5). The Filter Criteria set includes matching conditions and filter handling conditions. One of the handling conditions is the filterUsage condition (table 8.1.2-2) which governs the use of the other Filter Criteria conditions and the Discovery-based operations as detailed in clause 10.2.6. Matching conditions are evaluated against resources and, when true, determine the matched resources which compose the matching result. The filter handling conditions provide additional input used to determine the filtering result (e.g. maximum number of resources to be included in the filtering result). The filtering result may be composed of one or more resources and determines the target resources for Discovery-based operations. Examples of filter criteria usage are provided in clause 10.2.6. • Desired Identifier Result Type: Optional result format of resource identifiers. This parameter indicates the format of the resource identifiers in the result of operations that can return a list of resource identifiers or Child Resource References. This parameter shall take on one of the following values reflecting the options in clause 9.3.1: - Structured identifier format. - Unstructured identifier format. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 81 (oneM2M TS-0001 version 4.15.0 Release 4) This shall be only valid for the following options: - For Retrieve requests with the Result Content parameter set to "attributes+child-resource-references" or "child-resource-references". In this case the identifier format applies to the child resource references which are child resource identifiers. - For Retrieve requests with filterUsage condition set to 'Discovery' or 'IPE On-demand Discovery' and the Result Content parameter set to "discovery-result-references". In this case the identifier format applies to the resource references discovered. - For Create/ Update/Delete requests with the filterUsage condition set to 'discoveryBasedOperation' and the Result Content parameter set to "discovery-result-references". In this case the identifier format applies to the resource references discovered where the operation was performed successfully or unsuccessfully. For example, for a Retrieve request with Result Content parameter set to "child-resource-references", if Desired Identifier Result Type is set to Unstructured identifier format, then the request Originator indicates that the result should be in the form of one or more Unstructured identifiers of child resources. The absence of the parameter implies that the result shall be in Structured identifier format. • Token Request Indicator: Optional parameter used to indicate that the Originator supports the Token Request procedure, and the Originator may attempt the Token Request procedure if the Receiver provides a Token Request Information parameter in the response. • Tokens: Optional parameter used to transport ESData-protected Tokens applicable to the request for use in Indirect Dynamic Authorization. • Token IDs: Optional parameter used to transport Token-IDs applicable to the request for use in Indirect Dynamic Authorization. • Local Token IDs: Optional parameter used to transport Local-Token-IDs applicable to the request for use in Indirect Dynamic Authorization. • Authorization Signatures Indicator: Optional parameter used to indicate the capability for creating AuthorRelMapRecord when Originator is an AE. If the Hosting CSE does not support this parameter, the Hosting CSE should ignore it. The details of the AuthorRelMapRecord are described in clause 7.3.2.2 of ETSI TS 118 103 [2]. • Authorization Signatures: Optional parameter used to transport the signatures for Token(s) or TokenID(s) generated using the certificate of the AE or a MIC generated using a symmetric key shared between the AE and DAS server. • Authorization Relationship Indicator: Optional parameter used to indicate that the relationship between the AE and the Token(s) are maintained in the DAS server. • Semantic Query Indicator: Optional parameter used to indicate whether a RETRIEVE request is a semantic query or a semantic resource discovery. If the request contains this parameter with the value set to "TRUE", the request shall be processed as a semantic query based on the SPARQL query statement included in the "semanticsFilter" condition tag; other Filter Criteria and the following parameters shall be ignored: Desired Identifier Result Type, Delivery Aggregation. The parameter Result Content shall be set to semantic-content to indicate that the response message contains the result of a semantic query request. If it is not set or set to "FALSE" the request shall be processed as a semantic resource discovery. Note that for semantic queries or semantic resource discoveries, the Discovery privileges are checked to determine the scope of the query or discovery. • Ontology Mapping Resources: Optional parameter that contains a list of resource identifiers of existing <ontologyMapping> resources that are used as the base of converting the query statement or the <semanticDescriptor> of the target resources into their equivalents for semantic query or discovery resource discovery operation. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 82 (oneM2M TS-0001 version 4.15.0 Release 4) • Release Version Indicator: This parameter is used to indicate the oneM2M release version that this request message conforms to. Starting with Release 2 this parameter is mandatory. The release version indicated shall apply to all oneM2M defined request parameters and certain types of content carried in the Content request parameter. Within the Content request parameter, the release version indicated shall apply to all oneM2M defined elements (e.g. notifications) and resource types with the exception of <flexContainer> and <mgmtObj> specializations which have their own version implicitly defined by their respective containerDefinition and mgmtSchema attributes. In addition, the release version indicated does not apply to resource types or specializations defined external to oneM2M. • Vendor Information: This optional parameter is available to convey vendor specific information. The use of this parameter is not defined by oneM2M specifications. • M2M Service User: Optional parameter used to indicate the identity of a M2M Service User associated with the AE originating the request. This parameter may be used if the Originator is an AE and shall not be used if the Originator is a CSE. • Primitive Profile Identifier: This optional parameter is used to indicate the CSE-Relative resource identifier of a <primitiveProfile> resource applicable to this request and its response. Table 8.1.2-2: Filter Criteria conditions Condition tag Multiplicity Description Matching Conditions createdBefore 0..1 The creationTime attribute of the matched resource is chronologically before the specified value. createdAfter 0..1 The creationTime attribute of the matched resource is chronologically after the specified value. modifiedSince 0..1 The lastModifiedTime attribute of the matched resource is chronologically after the specified value. unmodifiedSince 0..1 The lastModifiedTime attribute of the matched resource is chronologically before the specified value. stateTagSmaller 0..1 The stateTag attribute of the matched resource is smaller than the specified value. stateTagBigger 0..1 The stateTag attribute of the matched resource is bigger than the specified value. expireBefore 0..1 The expirationTime attribute of the matched resource is chronologically before the specified value. expireAfter 0..1 The expirationTime attribute of the matched resource is chronologically after the specified value. labels 0..1 The labels attribute of the matched resource matches the specified value. labelsQuery 0..1 The value is an expression for the filtering of labels attribute of resource when it is of key-value pair format. The expression is about the relationship between label-key and label-value which may include equal to or not equal to, within or not within a specified set, etc. For example, label-key equals to label value, or label-key within {label-value1, label-value2}. Details are defined in ETSI TS 118 104 [3]. childLabels 0..1 A child of the matched resource has labels attributes matching the specified value. The evaluation is the same as for the labels attribute above. Details are defined in ETSI TS 118 104 [3]. parentLabels 0..1 The parent of the matched resource has labels attributes matching the specified value. The evaluation is the same as for the labels attribute above. Details are defined in ETSI TS 118 104 [3]. resourceType 0..n The resourceType attribute of the matched resource is the same as the specified value. It also allows differentiating between normal and announced resources. childResourceType 0..n A child of the matched resource has the resourceType attribute the same as the specified value. parentResourceType 0..1 The parent of the matched resource has the resourceType attribute the same as the specified value. sizeAbove 0..1 The contentSize attribute of the <contentInstance> matched resource is equal to or greater than the specified value. sizeBelow 0..1 The contentSize attribute of the <contentInstance> matched resource is smaller than the specified value. contentType 0..n The contentInfo attribute of the <contentInstance> matched resource matches the specified value. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 83 (oneM2M TS-0001 version 4.15.0 Release 4) Condition tag Multiplicity Description attribute 0..n This is an attribute of resource types (clause 9.6). Therefore, a real tag name is variable and depends on its usage and the value of the attribute can have wild card . E.g. creator of container resource type can be used as a filter criteria tag as "creator=Sam", "creator=Sam", "creator=*Sam". childAttribute 0..n A child of the matched resource meets the condition provided. The evaluation of this condition is similar to the attribute matching condition above. parentAttribute 0..n The parent of the matched resource meets the condition provided. The evaluation of this condition is similar to the attribute matching condition above. semanticsFilter 0..n Both semantic resource discovery and semantic query use semanticsFilter to specify a query statement that shall be specified in the SPARQL query language [5]. When a CSE receives a RETRIEVE request including a semanticsFilter, and the Semantic Query Indicator parameter is also present in the request, the request shall be processed as a semantic query; otherwise, the request shall be processed as a semantic resource discovery. In the case of semantic resource discovery targeting a specific resource, if the semantic description contained in the <semanticDescriptor> of a child resource matches the semanticFilter, the URI of this child resource will be included in the semantic resource discovery result. In the case of semantic query, given a received semantic query request and its query scope, the SPARQL query statement shall be executed over aggregated semantic information collected from the semantic resource(s) in the query scope and the produced output will be the result of this semantic query. Examples for matching semantic filters in SPARQL to semantic descriptions can be found in oneM2M TR-0007 [i.28]. filterOperation 0..1 Indicates the logical operation (AND/OR/XOR) to be used for different condition tags. The default value is logical AND. contentFilterSyntax 0..1 Indicates an identifier for the syntax used in contentFilterQuery for content-based discovery. contentFilterQuery 0..1 The query string shall be specified when contentFilterSyntax parameter is present. geoQuery 0..1 Indicates geo-query conditions having the following sub-elements: - geometry type (e.g. Point, Polygon) of the geo-coordinates - geo-coordinates - geo-spatial function type (e.g. ST_Within) When this condition is present, all three sub-elements shall be present. operations 0..1(L) A matched resource has a linked <accessControlPolicy> that grants the originator permission to perform the operations listed. Filter Handling Conditions filterUsage 0..1 Indicates how the filter criteria is used. If provided, possible values are 'discovery', 'conditionalOperation', 'discoveryBasedOperation' and 'IPEOnDemandDiscovery'. If filterUsage is 'conditionalOperation', the request is a conditional operation executed only if the target resource conforms to the filter criteria. If this parameter is 'discovery', 'discoveryBasedOperation' or 'IPEOnDemandDiscovery', the matching conditions in this table are evaluated against resources and, when true, determine the matching result. Other filter handling conditions provide additional input used to determine the filtering result, which may be composed of zero or more descendant resources. If filterUsage is 'discovery', the only valid operation is a RETRIEVE and the request is for resource discovery (clause 10.2.6), i.e. only the resource IDs in the filtering result are returned. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 84 (oneM2M TS-0001 version 4.15.0 Release 4) Condition tag Multiplicity Description If filterUsage is 'discoveryBasedOperation' the valid operations are CREATE, UPDATE or DELETE, and the operation is applied to all the resources in the filtering result. If filterUsage is 'IPEOnDemandDiscovery' the Hosting CSE first processes the request locally as a regular discovery and if no target resources have been discovered, the request is sent to the IPE with the discovery Originator ID. When the IPE successfully generates new resources matching the Filter Criteria conditions, the Hosting CSE discovers them and returns the corresponding resource ID(s). This value shall only be valid for the Retrieve request targeting an <AE> resource that represents the IPE. Additional details are provided in clause 10.2.6. limit 0..1 The maximum number of resources to be included in the filtering result. This may be modified by the Hosting CSE. When it is modified, then the new value shall be smaller than the suggested value by the Originator. level 0..1 The maximum level of resource tree that the Hosting CSE shall perform the operation starting from the target resource (i.e. To parameter). This shall only be applied for Retrieve operation and 'discoveryBasedOperation'. The level of the target resource itself is zero and the level of the direct children of the target is one. offset 0..1 The number of direct child and descendant resources that a Hosting CSE shall skip over and not include within a Retrieve response when processing a Retrieve request to a targeted resource. This shall only be valid for Retrieve operations. applyRelativePath 0..1 This attribute contains a resource tree relative path (e.g. ../tempContainer/LATEST). This condition applies after all the matching conditions have been used (i.e. a matching result has been obtained). The attribute determines the set of resource(s) in the final filtering result. The filtering result is computed by appending the relative path to the path(s) in the matching result. All resources whose Resource-IDs match that combined path(s) shall be returned in the filtering result. If the relative path does not represent a valid resource, the outcome is the same as if no match was found, i.e. there is no corresponding entry in the filtering result. This shall only be valid for filterUsage 'discovery' or 'discoveryBasedOperation'. The rules when multiple matching conditions are used together shall be as follows: • Different condition tags shall use the "AND/OR/XOR" logical operation based on the filterOperation specified. E.g. createdBefore = "time1" AND unmodifiedSince = "time2" if filterOperation = "AND" or "NULL", or createdBefore = "time1" OR unmodifiedSince = "time2" if filterOperation = "OR", or createdBefore = "time1" XOR unmodifiedSince = "time2" if filterOperation = "XOR". • Same condition tags shall use the "OR" logical operation, i.e. filterOperation does not apply to same conditions. • The XOR operation evaluates to true if and only if an odd number of its inputs are true. • No mixed AND/OR/XOR filter operation will be supported. Once the Request is delivered, the Receiver shall analyse the Request to determine the target resource. If the target resource is addressing another M2M Node, the Receiver shall route the request appropriately. If the target resource is addressing the Receiver, it shall: • Check the existence of To addressed resource. • Identify the resource type by Resource Type. • Check the privileges for From Originator to perform the requested operation. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 85 (oneM2M TS-0001 version 4.15.0 Release 4) • Perform the requested operation (using Content content when provided) according to the provided request parameters as described above. • Depending on the request result content, respond to the Originator with indication of successful or unsuccessful operation results. In some specific cases (e.g. limitation in the binding protocol or based on application indications), the Response could be avoided. Table 8.1.2-3 summarizes the parameters specified in this clause for the Request message, showing any differences as applied to C, R, U, D or N operations. "M" indicates mandatory, "O" indicates optional, "N/A" indicates "not applicable". Table 8.1.2-3: Summary of Request Message Parameters Request message parameter Operation Create Retrieve Update Delete Notify Mandatory Operation - operation to be executed M M M M M To - the address of the target resource on the target CSE M M M M M From - the identifier of the message Originator O See note 1 M M M M Request Identifier - uniquely identifies a Request message M M M M M Operation dependent Content - to be transferred M O M N/A M Resource Type - of resource to be created M N/A N/A N/A N/A Optional Originating Timestamp - when the message was built O O O O O Request Expiration Timestamp - when the request message expires O O O O O Result Expiration Timestamp - when the result message expires O O O O O Operational Execution Time - the time when the specified operation is to be executed by the target CSE O O O O O Response Type - type of response that shall be sent to the Originator O O O O O Result Persistence - the duration for which the reference containing the responses is to persist O O O O N/A Result Content - the expected components of the result O O O O N/A Event Category - indicates how and when the system should deliver the message O O O O O Delivery Aggregation - aggregation of requests to the same target CSE is to be used O O O O O Group Request Identifier - Identifier added to the group request that is to be fanned out to each member of the group O O O O O Group Request Target Members-indicates subset of members of a group O O O O N/A ETSI ETSI TS 118 101 V4.15.0 (2022-09) 86 (oneM2M TS-0001 version 4.15.0 Release 4) Request message parameter Operation Create Retrieve Update Delete Notify Filter Criteria - conditions for filtered retrieve operation O O O O N/A Desired Identifier Result Type - format of resource identifiers returned N/A O N/A N/A N/A Token Request Indicator - indicating that the Originator may attempt Token Request procedure (for Dynamic Authorization) if initiated by the Receiver O O O O O Tokens - for use in dynamic authorization O O O O O Token IDs - for use in dynamic authorization O O O O O Role IDs - for use in role based access control O O O O O Local Token IDs - for use in dynamic authorization O O O O O Authorization Signatures Indicator - for use in Authorization Relationship Mapping O O O O N/A Authorization Signatures - for use in Authorization Relationship Mapping O O O O N/A Authorization Relationship Indicator - for use in Authorization Relationship Mapping O O O O N/A Semantic Query Indicator - for use in semantic queries N/A O N/A N/A N/A Ontology Mapping Resources - for use in semantic query or semantic resource discovery requests N/A O N/A N/A N/A Release Version Indicator - the oneM2M release version that this request message conforms to. M See note 2 M See note 2 M See note 2 M See note 2 M See note 2 Vendor Information O O O O O M2M Service User O O O O N/A Primitive Profile Identifier O O O O O NOTE 1: From parameter is optional in case of an AE CREATE request and mandatory for all other requests. NOTE 2: Release Version Indicator parameter is not present for the case when a request is targeting a Rel-1 entity and mandatory for all other cases. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 87 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	8.1.3 Response	The Response received by the Originator of a Request accessing resources over the Mca and Mcc reference points shall contain mandatory and may contain optional parameters. Certain parameters may be mandatory or optional depending upon the Requested operation (CRUDN) or the mandatory response code. In this clause, the mandatory parameters are detailed first, followed by those that are conditional, and then by those that are optional: Mandatory Parameters: • Response Status Code: response status code: This parameter indicates that a result of the requested operation is successful, unsuccessful, acknowledgement or status of processing such as authorization timeout, etc.: - A successful code indicates to the Originator that the Requested operation has been executed successfully by the Hosting CSE. - An unsuccessful code indicates to the Originator that the Requested operation has not been executed successfully by the Hosting CSE. - An acknowledgement indicates to the Originator that the Request has been received and accepted by the attached CSE, i.e. by the CSE that received the Request from the issuing Originator directly, but the Request operation has not been executed yet. The success or failure of the execution of the Requested operation is to be conveyed later. Details of successful, unsuccessful and acknowledge codes are provided in clause 6.6 of ETSI TS 118 104 [3]. • Request Identifier: Request Identifier. The Request Identifier in the Response shall match the Request Identifier in the corresponding Request. Conditional Parameters: • Content: resource content: - If Response Status Code is successful then: The Content response parameter may be present in a Create/Update/Delete Response and the information in this Content response parameter depends on the value of the Result Content and Desired Identifier Result Type request parameters of the corresponding Request. If the value of the Result Content request parameter is "nothing" or if the Result Content request parameter is not present in a Delete Request, the Content response parameter shall not be present. Otherwise, the Content response parameter shall be present in the following cases:  The Content parameter shall be present in a Retrieve Response and the information in this Content parameter depends on the Result Content value of the corresponding Retrieve Request. In a Retrieve Response the format of the information in this Content parameter depends also on the combination of FilterUsage and Desired Identifier Result Type values of the request.  If Response Status Code is unsuccessful then the Content parameter may be present in a Response to provide more error information.  If Response Status Code is acknowledgment, then the Content parameter: - Shall contain the address of a <request> resource if the response was an acknowledgement of a non-blocking request and the <request> resource type is supported by the Receiver CSE. - Is not present otherwise. • Content Status: This parameter shall be present in the response to a Retrieve operation when the returned content is partial. More specifically, this parameter takes the value of partial depending on the Content parameter. - If Response Code is successful then and the Content parameter is present due to the following case:  Retrieve (R): Content is the retrieved resource content or aggregated contents of discovered resources and the retrieved content is partial. Then Content Status parameter shall be present in the response for a Retrieve (R) operation. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 88 (oneM2M TS-0001 version 4.15.0 Release 4) • Content Offset: This parameter includes the point where a Hosting CSE left off with processing a Retrieve operation that resulted in a response with partial content (i.e. due to reaching the limit on the number of resources allowed in a response). This parameter shall be expressed as a number which can be used in a subsequent Retrieve request. The parameter shall be used by the Hosting CSE to skip over the specified number of direct child and descendant resources of a targeted resource and retrieve the remaining direct child and descendant resources. Its value depends on the information included in the Content Status parameter. When a Hosting CSE includes a Content Offset parameter within a Retrieve response to indicate partial results, and an originator includes this value within an offset Filter Criteria condition in a subsequent Retrieve request to indicate to the Hosting CSE where to continue processing, the Hosting CSE is not obligated to ensure consistency between any prior partial results it returned and the results it returns for a continued request. For example, a Hosting CSE may receive and process other requests (e.g. creation of new resource or deletion of existing resources) during the interim of when it returns a partial result to a Retrieve request and when it receives a subsequent request with an offset Filter Criteria condition to continue the Retrieve request. If these other requests target the same resources as the Retrieve, this can impact the offset calculations on the Hosting CSE. As a result, the combined set of partial results received by an originator may have duplicate or missing results: - If Content Status parameter is complete, then this parameter shall not be included. - If Content Status parameter is partial, then this shall include the offset where processing can restart for the remaining descendant resources in the resource tree. Then Content Offset parameter shall be present in the response for a Retrieve (R) operation. Optional parameters: • To: ID of the Originator or the Transit CSE. • From: ID of the Receiver. The To and From parameters can be used in the response for specific protocol bindings (e.g. MQTT): • Originating Timestamp: originating timestamp of when the message was built. • Result Expiration Timestamp: result expiration timestamp. The Receiver shall echo the result expiration timestamp if set in the Request message, or may set the result expiration timestamp itself. Example usage of the Receiver setting the result expiration timestamp is when the value of the delivery time is dependent upon some changing Receiver context e.g. Result message deadline for aircraft position based upon velocity. • Event Category: event category: Indicates the event category that should be used to handle this response. The definition of event category is the same as in the case of requests in clause 8.1.2. Example usage of "event category" set to specific value X: When the response is targeted to an entity that is different from the Transit CSE currently processing the response message and is not an AE registered with the Transit CSE that is currently processing the response message, the response may be stored in the Transit CSE that is currently processing the response on the way to the destination of the response message until it is allowed by provisioned policies for that event category X to use a communication link to reach the next CSE on a path to the destination of the response message or until the result expiration timestamp is expired. • Token Request Information: Optional parameter which may be used for requesting Tokens from Dynamic Authorization Systems. • Assigned Token Identifiers: Optional parameter containing the mapping from assigned Local-Token-IDs to corresponding Token-IDs. • Authorization Signatures Request Information: Optional parameter used to request the Authorization Signatures of the Token(s) from an AE which is the holder of the Token(s). ETSI ETSI TS 118 101 V4.15.0 (2022-09) 89 (oneM2M TS-0001 version 4.15.0 Release 4) • Release Version Indicator: This parameter is used to indicate the oneM2M release version that this response message is compliant with. Starting with Release 2 this parameter is mandatory. The release version indicated shall apply to all oneM2M defined response parameters and certain types of content carried in the Content response parameter. Within the Content response parameter, the release version indicated shall apply to all oneM2M defined elements (e.g. notifications) and resource types with the exception of <flexContainer> and <mgmtObj> specializations which have their own version implicitly defined by their respective containerDefinition and mgmtSchema attributes. The release version indicated does not apply to resource types or specializations defined external to oneM2M. • Vendor Information: This optional parameter is available to convey vendor specific information. The use of this parameter is not defined by oneM2M specifications. • M2M Service User: Optional parameter used to indicate the identity of a M2M Service User. The Receiver shall echo the M2M Service User in the response message if set in the request message. Table 8.1.3-1 summarizes the parameters specified in this clause for the Response messages, showing any differences as applied to successful C, R, U, D or N operations, and unsuccessful operations. "M" indicates mandatory, "O" indicates optional, "N/A" indicates "not applicable". ETSI ETSI TS 118 101 V4.15.0 (2022-09) 90 (oneM2M TS-0001 version 4.15.0 Release 4) Table 8.1.3-1: Summary of Response Message Parameters Response message parameter/success or not Ack Successful Operation Unsuccessful Operation Create Retrieve Update Delete Notify Create / Retrieve / Update / Delete Notify Response Status Code - successful, unsuccessful, ack M M M M M M M M Request Identifier - uniquely identifies a Request message M M M M M M M M Content - to be transferred O (Address of <request> resource if response is ACK of a non- blocking request) O (The address and/or the content of the created resource, an address list, or aggregated response primitives) (see notes 3, 4) M (The retrieved resource content, aggregated contents, an address list or aggregated response primitives) (see notes 3, 4) O (A complete or partial resource representation , an address list or aggregated response primitives.) (see notes 3, 4) O (The content actually deleted, an address list or aggregated response primitives) (see notes 3, 4) O (see note 1, end- to-end security protocol message) O (Additional error info) O (see note 1, additional error info secured using ESPrim) To - the identifier of the Originator or the Transit CSE that sent the corresponding non-blocking request O O O O O O O O From - the identifier of the Receiver O O O O O O O O Originating Timestamp - when the message was built O O O O O O O O Result Expiration Timestamp - when the message expires O O O O O O O O Event Category - what event category shall be used for the response message O O O O O O O O Content Status N/A N/A O N/A N/A N/A N/A N/A Content Offset N/A N/A O N/A N/A N/A N/A N/A Token Request Information N/A N/A N/A N/A N/A N/A O O Assigned Token Identifiers N/A O O O O O O O Authorization Signatures Request Information N/A N/A N/A N/A N/A N/A O N/A Release Version Indicator - the oneM2M release version that this response message conforms to M (see note 2) M (see note 2) M (see note 2) M (see note 2) M (see note 2) M (see note 2) M (see note 2) M (see note 2) Vendor Information O O O O O O O O M2M Service User O O O O O N/A O N/A NOTE 1: This parameter is present if the response contains an end-to-end security protocol message. Otherwise this parameter is not applicable. NOTE 2: Release Version Indicator parameter is not present for the case when a response is targeting a Rel-1 entity and mandatory for all other cases. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 91 (oneM2M TS-0001 version 4.15.0 Release 4) Response message parameter/success or not Ack Successful Operation Unsuccessful Operation Create Retrieve Update Delete Notify Create / Retrieve / Update / Delete Notify NOTE 3: A resource address list with zero or more resource addresses may be provided for some Discovery-related procedures (see clause 10.2.6 for conditions and details). NOTE 4: An aggregation of response primitives may be provided for group operations (see clause 10.2.7 for conditions and details) and some Discovery-related procedures (see clause 10.2.6 for conditions and details). ETSI ETSI TS 118 101 V4.15.0 (2022-09) 92 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	8.2 Procedures for Accessing Resources
2bd691fcce98b96819b9b3b005c72741	118 101	8.2.0 Overview	This clause describes the procedures for accessing the resources. The term "hop" in the descriptions here refers to the number of Transit CSEs traversed by a request on its route from the Originator to the Hosting CSE. Traversal implies that the request was forwarded from one CSE to either its Registrar CSE or Registree CSE. For example, when a CSE initiated a request and the Hosting CSE is its Registrar CSE, the hop count is zero. The Receiver CSE shall forward the received request in the following case: • The To parameter in the request contains a CSE-ID and it does not represent the ID of the Receiver CSE. The Receiver CSE shall handle the received request in the following cases: • The To parameter in the request contains a CSE-ID and it represents the ID of the Receiver CSE. • The To parameter in the request does not contain a CSE-ID. All the descriptions and message flows in this clause are illustrative for the direction from a Registree acting as an Originator to a Registrar acting as a Receiver only. The flows from a Registrar CSE to a Registree CSE are symmetric with respect to the one described in this clause. Both the IN-CSE and MN-CSE have the ability to route a received request or response messages to one of their Registrees. If the Hosting CSE is not known by an MN-CSE that receives a request or response message, that MN-CSE shall forward the message to its own Registrar CSE by default.
2bd691fcce98b96819b9b3b005c72741	118 101	8.2.1 Accessing Resources in CSEs - Blocking Requests
2bd691fcce98b96819b9b3b005c72741	118 101	8.2.1.0 Overview	For the procedures described herein, the addressed resource can be stored in different CSEs. Table 8.2.1.0-1 describes the possible scenarios, where the addressed resource may be on the Registrar CSE or on a CSE located elsewhere in the oneM2M System. In this clause - for simplicity - it is assumed that the Originator of a Request can always wait long enough to get a Response to the Request after the requested operation has finished. This implies potentially long or unknown blocking times (time for which a pending Request has not been responded to) for the Originator of a Request. For scenarios that avoid such possibly long blocking times, clause 8.2.2 specifies mechanisms to handle synchronous and asynchronous resource access procedures via returning appropriate references. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 93 (oneM2M TS-0001 version 4.15.0 Release 4) Table 8.2.1.0-1: Accessing Resources in different CSEs, from Registree to Registrar CSE Number of Transit CSEs Description Reference No Hops • The Originator of the Request accesses a resource. • The Originator of the Request can be an AE or a CSE. • Registrar CSE and Hosting CSE are the same entity. • The Hosting CSE checks the Access Control Privileges for accessing the resource. • Depending on the expected result content, the Hosting CSE responds to the Originator of the Request, either with a success or failure Response. Figure 8.2.1.0-1 1 Hop • The Originator of the Request accesses a resource. • The Originator of the Request may be an AE or a CSE. • Registrar CSE and hosting CSEs are different entities. • Registrar CSE forwards the Request to the Hosting CSE if the Registrar CSE is registered with the Hosting CSE, for accessing the resource. • Hosting CSE checks the Access Control Privileges for accessing the resource and depending on the expected result content respond with a success or failure Response. Figure 8.2.1.0-2 Multi Hops • The Originator of the Request accesses a resource. • The Originator of the Request may be an AE or a CSE. • Registrar CSE, Transit CSE(s) and the Hosting CSE are different entities. • Registrar CSE: − Forwards the request to a Registree Transit-1 CSE if the Hosting CSE is a descendant of a Registree Transit-1 CSE; or − Forwards the request to its Registrar Transit-1 CSE if the Hosting CSE is not a descendant of any Registree Transit-1 CSE • Transit-N CSE: − Forwards the request to the Hosting CSE if it is registered with the Hosting CSE; or − Forwards the request to a Registree Transit-(N+1) CSE if the Hosting CSE is a descendant of a Registree Transit- (N+1) CSE − Forwards the request to its Registrar Transit-(N+1) CSE if the Hosting CSE is not a descendant of any Registree Transit-(N+1) CSEs and if the Transit-(N-1) CSE is not the Registrar CSE of the Transit-N CSE − Return an error if the Hosting CSE is not a descendant of any Registree Transit-(N+1) CSEs and if the Transit-(N-1) CSE is the Registrar CSE of the Transit-N CSE • In case the Request reaches the IN-CSE, the IN-CSE: − Performs the processing defined under 'Hosting CSE' below if the targeted resource is hosted on IN-CSE − Forwards the request to another IN-CSE if the resource belongs to another M2M SP based on the routing procedure defined in clause 8.2.1.2; or − Forwards the request to the Hosting CSE if the Hosting CSE is registered with the IN-CSE; or − Forwards the request to a Registree Transit-(N+1) CSE if the Hosting CSE is a descendant of a Registree Transit- (N+1) CSE − Return an error if the Hosting CSE is not a descendant of a Registree Transit-(N+1) CSE or the request cannot be forwarded to another IN-CSE in another M2M SP domain • Hosting CSE checks the Access Control Privileges for accessing the resource and depending on the expected result content respond with a success or failure Response. Figure 8.2.1.0-3 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 94 (oneM2M TS-0001 version 4.15.0 Release 4) Figure 8.2.1.0-1: Originator accesses a resource on the Registrar CSE (No Hops) ETSI ETSI TS 118 101 V4.15.0 (2022-09) 95 (oneM2M TS-0001 version 4.15.0 Release 4) Figure 8.2.1.0-2: AE/CSE accesses a resource at the Hosting CSE (One Hop) ETSI ETSI TS 118 101 V4.15.0 (2022-09) 96 (oneM2M TS-0001 version 4.15.0 Release 4) Figure 8.2.1.0-3: Originator accesses a resource at the Hosting CSE (Multi Hops) ETSI ETSI TS 118 101 V4.15.0 (2022-09) 97 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	8.2.1.1 M2M Requests Routing Policies	A CSE shall route M2M requests targeting another CSE in the same SP domain by forwarding the request to the next hop towards the target CSE by first checking each of its <remoteCSE> resources to determine whether the CSE-ID specified in the To parameter of the request matches either the CSE-ID or descendantCSEs attributes of a <remoteCSE> resource. If a match is found, the CSE shall retarget the request to the pointOfAccess of the matching <remoteCSE> resource. If a match is not found, and the CSE received the request from an AE or a descendant CSE, and the CSE is not the IN-CSE, then it shall retarget the request to its Registrar CSE. If a match is not found and the CSE is the IN-CSE, then the CSE shall not forward the request and it shall respond with an error. If a match is not found and the CSE is not the IN-CSE and the CSE receives the request from its registrar CSE, then the CSE shall not forward the request and it shall respond with an error. Anytime a CSE re-targets a request to another CSE, it shall keep track of the requestID and the corresponding Originator's ID. This information shall be used to route re-targeted responses back to the Originator.
2bd691fcce98b96819b9b3b005c72741	118 101	8.2.1.2 Inter SP Domain M2M Request Routing	If a CSE in the originating SP domain is not the IN-CSE and it receives a request targeting another CSE in a different SP domain, it shall retarget the request to its Registrar CSE. This shall be done by retargeting the requests to the pointOfAccess of the <remoteCSE> of its Registrar CSE. If a CSE in the originating SP domain is the IN-CSE and it receives a request targeting another CSE in a different SP domain, the IN-CSE shall routes the request to the IN-CSE in the targeted SP domain using either the DNS-based procedures or the inter-M2M SP registration procedures defined in clause 6.5. For the inter-M2M SP registration based procedure, the IN-CSE in the originating SP domain shall forward the request to the IN-CSE in the target SP domain by checking each of its <remoteCSE> resources to determine whether the SP-ID specified in the To parameter of the request matches the SP-ID specified in the CSE-ID attribute containing a SP-relative CSE-ID. If the IN-CSE finds a match, it shall retarget the request to the pointOfAccess of the matching <remoteCSE> resource. If the IN-CSE does not find a match, then it shall not forward the request and it shall respond with an error. An IN-CSE receiving a request from an IN-CSE in another SP domain, shall route the request to the targeted CSE residing in its own domain using the Intra SP Domain routing as described in clause 8.2.1.1 to route the request to the CSE in the targeted SP domain. Anytime a CSE re-targets a request to another CSE in its own SP domain or another SP domain, it shall keep track of the requestID and the corresponding Originator's ID. This information shall be used to route re-targeted responses back to the Originator.
2bd691fcce98b96819b9b3b005c72741	118 101	8.2.2 Accessing Resources in CSEs - Non-Blocking Requests	8.2.2.1 Response with Acknowledgement and optional Reference to Request Context and Capturing Result of Requested Operation In case the Originator of a Request has asked for only a response with an Acknowledgement indicating acceptance of the Request and an optional reference to the context where the result of the requested operation is expected - i.e. when the Response Type parameter of the request as defined in clause 8.1.2 is set to nonBlockingRequestSynch or to nonBlockingRequestAsynch - it is necessary to provide a prompt response to the Originator with an Acknowledgement - and in case the <request> resource type is supported by the Receiver CSE also, with a reference to an internal resource on the Receiver CSE, so that the Originator can retrieve the status of the request and the outcome of the requested operation at a later time. The details of such an internal resource are defined in clause 9.6.12. In case the <request> resource type is supported, the reference is provided in the response to the Request within the Content parameter of the Response. The abbreviation "Req-Ref" is used for simplicity in the figures of the following clauses. Two different cases to allow the Originator of a non-blocking request to retrieve the result of a requested operation are defined in the following two clauses.
2bd691fcce98b96819b9b3b005c72741	118 101	8.2.2.2 Synchronous Case	In the synchronous case, it is assumed that the Originator of a Request is not able to receive asynchronous messages, i.e. all exchange of information between Originator and Receiver CSE needs to be initiated by the Originator. In the synchronous case, a Receiver CSE that does not support the <request> resource type shall respond an error indicating that is not supported. In that case the information flow depicted in figure 8.2.2.2-1 is applicable. For the flow depicted in figure 8.2.2.2-1 it is assumed that completion of the requested operation happens before the Originator is trying to retrieve the result of the requested operation with a second Request referring to the "Req-Ref" provided in the Response to the original Request. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 98 (oneM2M TS-0001 version 4.15.0 Release 4) Another variation of the information flow for the synchronous case is depicted in figure 8.2.2.2-2. In this variation it is assumed that the requested operation completes after the second request but before the third request sent by the Originator. Equivalent information flows are valid also for cases where the target resource of the requested operation is not hosted on the Receiver CSE. From an Originator's perspective there is no difference as the later retrieval of the result of a requested operation would always be an exchange of Request/Response messages between the Originator and the Receiver CSE using the reference to the original request. Figure 8.2.2.2-1: Non-blocking access to resource in synchronous mode (Hosting CSE = Receiver CSE), requested operation completed before second request ETSI ETSI TS 118 101 V4.15.0 (2022-09) 99 (oneM2M TS-0001 version 4.15.0 Release 4) Figure 8.2.2.2-2: Non-blocking access to resource in synchronous mode (Hosting CSE = Receiver CSE), requested operation completed after the second but before the third request ETSI ETSI TS 118 101 V4.15.0 (2022-09) 100 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	8.2.2.3 Asynchronous Case	In the asynchronous case, it is assumed that the Originator or other entities that need to know about the outcome of a Request are able to receive notification messages, i.e. the CSE carrying out the requested operation may send an unsolicited message to the Originator or to other indicated entities at an arbitrary time to send the status and result of the requested operation to one or more Notification Target(s). If the Receiver CSE selects to send the NOTIFY in non blocking asynchronous mode, then the Hosting CSE shall request NOTIFY with Response Type parameter indicating non blocking asynchronous operation with empty target list. In the asynchronous case, a Receiver CSE that does not support the <request> resource type shall respond to an acceptable request with a response containing an Acknowledgement without a reference to a resource containing the context of the request. In the asynchronous case the exemplary information flow depicted in figure 8.2.2.3-1 is applicable. In this case it is assumed that the Originator of the Request provided two Notification Targets. (the Originator and one other Notification Target) to which notification shall be sent when the result of the requested operation is available or when the request failed. Equivalent information flows are valid also for cases where the target resource of the requested operation is hosted on the Hosting CSE itself. From an Originator's or Notification Target's perspective there is no difference as the later notification of the result of a requested operation would always be an exchange of request/response messages between the CSE carrying out the requested operation and the Notification Targets using reference to the original Request ID. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 101 (oneM2M TS-0001 version 4.15.0 Release 4) Originator (AE) Registrar CSE Hosting CSE The addressed resource is stored here . Request (access resource notification target(s)) Request accepted, but Receiver – 1 CSE does not host the target resource Response (Without Req-Ref) Request (notification) Response Message flow for forwarding request to Hosting CSE Response Other Notification Target Response Request (notification) Request (notification) Request operation completes Compose Notification for first Receiver Store Notification for re-retargeting Compose Notification for second Receiver Re-target stored Notification to AE Figure 8.2.2.3-1: Non-blocking access to resource in asynchronous mode (Hosting CSE not equal to Receiver - 1 CSE), Originator provided targets for notification
2bd691fcce98b96819b9b3b005c72741	118 101	8.3 Procedures for interaction with Underlying Networks
2bd691fcce98b96819b9b3b005c72741	118 101	8.3.1 Introduction	Procedures for interaction with Underlying Networks are used to provide information about the M2M service layer (e.g. communication patterns of oneM2M devices) to the Underlying Network or receive information from the Underlying Network (e.g. reports on issues of the Underlying Network). Such information enables the Underlying Network to provide means for optimization of M2M traffic and also allows M2M service layer to optimize its services. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 102 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	8.3.2 Description and Flows on Mcn Reference Point	Communications between the CSEs and the NSEs across the Mcn reference point include: • the CSE(s) accessing network service functions provided by Underlying Networks; and • optimizing network service processing for Underlying Networks. Such services normally are more than just the general transport services. Communications which pass over the Mcn reference point to Underlying Networks include: • Messaging services that are widely deployed by Applications and network operators using a number of existing mechanisms. • Network APIs defined by other SDOs (e.g. OMA and GSMA) are used by network operators for their services. • Interworking for services and security aspects for MTC (Machine Type Communications) has been defined by 3GPP and 3GPP2. Examples of service requests from a CSE towards the Underlying Networks are: • Connection requests with/without QoS requirements. • Payments, messages, location, bearer information, call control and other network capabilities (e.g. by using GSMA oneAPI, network APIs supporting protocols defined by other SDOs, or proprietary network APIs). • Device triggering. • Device management. • Management information exchange such as charging/accounting records, monitoring and management data exchange. • Location request.
2bd691fcce98b96819b9b3b005c72741	118 101	8.3.3 Device Triggering
2bd691fcce98b96819b9b3b005c72741	118 101	8.3.3.1 Definition and scope	Device Triggering is a means by which a node in the infrastructure domain (e.g. IN-CSE) sends information to a node in the field domain (e.g. ASN/MN-CSE or ADN-AE) to perform a specific task, e.g. to wake up the device, to establish communication from the field domain towards the infrastructure domain, or when the IP address for the device is not available or reachable by the infrastructure domain. Triggers are only addressed to and received by ASN/MN-CSEs and ADN-AEs. Triggers may be used to request anASN/MN-CSE or ADN-AE take some action such as enrol, or as refresh its PoA, or, register, or to request an ADN-AE or a registree AE of the ASN/MN-CSE to perform a CRUD operation. Underlying Network functionality is used to perform device triggering, for example, using alternate means of communication (e.g. SMS) with the Field Node. NOTE: Device Triggering is applicable for the entities which are registered with IN-CSE. Each Underlying Network type may provide a different way of performing a device triggering. For example, 3GPP and 3GPP2 have defined dedicated interfaces for requesting device triggering. The normative references for applicable interfaces are as follows: ETSI TS 123 682 [i.14] and 3GPP2 X.P0068 [i.17]. Access specific mechanisms are covered in ETSI TS 118 126 [15] and annex C.
2bd691fcce98b96819b9b3b005c72741	118 101	8.3.3.2 General Procedure for Device Triggering
2bd691fcce98b96819b9b3b005c72741	118 101	8.3.3.2.0 Overview	This clause covers different scenarios for device triggering. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 103 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	8.3.3.2.1 Triggering procedure	This case describes the scenario where IN-CSE targets an ASN/MN-CSE or ADN-AE for the Device Triggering request. Figure 8.3.3.2.1-1 shows the general procedure for Device Triggering and, if required, for establishment of connectivity between an IN-CSE and the Field Node. ASN/MN -CSE or ADN-AE Device Triggering Handler IN-CSE IN-AE NSE Mcc/Mca Field Domain Infrastructure Domain Mca 1b. CRUD Request to ASN/MN-CSE or ADN-AE 3. Underlying Network selection . 4. Device Triggering request 6. Device Triggering response 5. Underlying Network Specific Device Triggering Procedure 7. ASN/MN-CSE or ADN- AE receives trigger - 8. Perform Trigger Actions Mcn 1a. Device Trigger Request 2. Determine if Device Triggering is Required NOTE 1: The IN and M2M Device are assumed to be connected through the same Underlying Network. NOTE 2: The Device Triggering Handler is a functional entity that receives the device triggering request, and it is dependent on the Underlying Network. The Device Triggering Handler is out of scope of the present document. Figure 8.3.3.2.1-1: General Device Triggering general Procedure Pre-condition The ASN/MN-CSE or ADN-AE which is the target of the device triggering may be registered with the IN-CSE, or the IN-CSE may be provisioned with the information necessary to send a trigger to the ASN/MN-CSE or ADN-AE, or an AE can provide the necessary information to the IN-CSE via an AE device trigger request. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 104 (oneM2M TS-0001 version 4.15.0 Release 4) Step 1 (Optional): Request to the targeted ASN/MN-CSE or ADN-AE An AE may issue a device trigger request to an ASN/MN-CSE or ADN-AE by creating or updating a <triggerRequest> resource hosted on an IN-CSE. Alternatively, an IN-CSE may initiate a device trigger request to an ASN/MN-CSE or ADN-AE. For example, if an IN-CSE receives an AE request to perform a CRUD operation targeting an ASN/MN-CSE or ADN-AE that is not reachable by the IN-CSE, the IN-CSE may generate a trigger request. Step 2: Determine if Device Triggering is required The IN-CSE determines whether or not to send a device trigger to the targeted ASN/MN-CSE or ADN-AE by performing the following ASN/MN-CSE or ADN-AE registration and trigger enable checks. • If the ASN/MN-CSE or ADN-AE is not registered to the IN-CSE and the purpose of the trigger is to have the ASN/MN-CSE or ADN-AE register to the IN-CSE or enrol to a MEF, then the IN-CSE sends a trigger request without checking whether trigger functionality is enabled for the ASN/MN-CSE or ADN-AE. If the ASN/MN- CSE or ADN-AE is already registered and the purpose of the trigger is to have the ASN/MN-CSE or ADN-AE register to the IN-CSE or enrol to a MEF, then the IN-CSE shall not send a trigger request. • If the purpose of the trigger is to have the ASN/MN-CSE or ADN-AE establish a connection, update its PoA, or perform a CRUD operation, then the IN-CSE shall first checks whether the ASN/MN-CSE or ADN-AE is registered to the IN-CSE. If the ASN/MN-CSE or ADN-AE is not registered, then the IN-CSE shall not perform the trigger. If registered, the IN-CSE shall check whether the triggerEnable attribute of the corresponding ASN/MN-CSE's <remoteCSE> or ADN-AE's <AE> resource is "TRUE". If triggerEnable is "TRUE" the IN-CSE shall send a trigger request to the ASN/MN-CSE or ADN-AE. Step 3: Underlying network selection The IN-CSE selects the Underlying Network and the mechanism to deliver the triggering request to the Underlying Network according to the configuration for connected Underlying Networks. For example, for 3GPP access network IN-CSE may use Tsp, Tsms and GSMA OneAPI; and for 3GPP2 access networks IN-CSE may use Tsp and SMS. However the preferred mechanism is Tsp. Step 4: Device Triggering request IN-CSE issues the device triggering request to the selected Underlying Network. NOTE 1: The Underlying Network dependent Device Triggering procedure for 3GPP and 3GPP2 systems are described in ETSI TS 118 126 [15] and annex C respectively. Some information provided to the selected Underlying Network for performing device triggering includes: • M2M-Ext-ID associated with the target ASN/MN-CSE or ADN-AE of the triggering request (see clause 7.1.8). • Trigger-Recipient-ID associated with the target ASN/MN-CSE or ADN-AE (see clause 7.1.10). For example, when 3GPP Underlying Network is used this identifier could map to Application-Port-ID. If there are multiple ADN-AEs on the node, then they shall use different Trigger-Recipient-IDs. • IN-CSE ID which could be used by the Underlying Network to authorize the IN-CSE for device triggering. • Optional Trigger Payload which includes a triggerPurpose, and additional payload fields. - The triggerPurpose field may take the following values:  establishConnection - The ASN/MN-CSE or ADN-AE shall interpret this as a request to establish a connection and, if the address of the <remoteCSE> (triggerInfo Address) is present in the payload, refresh its PoA.  enrolmentRequest - The ASN/MN-CSE or ADN-AE shall interpret this as a request to enroll with a MEF.  registrationRequest - The ASN/MN-CSE or ADN-AE shall interpret this as a request to register with a MN/IN-CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 105 (oneM2M TS-0001 version 4.15.0 Release 4)  executeCRUD - The ASN/MN-CSE or ADN-AE shall interpret this as a request to execute a particular CRUD operation. When the trigger recipient is an ASN/MN-CSE, the payload shall indicate which Registree AE of the ASN/MN-CSE is being asked to perform the CRUD operation. The MN/ASN-CSE checks the <AE> resource corresponding to the AE-ID of the ASN/MN-AE that was provided in the trigger payload. It checks if there is a <subscription> to the <AE> resource. It then checks if the eventType attribute of the <subscription> resource indicated that the subscription is for a trigger. If yes, then the MN/ASN-CSE creates the notification and includes the trigger payload in the content of the notification. The notification is sent to the AE and the AE creates a new CRUD request to the IN-CSE as a result of the trigger. It is assumed that an AE, who is targeted with this type of trigger has subscribed to its <AE> resource and is provisioned to know how to interpret the payload content. The CRUD operation shall be performed by the Registree AE as governed by rules and constrains detailed in note 5. When the trigger payload indicates that an ASN/MN-AE is being asked to perform a CRUD operation, its Registrar SN/MN-CSE may establish connectivity with the IN-CSE immediately or it may postpone establishing connectivity with the IN-CSE until the ASN/MN-AE initiates a CRUD request. - Depending on the triggerPurpose field, the rest of the trigger payload may contain:  When the triggerPurpose field is set to "establishConnection", the payload contains the resource address of the <remoteCSE> or <AE> where the PoA needs to be updated (triggerInfoAddress). If triggerInfoAddress is not provided, the ASN/MN-CSE or ADN-AE assumes that the PoA on its Registrar CSE does not need to be updated.  When the triggerPurpose field is set to "enrolmentRequest", the payload contains the resource address (triggerInfoAddress) of the <MEFBase> that the ASN/MN-CSE or ADN-AE should enroll to, the supported protocol bindings that may be used when contacting the <MEFBase> and the port number that should be used for each binding.  When the triggerPurpose field is set to "registrationRequest", the payload contains the resource address (triggerInfoAddress) of the <cseBase> that the ASN/MN-CSE or ADN-AE should register to, the supported protocol bindings that may be used when contacting the <cseBase> and the port number that should be used for each binding.  When the triggerPurpose field is set to "executeCRUD", the payload provides: the type of CRUDN operation (triggerInfoOperation), the address of the resource that the operation should be performed on (triggerInfoAdress) and the resource type (targetedResourceType). If the trigger recipient is an ASN/MN-CSE, the trigger payload also provides the identity of the ASN/MN-AE that is to perform the CRUD operation (triggerInfoAeId). NOTE 2: The M2M-Ext-ID may be pre-provisioned at the IN-CSE along with the associated CSE-ID or AE-ID, or may be sent at registration, or provided to the IN-CSE by an AE via a trigger request (see clause 7.1.8). NOTE 3: The above Trigger-Recipient-ID may be pre-provisioned at the IN-CSE along with the associated M2M- Ext-ID, or may be sent at registration, or provided to the IN-CSE by an AE via a trigger request (see clause 7.1.10). NOTE 4: It is left to Stage 3 to develop the bit encoding for the triggerPurpose and the rest of the payload fields. NOTE 5: The following defaults will be used by the trigger recipient to construct the operation requested via executeCRUD. NOTE 6: The trigger payload sent in the Trigger request should be serialized based on the contentSerialization attribute of the <AE> or <remoteCSE> resource of the targeted entity. • All triggered CRUD operations are non-blocking, with nonBlockingRequestSynch responses. • Operation, To, Resource type (if mandatory): set as directed by the triggerInfoOperation, triggerInfoAddress, and targetedResourceTypes fields in the trigger payload. • Event Category - set to "immediate" • Delivery Aggregation - set to "aggregation off" • From, Request Identifier, Originating timestamp Request Expiration, Result Expiration, Operational Execution Time, Result Persistence - set as per existing local policies. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 106 (oneM2M TS-0001 version 4.15.0 Release 4) • All other parameters are Not Present (NP). Step 5: Underlying Network Specific Device Triggering procedure Device Triggering processing procedure is performed between the Underlying Network and the target Node. Step 6: Device Triggering response The IN-CSE receives a response for the Device Triggering request via the Mcn reference point. Step 7: ASN/MN-CSE or ADN-AE Receives Device Trigger If the trigger had no optional trigger payload, the ASN/MN-CSE or ADN-AE assumes that the purpose of the trigger is to cause the ASN/MN-CSE or ADN-AE to establish connectivity with the IN-CSE. In this case, the address of the IN-CSE is already known to the ASN/MN-CSE or ADN-AE. If the trigger has an optional trigger payload, the ASN/MN-CSE or ADN-AE uses the triggerPurpose to determine the appropriate action and perform the necessary steps. Step 8: Perform Trigger Actions Based on the type of trigger request received, the ASN/MN-CSE or ADN-AE performs the corresponding trigger actions such as establish connectivity with the IN-CSE, enrol with the MEF, register to the IN-CSE, update its PoA, or execute a CRUD request on a specified resource.
2bd691fcce98b96819b9b3b005c72741	118 101	8.3.3.2.2 Support for device trigger recall/replace procedure	Figure 8.3.3.2.2-1 shows a procedure for device triggering recall (i.e. cancel a trigger request) and /replace (i.e. update a trigger request) between oneM2M and an Underlying Network. ASN/MN -CSE or ADN-AE Device Triggering Handler IN-CSE IN-AE NSE Mcc/ Mca Field Domain Infrastructure Domain Mca The IN-CSE has already send device trigger request to Underlying Network and connectivity is not established yet. Mcn 2. Device Trigger Recall/Replace Request 3. Underlying Network Device Trigger Recall/Replace Procedure 4. Device Trigger Recall/Replace Response 5. For trigger replace request, deliver new trigger message 1. Device Trigger Recall/Replace Request Figure 8.3.3.2.2-1: Device triggering recall/replace procedure ETSI ETSI TS 118 101 V4.15.0 (2022-09) 107 (oneM2M TS-0001 version 4.15.0 Release 4) Pre-condition The IN-CSE has already sent device trigger request to Underlying Network (e.g. 3GPP) and connectivity is not established yet. IN-CSE has already stored the previous device trigger information, e.g. trigger reference number, etc. Step 1: (Optional): AE Trigger Recall/Replace Request The AE issues a request to IN-CSE to recall/replace trigger that results in the IN-CSE generating a trigger recall/replace request to the Underlying Network. Alternatively, the IN-CSE may decide to recall/replace a trigger that the IN-CSE previously initiated. This may be done based on internal policies Step 2: Device Trigger Recall/Replace request IN-CSE issues the device trigger Recall/Replace request to the Underlying Network. In addition to same parameters in the original device trigger request, the following additional parameters for device trigger recall/replace include: • The old trigger reference number was assigned to the previously submitted trigger message that the IN-CSE wants to recall/replace. • For trigger replace request, the new trigger reference number which is assigned by the IN-CSE to the newly submitted trigger message. Step 3: Network Device Trigger Recall/Replace procedure Device Trigger Recall/Replace procedure is performed in Underlying Network. Step 4: Device Trigger Recall/Replace response The IN-CSE receives a response for the Device Trigger Recall/Replace request via the Mcn reference point. If the IN-CSE receives a success response, the IN-CSE updates the device trigger information as following: • For device trigger replace success response, the IN-CSE shall store the new trigger reference number replace the old trigger reference number. • For device trigger recall success response, the IN-CSE shall clear the old trigger reference number. Step 5: For trigger replace request, deliver new trigger message For trigger replace request, the new trigger message will be delivered to the target Node.
2bd691fcce98b96819b9b3b005c72741	118 101	8.3.4 Location Request
2bd691fcce98b96819b9b3b005c72741	118 101	8.3.4.1 Definition and Scope	Location Request is a means by which a CSE requests the geographical or physical location information of a target CSE or AE hosted in a M2M Node to the location server located in the Underlying Network over Mcn reference point. This clause describes only the case of location request when the attribute locationSource is set to Network Based. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 108 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	8.3.4.2 General Procedure for Location Request	This procedure describes a scenario wherein an AE sends a request to obtain the location information of a target AE or CSE hosted in an M2M Node to the location server NSE, and the location server responses to the CSE with location information. Figure 8.3.4.2-1 shows the general procedure for Location Request. Figure 8.3.4.2-1: General Procedure for Location Request NOTE 1: Detailed descriptions for step 1 to the step 3 are described in clause 10.2.11.1. Step 1: Create <locationPolicy> The Originator requests to CREATE <locationPolicy> resource at the Registrar CSE. The locationSource attribute of the <locationPolicy> resource shall be set to 'Network-Based' and the value for locationTargetID and locationServer attributes shall be set properly set for the Location Request. Step 2: Local Processing for creating <locationPolicy> resource After verifying the privileges and the given attributes, the Hosting CSE creates <container> resource where the actual location information is/are stored. Then the Hosting CSE shall create <locationPolicy> resource. The Hosting CSE shall maintain cross-reference between both resources: locationContainerID attribute for <locationPolicy> resource and locationID attribute for <container> resource. Step 3: Response for creating <locationPolicy> The Registrar CSE shall respond with a Response message. Step 4: Location Request The Registrar CSE issues Location Request to the selected Underlying Network. For doing this, the Registrar CSE shall transform the location configuration information received from the Originator into Location Request that is acceptable for the Underlying Network. For example, the Location Request can be one of existing location acquisition protocols such as OMA Mobile Location Protocol [i.5] or OMA RESTful NetAPI for Terminal Location [i.6]. Additionally, the Registrar CSE shall provide default values for other parameters (e.g. required quality of position) in the Location Request according to local policies. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 109 (oneM2M TS-0001 version 4.15.0 Release 4) NOTE 2: The Location Request can be triggered by the given conditions, e.g.: 1) when the locationUpdatePeriod attribute has expired, or if the locationUpdatePeriod attribute is not given from the step 1; 2) the <locationPolicy> is created or updated; 3) the linked <container> has been retrieved. 4) if the attribute locationUpdatePeriod has multiple value and the Hosting CSE of the resource is the target device, the Hosting CSE of the resource may update the location update period by choosing one of the values within the list according to the local context information of the device (velocity, battery level, current range) and its preprovisioned local policy which is out of scope of the present document. The Hosting CSE then issues Location Request with selected value as the update period. Then, if the value switches to another value, steps 4, 5, 6 and 7 shall be repeated using the new period. Step 5: Performing Location Procedure The Underlying Network specific procedures are performed. This may involve getting location information from the target device or the network node. These procedures are outside the scope of oneM2M specifications. Step 6: Location Response The NSE responds to the Registrar CSE with location information if the Registrar CSE is authorized. If not, the NSE sends an error code back to the Registrar CSE. Step 7: Local Processing after Location Response The received response shall be contained in the <container> resource that is related the <locationPolicy> resource. NOTE 3: See clause 10.2.11.2 for detail information. NOTE 4: For notification regarding the location response towards the Originator, the subscription mechanism is used.
2bd691fcce98b96819b9b3b005c72741	118 101	8.3.5 Configuration of Traffic Patterns
2bd691fcce98b96819b9b3b005c72741	118 101	8.3.5.1 Purpose of Configuration of Traffic Patterns	M2M devices that have predicable communication behaviour e.g. in the form of repeating traffic patterns can profit in terms of reduction of signalling, energy saving, fewer sleep/wake transitions, etc., when their traffic patterns are communicated to the underlying network. For example, 3GPP devices could use new 3GPP power savings features such as eDRX (extended discontinuous reception) and PSM (Power Saving Mode) on LTE devices. Also the underlying network can benefit from being informed about a device's traffic patterns by the oneM2M System. For example, if the IN-CSE knows the device's traffic patterns and transmits them to an underlying 3GPP network, then this information can be used by a 3GPP network to set the device's "Maximum Response Time" (3GPP Term) to tune the UE's DRX and PSM parameters. Thus the network will benefit because the UE will have fewer sleep/wake transitions and unnecessary signalling in the network can be avoided. Also, if the IN-CSE knows when the device is awake then data can be sent to the device exactly at the time when the device is listening, thus requiring the network to buffer less data for unavailable devices. The purpose of the Configuration of Traffic Patterns feature is to provide a means to the oneM2M System to provide the Underlying Network optimization information: • The Common Service Entity (CSE) shall use the Mcn interface towards the Underlying Network to provide information on the traffic patterns of a Field Domain Node (ASN or MN) to the underlying network. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 110 (oneM2M TS-0001 version 4.15.0 Release 4) To that purpose in the oneM2M System: • Field Domain Nodes are addressed using the CSE-ID or AE-ID resource identifiers of the corresponding <AE> or <remoteCSE> resources of the Field Domain Node. • A group of Field Domain Nodes can be addressed in the oneM2M System by the resource identifier of a corresponding <group> resource. In the case of a 3GPP network, Field Domain Nodes are identified by the CSE towards the Underlying Network using the M2M-Ext-ID or External Group Identifier.
2bd691fcce98b96819b9b3b005c72741	118 101	8.3.5.2 Traffic pattern parameters	Traffic Pattern (TP) parameters can be associated with one or multiple Field Domain Nodes and are defined in table 8.3.5.2-1. For each Underlying Network, a Field Domain Node can be associated with one or more TP parameters sets that have non-overlapping schedules. Each parameter set is derived by the CSE from information provided for AEs and CSEs, respectively, using information provided in one item of the activityPatternElements attribute (see table 9.6.4-3). Therefore, a set can be derived when the list in the activityPatternElements attribute has more than one item. The parameter derivation is described and exemplified in table 8.3.5.2-1. Table 8.3.5.2-1: Traffic parameter set TP parameter set Description Derivation from activityPatternElements TP Periodic communication indicator Identifies whether the Node communicates periodically or not, e.g. only on demand. If periodicity can be derived from the scheduleElement of the activityPatternElements, the indicator shall be set to TRUE. Otherwise, shall be set to FALSE. TP Communication duration time Duration interval time of periodic communication (may be used together with TP Periodic communication indicator). EXAMPLE: 5 minutes. To be derived from the scheduleElement of the activityPatternElements as follows: - If a finite communication duration time can be derived, the derived value shall be used. - If only a start time is provided, a maximum value according to set defaults shall be used. - If no start time is provided, the value 0 shall be set. TP Time period Interval Time of periodic communication [may be used together with TP Periodic communication indicator]. EXAMPLE: Every hour. If periodicity can be derived from the scheduleElement of the activityPatternElements, the derived periodicity value shall be set. TP Scheduled communication time Time and Day of the week when the Node is available for communication. EXAMPLE: Time: 13:00, Day: Monday. The start time derived from the current time and the scheduleElement of the activityPatternElements shall be set. TP Stationary indication Identifies whether the Node is stationary or mobile. The stationaryIndication provided in the activityPatternElements shall be used. If no stationaryIndication is provided this optional parameter is not set. TP Data size indication Indicates the expected data size for the pattern. The value of the dataSizeIndicator provided in the activityPatternElements shall be used. If no dataSizeIndicator is provided this optional parameter is not set. TP Validity time The time after which a TP parameter becomes invalid once it had been set. If an end time can be derived from the scheduleElement of the activityPatternElements, the end time value shall be used. If no end time can be derived a maximum value according to set defaults shall be used. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 111 (oneM2M TS-0001 version 4.15.0 Release 4) EXAMPLE: Consider an evaluation of an activityPatternElements attribute as follows: - scheduleElement (with the fields: second, minute, hour, day of month, month, day of week and year) ; 0-30; 2; ; Jan-Sept; Tues; 2017 - stationaryIndication: "Moving" - dataSizeIndicator: 30 kb. The following TP set shall be derived: • TP Periodic communication indicator: TRUE • TP Communication duration time: 30 min • TP Time period: 1 week • TP Scheduled communication time: Tues, 2:00 • TP Stationary indication: "Moving" • TP Data size indication: 30 kb • TP Validity time: 2 months (default maximum) Note that the IN-CSE may use a single set of TP parameters for an entire group of Field Nodes if the corresponding activityPatternElements attributes are identical or if the IN-CSE can derive a common pattern for the group, corresponding to a common activityPatternElements attribute. How the parameters corresponding to a common activityPatternElements attribute are derived by the IN-CSE is implementation dependent, e.g. by computing the time superset. The parameters of this common activityPatternElements attribute are then used as described above to derive a single TP set for the group. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 112 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	8.3.5.3 General procedure for Configuration of Traffic Patterns	Figure 8.3.5.3-1 depicts a general procedure for configuration of Traffic Patterns. Infrastructure Domain 4. Request to provide / remove Traffic Pattern parameter sets 5. Response 3. Derive Traffic Pattern parameters from the anticipatedActivityPatterns attribute. Select the NSE for handling the Traffic Pattern parameter sets Mcc/Mca Mcn Field node NSE IN-CSE Any Domain 0. Field node registration, creates <remoteCSE> or <AE> 1. Create/Update/Delete anticipatedActivityPatterns attribute of the corresponding <remoteCSE> or <AE> 2. (Opt) Notification of anticipatedTrafficPatterns attribute change Figure 8.3.5.3-1: General procedure for configuration of Traffic Patterns Step 0: Field Node registration with IN-CSE The field node (ADN-AE or ASN/MN-CSE) registers with the IN-CSE. The respective <AE> and <remoteCSE> resources are created and linked to the corresponding <node> resource. If the IN-CSE uses a single set of TP parameters for an entire group of Field Nodes, it is assumed that they are managed together using a <group> resource and that they are identified in the Underlying Network by a common External Group Identifier. The IN-CSE shall verify that the <group> resource membership consists solely of <AE> or <remoteCSE> resources. Step 1: Anticipated Communication behaviour of the ADN-AE or ASN/MN-CSE is changed The anticipated communication behaviour of the ADN-AE or ASN/MN-CSE is changed by updating the activityPatternElements attribute of either the <AE> or <remoteCSE> resource, respectively. In the group case the anticipated communication behaviour of the group members is changed by updating the activityPatternElements attribute using a request targeting the <fanoutPoint> virtual resource. Step 2: (Optional) IN-CSE notifies the Field Node that the communication behaviour has changed Optionally, the IN-CSE notifies the ADN-AE or ASN/MN-CSE that the anticipated communication schedule has been changed. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 113 (oneM2M TS-0001 version 4.15.0 Release 4) Step 3: The IN-CSE derives the TP parameters and the NSE for handling the TP parameter sets If the IN-CSE selects the NSE by using the network identifier of the Field Domain Node (i.e. the M2M-Ext-ID or External Group Identifier) by which the Field Node can be identified in the NSE (see clause 7.1.8). The IN-CSE derives the TP parameters as follows: • For a Field Node hosting one or more AEs represented with a single <node> resource, using the values provided in all the activityPatternElements attribute for the <AE>s on this node. • For a Field Node hosting an ASN or MN, using the values provided by the activityPatternElements attribute of the <remoteCSE> resource. • For a group of Field Nodes, using the values provided by the activityPatternElements attribute of each <group> member. Step 4: Request for the handling of the TP parameter sets IN-CSE sends a request for handling (i.e. provide or remove) TP parameter sets for the Field Domain Node to the NSE, using the appropriate Mcn protocol. The Mcn can correspond to one of the standard interfaces specified by an external organization, for example, OMA RESTful Network API for Communication Patterns V1.0 [i.31]. The request shall include the corresponding M2M-EXT-ID of a field Node or the External Group Identifier of a group of Field Nodes, and one or more TP parameter set(s) as defined at clause 8.3.5.2. NOTE 1: If the Underlying Network is 3GPP-compliant, see ETSI TS 118 126 [15] for more details. Step 5: Response for the handling of the TP parameter sets The IN-CSE receives the response for the configuration of the TP parameter sets from the NSE. NOTE 2: If the interaction with NSE in step 3 is unsuccessful, the IN-CSE has the choice to re-try it until successful. Step 6: The Field Node TP changes are applied After the notification in step 2, the Field Node (ASN/MN-CSE or ADN-AE) shall utilize the latest values provided by the activityPatternElements attribute.
2bd691fcce98b96819b9b3b005c72741	118 101	8.4 Connection Request	Connection request service is not defined in the present document.
2bd691fcce98b96819b9b3b005c72741	118 101	8.5 Device Management	See clause 6.2.4 for a detailed description on the interaction with a Device Management Server.
2bd691fcce98b96819b9b3b005c72741	118 101	9 Resource Management
2bd691fcce98b96819b9b3b005c72741	118 101	9.0 Overview	All entities in the oneM2M System, such as AEs, CSEs, data, etc. are represented as resources. A resource structure is specified as a representation of such resources. Such resources are uniquely addressable. Procedures for accessing such resources are also specified. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 114 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	9.1 General Principles	The following are the general principles for the design of the resource model: • The "type" of each resource shall be specified. New resource types shall be supported as the need for them is identified. • The root of the resource structure in a CSE shall be assigned an absolute address. See clause 9.3.1 for additional information. • The attributes for all resource type shall be specified. • Each resource type may be instantiated as multiple resources via Create procedure (clause 10.1.2). • All resources and associated attributes shall be addressable as specified in clause 9.3.1. • Both hierarchical and non-hierarchical URIs shall be supported by all CSEs.
2bd691fcce98b96819b9b3b005c72741	118 101	9.2 Resources
2bd691fcce98b96819b9b3b005c72741	118 101	9.2.0 Overview	This clause introduces the resources used in a CSE. A resource scheme is used for modelling the resource structure and associated relationships. Clause 9.5 provides guidelines on how to describe a resource. The present document identifies three categories of resources: • Normal resources (clause 9.2.1). • Virtual resources (clause 9.2.2). • Announced resources (clause 9.2.3).
2bd691fcce98b96819b9b3b005c72741	118 101	9.2.1 Normal Resources	Normal resources include the complete set of representations of data which constitutes the base of the information to be managed. Unless qualified as either "virtual" or "announced", the resource types in the present document are normal resources.
2bd691fcce98b96819b9b3b005c72741	118 101	9.2.2 Virtual Resources	A virtual resource is used to trigger processing and/or retrieve results, but they do not have a permanent representation in a CSE.
2bd691fcce98b96819b9b3b005c72741	118 101	9.2.3 Announced Resources	An announced resource contains a set of attributes of the original resource. An announced resource is updated automatically by the Hosting CSE of the original resource whenever the original resource changes. The announced resource contains a link to the original resource. Resource announcement can facilitate resource discovery. The announced resource at a remote CSE can also be used for creating child resources at the remote CSE that are not present as children of the original resource or are not announced children of the original resource. The following are the resource specification guidelines for resource announcement: • In order to support announcement of resources, an additional column in the resource template (clause 9.5.1), shall specify the attributes to be announced for inclusion in the associated announced resource type. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 115 (oneM2M TS-0001 version 4.15.0 Release 4) • For each announced <resourceType>, the addition of suffix "Annc" to the original <resourceType> shall be used to indicate its associated announced resource type. For example, resource <containerAnnc> shall indicate the announced resource type for <container> resource; <groupAnnc> shall indicate announced resource type for <group> resource, etc. • Resource announcement can also facilitate resource offloading to be used for Edge/Fog computing described in oneM2M TR-0052 [i.38]. In this case, when an announced resource (e.g. deployed at an Edge/Fog node) is updated by an entity other than the original resource Hosting CSE (i.e. other AE(s)/CSE(s) having privileges to update the announced resource), the announced resource Hosting CSE issues an update request to the original resource Hosting CSE to update the original resource. If applicable, the original resource Hosting CSE then reflects this update to any other announced resources. Figure 9.2.3-1 shows examples of different types of synchronization performed between original and announced resources. For example, if there is an announced resource(s), any updates to the original resource shall be reflected to all the announced resources (left). If an announced resource is updated by an entity other than the original resource Hosting CSE, any updates to the announced resource shall be reflected to the original resource and in turn to any other announced resources if applicable (right). Announced Resources A1 Hosting CSE O A2 A3 A O A Announced resource with bi-directional sync Announced resource with uni-directional sync Original resource (a) Update to the original resource (b) Update to an announced resource with bi-directional sync type 1. Update to original resource 2. Update to announced resource 1. Update to announced resource (A3) 2. Update to original resource 3. Update to all other announced resources (A1, A2) Announced Resources A1 Hosting CSE O A2 A3 Figure 9.2.3-1: Synchronizations based on update to original resource and announced resource
2bd691fcce98b96819b9b3b005c72741	118 101	9.3 Resource Addressing
2bd691fcce98b96819b9b3b005c72741	118 101	9.3.1 Generic Principles	An identifier of a resource is a string of characters used to uniquely identify the targeted resource within the scope of a request to access the resources. The scope of a request can be: • CSE-relative: The request is targeting a resource that resides on the same CSE as the Receiver CSE of the request. In that case a CSE-relative format of a resource identifier can be used to address the resource. • SP-relative: The request is targeting a resource that resides on a CSE within the same M2M SP domain as the Originator of the request. In that case an SP-relative format of a resource identifier can be used to address the resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 116 (oneM2M TS-0001 version 4.15.0 Release 4) • Absolute: The request is targeting a resource that resides on a CSE that is within an M2M SP domain that is different from the M2M SP domain of the Originator of the request. In that case the absolute format of a resource identifier shall be used to address the resource. Note that the absolute format of the resource identifier will always be acceptable also in other cases. A single resource may have more than one resource identifier formats depending on the method and scope that are summarized in table 9.3.1-1. There are two different methods for identifying a resource within the oneM2M resource structure with three different variants each depending on the scope of the request to access the resource. The ways how the resource identifiers are constructed in each case shall follow. Table 9.3.1-1: Resource addressing methods Method Request Scope CSE-Relative SP-Relative Absolute Unstructured Use the 'Unstructured-CSE- relative-Resource-ID' format of the resource identifier as defined in table 7.2-1. Use the 'SP-relative- Resource-ID' format of the resource identifier constructed with the 'Unstructured-CSE-relative- Resource-ID' as defined in table 7.2-1. Use the 'Absolute-Resource-ID' format of the resource identifier constructed with the 'Unstructured-CSE-relative- Resource-ID' as defined in table 7.2-1. Structured Use the 'Structured-CSE- relative-Resource-ID' format of the resource identifier as defined in table 7.2-1. Use the 'SP-relative Resource-ID' format of the resource identifier constructed with the 'Structured-CSE-relative- Resource-ID' as defined in table 7.2-1. Use the 'Absolute-Resource-ID' format of the resource identifier constructed with the 'Structured- CSE-relative-Resource-ID' as defined in table 7.2-1. These two methods with three request scope variants shall all be supported by a CSE receiving requests.
2bd691fcce98b96819b9b3b005c72741	118 101	9.3.2 Addressing an Application Entity
2bd691fcce98b96819b9b3b005c72741	118 101	9.3.2.1 Application Entity Addressing	In M2M communication, the goal of M2M addressing is to reach the CSE with which the target AE is registered, and ultimately the target AE on the M2M Node on which the target AE is resident. This principle applies to all Application Entities. Reachability and routing from/to AEs on M2M Nodes is associated with the CSEs with which these AEs are registered, and the connectivity of such CSEs to the Underlying Networks. Reaching an AE shall be performed through reaching the CSE the AE is registered with. A CSE-PoA (CSE Point of Access) shall provide the set of information needed to reach a CSE from an Underlying Network perspective. Typically a CSE-PoA contains information that is resolved into a network address.
2bd691fcce98b96819b9b3b005c72741	118 101	9.3.2.2 Application Entity Reachability
2bd691fcce98b96819b9b3b005c72741	118 101	9.3.2.2.1 CSE Point of Access (CSE-PoA)	The CSE-PoA shall be used by the M2M System to communicate with a CSE on an M2M Node. Once communication with a CSE is achieved, an AE registered with that CSE can be reached as long as the AE can be uniquely identified. The information included in the CSE-PoA as well as the refresh of the CSE-PoA, depends on the characteristics of the Underlying Network and an M2M Node's transport capabilities. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 117 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	9.3.2.2.2 Locating Application Entities	Locating an AE is a two-step process as follows: • Step 1: There is a need to locate the CSE where the AE is registered. Locating the CSE shall be accomplished as follows: - For AEs associated with ASNs/MNs/INs, the CSE-PoA of the ASN-CSE/MN-CSE/IN-CSE where the AE is registered shall be used. - For AEs associated with ADNs, the CSE-PoA of the MN-CSE/IN-CSE where the ADN is registered shall be used. • Step 2: The CSE shall locate the appropriate AE using its Application Entity Identifier (AE-ID).
2bd691fcce98b96819b9b3b005c72741	118 101	9.3.2.2.3 Usage of CSE-PoA by the M2M System	9.3.2.2.3.0 Overview The CSE-PoA holds the information used by the M2M System to locate routing information for a CSE. This information shall be provided by the CSE at registration time. However, the routing information related to a CSE (and ultimately to the target AE) in an M2M System depends on the characteristics of the Underlying Network. This impacts the criteria for updating the CSE-PoA by the registered CSE, in addition to the regular CSE registration updates. The information to be conveyed as CSE-PoA needs to support Underlying Network specifics. CSE-PoA is considered equivalent to the routable addresses of the targeted CSE. In general the addressing and routing information related to a CSE can be achieved when a static public IP address is assigned to and M2M Node and direct DNS address translation or dynamic DNS address translation is used. In those circumstances, the CSE-PoA for a registered CSE shall have a URI conforming to IETF RFC 3986 [18] as follows: • URI = scheme:/fullyqualifieddomainname/path/; or • URI = scheme://ip-address/path/. The following clauses specify the information to be conveyed in the CSE-PoA by a registered CSE for various types of Underlying Networks, as well as the criteria for updating the CSE-PoA for the registered CSEs, in addition to the normal CSE registration refresh. 9.3.2.2.3.1 CSE-PoA related to CSEs associated with a Fixed Network In this case the CSE-PoA for a registered CSE shall have a URI as described above. If the IP address is private, then the address is usually built based on the address of the related PPP protocol which is a public IP address. This in turn is mapped to the corresponding private address. 9.3.2.2.3.2 CSE-PoA related to CSEs associated with Mobile Networks If the IP address for the registered CSE cannot be reliably used, and cannot be included in the CSE-PoA, then the CSE-PoA for the registered CSE shall include appropriate information as required by the respective Underlying Networks and supported by oneM2M. Each Underlying Network shall need to specify the means for allowing an M2M SP to fetch the IP address associated with a CSE attaching to that Underlying Network and consequently the information to be included in the CSE-PoA for the registered CSE. In the event that the M2M SP has connections to multiple Underlying Networks, there is a need to establish a binding between the registered CSE and the associated Underlying Network. That binding may be established through CSEs explicitly identifying the Underlying Network at registration/update time. Otherwise the M2M SP may derive the identity of the Underlying Network, e.g. by using the link, over which the registration arrived, store it and bind it to the registration information. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 118 (oneM2M TS-0001 version 4.15.0 Release 4) In the scenarios an M2M Node in mobile networks is not reachable by the previously known IP address and it supports SMS, the originating CSE can make use of SMS for device triggering mechanism to wake up the M2M Node to renew the IP addresses or perform specific functionalities. To support this option, the CSE-PoA shall, on Mcn interface to the Underlying Networks supporting such an SMS for device triggering mechanism, include identification information of the CSE (such as the external identifier as defined by ETSI TS 123 682 [i.14] in the case of Tsp-based triggering, or MSISDN or any identifier used by triggering network APIs), and send the request to the Underlying Network via the mechanisms supported, such as Tsp, Tsms, Network APIs. The 3GPP defined interfaces for machine type communication interfaces and example device triggering flows are shown in ETSI TS 118 126 [15]. 9.3.2.2.3.3 CSE-PoA to CSEs associated with multiple Underlying Networks When an M2M Node attaches to a fixed network, the CSE-PoA for a registered CSE shall conform to the procedures associated with the fixed network. When an M2M Node attaches to a mobile network, the CSE-PoA for a registered CSE shall conform to the procedures associated that mobile network. If an M2M Node is already attached to an Underlying Network and attaches to another Underlying Network, the CSE may update its PoA information at the remote CSE.
2bd691fcce98b96819b9b3b005c72741	118 101	9.4 Resource Structure
2bd691fcce98b96819b9b3b005c72741	118 101	9.4.1 Relationships between Resources	NOTE: The resources shown are: - CSEBase1 is the name of a resource of type <CSEBase>. - CSE1 is the name of a resource of type <remoteCSE>. - APP1 is the name of a resource of type <AE>. - CONT1 and CONT2 are the names of resources of type <container>. - ACP1 and ACP2 are the names of resources of type <accessControlPolicy>. Figure 9.4.1-1: Resource Relationships Example in a CSE The solid line in figure 9.4.1-1 represents parent-child relation, which is supported by a link (e.g. parentID) in the non- hierarchical addressing method, and by the hierarchical addressing method. Dashed line in figure 9.4.1-1 represents a link i.e. a relationship between the resources (e.g. relationship between the APP1 resource and the ACP1). ETSI ETSI TS 118 101 V4.15.0 (2022-09) 119 (oneM2M TS-0001 version 4.15.0 Release 4) Figure 9.4.1-1 provides an example of a resource structure. The represented resources can be addressed by using one of the methods described in clause 9.3.1. Resources in the oneM2M System are linked with each other and they respect the containment relationship. The methods for linking resources are described in clause 9.4.2. A link shall contain the following information: • Linked Resource: The target linked resource is given by using the ID of that resource. • Link Relation: Describes the relationship that the current resource has with the linked resource (only in one direction, i.e. from this resource to the linked resource).
2bd691fcce98b96819b9b3b005c72741	118 101	9.4.2 Link Relations	The following link relations are defined. Table 9.4.2-1: Link Relations Linked Resource Type (link destination) Linking Resource Types (link origin) Linking Method Description accessControPolicy Several (e.g. node, AE, remoteCSE, container) Attribute named accessControlPolicyIDs See clause 9.6.2 node CSEBase, remoteCSE, AE Attribute named nodeLink See clause 9.6.3 See clause 9.6.4 See clause 9.6.5 CSEBase or remoteCSE node Attribute named hostedCSELink OR parent resource of type CSEBase See clause 9.6.18 AE node Attribute named hostedAELinks See clause 9.6.18 flexContainer node Attribute named hostedServiceLinks See clause 9.6.18 a parent resource of any resourceType a child resource of any resourceType Attribute named parentID See clause 9.6.1.3 a child resource of any resourceType a parent resource of any resourceType Child resource itself See clause 9.6 mgmtObj mgmtObj Attribute named: mgmtLink See clause 9.6.15 contentInstance contentInstance Attribute named contentRef See clauses 9.6.7 and 9.6.35 dynamicAuthorizationConsultation Several (e.g. node, AE, remoteCSE, container) Attribute named: dynamicAuthorizationConsult ationIDs See clause 9.6.40
2bd691fcce98b96819b9b3b005c72741	118 101	9.5 Resource Type Specification Conventions
2bd691fcce98b96819b9b3b005c72741	118 101	9.5.0 Overview	The following conventions are used for the specification of resources. Resources are specified via a tabular notation and the associated graphical representation as follows: • The resources are specified in association with a CSE. The resources are the representation in the CSE of the components and elements within the oneM2M System. Other CSEs, AEs, application data representing sensors, commands, etc. are known to the CSE by means of their resource representation. Resource, Child Resource and Attributes are defined in clause 3.1 and are restated below for readability: - Resource: A Resource is a uniquely addressable entity in oneM2M architecture. A resource is transferred and manipulated using CRUD operations (see clause 10.1). A resource can contain child resource(s) and attribute(s). ETSI ETSI TS 118 101 V4.15.0 (2022-09) 120 (oneM2M TS-0001 version 4.15.0 Release 4) - Child Resource: A sub-resource of another resource that is its parent resource. The parent resource contains references to the child resources(s). - Attribute: Stores information pertaining to the resource itself. • The set of attributes, which are common to all resources, are not detailed in the graphical representation of a resource. • Resource names and attribute names are strings in lower case. In case of a composed name, the subsequent word(s) start with a capital letter; e.g. accessControlPolicy, creationTime, expirationTime. • Resource type names and attribute names are written in italic form in the present document. • A string containing resource type name in italic delimited with '<' and '>' e.g. <resourceType> is used as an abbreviation referring to the type of a resource. For example, the text "a <container> resource" could be used as an abbreviation for "a resource of type container". • A string containing a resource type name delimited with '[' and ']' e.g. [resourceType] is an abbreviation referring to a specialization of a resource type. • Specialization of a resource type is done by defining specific names and descriptions of the attributes that can be specialized from the base resource type. For example, the text "a [battery] resource" could be used as an abbreviation for "a resource of type battery", where battery is a specialization of base resource type mgmtObj. • A string containing an attribute type name in italic delimited with '[' and ']', e.g. [objectAttribute] is used as an abbreviation referring to a type of an attribute that can be specialized. Attributes that can be specialized only occur in resource types that can be specialized. The resources are specified as shown in figure 9.5.0-1. Figure 9.5.0-1: <resourceType> representation convention The resource specification provides the graphical representation for the resource as in figure 9.5.0-1. The graphical representation of a resource shows the multiplicity of the attributes and child resources. The set of attributes, which are common to all resources are not detailed in the graphical representation of a resource. The following graphical representations are used for representing the attributes and child resources: • Square boxes are used for the resources. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 121 (oneM2M TS-0001 version 4.15.0 Release 4) • Square boxes with round corners are used for attributes. Child resources in a <resourceType> are detailed as shown in table 9.5.0-1. The child resource table for an announce-able <resourceType> resource includes an additional column titled '<resourceTypeAnnc> Child Resource Types', indicating the type of announced resources. See clause 9.6.26 for further details. An announced resource may have child resources, and such child resources can be of type "normal" or "announced". Child resources are of type "announced" when the child resources are announced independently of the original resource, as needed by the resource announcing CSE. Child resources are of type "normal" when child resources at the announced resource are created locally by the remote CSE. Table 9.5.0-1: Child Resources of <resourceType> Child Resources of <resourceType> Child Resource Type Multiplicity Description <resourceTypeAnnc> Child Resource Types <Fill in the name of Child Resource1 if a fixed name is required or [variable] if no fixed name is required> <Fill in the type of Child Resource1> <Fill in Multiplicity> See clause <XRef> <clause> where the type of this child resource is described. <Fill the child resource type for the announced resource. It can be none or <crTypeAnnc> or <crType>; where the <crType> is the child resource type of the original Child Resource1. <Fill in the name of Child ResourceN if a fixed name is required or [variable] if no fixed name is required> <Fill in the type of Child ResourceN> <Fill in Multiplicity> See clause <XRef> <clause> where the type of this child resource is described. <Fill the child resource type for the announced resource. It can be none or <crTypeAnnc> or <crType>; where the <crType> is the child resource type of the original Child ResourceN. Attributes in a <resourceType> are detailed as shown in table 9.5.0-2. The attributes table for announce-able <resourceType> resource includes an additional column titled 'Attributes for <resourceTypeAnnc>', indicating the attributes that are to be announced for that <resourceType>. See the clause 9.6.26 for further details. Table 9.5.0-2: Attributes of <resourceType> resource Attributes of <resourceType> Multiplicity RW/ RO/ WO Description <resourceTypeAnnc> (MA/OA/NA) <Fill in name of Common Attribute1> <Fill in Multiplicity> <Fill in RW or RO or WO> Provide description of this attribute - to be moved later to a common attribute clause. <Fill in MA or OA or NA> <Fill in name of Common AttributeN> <Fill in Multiplicity> <Fill in RW or RO or WO> Provide description of this attribute - to be moved later to a common attribute clause. <Fill in MA or OA or NA> <Fill in name of Resource Specific Attribute1> <Fill in Multiplicity> <Fill in RW or RO or WO> Provide description of this attribute - to be moved later to a central attribute table that also defines the type of the attribute, allowed ranges, etc. <Fill in MA or OA or NA> <Fill in name of Resource-Specific AttributeN> <Fill in Multiplicity> <Fill in RW or RO or WO> Provide description of this attribute - to be moved later to a central attribute table that also defines the type of the attribute, allowed ranges, etc. <Fill in MA or OA or NA> In case of misalignment of the graphical representation of a resource and the associated tabular representation, tabular representation shall take precedence. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 122 (oneM2M TS-0001 version 4.15.0 Release 4) The access modes for attributes can assume the following values: • Read/Write (RW): the value of the attribute is set when the resource is Created or Updated based on information from the Originator (i.e. Content parameter). Such attributes are allowed for Create/Update/Retrieve operations. Note that such an attribute can be deleted by Update operation. • Read Only (RO): the value of the attribute is set or can be updated by the Hosting CSE internally. Such an attribute is allowed for Retrieve operation only. • Write Once (WO): the value of the attribute is set when the resource is Created based on information from the Originator (i.e. Content parameter). Such an attribute is allowed for Retrieve operation after the creation. Such attribute can thereafter only be updated by hosting CSE internally. The multiplicity, both for the child resources and the attributes can have the following values: • A value of "0" indicates that the child resource/attribute shall not be present. • A value of "1" indicates that the child resource/attribute shall be present. • A value of "0..1" indicates that the child resource/attribute may be present. • A value of "0..n" indicates that the child resource/attribute may be present. If present, multiple instances are supported. • A value of "1..n" indicates that the child resource shall always be present. It has at least one instance and can have multiple instances. • An attribute multiplicity post-fixed with (L) indicates that it is a list of values. The multiplicity for the virtual child resources can have the following values: • A value of "1" indicates that the functionality related to the virtual child resource shall be supported. • A value of "0..1" indicates that the functionality related to the virtual child resource may be supported. The attributes for <resourceTypeAnnc> in the attribute table can have the following set of values: • MA (Mandatory Announced): The attribute in the original resource is announced to the announced resource. The content of such an announced attribute is the same as the content of the original attribute. • OA (Optional Announced): The attribute in the original resource may be announced to the announced resource depending on the contents of the announcedAttribute attribute at the original resource. The content of such an announced attribute is the same as the content of the original attribute. • NA (Not Announced): The original attribute is not announced to the announced resource. 9.5.1 Handling of Unsupported Resources/Attributes/Sub-resources within the M2M System A CSE shall respond to a received request targeted to it and that includes resource(s), resource attribute(s) or sub-resource(s) that are not supported by it, by sending an appropriate error code back to the request Originator. When a CSE is not the target entity of a received request, the CSE shall attempt to forward the received request to the targeted entity. If the CSE cannot forward the received request for any reason, it shall respond to the received request by sending an appropriate error code back to the request Originator. The present document includes both mandatory and optional functionalities for interfaces between oneM2M entities. Thus, the functionality implemented for the interfaces may not include all the functionalities specified in the present document. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 123 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	9.6 Resource Types
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.1 Overview
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.1.1 Resource Type Summary	Table 9.6.1.1-1 introduces the normal and virtual resource types and their related child or parent resource types. Details of each resource type follow in the remainder of this clause. Table 9.6.1.1-1 lists each specified ordinary - i.e. not announced - resource type. An addition of suffix "Annc" to the respective resource type identifier indicates the associated announced resource type. Resource types that can occur as child resources of announced resources are summarized in table 9.6.26.1-1. Among the resource types listed in table 9.6.1.1-1, the following are termed "Content Sharing Resources" in oneM2M Specifications for the purpose of referring to any of those resource types: • container; • contentInstance; • flexContainer; • flexContainerInstance; • timeSeries; • timeSeriesInstance. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 124 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.1.1-1: Resource Types Resource Type Short Description Child Resource Types Parent Resource Types Clause accessControlPolicy Stores a representation of privileges. It is associated with resources that shall be accessible to entities external to the Hosting CSE. It controls "who" is allowed to do "what" and the context in which it can be used for accessing resources subscription, transaction AE, AEAnnc, remoteCSE, remoteCSEAnnc, CSEBase, CSEBaseAnnc 9.6.2 AE Stores information about the AE. It is created as a result of successful registration of an AE with the Registrar CSE subscription, container, flexContainer, group, accessControlPolicy, pollingChannel, semanticDescriptor, timeSeries, transaction, transactionMgmt, triggerRequest, crossResourceSubscription, backgroundDataTransfer, semanticMashupInstance, locationPolicy, action, multimediaSession, dynamicAuthorizationConsultation, nwMonitoringReq, timeSyncBeacon, primitiveProfile, softwareCampaign, e2eQosSession CSEBase 9.6.5 container Shares data instances among entities. Used as a mediator that buffers data exchanged between AEs and/or CSEs. The exchange of data between AEs (e.g. an AE on a Node in a field domain and the peer-AE on the infrastructure domain) is abstracted from the need to set up direct connections and allows for scenarios where both entities in the exchange do not have the same reachability schedule container, flexContainer, contentInstance, subscription, latest, oldest，semanticDescriptor, timeSeries, transaction, action AE, AEAnnc, container, containerAnnc, remoteCSE, remoteCSEAnnc, CSEBase, CSEBaseAnnc, flexContainer, flexContainerAnnc 9.6.6 contentInstance Represents a data instance in the <container> resource semanticDescriptor, transaction container, containerAnnc 9.6.7 flexContainer A template which allows to define specialized (customizable) versions of containers with a flexible and lightweight structure container, flexContainer, flexContainerInstance, latest, oldest, subscription, semanticDescriptor, timeSeries, transaction, action AE, AEAnnc, container, containerAnnc, flexContainer, flexContainerAnnc, remoteCSE, remoteCSEAnnc, CSEBase, CSEBaseAnnc 9.6.35 flexContainerInstance Represents a timestamped Data instance in the <flexContainer> resource transaction flexContainer 9.6.59 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 125 (oneM2M TS-0001 version 4.15.0 Release 4) Resource Type Short Description Child Resource Types Parent Resource Types Clause CSEBase The structural root for all the resources that are residing on a CSE. Stores information about the CSE itself remoteCSE, remoteCSEAnnc, CSEBaseAnnc, node, AE, container, group, accessControlPolicy, subscription, mgmtCmd, locationPolicy, statsConfig, statsCollect, request, delivery, schedule, notificationTargetPolicy, semanticRuleRepository, flexContainer, timeSeries, AEContactList, transaction, transactionMgmt, crossResourceSubscription, backgroundDataTransfer, semanticMashupJobProfile, semanticMashupInstance, action, m2mServiceSubscriptionProfile, dynamicAuthorizationConsultation, localMulticastGroup, serviceSubscribedAppRule, authorizationPolicy, authorizationDecision, authorizationInformation, ontologyRepository, nwMonitoringReq, timeSyncBeacon, primitiveProfile, softwareCampaign, e2eQosSession None specified 9.6.3 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 126 (oneM2M TS-0001 version 4.15.0 Release 4) Resource Type Short Description Child Resource Types Parent Resource Types Clause delivery Forwards requests from CSE to CSE subscription, transaction CSEBase 9.6.11 eventConfig Defines events that trigger statistics collection subscription, transaction statsConfig 9.6.24 execInstance Contains all execution instances of the same Management Command subscription, transaction mgmtCmd 9.6.17 fanOutPoint (V) Virtual resource containing target for group request It is used for addressing bulk operations to all the resources that belong to a group None specified group 9.6.14 group Stores information about resources of the same type that need to be addressed as a Group. Operations addressed to a Group resource shall be executed in a bulk mode for all members belonging to the Group fanOutPoint, subscription, semanticFanOutPoint, semanticDescriptor, transaction, action AE, AEAnnc, remoteCSE, remoteCSEAnnc, CSEBase, CSEBaseAnnc 9.6.13 latest (V) Virtual resource that points to most recently created <contentInstance>, <timeSeriesInstance> or <flexContainerInstance> child resource within a <container>, <timeSeries> or <flexContainer> resource None specified container, timeSeries, or flexContainer 9.6.27 locationPolicy Includes information to obtain and manage geographical location. It is only referenced within a container, the contentInstances of the container provide location information subscription, transaction CSEBase, AE 9.6.10 mgmtCmd Management Command resource represents a method to execute management procedures required by existing management protocols execInstance, subscription, transaction CSEBase 9.6.16 mgmtObj Management Object resource represents management functions that provides an abstraction to be mapped to external management technology. It represents the node and the software installed in the node (see note) subscription, transaction, semanticDescriptor node, mgmtObjAnnc 9.6.15 Annex D m2mServiceSubscription Profile Data pertaining to the M2M Service Subscription serviceSubscribedNode, subscription, transaction, serviceSubscribedUserProfile CSEBase 9.6.19 node Represents specific Node information mgmtObj, subscription, semanticDescriptor, schedule, transaction, action CSEBase 9.6.18 notificationTargetMgmtP olicyRef Represents a list of notification targets and the deletion policy subscription, transaction subscription 9.6.31 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 127 (oneM2M TS-0001 version 4.15.0 Release 4) Resource Type Short Description Child Resource Types Parent Resource Types Clause notificationTargetPolicy Represents a notification target deletion policy with pre-defined action and deletion rules subscription, policyDeletionRules, transaction CSEBase 9.6.32 notificationTargetSelfRef erence (V) Virtual resource used to remove the Notification Target None specified subscription 9.6.34 oldest (V) Virtual resource that points to first created <contentInstance>, <timeSeriesInstance> or <flexContainerInstance> child resource within a <container>, <timeSeries> or <flexContainer> resource None specified container, timeSeries, or flexContainer 9.6.28 pollingChannel Represent a channel that can be used for a request-unreachable entity pollingChannelURI remoteCSE, AE 9.6.21 pollingChannelURI (V) Virtual resource used to perform service layer long polling of a resource Hosting CSE by a request-unreachable entity None specified pollingChannel 9.6.22 policyDeletionRules Represents a set of rules which is associated with notification target removal policy subscription, transaction notificationTargetPolicy 9.6.33 remoteCSE Represents a remote CSE for which there has been a registration procedure with the registrar CSE identified by the CSEBase resource container, containerAnnc, contentInstanceAnnc flexContainer, flexContainerAnnc, group, groupAnnc, accessControlPolicy, accessControlPolicyAnnc, subscription, scheduleAnnc, pollingChannel, timeSeries, timeSeriesAnnc, timeSeriesInstanceAnnc, remoteCSEAnnc, mgmtObjAnnc, nodeAnnc, AEAnnc, locationPolicyAnnc, transaction, crossResourceSubscription, backgroundDataTransfer, semanticDescriptorAnnc, semanticMashupJobProfile, semanticMashupJobProfileAnnc, semanticMashupInstance, semanticMashupInstanceAnnc, action, dynamicAuthorizationConsultation, dynamicAuthorizationConsultationAnnc, nwMonitoringReq, timeSyncBeacon, primitiveProfile, softwareCampaign, e2eQosSession CSEBase 9.6.4 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 128 (oneM2M TS-0001 version 4.15.0 Release 4) Resource Type Short Description Child Resource Types Parent Resource Types Clause request Expresses/access context of an issued Request subscription, transaction CSEBase 9.6.12 schedule Contains scheduling information for delivery of messages subscription, transaction subscription, CSEBase, node, softwareCampaign 9.6.9 serviceSubscribedNode Node information subscription, transaction m2mServiceSubscriptionP rofile 9.6.20 statsCollect Defines triggers for the IN-CSE to collect statistics for applications subscription, transaction CSEBase (in IN-CSE) 9.6.25 statsConfig Stores configuration of statistics for applications eventConfig, subscription, transaction CSEBase (in IN-CSE) 9.6.23 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 129 (oneM2M TS-0001 version 4.15.0 Release 4) Resource Type Short Description Child Resource Types Parent Resource Types Clause subscription Subscription resource represents the subscription information related to a resource. Such a resource shall be a child resource for the subscribed-to resource schedule, notificationTargetSelfReference, notificationTargetMgmtPolicyRef, transaction accessControlPolicy, accessControlPolicyAnnc, AE, AEAnnc, container, containerAnnc, CSEBase, delivery, eventConfig, execInstance, group, groupAnnc, locationPolicy, locationPolicyAnnc, mgmtCmd, mgmtObj, mgmtObjAnnc, m2mServiceSubscriptionP rofile, node, nodeAnnc, serviceSubscribedNode, remoteCSE, remoteCSEAnnc, CSEBaseAnnc, request, schedule, scheduleAnnc, semanticDescriptor, semanticDescriptorAnnc, statsCollect, statsConfig, flexContainer, flexContainerAnnc, timeSeries, timeSeriesAnnc, nwMonitoringReq, semanticRuleRepository, reasoningRules, reasoningJobInstance, timeSyncBeacon, primitiveProfile, state, processManagement 9.6.8 serviceSubscribedAppRu le Represents a rule that defines allowed App-ID and AE-ID combinations that are acceptable for registering an AE on a Registrar CSE subscription, transaction CSEBase 9.6.29 semanticDescriptor Stores semantic description pertaining to a resource and potentially sub- resources subscription, transaction AE, container, contentInstance, group, node, flexContainer, timeSeries, mgmtObj 9.6.30 semanticFanOutPoint Virtual resource used as target for semantic discovery aimed at a logical graph distributed over multiple semanticDescriptor resources, which belong to the corresponding group parent resource group 9.6.14a ETSI ETSI TS 118 101 V4.15.0 (2022-09) 130 (oneM2M TS-0001 version 4.15.0 Release 4) Resource Type Short Description Child Resource Types Parent Resource Types Clause dynamicAuthorizationCo nsultation Represents consultation information used by a CSE when performing consultation-based dynamic authorization subscription, transaction AE, AEAnnc, remoteCSE, remoteCSEAnnc, CSEBase, CSEBaseAnnc 9.6.40 timeSeries Stores and Shares Time Series Data instances among entities timeSeriesInstance, subscription, semanticDescriptor, latest, oldest, transaction, action AE, AEAnnc, remoteCSE, remoteCSEAnnc, CSEBase, CSEBaseAnnc, container, containerAnnc, flexContainer, flexContainerAnnc 9.6.36 timeSeriesInstance Represents a Time Series Data instance in the <timeSeries> resource transaction timeSeries, timeSeriesAnnc 9.6.37 role Represents a role that is assigned to an AE or CSE subscription, transaction authorizationInformation 9.6.38 token Used for storing a token that is issued to an AE or CSE subscription, transaction authorizationInformation 9.6.39 authorizationDecision Represents an access control decision point subscription, transaction CSEBase 9.6.41 authorizationPolicy Represents an access control policy retrieval point subscription, transaction CSEBase 9.6.42 authorizationInformation Represents an access control information point role token subscription, transaction CSEBase 9.6.43 localMulticastGroup Stores local multicast group information of member hosting CSE. transaction CSEBase 9.6.44 AEContactList Contains information about a CSE that has resources that referencing an AE- ID AEContactListPerCSE, subscription, transaction CSEBase 9.6.45 AEContactListPerCSE Contains information about a CSE that has resources that referencing an AE resource identifier for tracking purposes None specified AEContactList 9.6.46 transactionMgmt subscription CSEBase, AE, remoteCSE 9.6.47 transaction action All non-virtual resource types with the exception of the following: request, delivery, pollingChannel, transactionMgmt, transaction, timeSyncBeacon 9.6.48 triggerRequest Used by an AE to initiate, replace or recall a device trigger request subscription AE 9.6.49 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 131 (oneM2M TS-0001 version 4.15.0 Release 4) Resource Type Short Description Child Resource Types Parent Resource Types Clause ontologyRepository Represents the collection of the managed ontologies and the semantic validation service ontology, semanticValidation, subscription, ontologyMapping, ontologyMappingAlgorithmRepository CSEBase 9.6.50 ontology Store the representation of an ontology subscription ontologyRepository 9.6.51 semanticValidation A virtual resource as the interface to perform semantic validation on the received <semanticDescriptor> resource against the referenced ontology None specified ontologyRepository 9.6.52 ontologyMapping Represents a mapping operation between two different ontologies subscription ontologyRepository 9.6.70 ontologyMappingAlgorith mRepository Represents the collection of ontology mapping algorithms subscription, ontologyMappingAlogrithm ontologyRepository 9.6.71 ontologyMappingAlogrith m Represents an ontology mapping algorithm None specified ontologyMappingAlgorithm Repository 9.6.72 semanticMashupJobProfi le Represents the profile and description of a semantic mashup service semanticMashupInstance, semanticDescriptor, subscription CSEBase, remoteCSE 9.6.53 semanitcMashupInstanc e Represents a semantic mashup instance semanticMashupResult, semanticDescriptor, mashup, subscription semanticMashupJobProfil e, AE, remoteCSE, CSEBase 9.6.54 mashup A virtual resource use to trigger the calculation and generation of new mashup result Not specified semanticMashupInstance 9.6.55 semanticMashupResult Represent semantic mashup results semanticDescriptor, subscription semanticMashupInstance 9.6.56 multimediaSession Stores a representation of a multimedia session information requested by a registering AE subscription AE 9.6.57 crossResourceSubscripti on represents the cross-resource subscription information related to multiple subscribed-to resources. Such a resource shall include a list of subscribed-to resources as its attribute, or shall be created as a child resource of a <group> resource where member resources shall be the subscribed-to resources schedule, notificationTargetSelfReference, notificationTargetMgmtPolicyRef, transaction CSEBase, remoteCSE, AE 9.6.58 backgroundDataTransfer Stores information for a background data transfer request None specified AE, remoteCSE, CSEBase 9.6.60 action Specifies the action(s) that is performed whenever an event is triggered at the <dependency> resource subscription, transaction, dependency CSEBase, remoteCSE, node, AE, container, flexContainer, group, timeSeries, transaction, state 9.6.61 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 132 (oneM2M TS-0001 version 4.15.0 Release 4) Resource Type Short Description Child Resource Types Parent Resource Types Clause dependency Specifies the condition(s) of a monitored event which triggers the operation(s) specified by the <action> resource subscription, transaction action 9.6.62 e2eQosSession Specifies the end-to-end (E2E) QoS session requirements for the exchange of oneM2M request and response primitives between oneM2M entities subscription, transaction CSEBase, remoteCSE, AE 9.6.63 nwMonitoringReq Specifiesed the request that an AE retrieves the Underlying Network information. The resource provides the characteristics of the Underlying Network status in a particular geographic area such as congestion status and number of devices. subscription CSEBase, remoteCSE, AE 9.6.64 semanticRuleRepository Specifies one or multiple <reasoningRules> child resources to represent different sets of reasoning rules in the oneM2M system reasoningRules, reasoningJobInstance CSEBase 9.6.65 reasoningRules Store a set of related reasoning rules subscription semanticRuleRepository 9.6.66 reasoningJobInstance Represents a specific reasoning job instance for enabling one-time or continuous reasoning operations subscription semanticRuleRepository 9.6.67 serviceSubscribedUserPr ofile Stores user profile information for a given M2M Service User subscription, transaction m2mServiceSubscriptionP rofile 9.6.68 timeSyncBeacon Specifies criteria that a Hosting CSE uses to generate time synchronization beacon notifications subscription, transaction CSEBase, remoteCSE, AE 9.6.69 primitiveProfile Stores message parameters and/or resource attributes that can be applied (i.e. added, removed or modified) to a request or a response primitive subscription, transaction CSEBase, remoteCSE, AE 9.6.73 state Stores status information and actions for a given state of a process that is managed by a Hosting CSE subscription, transaction, action processManagement 9.6.74 processManagement Specifies a process that a Hosting CSE manages on behalf of an AE that consists of sequence of states defined by <state> resources state, subscription, transaction CSEBase, remoteCSE, AE 9.6.75 softwareCampaign Provides policies and rules for the dynamic management of a software by a Hosting CSE subscription, transaction, schedule CSEBase, remoteCSE, AE 9.6.76 NOTE: See clause 9.6.15 for a summary of specializations of <mgmtObj>. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 133 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.1.2 Resource Type Specializations
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.1.2.1 Specializations of <mgmtObj>	Table 9.6.1.2.1-1 lists specializations of the <mgmtObj> resource type in which the mgmtDefinition attribute contains an enumerated value that provides further definition of the resource. Table 9.6.1.2.1-1: <mgmtObj> Specializations Resource specialization Short Description Child Resource Types Parent Resource Types Clause activeCmdhPolicy Provides a link to the currently active set of CMDH policies None specified node D.12.1 areaNwkDeviceInfo Provides information about the Node in the M2M Area Network subscription node D.6 areaNwkInfo Describes the list of Nodes attached behind the MN node and its physical or underlying relation among the nodes in the M2M Area Network subscription node D.5 battery Provides the power information of the node (e.g. remaining battery charge) subscription node D.7 cmdhBuffer Defines CMDH buffer usage limits subscription cmdhPolicy D.12.8 cmdhDefaults Defines CMDH default values cmdhDefEcValue, cmdhEcDefParamVal ues subscription cmdhPolicy D.12.2 cmdhEcDefParamValues Represent a specific set of default values for the CMDH related parameters subscription cmdhDefaults D.12.4 cmdhDefEcValue Defines a value for the Event Category parameter of an incoming request when it is not defined subscription cmdhDefaults D.12.3 cmdhLimits Defines limits for CMDH related parameter values subscription cmdhPolicy D.12.5 cmdhNetworkAccessRules Defines rules for the usage of underlying networks cmdhNwAccessRule, subscription cmdhPolicy D.12.6 cmdhNwAccessRule Defines a rule for the usage of underlying networks subscription cmdhNetworkA ccessRules D.12.7 cmdhPolicy A set of rules defining which CMDH parameters will be used by default cmdhDefaults, cmdhLimits, cmdhNetworkAccess Rules, cmdhBuffer, subscription node D.12 deviceCapability Contains information about the capability supported by the Node subscription node D.9 deviceInfo Contains information about the identity, manufacturer and model number of the device subscription node D.8 eventLog Contains information about the log of events of the Node subscription node D.11 firmware Provides information about the firmware of the Node (e.g. name, version) subscription node D.2 memory Provides the memory (typically RAM) information of the node (e.g. the amount of total volatile memory) subscription node D.4 reboot Used to reboot or reset the Node subscription node D.10 software Provides information about the software of the Node subscription node D.3 registration To convey the service layer configuration information subscription node 7.1 in [10] dataCollection To convey the application configuration information subscription node 7.2 in [10] ETSI ETSI TS 118 101 V4.15.0 (2022-09) 134 (oneM2M TS-0001 version 4.15.0 Release 4) Resource specialization Short Description Child Resource Types Parent Resource Types Clause authenticationProfile To convey the configuration information regarding establishing mutually-authenticated secure communications subscription node 7.1 in [10] myCertFileCred To configure a certificate or certificate chain subscription authenticationP rofile 7.1 in [10] trustAnchorCred To identify a trust anchor certificate for validation of certificates subscription authenticationP rofile 7.1 in [10] MAFClientRegCfg To convey instructions regarding the MAF Client Registration procedure subscription authenticationP rofile 7.1 in [10] wifiClient To set up configuration of WiFi connection on the client device. subscription node 7.1 in [10] storage To manage available storage memory on the device subscription node D.13 OAuth2Authentication To store access token and refresh token used in OAuth2 security protocol subscription node 7.1 in [10]
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.1.2.2 Specializations of <flexContainer>	9.6.1.2.2.1 <flexContainer> for generic interworking Generic interworking (specified in ETSI TS 118 112 [6]) provides interworking with many types of non- oneM2M area networks and their devices. It supports the interworking variant " full mapping of the semantic of the non-oneM2M data model to Mca" as indicated in clause F.2. Generic interworking can be done for non-oneM2M systems for which no oneM2M specified interworking exists. For generic interworking the non-oneM2M data model of the non- oneM2M area network needs to be described in the form of a oneM2M compliant ontology which is derived from the oneM2M base ontology (specified in ETSI TS 118 112 [6]) and that may be available in a formal description language (e.g. OWL). Table 9.6.1.2.2.1-1 lists specializations of the <flexContainer> resource type for generic interworking in which the containerDefinition attribute provides further definition of the resource. Table 9.6.1.2.2.1-1: <flexContainer> Specializations for Generic Interworking Resource specialization Short Description Child Resource Types Parent Resource Types Clause genericInterworkingSe rvice This resource type is used to link to a set of input- and outputDataPoints of the service and to provide the parent resource for operationInstance resources of the service genericInterworkingSe rvice, genericInterworkingOp erationInstance, semanticDescriptor, subscription AE, container, flexContainer, genericInterworkin gService 9 in [6] genericInterworkingOp erationInstance This resource type is used to link to a set of input- and outputDataPoints and a set of operationInputs and operationOutputs of the operationInstance semanticDescriptor, subscription genericInterworkin gService 9 in [6] 9.6.1.2.2.2 <flexContainer> for AllJoyn interworking Table 9.6.1.2.2.2-1 contains the list of <flexContainer> specialization resources for oneM2M and AllJoyn interworking defined in ETSI TS 118 121 [7]. This also summarizes parent-child relationship for each specialization resource type. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 135 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.1.2.2.2-1: <flexContainer> Specializations Resource specialization Short Description Child Resource Types Parent Resource Types Clause svcObjWrapper AllJoyn service object wrapper allJoynApp AE B.2 in [7] svcFwWrapper AllJoyn service framework wrapper n/a AE B.3 in [7] allJoynApp AllJoyn application allJoynSvcObject svcObjWrapper B.4 in [7] allJoynSvcObject AllJoyn service object allJoynInterface allJoynApp B.5 in [7] allJoynInterface AllJoyn interface allJoynMethod, allJoynProperty allJoynSvcObject B.6 in [7] allJoynMethod AllJoyn method allJoynMethodCall allJoynInterface B.7 in [7] allJoynMethodCall AllJoyn method call n/a allJoynMethod B.8 in [7] allJoynProperty AllJoyn property n/a allJoynInterface B.9 in [7] 9.6.1.2.2.3 <flexContainer> for Home Appliance Information Model Table 9.6.1.2.2.3-1 contains the list of <flexContainer> specialization resources for oneM2M Home Appliance Information Model (HAIM) defined in ETSI TS 118 123 [8]. This also summarizes parent-child relationship for each specialization resource type. Table 9.6.1.2.2.3-1: <flexContainer> Specializations Resource specialization Short Description Child Resource Types Parent Resource Types Clause alarmSpeaker HAIM ModuleClass subscription n/a 5.3.1 in [8] audioVideoInput HAIM ModuleClass subscription television 5.3.2 in [8] audioVolume HAIM ModuleClass upVolume, downVolume subscription television 5.3.3 in [8] battery HAIM ModuleClass subscription electricVehicleCharg er, robotCleaner, storageBattery 5.3.4 in [8] binarySwitch HAIM ModuleClass toggle, subscription airConditioner, clothesWasher, electricVehicleCharg er, light, microgeneration, oven, refrigerator, robotCleaner, smartElectricMeter, storageBattery, television, waterHeater 5.3.5 in [8] bioElectricalImpedanc eAnalysis HAIM ModuleClass subscription n/a 5.3.6 in [8] boiler HAIM ModuleClass subscription waterHeater 5.3.7 in [8] brightness HAIM ModuleClass subscription light 5.3.8 in [8] clock HAIM ModuleClass subscription smartElectricMeter, waterHeater 5.3.9 in [8] colour HAIM ModuleClass subscription light 5.3.10 in [8] colourSaturation HAIM ModuleClass subscription light 5.3.11 in [8] doorStatus HAIM ModuleClass subscription refrigerator 5.3.12 in [8] electricVehicleConnect or HAIM ModuleClass subscription electricVehicleCharg er 5.3.13 in [8] energyConsumption HAIM ModuleClass subscription smartElectricMeter 5.3.14 in [8] energyGeneration HAIM ModuleClass subscription Microgeneration, smartElectricMeter 5.3.15 in [8] faultDetection HAIM ModuleClass subscription electricVehicleCharg er, light microgeneration, smartElectricMeter, storageBattery, waterHeater 5.3.16 in [8] height HAIM ModuleClass subscription n/a 5.3.17 in [8] hotWaterSupply HAIM ModuleClass subscription waterHeater 5.3.18 in [8] ETSI ETSI TS 118 101 V4.15.0 (2022-09) 136 (oneM2M TS-0001 version 4.15.0 Release 4) Resource specialization Short Description Child Resource Types Parent Resource Types Clause keypad HAIM ModuleClass subscription n/a 5.3.19 in [8] motionSensor HAIM ModuleClass subscription n/a 5.3.20 in [8] oximeter HAIM ModuleClass subscription n/a 5.3.21 in [8] powerSave HAIM ModuleClass subscription refrigerator 5.3.22 in [8] pushButton HAIM ModuleClass subscription n/a 5.3.23 in [8] recorder HAIM ModuleClass subscription n/a 5.3.24 in [8] refrigeration HAIM ModuleClass subscription refrigerator 5.3.25 in [8] relativeHumidity HAIM ModuleClass subscription n/a 5.3.26 in [8] rinseLevel HAIM ModuleClass subscription clothesWasher 5.3.27 in [8] runMode HAIM ModuleClass subscription airConditioner, clothesWasher, electricVehicleCharg er, light, microgeneration, oven, robotCleaner, smartElectricMeter, storageBattery, thermostat, waterHeater 5.3.28 in [8] signalStrength HAIM ModuleClass subscription n/a 5.3.29 in [8] smokeSensor HAIM ModuleClass subscription n/a 5.3.30 in [8] spinLevel HAIM ModuleClass subscription clothesWasher 5.3.31 in [8] televisionChannel HAIM ModuleClass upChannel, downChannel, subscription television 5.3.32 in [8] temperature HAIM ModuleClass subscription airConditioner, clothesWasher, oven, refrigerator, thermostat 5.3.33 in [8] temperatureAlarm HAIM ModuleClass subscription n/a 5.3.34 in [8] timer HAIM ModuleClass activateClockTimer, deactivateClockTime r, subscription airConditioner, clothesWasher, oven, robotCleaner, thermostat 5.3.35 in [8] turbo HAIM ModuleClass subscription airConditioner 5.3.36 in [8] waterFlow HAIM ModuleClass subscription clothesWasher 5.3.37 in [8] waterLevel HAIM ModuleClass subscription clothesWasher 5.3.38 in [8] waterSensor HAIM ModuleClass subscription n/a 5.3.39 in [8] weight HAIM ModuleClass subscription n/a 5.3.40 in [8] wind HAIM ModuleClass subscription airConditioner 5.3.41 in [8] activateClockTimer HAIM Action subscription timer C.1 in [8] deactivateClockTimer HAIM Action subscription timer C.2 in [8] downChannel HAIM Action subscription televisionChannel C.3 in [8] downVolume HAIM Action subscription audioVolume C.4 in [8] toggle HAIM Action subscription binarySwitch C.5 in [8] upChannel HAIM Action subscription televisionChannel C.6 in [8] upVolume HAIM Action subscription audioVolume C.7 in [8] airConditioner HAIM Device binarySwitch, runMode, temperature, timer, turbo, wind, subscription AE 5.4.1 in [8] clothesWasher HAIM Device binarySwitch, timer, runMode, temperature, waterLevel, rinseLevel, waterFlow, spinLevel, subscription AE 5.4.2 in [8] electricVehicleCharger HAIM Device faultDetection, binarySwitch, runMode, battery, electricVehicleConne ctor, subscription AE 5.4.3 in [8] ETSI ETSI TS 118 101 V4.15.0 (2022-09) 137 (oneM2M TS-0001 version 4.15.0 Release 4) Resource specialization Short Description Child Resource Types Parent Resource Types Clause light HAIM Device faultDetection, binarySwitch, runMode, colour, colourSaturation, brightness, subscription AE 5.4.4 in [8] microgeneration HAIM Device faultDetection, binarySwitch, runMode, energyGeneration, subscription AE 5.4.5 in [8] oven HAIM Device binarySwitch, runMode, timer, temperature, subscription AE 5.4.6 in [8] refrigerator HAIM Device binarySwitch, powerSave, doorStatus, temperature, refrigeration, subscription AE 5.4.7 in [8] robotCleaner HAIM Device binarySwitch, runMode, battery, timer, subscription AE 5.4.8 in [8] smartElectricMeter HAIM Device faultDetection, binarySwitch, runMode, clock, energyConsumption, energyGeneration, subscription AE 5.4.9 in [8] storageBattery HAIM Device faultDetection, binarySwitch, runMode, battery, subscription AE 5.4.10 in [8] television HAIM Device binarySwitch, audioVolume, televisionChannel, audioVideoInput, subscription AE 5.4.11in [8] thermostat HAIM Device runMode, timer, temperature, subscription AE 5.4.12 in [8] waterHeater HAIM Device faultDetection, binarySwitch, runMode, clock, boiler, hotWaterSupply, subscription AE 5.4.13 in [8] deviceProperty HAIM Property subscription airConditioner, clothesWasher, electricVehicleCharg er, light, microgeneration, oven, refrigerator, robotCleaner, smartElectricMeter, storageBattery, television, thermostat waterHeater D.1 in [8] moduleClassProperty HAIM Property subscription battery, electricVehicleConne ctor D.2 in [8] ETSI ETSI TS 118 101 V4.15.0 (2022-09) 138 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.1.3 Commonly Used Attributes
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.1.3.0 Overview	Some attributes described herein are present in all <resourceTypes>. Such attributes are described in clause 9.6.1.3.1 once in order to avoid duplicating the description for every <resourceType> and are referred to as "universal attributes". Some other attributes described herein are commonly used in multiple, but not all, <resourceTypes>. Such attributes are described in clause 9.6.1.3.2 once in order to avoid duplicating the description for every <resourceType> that contains it and are referred to as "common attributes". Remaining attributes are described in the clause specific for that resource type.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.1.3.1 Universal attributes	The following attributes are universal to all resource types which are normal, not virtual or announced. Universal attributes for announced resource types are independently defined in clause 9.6.26.2. Table 9.6.1.3.1-1: Universal Attributes Attribute Name Description resourceType Resource Type. This Read Only (assigned at creation time. and then cannot be changed) attribute identifies the type of the resource as specified in clause 9.6. Each resource shall have a resourceType attribute. resourceID This attribute is an identifier for the resource that is used for 'non-hierarchical addressing method', i.e. this attribute shall contain the 'Unstructured-CSE-relative-Resource-ID' format of a resource ID as defined in table 7.2-1. This attribute shall be provided by the Hosting CSE when it accepts a resource creation procedure. The Hosting CSE shall assign a resourceID which is unique in that CSE. resourceName This attribute is the name for the resource that is used for 'hierarchical addressing method' to represent the parent-child relationships of resources. See clause 7.2 for more details. This attribute may be provided by the resource creator. The Hosting CSE shall use a provided resourceName as long as it does not already exist among child resources of the targeted parent resource. If the resourceName already exists, the Hosting CSE shall reject the request and return an error to the Originator. The Hosting CSE shall assign a resourceName if one is not provided by the resource creator. parentID This attribute is the resourceID of the parent of this resource. The value of this attribute shall be an empty string for the <CSEBase> resource type. creationTime Time/date of creation of the resource. This attribute is mandatory for all resources and the value is assigned by the system at the time when the resource is locally created. Such an attribute cannot be changed. lastModifiedTime Last modification time/date of the resource. The lastModifiedTime value is set by the Hosting CSE when the resource is created, and the lastModifiedTime value is updated when the resource is updated.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.1.3.2 Common attributes	The following attributes are commonly used in multiple, but not all, resource types which are normal, not virtual or announced. Common attributes for announced resource types are independently defined in clause 9.6.26.3. NOTE: The list of attributes in table 9.6.1.3.2-1 is not exhaustive. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 139 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.1.3.2-1: Common Attributes Attribute Name Description accessControlPolicyIDs The attribute contains a list of identifiers for <accessControlPolicy> resources. The privileges defined in the <accessControlPolicy> resources that are referenced determine who is allowed to access the resource containing this attribute for a specific purpose (e.g. Retrieve, Update, Delete, etc.). For an Update operation to a resource, it is forbidden to change the accessControlPolicyIDs attribute in the same request to Update other attributes of the targeted resource, i.e a request to Update the accessControlPolicyIDs attribute shall be the only attribute in the UPDATE request. To update the accessControlPolicyIDs attribute, a Hosting CSE shall check whether the Originator has Update privilege in any current selfPrivileges of the <accessControlPolicy> resources which this attribute references. To update any attribute other than the accessControlPolicyIDs attribute, a Hosting CSE shall check whether the Originator has Update privilege in any privileges, of the <accessControlPolicy> resources which the accessControlPolicyIDs attribute references. If a resource type does not have an accessControlPolicyIDs attribute definition, then the accessControlPolicyIDs for that resource is governed in a different way, for example, the accessControlPolicy associated with the parent may apply to a child resource that does not have an accessControlPolicyIDs attribute definition, or the privileges for access are fixed by the system. Refer to the corresponding resource type definitions and procedures to see how access control is handled in such cases. If a resource type does have an accessControlPolicyIDs attribute definition, but the (optional) accessControlPolicyIDs attribute value is not set in a resource instance, then the Hosting CSE shall apply the concept of the default access policy. The Hosting CSE shall first check whether the resource has a custodian attribute configured and if so, the default policy shall provide unrestricted access only to the custodian. If the custodian attribute is not configured, then the default policy shall provide unrestricted access only to the Originator of the successful resource creation request. All other entities shall be denied to access the resource. For that purpose, the Hosting CSE shall keep that Originator information of the resource. Note that how to keep that information is implementation specific. The default access policy is not applied to a resource which has a value assigned to the accessControlPolicyIDs attribute. All resources are accessible if and only if the privileges (i.e. configured as privileges or selfPrivileges attribute of <accessControlPolicy> resource) allow it, therefore all resources shall have an associated accessControlPolicyIDs attribute, either explicitly (setting the attribute in the resource itself) or implicitly (either by using the parent privileges or the system default policies). Which means that the system shall provide default access privileges in case that the Originator does not provide a specific accessControlPolicyIDs during the creation of the resource. expirationTime Time/date after which the resource will be deleted by the Hosting CSE. This attribute can be provided by the Originator, and in such a case it will be regarded as a hint to the Hosting CSE on the lifetime of the resource. The Hosting CSE shall configure the expirationTime value. If the Hosting CSE configures the new expirationTime attribute value rather than the Originator suggested value, the new value can be sent back to the Originator depending on the Result Content value. The lifetime of the resource can be extended by providing a new value for this attribute in an UPDATE operation. Or by deleting the attribute value, e.g. by updating the attribute with NULL when doing a full UPDATE, in which case the Hosting CSE can decide on a new value. If the Originator does not provide a value in the CREATE operation the system shall assign an appropriate value depending on its local policies and/or M2M service subscription agreements. A resource is known as 'obsolete' when the resource contains the attribute "expirationTime" and the lifetime of this resource has reached the value of this attribute. If the 'obsolete' resource had a reference to an Application Entity Resource ID, the Hosting CSE shall send a NOTIFY request to the IN-CSE, requesting to delete the entry from the <AEContactList> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 140 (oneM2M TS-0001 version 4.15.0 Release 4) Attribute Name Description stateTag An incremental counter of modification on the resource. When a resource is created, this counter is set to 0, and it will be incremented on every modification of the resource (see notes 1 and 2). announceTo This attribute may be included in a CREATE or UPDATE Request in which case it contains a list of addresses/CSE-IDs where the resource is to be announced. For the case that CSE-IDs are provided, the announced-to CSE shall decide the location of the announced resources based on the rules described in clause 9.6.26. For the original resource, this attribute shall only be present if it has been successfully announced to other CSEs. This attribute maintains the list of the resource addresses to the successfully announced resources. Updates on this attribute will trigger new resource announcement or de-announcement. If the announceTo attribute includes resource address(s), the present document does not provide any means for validating these address(s) for announcement purposes. It is the responsibility of the Hosting-CSE referenced by the resource address(s) to validate the access privileges of the originator of the Request that triggers the announcement. announcedAttribute This attribute shall only be present at the original resource if some Optional Announced (OA) type attributes have been announced to other CSEs. This attribute maintains the list of the announced Optional Attributes (OA type attributes) in the original resource. Updates to this attribute will trigger new attribute announcement if a new attribute is added or de- announcement if the existing attribute is removed. announceSyncType This attribute indicates the types of synchronization for resource announcement. Possible values are as follows: - Uni-directional synchronization: Announced resource(s) is updated if the original resource is updated - Bi-directional synchronization: Announced resource(s) is updated if the original resource is updated and vice versa This attribute is presented in both the original resource and the announced resource(s). The absence of this attribute implies that uni-directional synchronization is the type of supported synchronization for resource announcement. labels Tokens used to add meta-information to resources. This attribute is optional. The value of the labels attribute is a list of individual labels, each of them being: - Either a standalone label-key, used as a simple "tag", that can be used for example for discovery purposes when looking for particular resources that one can "tag" using that label-key. - Or a composite element made of a label-key and a label-value, separated by a special character defined in ETSI TS 118 104 [3]. The list of allowed characters in a label (and in label-keys and label-values) and separator characters is defined in ETSI TS 118 104 [3], clause 6.3.3. e2eSecInfo Present in a resource representing an AE or CSE. Indicates the end-to-end security capabilities supported by the AE or CSE. May indicate supported end-to-end security frameworks. May also contains a certificate or credential identifier used by the AE or CSE. May include random values for use in end-to-end security protocols. The details of this attributes are described in ETSI TS 118 103 [2]. This attribute is optional and if not present it means that the represented entity does not support oneM2M end-to-end security procedures. dynamicAuthorizationCo nsultationIDs This attribute contains a list of identifiers of <dynamicAuthorizationConsultation> resources. The information defined in a <dynamicAuthorizationConsultation> resource is used by a CSE for initiating consultation-based dynamic authorization requests. Consultation-based dynamic authorization is only performed for a targeted resource if and only if it is linked to an enabled <dynamicAuthorizationConsultation> resource. If the attribute is not set or has a value that does not correspond to a valid <dynamicAuthorizationConsultation> resource(s), or it refers to an <dynamicAuthorizationConsultation> resource(s) that is not reachable, then the dynamicAuthorizationConsultationIDs associated with the parent may apply to the child resource if present, or a system default <dynamicAuthorizationConsultation> may apply if present. creator The AE-ID or CSE-ID of the entity which created the resource containing this attribute. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 141 (oneM2M TS-0001 version 4.15.0 Release 4) Attribute Name Description location This attribute contains the geo-coordinates of entities or things represented by its resource types (e.g. AE, container). Longitude and Latitude are shall be included as a coordinate and optionally altitude may also be included. The representation format shall follow the definition in the GeoJSON format [16]. This attribute can be used for geo-query (Clause 10.2.6) with relevant filter conditions (clause 8.1.2). custodian The AE-ID, M2M-User-ID or CSE-ID of the entity which owns the resource containing this attribute. NOTE 1: In order to enable detection of overflow, the counter needs to be capable of expressing sufficiently long numbers. NOTE 2: This attribute has the scope to allow identifying changes in resources within a time interval that is lower than the one supported by the attribute lastModifiedTime (e.g. less than a second or millisecond). This attribute can also be used to avoid race conditions in case of competing modifications.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.2 Resource Type accessControlPolicy
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.2.0 Introduction	The Access Control Policies (ACPs) shall be used by the CSE to control access to the resources and their attributes as specified in the present document and in ETSI TS 118 103 [2]. The ACP is designed to fit different access control models such as access control lists, role or attribute based access control. The <accessControlPolicy> resource is comprised of privileges and selfPrivileges attributes which represent a set of access control rules defining which entities (defined as accessControlOriginators) have the privilege to perform certain operations (defined as accessControlOperations) within specified contexts (defined as accessControlContexts) and are used by the CSEs in making Access Decision to all or specific parts (i.e. child resources or attributes) of the targeted resource (defined as accessControlObjectDetails and accessControlAttributes). In a privilege, each access control rule defines which AE/CSE is allowed for which operation. So for sets of access control rules an operation is permitted if it is permitted by one or more access control rules in the set. For a resource that is not of <accessControlPolicy> resource type, the common attribute accessControlPolicyIDs for such resources (defined in table 9.6.1.3.2-1) contains a list of identifiers which link that resource to <accessControlPolicy> resources. The CSE Access Decision for such a resource shall follow the evaluation of the set of access control rules expressed by the privileges attributes defined in the <accessControlPolicy> resources. The selfPrivileges attribute shall represent the set of access control rules for the <accessControlPolicy> resource itself. The CSE Access Decision for <accessControlPolicy> resource shall follow the evaluation of the set of access control rules expressed by the selfPrivileges attributes defined in the <accessControlPolicy> resource itself. Logically an authorization system may comprise four sub-functions: enforcing access control decision, making access control decision, providing access control policies and providing access control information (e.g. roles). As specified in ETSI TS 118 103 [2], these sub-functions are modelled as Policy Enforcement Point (PEP), Policy Decision Point (PDP), Policy Retrieval Point (PRP) and Policy Information Point (PIP) respectively. In a oneM2M System these authorization sub-functions may coexist in one CSE or may be distributed in different CSEs in different combinations. In the <accessControlPolicy> resource three operational attributes are defined for holding the information about where to find the distributed authorization sub-functions. These attributes are: authorizationDecisionResourceIDs, authorizationPolicyResourceIDs and authorizationInformationResourceIDs. The authorizationDecisionResourceIDs attribute contains a list of addresses of <authorizationDecision> resources. Each <authorizationDecision> resource represents a PDP to which an access control decision request shall be sent in order to obtain an access control decision. See clause 9.6.41 for further details of <authorizationDecision> resource type. The authorizationPolicyResourceIDs attribute contains a list of addresses of <authorizationPolicy> resources. Each <authorizationPolicy> resource represents a PRP to which an access control policy request shall be sent in order to obtain access control policies. See clause 9.6.42 for further details of <authorizationPolicy> resource type. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 142 (oneM2M TS-0001 version 4.15.0 Release 4) The authorizationInformationResourceIDs attribute contains a list of addresses of <authorizationInformation> resources. Each <authorizationInformation> resource represents a PIP to which an access control information request shall be sent in order to obtain requested access control information (e.g. role and/or token) for making an access control decision. See clause 9.6.43 for further details of <authorizationInformation> resource type. When processing a request to a targeted resource, the Hosting CSE shall progress through the different types of authorization (if supported) as described in clause 10.2.3.1. The applicability of the authorizationDecisionResourceIDs, authorizationPolicyResourceIDs and authorizationInformationResourceIDs attributes for the distributed authorization depends on the deployment form of authorization sub-functions: • In the case the privileges attribute is not NULL, the access control rules in the privileges attribute shall be used for access control, and the authorizationDecisionResourceIDs, authorizationPolicyResourceIDs and authorizationInformationResourceIDs attributes shall not be present. • In the case the privileges attribute is NULL, how to process further depends on which authorization method is adopted. In the case distributed authorization method is supported, authorizationDecisionResourceIDs or authorizationPolicyResourceIDs attribute shall be considered for obtaining access control decision or access control policies from another CSE. However, authorizationDecisionResourceIDs and authorizationPolicyResourceIDs attributes shall not be present at the same time. • In case the authorizationInformationResourceIDs attribute is present, the access control information request (e.g. for role information) related to the access control policy specified in the privileges attribute shall be sent to one of the addresses listed in this attribute. The details of distributed authorization procedures are described in ETSI TS 118 103 [2]. The <accessControlPolicy> resource shall contain the child resource specified in table 9.6.2.0-1. Table 9.6.2.0-1: Child resources of <accessControlPolicy> resource Child Resources of <accessControlPolicy> Child Resource Type Multiplicity Description <accessControlPolicyAnnc> Child Resource Types [variable] <subscription> 0..n See clause 9.6.8 <subscription> [variable] <transaction> 0..n See clause 9.6.48 <transaction> The <accessControlPolicy> resource shall contain the attributes specified in table 9.6.2.0-2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 143 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.2.0-2: Attributes of <accessControlPolicy> resource Attributes of <accessControlPolicy> Multiplicity RW/ RO/ WO Description <accessControl PolicyAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA labels 0..1(L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA privileges 1 RW A set of access control rules that applies to resources referencing this <accessControlPolicy> resource using the accessControlPolicyID attribute. MA selfPrivileges 1 RW A set of access control rules that apply to the <accessControlPolicy> resource itself and accessControlPolicyIDs attribute of any other resource which is linked to this <accessControlPolicy> resource. MA authorizationDecisionReso urceIDs 0..1 (L) RW A list of addresses of <authorizationDecision> resources. See clause 9.6.41 for further details. MA authorizationPolicyResour ceIDs 0..1 (L) RW A list of addresses of <authorizationPolicy> resources. See clause 9.6.42 for further details. MA authorizationInformationRe sourceIDs 0..1 (L) RW A list of addresses of <authorizationInformation> resources. See clause 9.6.43 for further details. MA The set of access control rules represented in privileges and selfPrivileges attributes are comprised of access-control- rule-tuples (accessControlOriginators, accessControlContexts, accessControlOperations, accessControlObjectDetails, accessControlAuthenticationFlag and accessControlAttributes) with parameters shown in table 9.6.2.0-3 which are further described in the following clauses. If the privileges attribute contains no access-control-rule-tuples, then this represents an empty set of the access control rules. The selfPrivileges attribute shall contain at least one access-control-rule-tuple. The CSE access granting mechanism shall follow the procedure described in ETSI TS 118 103 [2] clause 7.1 (Access Control Mechanism). Table 9.6.2.0-3: Parameters in access-control-rule-tuples Name Description accessControlOriginators See clause 9.6.2.1 accessControlContexts See clause 9.6.2.2 accessControlOperations See clause 9.6.2.3 accessControlObjectDetails See clause 9.6.2.4 accessControlAuthenticationFlag See clause 9.6.2.5 accessControlAttributes See clause 9.6.2.6 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 144 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.2.1 accessControlOriginators	The accessControlOriginators is a mandatory parameter in an access-control-rule-tuple. It represents the set of Originators that shall be allowed to use this access control rule. The set of Originators is described as a list of parameters, where the types of the parameter can vary within the list. Table 9.6.2.1-1 describes the supported types of parameters in accessControlOriginators. The following Originator privilege types shall be considered for access control policy check by the CSE. Table 9.6.2.1-1: Types of Parameters in accessControlOriginators Name Description domain A SP domain or SP sub-domain originatorID CSE-ID, AE-ID or the resource-ID of a <group> resource that contains the AE or CSE that represents the Originator all Any Originators are allowed to access the resource within the accessControlOriginators constraints Role-ID A Role Identifier as defined in clause 7.1.14 When the originatorID is the resource-ID of a <group> resource which contains <AE> or <remoteCSE> as member, the Hosting CSE of the resource shall check if the originator of the request matches one of the members in the memberIDs attribute of the <group> resource (e.g. by retrieving the <group> resource). If the <group> resource cannot be retrieved or does not exist, the request shall be rejected.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.2.2 accessControlContexts	The accessControlContexts is an optional parameter in an access-control-rule-tuple that contains a list, where each element of the list, when present, represents a context that is permitted to use this access control rule. Each request context is described by a set of parameters, where the types of the parameters can vary within the set. Table 9.6.2.2-1 describes the supported types of parameters in accessControlContexts. The following Originator accessControlContexts shall be considered for access control policy check by the CSE. Table 9.6.2.2-1: Types of Parameters in accessControlContexts Name Description accessControlWindow Represents a time window constraint which is compared against the time that the request is received at the Hosting CSE. accessControlLocationRegion Represents a location region constraint which is compared against the location of the Originator of the request. accessControlIPAddresses Represents an IP address constraint or IP address block constraint which is compared against the IP address of the Originator of the request. accessControlUserIDs Represents a M2M Service User constraint which is compared against the M2M Service User parameter of the request. accessControlEvalCriteria This attribute provides the conditions determining if the request operation is to be allowed. It allows conditional access to the resource based on conditions not contained in the received request. The accessControlEvalCriteria parameter consists of a mandatory subjectResourceID attribute as defined in table 9.6.61-2 and the evalCriteria attribute described in table 9.6.61-3. See note. accessControlLimit Represents the number of times that the policy defined in this accessControlRule can allow authorization to the requested resource. This attribute maintains of the number of authorizations granted based on this policy. This value is decremented each time the evaluation grants access to the requested resource. If this value is greater than zero (0) then the request operation is allowed. If the accessControlLimit parameter is not present then the request operation is allowed (unlimited access). NOTE: This uses the same definitions that are present in the <action> resource, but does not use the <action> resource ETSI ETSI TS 118 101 V4.15.0 (2022-09) 145 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.2.3 accessControlOperations	The accessControlOperations is a mandatory parameter in an access-control-rule-tuple that represents the set of operations that are authorized using this access control rule. Table 9.6.2.3-1 describes the supported set of operations that are authorized by accessControlOperations. The following accessControlOperations shall be considered for access control policy check by the CSE. Table 9.6.2.3-1: Types of parameters in accessControlOperations Name Description RETRIEVE Privilege to retrieve the content of an addressed resource CREATE Privilege to create a child resource UPDATE Privilege to update the content of an addressed resource DELETE Privilege to delete an addressed resource DISCOVER Privilege to discover the resource NOTIFY Privilege to receive a notification
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.2.4 accessControlObjectDetails	The accessControlObjectDetails is an optional parameter of an access control rule. It specifies a subset of child resource types of the targeted resource to which the access control rule applies. If an access control rule includes accessControlObjectDetails, then childResourceType shall be specified. An access control rule which does not include any accessControlObjectDetails parameters applies to the child resource types of the target resource. The accessControlObjectDetails parameter shall consist of the elements listed in table 9.6.2.4-1. Child resource types listed in the childResourceType component are subject of access control for the Create operation only. Once a child resource is created, the Access Control Policies assigned directly to it apply. The resourceType and specialization element are optional. If either the resourceType or specialization element is present in accessControlObjectDetails, the CSE shall match the type of resource or specialization of the targeted resource with the value specified in the resourceType or specialization element. Further checking of childResourceType shall be done only if the resourceType or specialization match occurs. However, if the resourceType and specialization elements are not provided, only childResourceType match shall be performed. Table 9.6.2.4-1: Types of Parameters in accessControlObjectDetails Name Description resourceType Identifier of the resource type to which this access control rule applies. specializationType When the resourceType is mgmtObj or flexContainer, the identifier of the specialization as defined by mgmtDefinition or containerDefinition attribute, respectively, shall be specified. childResourceType List of child resource types and/or the identifier of the specialization. The identifier of the specialization shall be specified when the resourceType is mgmtObj or flexContainer.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.2.5 accessControlAuthenticationFlag	The accessControlAuthenticationFlag is an optional parameter in an access-control-rule-tuple: if the value is TRUE, then the access control rule applies only if the Originator is considered to be authenticated by the Hosting CSE; if the value is FALSE, then the access control rule applies whether or not the Originator is considered to be authenticated by the Hosting CSE. Clause 7.1.2 in ETSI TS 118 103 [2] describes the criteria used to determine if the Originator is considered to be authenticated by the Hosting CSE. If the accessControlAuthenticationFlag parameter is not present, then the value is assumed to be FALSE.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.2.6 accessControlAttributes	The accessControlAttributes is an optional parameter in an access-control-rule-tuple. It specifies a list of resource attributes names to which the access-control-rule-tuple applies. The list includes one or more names of oneM2M resource attributes represented in their short name format as defined in ETSI TS 118 104 [3]. If an access-control-rule- tuple does not include an accessControlAttributes parameter, then the access-control-rule-tuple applies to all the attributes of the target resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 146 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.3 Resource Type CSEBase	A <CSEBase> resource shall represent a CSE. The <CSEBase> resource shall be the root for all resources that are residing in the CSE. A CSE shall be represented by only one <CSEBase> resource. The <CSEBase> resource shall contain the child resources specified in table 9.6.3-1. Table 9.6.3-1: Child resources of <CSEBase> resource Child Resources of <CSEBase> Child Resource Type Multiplicity Description [variable] <cseBaseAnnc> 0..n Announced variant of <cseBase>. Resource with CSE-specific information for a CSE that intends to announce resources to another CSE [variable] <remoteCSE> 0..n See clause 9.6.4 [variable] <remoteCSEAnnc> 0..n Announced variant of <remoteCSE>. Resource with CSE-specific information for a CSE that announced itself to another CSE with which it does not have a registration relationship [variable] <node> 0..n See clause 9.6.18 [variable] <AE> 0..n See clause 9.6.5 [variable] <container> 0..n See clause 9.6.6 [variable] <flexContainer> 0..n See clause 9.6.35 [variable] <group> 0..n See clause 9.6.13 [variable] <accessControlPolicy> 0..n See clause 9.6.2 [variable] <subscription> 0..n See clause 9.6.8 [variable] <mgmtCmd> 0..n See clause 9.6.16 [variable] <locationPolicy> 0..n See clause 9.6.10 [variable] <statsConfig> 0..n See clause 9.6.23 [variable] <statsCollect> 0..n See clause 9.6.25 [variable] <request> 0..n See clause 9.6.12 [variable] <delivery> 0..n See clause 9.6.11 [variable] <schedule> 0..1 This resource defines the reachability schedule information of the entity. The absence of this resource implies the entity is always reachable. See clause 9.6.9 [variable] <role> 0..n See clause 9.6.38 [variable] <token> 0..n See clause 9.6.39 [variable] <m2mServiceSubscriptionProfile> 0..n See clause 9.6.19 [variable] <serviceSubscribedAppRule> 0..n See clause 9.6.29 [variable] <notificationTargetPolicy> 0..n See clause 9.6.32 [variable] <dynamicAuthorizationConsultation> 0..n See clause 9.6.40 [variable] <timeSeries> 0..n See clause 9.6.36 [variable] <authorizationDecision> 0..n See clause 9.6.41 [variable] <authorizationPolicy> 0..n See clause 9.6.42 [variable] <authorizationInformation> 0..n See clause 9.6.43 [variable] <localMulticastGroup> 0..n See clause 9.6.44 [variable] <transactionMgmt> 0..n See clause 9.6.47 [variable] <transaction> 0..n See clause 9.6.48 [variable] <ontologyRepository> 0..1 See clause 9.6.50 [variable] <semanticMashupJobProfile> 0..n See clause 9.6.53 [variable] <semanticMashupInstance> 0..n See clause 9.6.54 [variable] <AEContactList> 0..n See clause 9.6.45 [variable] <e2eQosSession> 0..1 See clause 9.6.63 [variable] <nwMonitoringReq> 0..n See clause 9.6.64 [variable] <semanticRuleRepository> 0..1 See clause 9.6.65 [variable] <softwareCampaign> 0..n See clause 9.6.76 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 147 (oneM2M TS-0001 version 4.15.0 Release 4) The <CSEBase> resource shall contain the attributes specified in table 9.6.3-2. Table 9.6.3-2: Attributes of <CSEBase> resource Attributes of <CSEBase> Multiplicity RW/ RO/ WO Description <CSEBaseAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 RO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. Shall be an empty string. NA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA accessControlPolicyIDs 0..1 (L) RO See clause 9.6.1.3. MA labels 0..1 (L) RO See clause 9.6.1.3. MA announceTo 0..1 (L) RO See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RO See clause 9.6.1.3. NA dynamicAuthorizationConsul tationIDs 0..1 (L) RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA location 0..1 RW See clause 9.6.1.3. NA cseType 0..1 RO Indicates the type of CSE represented by the created resource: • Mandatory for an IN-CSE, hence multiplicity (1). • Its presence is subject to SP configuration in case of an ASN-CSE or a MN-CSE. NA CSE-ID 1 RO The CSE identifier in SP-relative CSE-ID format (clause 7.2). NA supportedResourceType 1 (L) RO List of the resource types which are supported in the CSE. This attribute contains subset of resource types listed in clause 9.2. NA pointOfAccess 1 (L) RO Represents the list of physical addresses to be used by remote CSEs to connect to this CSE (e.g. IP address, FQDN). This attribute is exposed to its Registree. NA nodeLink 0..1 RO The resource identifier of a <node> resource that stores the node specific information of the node on which the CSE represented by this <CSEBase> resource resides. NA notificationCongestionPolicy 0..1 RO This attribute applies to CSEs generating subscription notifications. It specifies the rule which is applied when the storage of notifications for each subscriber (an AE or CSE) reaches the maximum storage limit for notifications for that subscriber. E.g. Delete stored notifications of lower notificationStoragePriority to make space for new notifications of higher notificationStoragePriority, or delete stored notifications of older creationTime to make space for new notifications when all notifications are of the same notificationStoragePriority. NA contentSerialization 0..1 (L) RO The list of supported serializations of the Content primitive parameter for receiving a request from its registrants. (e.g. XML, JSON). The list shall be ordered so that the most preferred format comes first. NA e2eSecInfo 0..1 RO See clause 9.6.1.3. MA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 148 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <CSEBase> Multiplicity RW/ RO/ WO Description <CSEBaseAnnc> Attributes supportedReleaseVersions 0..1 (L) RO List of oneM2M release versions which are supported by the CSE. Starting with Release 2, this attribute is mandatory for a CSE. For CSEs compliant to older releases, this attribute is optional. For CSEs that do not include this attribute, the default release version shall be Release 1. MA currentTime 0..1 RO When the CSE receives a retrieve request targeting this resource or attribute, the CSE samples its current time (e.g. makes an OS call to get the system time) and respond with the value in this attribute. An Originator retrieving this attribute can use this time value to adjust and synchronize its time value to the time value of this CSE. NA
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.4 Resource Type remoteCSE	A <remoteCSE> resource shall represent a Registree CSE that is registered to the Registrar CSE. <remoteCSE> resources shall be located directly under the <CSEBase> resource of Registrar CSE. Similarly <remoteCSE> resource shall also represent a Registrar CSE. <remoteCSE> resource shall be located directly under the <CSEBase> resource of Registree CSE. For example, when CSE1 (Registree CSE) registers with CSE2 (Registrar CSE), there will be two <remoteCSE> resources created: one in CSE1: <CSEBase1>/<remoteCSE2> and one in CSE2: <CSEBase2>/<remoteCSE1>. Note that the creation of the two resources does not imply mutual registration. The <CSEBase1>/<remoteCSE2> does not mean CSE2 registered with CSE1 in the example above. The <remoteCSE> resource shall contain the child resources specified in table 9.6.4-1. Table 9.6.4-1: Child resources of <remoteCSE> resource Child Resources of <remoteCSE> Child Resource Type Multiplicity Description <remoteCSEAnnc> Child Resource Types [variable] <container> 0..n See clause 9.6.6 <container> [variable] <containerAnnc> 0..n Announced variant of <container>. See clause 9.6.6 <containerAnnc> [variable] <flexContainer> 0..n See clause 9.6.35 <flexContainer> [variable] <flexContaineAnnc> 0..n Announced variant of <flexContainer>. See clause 9.6.35 <flexContainerAnnc> [variable] <group> 0..n See clause 9.6.13 <group> [variable] <groupAnnc> 0..n Announced variant of <group>. See clause 9.6.13 <groupAnnc> [variable] <accessControlPolicy> 0..n See clause 9.6.2 <accessControlPolicy> [variable] <accessControlPolicyAn nc> 0..n Announced variant of <accessControlPolicy>. See clause 9.6.2 <accessControlPolicyAnnc> [variable] <subscription> 0..n See clause 9.6.8 <subscription> ETSI ETSI TS 118 101 V4.15.0 (2022-09) 149 (oneM2M TS-0001 version 4.15.0 Release 4) Child Resources of <remoteCSE> Child Resource Type Multiplicity Description <remoteCSEAnnc> Child Resource Types [variable] <pollingChannel> 0..1 See clause 9.6.21. If requestReachability is FALSE, the CSE that created this <remoteCSE> resource should create a <pollingChannel> resource and perform long polling. The <pollingChannel> shall be utilized by the parent resource None [variable] <nodeAnnc> 0..n Announced variant of <node>. This announced resource is associated with a <node> resource that is hosted on a CSE which is represented by the parent <remoteCSE> or <remoteCSEAnnc> resource. See clause 9.6.18 for <node> <nodeAnnc> [variable] <dynamicAuthorizationC onsultation> 0..n See clause 9.6.40 [variable] <timeSeries> 0..n See clause 9.6.36 <timeSeries> [variable] <timeSeriesAnnc> 0..n Announced variant of <timeSeries>. See clause 9.6.36 <timeSeriesAnnc> [variable] <AEAnnc> 0..n Announced variant of <AE>. See clause 9.6.5 <AEAnnc> [variable] <locationPolicyAnnc> 0..n Announced variant of <locationPolicy>. See clause 9.6.10 <locationPolicyAnnc> [variable] <transactionMgmt> 0..n See clause 9.6.47 <transactionMgmt> [variable] <transaction> 0..n See clause 9.6.48 <transaction> [variable] <ontologyRepositoryAnn c> 0..1 Announced variant of <ontologyRepository>. See clause 9.6.50 <ontologyRepositoryAnnc> [variable] <ontologyMappingAnnc> 0..n Announced variant of <ontologyMapping>. See clause 9.6.70 <ontologyMappingAnnc> [variable] <ontologyMappingAlgorit hmRepositoryAnnc> 0..n Announced variant of <ontologyMappingAlgorithmR epository>. See clause 9.6.71 <ontologyMappingAlgorithm RepositoryAnnc> [variable] <semanticMashupJobPr ofile> 0..n See clause 9.6.53 <semanticMashupJobProfile > [variable] <semanticMashupJobPr ofileAnnc> 0..n Announced variant of <semanticMashupJobProfile> . See clause 9.6.53 <semanticMashupJobProfile Annc> [variable] <semanticMashupInstan ce> 0..n See clause 9.6.54 <semanticMashupInstance> [variable] <semanticMashupInstan ceAnnc> 0..n Announced variant of <semanticMashupInstance >. See clause 9.6.54 <semanticMashupInstanceA nnc> [variable] <action> 0..n See clause 9.6.61 <actionAnnc> [variable] <e2eQosSession> 0..1 See clause 9.6.63 <e2eQosSession> [variable] <nwMonitoringReq> 0..n See clause 9.6.64 <nwMonitoringReq> [variable] <softwareCampaign> 0..n See clause 9.6.76 <softwareCampaignAnnc> ETSI ETSI TS 118 101 V4.15.0 (2022-09) 150 (oneM2M TS-0001 version 4.15.0 Release 4) The <remoteCSE> resource shall contain the attributes specified in table 9.6.4-2. Table 9.6.4-2: Attributes of <remoteCSE> resource Attributes of <remoteCSE> Multiplicity RW/ RO/ WO Description <remoteCSEAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. MA labels 0..1 (L) RW See clause 9.6.1.3. MA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationCon sultationIDs 0..1 (L) RW See clause 9.6.1.3. OA location 0..1 RW See clause 9.6.1.3. OA custodian 0..1 RW See clause 9.6.1.3. NA cseType 0..1 WO Indicates the type of CSE represented by the created resource. • Mandatory for an IN-CSE, hence multiplicity (1). • Its presence is subject to SP configuration in case of an ASN-CSE or a MN-CSE. OA pointOfAccess 0..1 (L) RW For request-reachable remote CSE it represents the list of physical addresses to be used to connect to it (e.g. IP address, FQDN). If this information is not provided and <pollingChannel> resource does exist, the CSE should use <pollingChannel> resource. Then the Hosting CSE can forward a request to the CSE without using the PoA. OA CSEBase 1 WO The address of the <CSEBase> resource represented by this <remoteCSE> resource. OA CSE-ID 1 WO The CSE identifier of the remote CSE represented by this <remoteCSE> resource (clause 7.2). OA M2M-Ext-ID 0..1 RW See clause 7.1.8 where this attribute is described. This attribute is used only for the case of dynamic association of M2M- Ext-ID and CSE-ID. NA Trigger-Recipient-ID 0..1 RW See clause 7.1.10 where this attribute is described. This attribute is used only for the case of dynamic association of M2M-Ext-ID and CSE-ID. NA requestReachability 1 RW This attribute is an indication of static capability of the CSE that created this <remoteCSE> resource. If the CSE can receive requests originated at or forwarded by its registrar CSE, this attribute is set to "TRUE" otherwise "FALSE" (see note 1). OA nodeLink 0..1 RW The resource identifier of a <node> resource that stores the node specific information of the node on which the CSE represented by this <remoteCSE> resource resides. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 151 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <remoteCSE> Multiplicity RW/ RO/ WO Description <remoteCSEAnnc> Attributes contentSerialization 0..1 (L) RW The list of supported serializations of the Content primitive parameter for receiving a request (e.g. XML, JSON). The list shall be ordered so that the most preferred format comes first. OA e2eSecInfo 0..1 RW See clause 9.6.1.3. MA triggerReferenceNumber 0..1 RW This is to identify device trigger procedure request. This attribute is used only for device trigger and assigned by the CSE. NA descendantCSEs 0..1(L) RW This attribute contains a list of identifiers of descendent CSEs of the Registree CSE represented by this <remoteCSE> resource. A descendant CSE is a CSE that either registers to the CSE represented by this <remoteCSE>, or registers to another CSE which is a descendant CSE of this <remoteCSE>. The Registree CSE represented by this <remoteCSE> shall configure this attribute with a list of descendent CSEs upon creation of the <remoteCSE> resource. The Registree CSE shall update this attribute whenever a new descendent CSE either registers or de- registers. The Registree CSE shall detect when a descendent CSE registers or de- registers by monitoring its <remoteCSE> resources and the descendent CSEs attribute(s) of these <remoteCSE> resources. For a <remoteCSE> resource representing a Registrar CSE this attribute shall not be set. OA multicastCapability 0..1 RW Indicates the oneM2M node multicast Capability, pre-defined values are: • MBMS. • IP. OA externalGroupID 0..1 RW It is used by an M2M Service Provider (M2M SP) when services targeted to a group of M2M Devices are requested from the Underlying Network. It is assumed to be a globally unique ID exposed by the underlying network to identify a group of M2M Devices (e.g. ASN, MN) for group related services. OA triggerEnable 0..1 RW When set to "TRUE", trigger requests may be sent to the CSE represented by this <remoteCSE> resource. When set to "FALSE" trigger requests shall not be sent to this CSE. OA activityPatternElements 0..1(L) RW This attribute describes the anticipated availability of the CSE for communications. See further description below and table 9.6.4-3. OA supportedReleaseVersio ns 0..1(L) RW The oneM2M release versions supported by the CSE represented by this <remoteCSE> resource. Starting with Release 2, this attribute is mandatory for a CSE. For CSEs compliant to older releases, this attribute is optional. For CSEs that do not include this attribute, the default release version shall be Release 1. MA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 152 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <remoteCSE> Multiplicity RW/ RO/ WO Description <remoteCSEAnnc> Attributes enableTimeCompensatio n 0..1 RW Enables time offset compensation functionality. When set to "TRUE", the Registrar CSE peforms time offset compensation for the Registree CSE. If "FALSE", the Registrar CSE does not perform time offset compensation. See clause 10.2.24. Default value is "FALSE". NA NOTE-1: Even if this attribute is set to "FALSE", it is not meant that the CSE is always unreachable by its registrees. E.g. if the CSE and its registrees are behind the same NAT, then the CSE can receive requests from its registrees. See also pollingChannel description in clause 9.6.21. NOTE-2: For the case of a response, this attribute is applicable if the corresponding request does not contain the serialization format of the Content request parameter to allow a CSE to determine the proper serialization format to use in the response. The set of activity patterns represented in the activityPatternElements attribute describes the anticipated availability of the CSE for communications. The set provides the anticipated activity timing pattern, and may provide additional information about the anticipated mobility status and expected data size to be exchanged. Each activityPatternElements item is comprised of triples (scheduleElement, stationaryIndication, dataSizeIndicator) with parameters shown and described in table 9.6.4-3. Table 9.6.4-3: Parameters in activityPatternElements triple Name Description scheduleElement See clause 9.6.9. This parameter shall be composed from seven fields of second, minute, hour, day of month, month, day of week and year. This is a mandatory parameter in the triple. This parameter indicates the times when the entity is available to send and receive primitives. stationaryIndication It indicates the field node as 'Stationary (Stopping)' or 'Mobile (Moving)' for the traffic pattern. The default value is NULL, denoting that no stationaryIndication is provided. dataSizeIndicator It indicates the expected data size for the traffic pattern. The default value is NULL, denoting that no dataSizeIndicator is provided.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.5 Resource Type AE	An <AE> resource shall represent information about an Application Entity registered to a CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 153 (oneM2M TS-0001 version 4.15.0 Release 4) The <AE> resource shall contain the child resources specified in table 9.6.5-1. Table 9.6.5-1: Child resources of <AE> resource Child Resources of <AE> Child Resource Type Multiplicity Description <AEAnnc> Child Resource Types [variable] <semanticDescriptor> 0..n See clause 9.6.30 <semanticDescriptor>, <semanticDescriptorA nnc> [variable] <subscription> 0..n See clause 9.6.8 <subscription> [variable] <container> 0..n See clause 9.6.6 <container> <containerAnnc> [variable] <flexContainer> 0..n See clause 9.6.35 <flexContainer> <flexContainerAnnc> [variable] <group> 0..n See clause 9.6.13 <group> <groupAnnc> [variable] <accessControlPolicy> 0..n See clause 9.6.2 <accessControlPolicy> <accessControlPolicyA nnc> [variable] <pollingChannel> 0..1 See clause 9.6.21 When the AE is request- unreachable, the AE should create this <pollingChannel> resource and perform long polling. The <pollingChannel> shall be utilized by the parent resource None [variable] <dynamicAuthorizationC onsultation> 0..n See clause 9.6.40 None [variable] <timeSeries> 0..n See clause 9.6.36 <timeSeries> <timeSeriesAnnc> [variable] <transactionMgmt> 0..n See clause 9.6.47 <transactionMgmt> [variable] <transaction> 0..n See clause 9.6.48 <transaction> [variable] <triggerRequest> 0..n See clause 9.6.49 None [variable] <multimediaSession> 0..n See Clause 9.6.57. This resource holds information describing the established multimedia session None [variable] <semanticMashupInstan ce> 0..n See clause 9.6.54 <semanticMashupInst ance> <semanticMashupInst anceAnnc> [variable] <locationPolicy> 0..n See clause 9.6.10 <locationPolicyAnnc> [variable] <action> 0..n See clause 9.6.61 None [variable] <e2eQosSession> 0..1 See clause 9.6.63 <e2eQosSession> [variable] <nwMonitoringReq> 0..n See clause 9.6.64 <nwMonitoringReq > [variable] <softwareCampaign> 0..n See clause 9.6.76 <softwareCampaignAn nc> The <AE> resource shall contain the attributes specified in table 9.6.5-2. Table 9.6.5-2: Attributes of <AE> resource Attributes of <AE> Multiplicity RW/ RO/ WO Description <AEAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. Contains the AE-ID-Stem of the AE (see clause 7.2 on identifier formats and clause 10.2.2.2 for AE registration procedure). NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. MA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 154 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <AE> Multiplicity RW/ RO/ WO Description <AEAnnc> Attributes creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA labels 0..1 (L) RW See clause 9.6.1.3. MA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationCon sultationIDs 0..1 (L) RW See clause 9.6.1.3. OA location 0..1 RW See clause 9.6.1.3. OA custodian 0..1 RW See clause 9.6.1.3. NA appName 0..1 RW The name of the application, as declared by the application developer (e.g. "HeatingMonitoring"). Several sibling resources may share the appName. OA App-ID 1 WO The identifier of the Application (see clause 7.1.3). OA AE-ID 1 RO The identifier of the Application Entity (see clause 7.1.2). OA M2M-Ext-ID 0..1 RW See clause 7.1.8 where this attribute is described. This attribute is used only for the case of dynamic association of M2M-Ext-ID and AE-ID. NA trigger-Recipient-ID 0..1 RW See clause 7.1.10 where this attribute is described. This attribute is used only for the case of dynamic association of M2M-Ext-ID and AE-ID. NA triggerReferenceNumber 0..1 RW This is to identify device trigger procedure request. This attribute is used only for device trigger and assigned by the CSE. NA pointOfAccess 0..1 (L) RW The list of addresses for communicating with the registered Application Entity over Mca reference point via the transport services provided by Underlying Network (e.g. IP address, FQDN, URI). This attribute shall be accessible only by the AE and the Hosting CSE. If this information is not provided and the <pollingChannel> resource does exist, the AE should use <pollingChannel> resource. Then the Hosting CSE can forward a request to the AE without using the PoA. OA registrationStatus 0..1 RW Denotes status of the AE registration. If ACTIVE, the <AE> resource and all its child resources may be discoverable. If INACTIVE, the <AE> resource and all its child resources shall not be discoverable. Set to ACTIVE during an AE registration or re-registration. When an AE changes its registration point, the registration at the old registration point is set to INACTIVE. OA trackRegistrationPoints 0..1 RW Denotes if the Application Entity requests that its Registration Points be tracked. If TRUE, AE requests to be tracked as it changes its Registration Points. If FALSE, the AE requests not to be tracked as it changes its Registration Points. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 155 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <AE> Multiplicity RW/ RO/ WO Description <AEAnnc> Attributes ontologyRef 0..1 RW A URI of the ontology used to represent the information that is managed and understood by the AE. OA requestReachability 1 RW This attribute is an indication of static capability of the AE that created this <AE> resource. If the AE can receive requests originated at or forwarded by its registrar CSE, this attribute is set to "TRUE" otherwise "FALSE". OA nodeLink 0..1 RW The resource identifier of a <node> resource that stores the node specific information of the node on which the AE represented by this <AE> resource resides. OA contentSerialization 0..1 (L) RW The list of supported serializations of the Content primitive parameter for receiving a request and a response from its registrar CSE. (e.g. XML, JSON, CBOR). The list shall be ordered so that the most preferred format comes first. OA e2eSecInfo 0..1 RW See clause 9.6.1.3. MA activityPatternElements 0..1(L) RW This attribute describes the anticipated availability of the AE for communications. See further description below and table 9.6.4-3. OA triggerEnable 0..1 RW When set to "TRUE", trigger requests may be sent to the AE represented by this <AE> resource. When set to "FALSE" trigger requests shall not be sent to this AE. OA sessionCapabilities 0..1 (L) RW The list of supported session media types (e.g. audio, video, image) and supported session protocols (e.g. RTP, RTP/AVP) as defined by session parameters as defined by the IETF IANA Session Descriptor Protocol (SDP) Parameter Registry. OA supportedReleaseVersion s 0..1(L) RW The oneM2M release versions supported by the Registree AE represented by this <AE> resource. Starting with Release 2, this attribute is mandatory for an AE. For AEs compliant to older releases, this attribute is optional. For AEs that do not include this attribute, the default release version shall be Release 1. MA externalGroupID 0..1 RW It is used by an M2M Service Provider (M2M SP) when services targeted to a group of M2M Devices are requested from the Underlying Network. It is assumed to be a globally unique ID exposed by the underlying network to identify a group of M2M Devices (e.g. ADN, ASN, MN) for group related services. OA enableTimeCompensatio n 0..1 RW Enables time offset compensation functionality. When set to "TRUE", the Registrar CSE peforms time offset compensation for the Registree AE. If "FALSE", the Registrar CSE does not perform time offset compensation. See clause 10.2.24. Default value is "FALSE". NA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 156 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <AE> Multiplicity RW/ RO/ WO Description <AEAnnc> Attributes NOTE: For the case of a response, this attribute is applicable if the corresponding request does not contain the serialization format of the Content request parameter to allow a CSE to determine the proper serialization format to use in the response. The set of activity patterns represented in the activityPatternElements attribute describes the anticipated availability of the AE for communications. The set provides the anticipated activity timing pattern and might provide additional information about the anticipated mobility status and expected data size to be exchanged. Each activityPatternElements item is comprised of triples (scheduleElement, stationaryIndication, datasizeIndicator) with parameters shown and described in table 9.6.4-3.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.6 Resource Type container	The <container> resource represents a container for data instances. It is used to share information with other entities and potentially to track the data. A <container> resource has no associated content. It has only attributes and child resources. The <container> resource shall contain the child resources specified in table 9.6.6-1. Table 9.6.6-1: Child resources of <container> resource Child Resources of <container> Child Resource Type Multiplicity Description <containerAnnc> Child Resource Types [variable] <semanticDescriptor> 0..n See clause 9.6.30 <semanticDescriptor>, <semanticDescriptorAnnc> [variable] <contentInstance> 0..n See clause 9.6.7 <contentInstance>, <contentInstanceAnnc> [variable] <subscription> 0..n See clause 9.6.8 <subscription> [variable] <container> 0..n See clause 9.6.6 <container> <containerAnnc> [variable] <flexContainer> 0..n See clause 9.6.35 <flexContainer> <flexContainerAnnc> [variable] <timeSeries> 0..n See clause 9.6.36 <timeSeries>, <timeSeriesAnnc> la <latest> 1 See clause 9.6.27 None ol <oldest> 1 See clause 9.6.28 None [variable] <transaction> 0..n See clause 9.6.48 <transaction> [variable] <action> 0..n See clause 9.6.61 None The <container> resource shall contain the attributes specified in table 9.6.6-2. Table 9.6.6-2: Attribute of <container> resource Attributes of <container> Multiplicity RW/ RO/ WO Description <containerAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. MA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA stateTag 1 RO See clause 9.6.1.3. NA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationCon sultationIDs 0..1 (L) RW See clause 9.6.1.3. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 157 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <container> Multiplicity RW/ RO/ WO Description <containerAnnc> Attributes creator 0..1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA location 0..1 RW See clause 9.6.1.3. OA maxNrOfInstances 0..1 RW Maximum number of direct child <contentInstance> resources in the <container> resource. OA maxByteSize 0..1 RW Maximum size in bytes of data (i.e. content attribute of a <contentInstance> resource) that is allocated for the <container> resource for all direct child <contentInstance> resources in the <container> resource. OA maxInstanceAge 0..1 RW Maximum age of a direct child <contentInstance> resource in the <container> resource. The value is expressed in seconds. OA currentNrOfInstances 1 RO Current number of direct child <contentInstance> resource in the <container> resource. It is limited by the maxNrOfInstances. The currentNrOfInstances attribute of the <container> resource shall be updated on successful creation or deletion of direct child <contentInstance> resource of <container> resource. NA currentByteSize 1 RO Current size in bytes of data (i.e. content attribute of a <contentInstance> resource) stored in all direct child <contentInstance> resources of a <container> resource. This is the summation of contentSize attribute values of the <contentInstance> resources. It is limited by themaxByteSize. The currentByteSize attribute of the <container> resource shall be updated on successful creation of deletion of direct child <contentInstance> resource of <container> resource. NA locationID 0..1 RO An ID of the resource where the attributes/policies that define how location information are obtained and managed. This attribute is defined only when the <container> resource is used for containing location information. OA ontologyRef 0..1 RW A reference (URI) of the ontology used to represent the information that is stored in the child <contentInstance> resources of the present <container> resource (see note). OA disableRetrieval 0..1 RW Boolean value to control RETRIE/UPDATE/DELETE operation on the child <contentInstance> resource. When the value is set to "TRUE", RETRIEVE/DELETE/UPDATE operations for child <contentInstance> shall be rejected at all times. When the value is updated from "TRUE" to "FALSE", all existing <contentInstance> are deleted immediately. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 158 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <container> Multiplicity RW/ RO/ WO Description <containerAnnc> Attributes When the value is set to "FALSE", all operations are permitted on the <contentInstance> resource as per existing procedures. NOTE: The access to this URI is out of scope of oneM2M.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.7 Resource Type contentInstance	The <contentInstance> resource represents a data instance in the <container> resource. The content of the contentInstance can be encrypted. Unlike other resources, the <contentInstance> resource shall not be modified once created. This pertains to its attributes, but not to the creation of child resources. An AE shall be able to delete a contentInstance resource explicitly or it may be deleted by the platform based on policies. If the platform has policies for contentInstance retention, these shall be represented by the attributes maxByteSize, maxNrOfInstances and/or maxInstanceAge attributes in the <container> resource. If multiple policies are in effect, the strictest policy shall apply. The <contentInstance> resource inherits the same access control policies of the parent <container> resource, and does not have its own accessControlPolicyIDs attribute. The <contentInstance> resource shall contain the child resources specified in table 9.6.7-1. Table 9.6.7-1: Child resources of <contentInstance> resource Child Resources of <contentInstance> Child Resource Type Multiplicity Description <contentInstanceAnnc> Child Resource Types [variable] <semanticDescriptor> 0..n See clause 9.6.30 <semanticDescriptor>, <semanticDescriptorAnnc> [variable] <transaction> 0..n See clause 9.6.48 <transaction> The <contentInstance> resource shall contain the attributes specified in table 9.6.7-2. Table 9.6.7-2: Attributes of <contentInstance> resource Attributes of <contentInstance> Multiplicity RW/ RO/ WO Description <contentInstan ceAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA labels 0..1 (L) WO See clause 9.6.1.3. MA expirationTime 1 WO See clause 9.6.1.3. NA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA stateTag 1 RO See clause 9.6.1.3. The stateTag attribute of the parent resource should be incremented first and copied into this stateTag attribute when a new instance is added to the parent resource. NA announceTo 0..1 (L) WO See clause 9.6.1.3. NA announcedAttribute 0..1 (L) WO See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA creator 0..1 RO See clause 9.6.1.3. NA contentInfo 0..1 WO This attribute contains information to understand the content s of content attribute. It shall be composed of two mandatory components consisting of OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 159 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <contentInstance> Multiplicity RW/ RO/ WO Description <contentInstan ceAnnc> Attributes Internet Media Type (as defined in the IETF RFC 6838 [i.36]) and an encoding type. In addition, an optional content security component may also be included. The format of this attribute is defined in ETSI TS 118 104 [3]. This attribute should be used so that AEs can understand the content. If the value of contentInfo is a supported representation of semantic information, as defined in ETSI TS 118 104 [3], the value of content shall be handled as semantic information with respect to the supported semantic oneM2M functionalities. contentSize 1 RO Size in bytes of the content attribute. NA contentRef 0..1 WO This attribute contains a list of name- value pairs. Each entry expresses and associative reference to a <contentInstance> resource. The name of the entry indicates the relationship and the value of the entry the indicates reference (URI) to the resource. OA ontologyRef 0..1 WO A reference (URI) of the ontology used to represent the information that is stored in the contentInstances resources of the <container> resource. If this attribute is not present, the contentInstance resource inherits the ontologyRef from the parent <container> resource if present (see note). OA content 1 WO Actual content of a contentInstance. This content may be opaque data for understandable with the help of the contentInfo. This may, for example, be an image taken by a security camera, or a temperature measurement taken by a temperature sensor. OA deletionCnt 0..1 WO A decremental counter used to indicate that the resource shall be deleted by the Hosting CSE when the value becomes 0. If configured, initial value for this attribute shall be greater than 0 and it shall be decremented on every successful retrieval of the resource. This attribute is optional. A successful RETRIEVE operation to the <contentInstance> resource decrements the counter by 1. A notification for a new <contentInstance> resource creation decremenets the counter by 1. A single notification event regardless of the number of subscriptions, possibly generating multiple notifications, is considered as one retrieval. NA NOTE: Access to this URI is out of scope of oneM2M. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 160 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.8 Resource Type subscription	The <subscription> resource contains subscription information for its subscribed-to resource. A subscription to a resource allows an entity in the oneM2M architecture to be notified about changes of the subscribed- to resource. The <subscription> resource shall represent a subscription to a subscribed-to resource. In order to establish a subscription, a <subscription> resource shall be created as a child resource of the subscribed-to resource. The <subscription> child resource contains information about the exact scope of the subscription and targets to be notified. For example, a <container> resource having a <subscription> resource as a child resource (see clause 9.6.6) shall result in notification(s) of target(s) configured in the <subscription> child resource when changes to the parent <container> resource matching with notification event criteria described by the child <subscription> resource occur. A <subscription> resource shall be deleted when the parent subscribed-to resource is deleted. In general, an Originator shall be able to create a resource of <subscription> resource type when the Originator has RETRIEVE privilege to the subscribed-to resource. The Originator which creates a <subscription> resource becomes the resource subscriber. A <subscription> resource can be configured to implement a blocking "UPDATE" to a resource or attributes of a resource whereby a notification is sent to the notification target to respond with the result of the "UPDATE" request. Each <subscription> may include notification policies that specify which, when, and how notifications are sent. These notification policies may work in conjunction with CMDH policies. When a <subscription> resource is deleted, a Notify request shall be sent to the target indicated by the attribute subscriberURI if it is provided by the Subscriber. The <subscription> resource shall contain the child resources specified in table 9.6.8-1. Table 9.6.8-1: Child resources of <subscription> resource Child Resources of <subscription> Child Resource Type Multiplicity Description notificationSchedule <schedule> 0..1 In the context of the <subscription> resource, the notificationSchedule specifies when notifications may be sent by the Hosting CSE to the notificationURI(s). See clause 9.6.9. [variable] <notificationTarget MgmtPolicyRef> 0..n See 9.6.31 for this type of resource. nstr <notificationTarget SelfReference> 1 See 9.6.34 for this type of resource. [variable] <transaction> 0..n See clause 9.6.48. The <subscription> resource shall contain the attributes specified in table 9.6.8-2. Table 9.6.8-2: Attributes of <subscription> resource Attributes of <subscription> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. dynamicAuthorizationCon sultationIDs 0..1 (L) RW See clause 9.6.1.3. creator 0..1 RO See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 161 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <subscription> Multiplicity RW/ RO/ WO Description eventNotificationCriteria 0..1 RW This attribute (notification policy) indicates the event criteria for which a notification is to be generated. When no eventNotificationCriteria attribute is present in a <subscription> resource, the Hosting CSE shall trigger notifications for this subscription when any of the attributes of the subscribed-to resource is modified. expirationCounter 0..1 RW This attribute (notification policy) indicates that the subscriber wants to set the life of this subscription to a limit of a maximum number of notifications. When the number of notifications sent reaches the count of this counter, the <subscription> resource shall be deleted, regardless of any other policy. notificationURI 1 (L) RW This attribute shall be configured as a list consisting of one or more targets that the Hosting CSE shall send notifications to. A target shall be formatted as a oneM2M compliant Resource- ID as defined in clause 7.2 or as an identifier compliant with a oneM2M supported protocol binding (e.g. http, coap, mqtt). If a target is formatted as a oneM2M compliant Resource-ID, then the target shall be formatted as a structured or unstructured CSE-Relative-Resource-ID, SP-Relative- Resource-ID, and/or Absolute-Resource-ID of an <AE> or <CSEBase> resource. A Hosting CSE shall use this information to determine proper pointOfAccess, requestReachability and/or pollingChannel information needed to send a notification to the target. The following is an example. • /CSE0001/AE0001 For a target that is formatted as an identifier compliant with a oneM2M supported protocol binding, the details of this format are defined by the respective oneM2M protocol specification. The following is an example of an HTTP URI compliant with oneM2M HTTP protocol binding. • https://172.25.30.25:7000/notification/handler For a subscription to a <fanoutpoint> resource, if <subscription> resource in request contains a notificationForwardingURI, then the group hosting CSE shall configure the notificationURI of the fanout subscription request with an address specified by the Group Hosting CSE that can be used by the Group Hosting CSE to receive aggregated notifications. A notification serialization type may be appended to each notification target configured in this list. The Hosting CSE shall serialize notifications and send it to a notification target based on this serialization type indicator. Possible serialization types are defined in ETSI TS 118 104 [3] (e.g. XML, JSON or CBOR). If a notification serialization type is not appended to a notification target, a default shall apply based on the Hosting CSE local policy. The syntax for appending a serialization type to a notification target shall use the "?" delimiter character as shown in the below examples. • http://mydomain/notificationHandler?ct=json • CSE02/base/ae2?ct=xml groupID 0..1 RW The ID of a <group> resource in case the subscription is made through a group. This attribute may be used in the Filter Criteria to discover all subscription resources created via a <fanOutPoint> resource to a specific groupID. notificationForwardingURI 0..1(L) RW The attribute shall be present only for group related subscriptions. If the subscriber intends the Group Hosting CSE to aggregate the notifications, the attribute shall be set identical to the notificationURI attribute. It shall be used by Group Hosting CSE for forwarding aggregated notifications. See clauses 10.2.7.10 and 10.2.7.11. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 162 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <subscription> Multiplicity RW/ RO/ WO Description batchNotify 0..1 RW This attribute (notification policy) indicates that the subscription originator wants to receive batches of notifications rather than receiving them one at a time. This attribute includes: the number of notifications to be batched for delivery and the duration. When only the number is specified by the subscription originator, the Hosting CSE shall set the default duration given by M2M Service Provider. If batchNotify is used simultaneously with latestNotify, only the latest notification shall be sent and have the Event Category set to "latest". rateLimit 0..1 RW This attribute (notification policy) indicates that the subscriber wants to limit the rate at which it receives notifications. This attribute expresses the subscriber's notification policy and includes two values: a maximum number of events that may be sent within some duration, and the rateLimit window duration. When the number of generated notifications within the rateLimit window duration exceeds the maximum number, notification events are temporarily stored, until the end of the window duration, when the sending of notification events restarts in the next window duration. The sending of notification events continues as long as the maximum number of notification events is not exceeded during the window duration. The rateLimit policy may be used simultaneously with other notification policies. preSubscriptionNotify 0..1 WO This attribute (notification policy) indicates that the subscriber wants to be sent notifications for events that were generated prior to the creation of this subscription. This attribute has a value of the number of prior notification events requested. If up-to-date caching of retained events is supported on the Hosting CSE and contains the subscribed events, then prior notification events will be sent up to the number requested. The preSubscriptionNotify policy may be used simultaneously with any other notification policy. pendingNotification 0..1 RW This attribute (notification policy), if set, indicates how missed notifications due to a period of no connectivity are handled (according to the reachability and notification schedules). The possible values for pendingNotification are: • "sendLatest"; • "sendAllPending". This policy depends upon caching of retained notifications on the hosted CSE. When this attribute is set to "sendLatest", only the last notification shall be sent and it shall have the Event Category set to "latest". If this attribute is not present, the Hosting CSE sends no missed notifications. This policy applies to all notifications regardless of the selected delivery policy (batchNotify, latestNotify, etc.). Note that unreachability due to reasons other than scheduling is not covered by this policy. notificationStoragePriority 0..1 RW Indicates that the subscriber wants to set a priority for this subscription relative to other subscriptions belonging to this same subscriber. This attribute sets a number within the priority range. When storage of notifications exceeds the allocated size, this policy is used as an input with the storage congestion policy (notificationCongestionPolicy) specified in clause 9.6.3 to determine which stored and generated notifications to drop and which ones to retain. latestNotify 0..1 RW This attribute (notification policy) indicates if the subscriber wants only the latest notification. If multiple notifications of this subscription are buffered, and if the value of this attribute is set to true, then only the last notification shall be sent and it shall have the Event Category value set to "latest". ETSI ETSI TS 118 101 V4.15.0 (2022-09) 163 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <subscription> Multiplicity RW/ RO/ WO Description notificationContentType 1 RW Indicates a notification content type that shall be contained in notifications. For example, "modified attributes" or "all attributes". • For a list of the default and allowed values of notificationContentType for each of the supported values of notificationEventType refer to table 9.6.8-4. notificationEventCat 0..1 RW This attribute (notification policy) indicates the subscriber's requested Event Category to be used for notification messages generated by this subscription. subscriberURI 0..1 WO This attribute shall be configured with the target of the subscriber. The target is used by the Hosting CSE to determine where to send a notification when the subscription is deleted. A target shall be formatted as a oneM2M compliant Resource-ID as defined in clause 7.2 or as an identifier compliant with one of the oneM2M supported protocol bindings (the detailed format of which are defined by each respective oneM2M protocol binding specification). associatedCrossResourc eSub 0..1 RW This attribute lists the identifier of <crossResourceSubscription> resources where this <subscription> is involved in. primitiveProfileID 0..1 RW This attribute lists the identifier of a <primitiveProfile> resource that specifies attributes and parameters to be added, removed, or modified in the notifications for this subscription. notificationStatsEnable 1 RW When set to "TRUE", the Hosting CSE shall clear any statistics that were previously stored in the notificationStatsInfo attribute and start recording notification statistics for each notification generated for this resource. When set to "FALSE", the Hosting CSE shall stop recording notification statistics for this resource and maintain the current value of the notificationStatsInfo attribute. Default is "FALSE". notificationStatsInfo 0..1(L) RO A list containing notification statistics recorded by the Hosting CSE for each notification target specified by the notificationURI attribute of this resource. The Hosting CSE shall maintain a separate set of notification statistics that include: • Total number of notification requests sent to a notification target • Total number of notification responses received from a notification target Refer to ETSI TS 118 104 [3] for further details regarding the format of this attribute. Table 9.6.8-3 describes the eventNotificationCriteria conditions. Table 9.6.8-3: eventNotificationCriteria conditions Condition tag Multiplicity Matching condition createdBefore 0..1 The creationTime attribute of the resource is chronologically before the specified value. createdAfter 0..1 The creationTime attribute of the resource is chronologically after the specified value. modifiedSince 0..1 The lastModifiedTime attribute of the resource is chronologically after the specified value. unmodifiedSince 0..1 The lastModifiedTime attribute of the resource is chronologically before the specified value. stateTagSmaller 0..1 The stateTag attribute of the resource is smaller than the specified value. stateTagBigger 0..1 The stateTag attribute of the resource is bigger than the specified value. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 164 (oneM2M TS-0001 version 4.15.0 Release 4) Condition tag Multiplicity Matching condition expireBefore 0..1 The expirationTime attribute of the resource is chronologically before the specified value. expireAfter 0..1 The expirationTime attribute of the resource is chronologically after the specified value. sizeAbove 0..1 The contentSize attribute of the <contentInstance> resource is equal to or greater than the specified value. sizeBelow 0..1 The contentSize attribute of the <contentInstance> resource is smaller than the specified value. notificationEventType 0..5 The type of event that shall trigger a notification. If multiple notificationEventType tags are present, a notification shall be triggered if any of the configured events occur. Note that not all combinations of event type are meaningful. Possible notification event type values are: A. Update to attributes of the subscribed-to resource B. Deletion of the subscribed-to resource, C. Creation of a direct child of the subscribed-to resource, D. Deletion of a direct child of the subscribed-to resource E. An attempt to retrieve a <contentInstance> direct-child- resource of a subscribed-to <container> resource is performed while this <contentInstance> child resource is an obsolete resource or the reference used for retrieving this resource is not assigned. This retrieval is performed by a RETRIEVE request targeting the subscribed-to resource with the Result Content parameter set to either "child-resources" or "attributes+child-resources". This value for the notificationEventType tag implies that the subscribed- to resource shall be an <container> resource. Otherwise this setting is not valid. F. Trigger Received targeting the MN/ASN-AE associated with the <AE> parent resource. This implies that the subscribed-to resource shall be an <AE> resource instance. Otherwise this setting is not valid. G. Update to attributes of the subscribed-to resource with blocking of the triggering UPDATE operation. For this notificationEventType value setting, only one single Notification Target shall be present in the notificationURI attribute - see notificationURI attribute definition. This value for the notificationEventType tag shall not be combined with any other notificationEventType tag value. This value for notificationEventType establishes a subscription that is triggered for the same events as for the value "Update to attributes of the subscribed-to resource". However, upon occurrence of a triggering UPDATE operation that has been validated and results in an authorized UPDATE operation, the triggering UPDATE operation shall be blocked by the Hosting CSE until a notification request was sent out and a corresponding response message was received or a timeout happens. When the response status code of the notification response message indicates a successful notification reception in combination with a successful notification action taken by the Notification Target entity, the triggering UPDATE operation shall be completed with a successful update of the targeted attribute(s). If the notification response message indicates an unsuccessful notification reception or a successful notification reception with unsuccessful notification action by the targeted entity or times out, the blocked UPDATE operation shall be completed with no success and no change of the targeted attribute(s). ETSI ETSI TS 118 101 V4.15.0 (2022-09) 165 (oneM2M TS-0001 version 4.15.0 Release 4) Condition tag Multiplicity Matching condition For any subscribed-to resource there shall exist a maximum of one subscription with this setting of notificationEventType. All other notification policies shall not be allowed when this setting of notificationEventType is used. The notificationContentType shall be "modified attributes". When an UPDATE operation has been blocked due to triggering this type of notification, any other occurring UPDATE or DELETE requests to the same resource shall be handled only after the blocked UPDATE operation has been completed. H. Report on missing data points. This notificationEventType value shall not be combined with any other notificationEventType value. The other conditions in eventNotificationCriteria conditions apply within the scope of the selected notificationEventType. For example, if notificationEventType is "Creation of a direct child of the subscribed-to resource" then other eventNotificationCriteria conditions is applied to the direct child resources of the subscribed-to resource. If this condition is not specified, the default value is "Update to attributes of the subscribed-to resource". This default value shall apply only if operationMonitor is not present in the resource. The notion of "obsolete resource" is defined in clause 9.6.1.3.2 (Common attributes). For a list of the default and allowed values of notificationContentType for each of the supported values of notificationEventType refer to table 9.6.8-4. operationMonitor 0..n The operations and/or the Originators accessing the subscribed- to resource matches with the specified value. It allows monitoring which operation and/or which Originator is attempting to the access subscribed-to resource regardless of whether the operation is performed. This feature is useful to detect AEs that send requests to a subscribed-to resource and that result in a successful or failure response. Possible arguments are operation(s) (e.g.: CREATE, RETRIEVE, UPDATE, DELETE, NOTIFY) and/or Originator identifier(s). If a set of Originator identifier(s) is included in this tag and no operations are listed, any operations initiated from any of the indicated Originator(s) shall trigger a notification. If a set of operation(s) is included in this tag and no Originator identifier, any of the listed operations shall trigger a notification. If both, a set of Originator identifiers and a set of operations are listed, then any of the listed operations initiated from any of the listed Originators shall trigger the notification. attribute 0..n A list of attribute names of a subscribed-to-resource. This list is only applicable when notificationEventType has a value of "Update to attributes of the subscribed-to resource". or "Update to attributes of the subscribed-to resource with blocking of the triggering UPDATE operation". If this list is present, then it is used to specify a subset of a subscribed-to resource's attributes for which updates shall result in a notification. If ANY attribute specified on this list is updated, then a notification shall be generated. If an attribute that is not specified in this list is updated, then a notification shall not be generated. If this list is not presented, then the default attribute list is the full set of a subscribed-to resource's attributes. If ANY attribute of a subscribed-to resource is updated, then a notification shall be generated. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 166 (oneM2M TS-0001 version 4.15.0 Release 4) Condition tag Multiplicity Matching condition childResourceType 0.. 1 (L) A list of resource types. This list is only applicable when notificationEventType has a value of "Creation of a direct child of the subscribed-to resource" or "Deletion of a direct child of the subscribed-to resource". If this list is present, then it is used to specify a subset of resource type for direct child resource of which creation or deletion shall result in a notification. If ANY resource type specified on this list is created or deleted, then a notification shall be generated. If a resource type that is not specified in this list is created or deleted, then a notification shall not be generated. If this list is not present, then the default resource type list is the full set of a direct child resource. missingData 0..1 The missingData includes two values: a minimum specified missing number of the Time Series Data within the specified window duration, and the window duration. The condition only applies to subscribed-to resources of type <timeSeries>. This condition is ignored unless notificationEventType has a value of "Report on missing data points". If this attribute is modified by an UPDATE the associated timer/counter are stopped and restarted with the new values. The first detected missing data point starts the timer associated with the window duration. The window duration is restarted upon its expiry until such time as the entire subscription is terminated or not refreshed. More details about NOTIFICATIONS related to data reporting is found in clause 10.2.4.29. filterOperation 0..1 Indicates the logical operation (AND/OR/XOR) to be used for the condition tags createdBefore, createdAfter, modifiedSince, unmodifiedSince, stateTagSmaller, stateTagBigger, expireBefore, expireAfter, sizeAbove, sizeBelow. The default value is logical AND. The rules when multiple conditions are used together shall be as follows: • Different condition tags shall use the "AND/OR/XOR" logical operation based on the filterOperation specified. • Same condition tags shall use the "OR" logical operation. The XOR operation evaluates to true if and only if an odd number of its inputs are true. No mixed AND/OR/XOR filter operation will be supported. Table 9.6.8-4 defines the default and allowed values of notificationContentType for each of the supported values of notificationEventType. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 167 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.8-4: Default and allowed values of notificationContentType notificationEventType notificationContentType A B C D E F G H "modified attributes" valid n/a n/a n/a n/a n/a valid (default) n/a "all attributes" valid (default) valid (default) valid (default) valid (default) valid (default) n/a n/a n/a "ID" of the resource indicated in the notificationEventType condition valid valid valid valid valid n/a n/a n/a "Trigger Payload" n/a n/a n/a n/a n/a valid (default) n/a n/a "TimeSeries notification" n/a n/a n/a n/a n/a n/a n/a valid (default)
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.9 Resource Type schedule	The <schedule> resource contains scheduling information. The usage of the <schedule> resource is slightly different depending on the associated resource type, as follows: • A child <schedule> resource of the <node> resource shall indicate the time periods when the node can communicate via the Underlying Network. If multiple Underlying Networks are supported, for each there can be a maximum of one <schedule> resources. One <schedule> resource may be used for multiple Underlying Networks. • The mgmtLink attribute of the <cmdhNwAccessRule> child of a <node> resource shall link to a <schedule> resource, child of the same <node> resource. NOTE: The node will obey the communication schedule indicated for the Underlying Network. If the schedule information is modified, the node will ensure that the change of schedule is detected e.g. via external DM, subscription/notification mechanisms, polling, etc. • A child <schedule> resource of the <CSEBase> resource shall indicate the anticipated time periods when the CSE is available for processing. • A child <schedule> resource of the <subscription> resource shall indicate the time periods when the notifications can be sent to the notification targets. The <schedule> resource shall contain the child resource specified in table 9.6.9-1. Table 9.6.9-1: Child resources of <schedule> resource Child Resources of <schedule> Child Resource Type Multiplicity Description <scheduleAnnc> Child Resource Types [variable] <subscription> 0..n See clause 9.6.8 None [variable] <transaction> 0..n See clause 9.6.48 <transaction> The <schedule> resource shall contain the attributes specified in table 9.6.9-2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 168 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.9-2: Attributes of <schedule> resource Attributes of <schedule> Multiplicity RW/ RO/ WO Description <scheduleAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA labels 0..1 (L) RW See clause 9.6.1.3. MA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3 NA dynamicAuthorizationC onsultationIDs 0..1 (L) RW See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA scheduleElement 1 (L) RW Each item of the scheduleElement list shall be composed from seven fields of second, minute, hour, day of month, month, day of week and year. OA networkCoordinated 0..1 RW Indicates if CSE shall perform schedule coordination with an Underlying Network. This attribute is only applicable when <schedule> is a child resource of <node>. The supported values are: • True: The CSE shall perform schedule coordination. • False: The CSE may not perform schedule coordination. See note. OA NOTE: The schedule coordination is also subject to CSE local policy.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.10 Resource Type locationPolicy	The <locationPolicy> resource represents the method for obtaining and managing geographical location information of an M2M Node. The actual location or event result (in case Geo-fence-Based method) information shall be stored in a <contentInstance> resource which is a child resource of the <container> resource. The <container> resource includes the locationID attribute which holds the ID of this <locationPolicy> resource. A CSE can obtain location information based on the attributes defined under <locationPolicy> resource, and store the location information in the target <container> resource. Based on the locationSource attribute, the method for obtaining location information of an M2M Node can be differentiated. The methods for obtaining location information shall be as follows: • Network-based method: where the CSE on behalf of the AE obtains the target M2M Node's location information from an Underlying Network. • Device-based method: where the ASN is equipped with any location capable modules or technologies (e.g. GPS) and is able to position itself. • Sharing-based method: where the ADN has no GPS nor an Underlying Network connectivity. Its location information can be retrieved from either the associated ASN or a MN. NOTE: Geographical location information could include more than longitude and latitude. Figure 9.6.10-1 shows the graphical information regarding the event types for the Geo-fence feature defined as the geofenceEventCriteria attribute. The time difference between t1 and t2 described in figure 9.6.10-1 is defined by locationUpdatePeriod attribute. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 169 (oneM2M TS-0001 version 4.15.0 Release 4) Figure 9.6.10-1: The Event Types for the Geo-fence The <locationPolicy> resource shall contain the child resources specified in table 9.6.10-1. Table 9.6.10-1: Child resources of <locationPolicy> resource Child Resources of <locationPolicy> Child Resource Type Multiplicity Description <locationPolicyAnnc> Child Resource Types [variable] <subscription> 0..n See clause 9.6.8 None [variable] <transaction> 0..n See clause 9.6.48 <transaction> The <locationPolicy> resource shall contain the attributes specified in table 9.6.10-2. Table 9.6.10-2: Attributes of <locationPolicy> resource Attributes of <locationPolicy> Multiplicity RW/ RO/ WO Description <locationPolicyAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA labels 0..1 (L) RW See clause 9.6.1.3. MA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationConsul tationIDs 0..1 (L) RW See clause 9.6.1.3. OA custodian 0..1 RW See clause 9.6.1.3. NA locationSource 1 WO Indicates the source of location information: • Network Based; • Device Based; • Sharing Based. OA locationInformationType 1 RW • Indicate the types of location information: • Position fix (e.g. longitude and latitude); • Geo-fence event (e.g. entering and leaving). OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 170 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <locationPolicy> Multiplicity RW/ RO/ WO Description <locationPolicyAnnc> Attributes locationUpdatePeriod 0..1(L) RW Indicates the period for updating location information. If the value is marked '0' or not defined and locationUpdateEventCriteria is absent, location information is updated only when a retrieval request to the <latest> child resource of the <container> indicated by locationContainerID is detected. If the attribute has more than one value and the hosting CSE of the resource is the target device, the value could be selected within the listed values depending on device's local context information (e.g. velocity, status of battery, range of the location, etc.). Zero ('0') shall not be stored with non zero value(s). When the value is read, the first value in the list is the current active update period. OA locationTargetID 0..1 WO The identifier to be used for retrieving the location information of a remote Node and this attribute is only used for the case that location information is provided by a location server. For example, when the remote Node is a 3GPP UE, locationTargetID could be M2M-Ext-ID or MSISDN. OA locationServer 0..1 WO Indicates the identity of the location or Geo-fence server. This attribute is only used in that case location information is provided by a location server or Geo-fence server. OA locationContainerID 1 RO ID of the <container> resource where the actual location information or event result of a M2M Node is stored. OA locationContainerName 0..1 WO A name of the <container> resource where the actual location information of a M2M Node is stored. If it is not assigned, the Hosting CSE automatically assigns a name of the resource (see note). OA locationStatus 1 RO Contains the information on the current status of the location request (e.g. location server fault). OA geographicalTargetArea 0..1 RW Indicates area information where the Geo-fence feature is applied. The area is a polygon and represented as a list of geographical coordinates that define the perimeter corner points of the polygon. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 171 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <locationPolicy> Multiplicity RW/ RO/ WO Description <locationPolicyAnnc> Attributes geofenceEventCriteria 0..1 RW • Indicate the event type of Geo-fence feature: − Entering; − Leaving; − Inside; − Outside. OA authID 0..1 RW Indicates the identity of the application which retrieves the location information of a remote node. This attribute is only used by the Location Server in the Underlying Network to verify whether the application is authorized to request the location information. • See clause 7.1.8 where this attribute is described. OA retrieveLastKnownLocation 0..1 RW Indicates if the Hosting CSE shall retrieve the last known location when the Hosting CSE fails to retrieve the latest location. This attribute shall only be applicable when the locationSource is Network Based. The supported values are: • True: Shall retrieve the last known location. • False: Shall not retrieve the last known location. OA locationUpdateEventCriteria 0..1 RW • Indicates the type of event that shall result in a location update. This attribute shall only be applicable when locationUpdatePeriod is zero or not defined and locationSource is Network Based. • The supported values are: − LocationChange. OA NOTE: The created <container> resource related to this policy shall be stored only in the Hosting CSE.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.11 Resource Type delivery	When a CSE is requested to initiate an operation (CRUDN) targeting resources on another CSE, then it needs to do scheduling and execution of delivery of data from the source CSE to the target CSE in line with the provisioned policies. It shall be in one of the following ways: • using delivery aggregation (Delivery Aggregation information set to ON); or • forwarding the original request as a separate request on the Mcc reference point without changes. In order to be able to initiate and manage the execution of data delivery in a resource-based manner, resource type <delivery> is defined. This resource type shall be used for forwarding requests from one CSE to another CSE when the Delivery Aggregation parameter in the request is set to ON. If the Delivery Aggregation parameter is set to OFF, the original request shall be forwarded without change to the next CSE, i.e. without the use of <delivery> resource. If the Delivery Aggregation parameter is not present, the latter method shall be used. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 172 (oneM2M TS-0001 version 4.15.0 Release 4) Operations to Retrieve, Update or Delete a <delivery> resource shall allow authorized entities to inquire the status of a delivery, change delivery attributes or cancel a delivery. As defined in clause 10.2.4, <delivery> resource can only be created by a CSE. A request for the creation of a <delivery> resource can only be issued to a registrar or registree CSE from a registree or registrar CSE with a direct registration relationship among each other (i.e. no transit CSE). <delivery> resource is deleted on successful delivery of the data in the aggregatedRequest attribute to the next hop CSE. The parent of a <delivery> resource is the <CSEBase> resource of the CSE that accepted the request for the creation of the <delivery> resource. The <delivery> resource shall contain the child resource specified in table 9.6.11-1. Table 9.6.11-1: Child resources of <delivery> resource Child Resources of <delivery> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 The <delivery> resource shall contain the attributes specified in table 9.6.11-2. Table 9.6.11-2: Attributes of <delivery> resource Attributes of <delivery> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. dynamicAuthorizationCo nsultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. source 1 WO The CSE-ID of the CSE that initiated the delivery process represented by this <delivery> resource. target 1 WO CSE-ID that defines the Hosting CSE for delivering the data contained in the aggregatedRequest attribute. lifespan 1 RW Defines the time limit when the delivery of the information in the aggregatedRequest attribute needs to complete. If the lifespan expires before successful delivery, no further attempts to deliver the information in the aggregatedRequest attribute need to be executed. If the delivery fails, a feedback may be expected by the source CSE depending on options reflected in the deliveryMetaData attribute. The lifespan attribute of a <delivery> resource shall be set consistent with the Request Expiration Timestamp parameters of the set of original requests contained in the aggregatedRequest attribute, i.e. lifespan shall not extend beyond the earliest expiring Request Expiration Timestamp parameter in the set of the original requests contained in the aggregatedRequest attribute. eventCat 1 RW Defines the category of the event that triggered the delivery request represented by this <delivery> resource. deliveryMetaData 1 RW Contains meta information on the delivery process represented by this <delivery> resource, such as delivery status, delivery options, tracing information, etc. aggregatedRequest 1 WO Attribute containing the request(s) to be delivered to the Hosting CSE. This represents one or more original requests that were targeting the same Hosting CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 173 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.12 Resource Type request	Creation of a <request> resource shall only be done on a Receiver CSE implicitly when a Registree AE or a Registree/Registrar CSE issues a request to the Receiver CSE targeting any other resource type or requesting a notification in non-blocking mode. Creation of a <request> resource is only permitted by the Receiver CSE after reception of a valid which contains the Response Type parameter that is set to 'nonBlockingReqeustSynch' or 'nonBlockingRequestAsynch'. When a CSE is requested to initiate an operation for which the result should be available to the Originator by Request Expiration Timestamp information of the request set to 'nonBlockingReqeustSynch' or 'nonBlockingRequestAsynch', the Receiver CSE which received the request directly from the Originator shall provide a reference of the created <request> resource back to the Originator so that the Originator can access attributes of the <request> resource at a later time - for instance in order to retrieve the result of an operation that was taking a longer time. If the Receiver CSE supports <request> resource type, the reference that shall be given back to the Originator as part of the acknowledgment that is the address of the <request> resource. The Originator (or any other authorized entity depending on access control) can access the request status and the requested operation result through it. The <request> resource may be deleted by the CSE that is hosting it when the expiration time of the <request> resource is reached. So after the expiration time of a <request> resource is reached it cannot be assumed that particular <request> resource is still accessible. A <request> resource may also get deleted earlier than the expiration time, when the result of the requested operation (if any result was requested at all) has been sent back to the Originator. For the purpose of providing a standardized structure for expressing and accessing the context of a previously issued request, the resource type <request> is defined. The parent resource of a <request> resource shall be the <CSEBase> resource of the Hosting CSE. The <request> resource shall contain the child resources specified in table 9.6.12-1. Table 9.6.12-1: Child resources of <request> resource Child Resources of <request> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 The <request> resource shall contain the attributes specified in table 9.6.12-2. Table 9.6.12-2: Attributes of <request> resource Attributes of <request> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. The value of the expirationTime is chosen by the CSE dependent on the Request Expiration Timestamp, Result Expiration Timestamp, Result Persistence and Operation Execution Time parameters associated with the original request. parentID 1 RO See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RO See clause 9.6.1.3. labels 0..1 (L) RO See clause 9.6.1.3. dynamicAuthorizationCo nsultationIDs 0..1 (L) RO See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. operation 1 RO It contains the value of the parameter Operation in the original request message. target 1 RO It contains the value of the parameter To in the original request message. originator 1 RO It contains the value of the parameter From in the original request message. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 174 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <request> Multiplicity RW/ RO/ WO Description requestID 1 RO It contains the value of the parameter Request Identifier in the original request message. metaInformation 1 RO Meta information about the request. The content of this attribute is equivalent to information in any other optional parameters described in clause 8.1. primitiveContent 0..1 RO Contains the content that is carried in the Content parameter of the original request message. requestStatus 1 RO Contains information on the current status of the Request, e.g. "accepted and pending". operationResult 1 RO Contains the result of the originally requested operation in line with the Result Content parameter and the Primitive Profile Identifier parameter associated with the original request. All operations on <request> resources except for the CREATE operations - which shall only be triggered implicitly are controlled by the access control policy.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.13 Resource Type group	The <group> resource represents a group of resources of the same or mixed types. The <group> resource can be used to do bulk manipulations on the resources represented by the memberIDs attribute. The <group> resource contains an attribute that represents the members of the group and the <fanOutPoint> virtual resource that enables generic operations to be applied to all the resources represented by those members. By grouping <semanticDescriptor> resources across which a semantic description is distributed, another virtual resource (<semanticFanOutPoint>) enables semantic discovery procedures to be applied across the full logical tree in the description. Members of a <group> resource may support unicast or multicast communication. In case multiple members of a <group> resource support multicast communications and they share the same multicast address, those members form a multicast group as a sub-set of the group. There may be multiple multicast groups corresponded to one group since the members of the group may use different multicast mechanisms (e.g. 3GPP MBMS vs. IP multicast) and different multicast addresses. The <group> resource shall contain the child resources specified in table 9.6.13-1. Table 9.6.13-1: Child resources of <group> resource Child Resources of <group> Child Resource Type Multiplicity Description <groupAnnc> Child Resource Types [variable] <semanticDescriptor> 0..n See clause 9.6.30 <semanticDescriptor>, <semanticDescriptorAnnc> [variable] <subscription> 0..n See clause 9.6.8 <subscription> fopt <fanOutPoint> 1 See clause 9.6.14 None sfop <semanticFanOutPoint> 0..1 See clause 9.6.14a None [variable] <transaction> 0..n See clause 9.6.48 <transaction> [variable] <action> 0..n See clause 9.6.61 None The <group> resource shall contain the attributes specified in table 9.6.13-2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 175 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.13-2: Attributes of <group> resource Attributes of <group> Multiplicity RW/ RO/ WO Description <groupAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. MA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationCons ultationIDs 0..1 (L) RW See clause 9.6.1.3. OA creator 0..1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA memberType 1 WO It is the resource type of the member resources of the group, if all member resources (including the member resources in any sub-groups) are of the same type. Otherwise, it is of type 'mixed'. OA specializationType 0..1 WO When the memberType attribute value is set to "mgmtObj" this specializationType may be set to the specialization defined by the mgmtDefinition attribute. When the memberType attribute value is set to "flexContainer", this specializationType may be set to the specialization defined by the containerDefinition attribute. OA currentNrOfMembers 1 RO Current number of members in a group. It shall not be larger than maxNrOfMembers. OA maxNrOfMembers 1 RW Maximum number of members in the <group>. OA memberIDs 1 (L) RW List of member resource IDs referred to in the remaining of the present document as memberID. Each ID (memberID) should refer to a member resource or a (sub-) <group> resource of the <group> if memberID is suffixed with "/fopt". A <group> resource with an empty member list is allowed. OA membersAccessControlPo licyIDs 0..1 (L) RW List of IDs of the <accessControlPolicy> resources defining who is allowed to access the <fanOutPoint> and <semanticFanOutPoint> virtual resources. OA memberTypeValidated 0..1 RO Denotes if the resource types of all members' resources of the group have been validated by the Hosting CSE. In the case that the memberType attribute of the <group> resource is not 'mixed', then this attribute shall be set. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 176 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <group> Multiplicity RW/ RO/ WO Description <groupAnnc> Attributes consistencyStrategy 1 WO This attribute determines how to deal with the <group> resource if the memberType validation fails. Its possible values are • ABANDON_MEMBER • ABANDON_GROUP • SET_MIXED Which means delete the inconsistent member if the attribute is ABANDON_MEMBER; delete the group if the attribute is ABANDON_GROUP; set the memberType to "mixed" if the attribute is SET_MIXED. If it is not given by the Originator at the creation procedure, default is "ABANDON_MEMBER". OA groupName 0..1 RW Human readable name of the <group>. OA semanticSupportIndicator 0..1 RO Indicator of support for semantic discovery functionality via <semanticFanOutPoint>. OA notifyAggregation 0..1 RW This attribute specifies the number of messages and/or the duration that the group hosting CSE will aggregate notification messages when the subscriptions created specify aggregation of notifications i.e. specifying the notificationForwardingURI of the original <subscription> resource. OA somecastEnable 1 RW When set to "TRUE", somecast functionality for this group is enabled. When set to "FALSE", somecast functionality for this group is disabled. Default is "FALSE". OA somecastAlgorithm 0..1 RW Defines the algorithm used by the Hosting CSE to select a subset of group members to target when a somecast fanout request is received and the somecastEnable attribute is set to TRUE. Supported algorithms include: • Round-robin (default) • Weighted Round-robin • Least work load • Random Note a somecast fanout request is a request that targets the fopt and includes a Group Somecast Target Number request parameter configured with a value that is less than the total number of group members. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 177 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.14 Resource Type fanOutPoint	The <fanOutPoint> resource is a virtual resource because it does not have a representation. It is the child resource of a <group> resource. Whenever a request is sent to the <fanOutPoint> resource, the request is fanned out to each of the members of the <group> resource indicated by the membersIDs attribute of the <group> resource. The responses (to the request) from each member are then aggregated and returned to the Originator. A timer should be set for the aggregation. The responses are aggregated if all the responses expected have been received or when the timer expires. The responses received after the time expires should be discarded. If the Result Expiration Timestamp parameter is received from the Originator, the timer should be set to enforce this parameter, otherwise, the timer is set based on the local policy configured at the Hosting CSE. The <fanOutPoint> resource does not have a resource representation by itself and consequently it does not have an accessControlPolicyIDs attribute. The <accessControlPolicy> resource used for access control policy validation is indicated by the membersAccessControlPolicyIDs attribute in the parent <group> resource. 9.6.14a Resource Type semanticFanOutPoint The <semanticFanOutPoint> resource is a virtual resource because it does not have a representation. It is the child resource of a <group> resource with members of type <semanticDescriptor> or <contentInstance>. In the former case the semantic information is contained in the descriptor attribute, in the latter case semantic information can be contained in the content attribute. It is allowed to reference a <latest> resource representing the most recent <contentInstance> in a container. Whenever a semantic discovery request is sent to the <semanticFanOutPoint> resource the host uses the memberIDs attribute of the parent <group> resource to retrieve all the related resources. If there are resources stored on different CSEs, individual RETRIEVE requests are sent to each CSE for retrieving the external resources. In case no semantic information is contained, the resource is not considered. All semantic resources are accessed based on the respective access control policies. Once all of the related resources with semantic information have been retrieved, the semantic content of each is added to the content on which the SPARQL request is being executed. The full/enlarged content subject to the SPARQL request is provided to the SPARQL engine for processing. The <semanticFanOutPoint> resource uses membersAccessControlPolicyIDs attribute in the parent <group> resource for access control policy validation.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.15 Resource Type mgmtObj	The <mgmtObj> resource contains management data which represents individual M2M management functions. It represents a general structure to map to technology specific data model e.g. OMA DM [i.3], BBF TR-069 [i.2] and LWM2M [i.4]. Each instance of <mgmtObj> resource shall be mapped to single technology specific protocol. The <mgmtObj> resource shall contain the child resource specified in table 9.6.15-1. Table 9.6.15-1: Child resources of <mgmtObj> resource Child Resources of <mgmtObj> Child Resource Type Multiplicity Description <mgmtObjAnnc> Child Resource Type [variable] <subscription> 0..n See clause 9.6.8 <subscription> [variable] <semanticDescriptor> 0..n See clause 9.6.30 <semanticDescriptor>, <semanticDescriptorAnnc> [variable] <transaction> 0..n See clause 9.6.48 <transaction> The <mgmtObj> resource shall contain the attributes specified in table 9.6.15-2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 178 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.15-2: Attributes of <mgmtObj> resource Attributes of <mgmtObj> Multiplicity RW/ RO/ WO Description <mgmtObjAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA labels 0..1 (L) RW See clause 9.6.1.3. MA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationCons ultationIDs 0..1 (L) RW See clause 9.6.1.3. OA custodian 0..1 RW See clause 9.6.1.3. NA mgmtDefinition 1 WO Specifies the type of <mgmtObj> resource e.g. software, firmware, memory. The list of the value of the attribute can be seen in annex D. MA mgmtSchema 0..1 WO Contains a URI to the <mgmtObj> schema definition which shall be used by the Hosting CSE to validate the syntax of incoming primitives targeting this <mgmtObj> resource. This URI may refer to a oneM2M specified <mgmtObj> definition as well as other <mgmtObj> definitions. MA objectIDs 0..1 (L) WO Contains the list URNs that uniquely identify the technology specific data model objects used for this <mgmtObj> resource as well as the managed function and version it represents. This attribute shall be provided during the creation of the <mgmtObj> resource and shall not be modifiable afterwards. If the <mgmtObj> resource is mapped to multiple technology specific data model objects, this attribute shall list all URNs for each mapped technology specific data model objects. This is mandatory for the <mgmtObj>, for which the data model is not specified by oneM2M but mapped from technology specific data model. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 179 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <mgmtObj> Multiplicity RW/ RO/ WO Description <mgmtObjAnnc> Attributes objectPaths 0..1 (L) WO Contains the list of local paths of the technology specific data model objects on the managed entity which is represented by the <mgmtObj> resource in the Hosting CSE. This attribute shall be provided during the creation of the <mgmtObj>, so that the Hosting CSE can correlate the created <mgmtObj> with the technology specific data model object on the managed entity for further management operations. It shall not be modifiable after creation. The format of this attribute shall be a local technology specific data model object path in the form as specified by technology specific protocol. (e.g. "./anyPath/Fw1" in OMA DM [i.3], "Device.USBHosts.Host.3." in BBF TR-069 [i.2]). The combination of the objectPaths and the objectIDs attribute, allows to address the technology specific data model. OA mgmtLink 0..1 (L) RW This attribute contains reference to a list of other <mgmtObj> resources in case a hierarchy of <mgmtObj> is needed. OA [objectAttribute] 0..n RW Each [objectAttribute] is mapped from a leaf node of a hierarchical structured technology specific data model object (including oneM2M data model and the technology specific data model objects) based on the mapping rules below the table. OA description 0..1 RW Text format description of <mgmtObj>. OA When mapping objects from technology specific protocol to a corresponding <mgmtObj> resource, the following rules shall apply: • The root objects of technology specific data model objects maps to the <mgmtObj> resource. • For the child of the root of technology specific data model objects: - Rule 1: If the child technology specific data model object cannot have another child technology specific data model object, the technology specific data model object maps to the [objectAttribute] attribute of the <mgmtObj> resource with the same resource name. - Rule 2: If the child technology specific data model object can have another child technology specific data model object, the technology specific data model object maps to a new <mgmtObj> resource. The ID of the new <mgmtObj> resource is stored as an mgmtLink attribute of the <mgmtObj> resource which is mapped from the parent technology specific data model object. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 180 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.16 Resource Type mgmtCmd	The <mgmtCmd> resource represents a method to execute management procedures or to model commands and remote procedure calls (RPC) required by existing management protocols (e.g. BBF TR-069 [i.2]), and enables AEs to request management procedures to be executed on a remote entity. It also enables cancellation of cancellable and initiated but unfinished management procedures or commands. Each <mgmtCmd> corresponds to a specific type of management command, as defined by its attribute cmdType. For multiple requests of the same management command, <mgmtCmd> shall use separate child-resources (i.e. <execInstance>) to contain each execution instance. The execution of the management procedure represented by <mgmtCmd> shall be triggered using the UPDATE method to its attribute execEnable. The <mgmtCmd> resource shall contain the child resources specified in table 9.6.16-1. Table 9.6.16-1: Child resources of <mgmtCmd> resource Child Resources of <mgmtCmd> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 [variable] <execInstance> 0..n See clause 9.6.17 [variable] <transaction> 0..n See clause 9.6.48 The <mgmtCmd> resource shall contain the attributes specified in table 9.6.16-2. Table 9.6.16-2: Attributes of <mgmtCmd> resource Attributes of <mgmtCmd> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. dynamicAuthorizationCo nsultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. description 0..1 RW The text-format description of this resource. cmdType 1 WO The type to identify the management operation (e.g. download). execReqArgs 0..1 RW Structured attribute (e.g. abstract type) to contain any command-specific arguments of the request. execEnable 1 RW Writing a value to this attribute via the UPDATE method causes execution of the <mgmtCmd>. execTarget 1 RW ID of the <node> resource of the target on which this <mgmtCmd> will be executed. It may be the URI of a <group> resource in which case the <mgmtCmd> will be executed on all members in the memberIDs attribute of the addressed <group> resource. execMode 0..1 RW The mode used to specify how the command will be executed (e.g. Immediate Once, Immediate and Repeatedly, Random Once, Random and Repeatedly). May be used together with execFrequency, execDelay and execNumber to provide the scheduling information. execFrequency 0..1 RW The minimum interval between two executions, to be used in conjunction with execMode. Modes involving random execution can be used to add random values between individual executions. execDelay 0..1 RW The minimum delay before the instance should be executed. Modes involving random execution can be used to increase this delay randomly. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 181 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <mgmtCmd> Multiplicity RW/ RO/ WO Description execNumber 0..1 RW The number of times the instance should be executed, to be used when execMode indicates a repetition pattern.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.17 Resource Type execInstance	The <execInstance> resource represents a successful instance of <mgmtCmd> execution request, which had been triggered by a M2M network application using the UPDATE method to the attribute execEnable of <mgmtCmd> resource. The <execInstance> resource shall contain the child resources specified in table 9.6.17-1. Table 9.6.17-1: Child resources of <execInstance> resource Child Resources of <execInstance> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 [variable] <transaction> 0..n See clause 9.6.48 The <execInstance> resource shall contain the attributes specified in table 9.6.17-2. Table 9.6.17-2: Attributes of <execInstance> resource Attributes of <execInstance> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. expirationTime 1 RO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. dynamicAuthorizationCo nsultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. execStatus 1 RO The status of <execInstance>. It can be Initiated, Pending, Finished, Cancelling, Cancelled, or Status Not Cancellable. execResult 1 RO The execution result of <execInstance>. execDisable 0..1 RW The attribute is used to cancel <execInstance> using UPDATE method. execTarget 1 RO ID of <node> resource of the target on which the <execInstance> will be executed. execMode 0..1 RO Modes used to specify how the command will be executed (e.g. Immediate Once, Immediate and Repeatedly, Random Once, Random and Repeatedly). May be used together with execFrequency, execDelay and execNumber to provide the scheduling information. execFrequency 0..1 RO The minimum interval between two executions, to be used in conjunction with execMode. Modes involving random execution can be used to add random values between individual executions. execDelay 0..1 RO The minimum delay before the instance should be executed. Modes involving random execution can be used to increase this delay randomly. execNumber 0..1 RO The number of times the instance should be executed, to be used when execMode indicates a repetition pattern. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 182 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <execInstance> Multiplicity RW/ RO/ WO Description execReqArgs 0..1 (L) RO Structured attribute (e.g. abstract type) to contain any command-specific arguments (as a list) used to trigger this <execInstance>.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.18 Resource Type node	The <node> resource represents specific information that provides properties of an M2M Node that can be utilized by other oneM2M operations. The <node> resource has specialization of the <mgmtObj> as its child resources. These resources represent the Node's context information (e.g. memory and battery), network topology, device information, device capability, etc. The specialized <mgmtObj> resources are used to perform management of the Node. This node specific information stored in these resources such as [memory] and [battery] can be obtained either by the existing device management technologies (OMA DM [i.3], BBF TR-069 [i.2]) or any other way (e.g. JNI [i.18]). For the case when the <node> resource belongs to an ADN, see figure 9.6.18-1 in conjunction with the description of nodeLink attribute in the <AE> resource (clause 9.6.5). For the case when the <node> resource belongs to an NoDN and the applications that correspond to interworked devices are represented by <flexContainer>s see figure 9.6.18-2. <IN/MN-A-CSEBase> nodeLink <AE-x1> <AE-x2> hostedAELinks <node-ADN-x> <node-ADN-y> <AE-y1> IN/MN-A-CSE AE-x1 AE-x2 AE-y1 ADN-X IN/MN-A ADN-Y <AE> <node> <node> <AE> <AE> <CSEBase> Mca Mca Figure 9.6.18-1: Relationship between IN/MN and ADN ETSI ETSI TS 118 101 V4.15.0 (2022-09) 183 (oneM2M TS-0001 version 4.15.0 Release 4) <IN/MN-A-CSEBase> nodeLink <Interworked Device-1> <Interworked Device-2> hostedAppLink <node-NoDN> <IPE-AE> <AE> <node> <node> <flexContainer> <flexContainer> <CSEBase> hostedServiceLinks Figure 9.6.18-2: Relationship between IPE, interworked Services and NoDN The <node> resource shall contain the child resources specified in table 9.6.18-1. Table 9.6.18-1: Child resources of <node> resource Child Resources of <node> Child Resource Type Multiplicity Description <nodeAnnc> Child Resource Type [variable] <semanticDescriptor> 0..n See clause 9.6.30. <semanticDescriptor>, <semanticDescriptorA nnc> [variable] <mgmtObj> as defined in the specialization [memory] 0..1 This resource provides the memory (typically RAM) information of the node. (E.g. the amount of total volatile memory), See clause D.4. <mgmtObjAnnc> [variable] <mgmtObj> as defined in the specialization [battery] 0..n The resource provides the power information of the node. (E.g. remaining battery charge). See clause D.7. <mgmtObjAnnc> [variable] <mgmtObj> as defined in the specialization [areaNwkInfo] 0..n This resource describes the list of Nodes attached behind the MN/ASN node and its physical or underlying relation among the nodes in the M2M Area Network. This attribute is defined in case the Node is MN/ASN. See clause D.5. <mgmtObjAnnc> [variable] <mgmtObj> as defined in the specialization [areaNwkDeviceInfo] 0..n This resource describes the information about the Node in the M2M Area Network. See clause D.6. <mgmtObjAnnc> [variable] <mgmtObj> as defined in the specialization [firmware] 0..n This resource describes the information about the firmware of the Node include name, version, etc. See clause D.2. <mgmtObjAnnc> [variable] <mgmtObj> as defined in the specialization [software] 0..n This resource describes the information about the software of the Node. See clause D.3. <mgmtObjAnnc> [variable] <mgmtObj> as defined in the specialization [deviceInfo] 0..n The resource contains information about the identity, manufacturer and model number of the device. See clause D.8. <mgmtObjAnnc> ETSI ETSI TS 118 101 V4.15.0 (2022-09) 184 (oneM2M TS-0001 version 4.15.0 Release 4) Child Resources of <node> Child Resource Type Multiplicity Description <nodeAnnc> Child Resource Type [variable] <mgmtObj> as defined in the specialization [deviceCapability] 0..n The resource contains information about the capability supported by the Node. See clause D.9. <mgmtObjAnnc> [variable] <mgmtObj> as defined in the specialization [reboot] 0..1 The resource is the place to reboot or reset the Node. See clause D.10. <mgmtObjAnnc> [variable] <mgmtObj> as defined in the specialization [eventLog] 0..1 The resource contains the information about the log of events of the Node. See clause D.11. <mgmtObjAnnc> [variable] <mgmtObj> as defined in the specialization [cmdhPolicy] 0..n The resource(s) contain(s) information about CMDH policies that are applicable to the CMDH processing on the CSE hosted on the node represented by this <node> resource and identified by the hostedCSELink attribute of this <node> resource. See clause D.12. NA [variable] <mgmtObj> as defined in the specialization [activeCmdhPolicy] 0..1 This resource defines which of the present [cmdhPolicy] resource(s) shall be active for the CMDH processing on the CSE hosted on the node represented by this <node> resource and identified by the hostedCSELink attribute of this <node> resource. See clause D.12. NA [variable] <mgmtObj> as defined in the specialization [registration] 0..n This specialization of <mgmtObj> is used to convey the service layer configuration information needed to register an AE or CSE with a Registrar CSE. <registrationAnnc> [variable] <mgmtObj> as defined in the specialization [dataCollection] 0..n This specialization of <mgmtObj> is used to convey the application configuration information needed by an AE to collect data and then transmit the data to a Hosting CSE. <dataCollectionAnnc> [variable] <mgmtObj> as defined in the specialization [authenticationProfile] 0..n The [authenticationProfile] specialization of the <mgmtObj> is used to convey the configuration information regarding establishing mutually-authenticated secure communications. NA [variable] <mgmtObj> as defined in the specialization [myCertFileCred] 0..n This <mgmtObj> specialization is used to configure a certificate or certificate chain which the Managed Entity knows the private key. NA [variable] <mgmtObj> as defined in the specialization [trustAnchorCred] 0..n The [trustAnchorCred] <mgmtObj> specialization is read by AEs or CSEs on ADN or ASN/MN nodes in the Field Domain. NA [variable] <mgmtObj> as defined in the specialization [MAFClientRegCfg] 0..1 This <mgmtObj> specialization is used to convey instructions regarding the MAF Client Registration procedure. NA [variable] <mgmtObj> as defined in the specialization [MEFClientRegCfg] 0..1 This <mgmtObj> specialization is used to convey instructions regarding the MEF Client Registration procedure. NA [variable] <mgmtObj> as defined in the specialization [OAuth2Authentication] 0..1 This specialization of <mgmtObj> is used to store access token and refresh token used in OAuth2 security protocol. NA [variable] <mgmtObj> as defined in the specialization [wifiClient] 0..1 This specialization of <mgmtObj> is used to store configuration of WiFi connection on the client device. NA [variable] <subscription> 0..n See clause 9.6.8. <subscription> [variable] <schedule> 0..n See clause 9.6.9. <scheduleAnnc> [variable] <transaction> 0..n See clause 9.6.48. <transaction> [variable] <action> 0..n See clause 9.6.61. None ETSI ETSI TS 118 101 V4.15.0 (2022-09) 185 (oneM2M TS-0001 version 4.15.0 Release 4) The <node> resource shall contain the attributes specified in table 9.6.18-2. Table 9.6.18-2: Attributes of <node> resource Attributes of <node> Multiplicity RW/ RO/ WO Description <nodeAnnc> attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA labels 0..1 (L) RW See clause 9.6.1.3. MA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationCons ultationIDs 0..1 (L) RW See clause 9.6.1.3. OA custodian 0..1 RW See clause 9.6.1.3. NA nodeID 1 RW The M2M-Node-ID of the node which is represented by this <node> resource. MA nodeType 0..1 RW Indicates the type of node. It shall have one of the following values: • IN • MN • ASN • ADN • NoDN • UNSPECIFIED OA hostedCSELink 0..1 RW This attribute allows to find the <CSEBase> or <remoteCSE> resource representing the CSE that is residing on the node that is represented by this <node> resource. The attribute contains the resource ID of a resource where all of the following applies: • The resource is a <CSEBase> resource or a <remoteCSE> resource. • The resource represents the CSE which resides on the specific node that is represented by the current <node> resource. In case the node that is represented by this <node> resource does not contain a CSE, this attribute shall not be present. OA hostedAELinks 0..1(L) RW This attribute allows to find the AEs hosted by the node that is represented by this <node> resource. The attribute shall contain a list of resource identifiers of <AE> resources representing the ADN-AEs residing on the node that is represented by the current <node> resource. In case the node that is represented by this <node> resource does not contain an AE, this attribute shall not be present. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 186 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <node> Multiplicity RW/ RO/ WO Description <nodeAnnc> attributes hostedServiceLinks 0..1(L) RW This attribute allows to find <flexContainer> resources that have been created by an IPE to represent services hosted on a NoDN, the NoDN being represented by this <node> resource. If the NoDN hosts a set of services represented by <flexContainer>s, then the attribute shall contain the list of resource identifiers of these <flexContainer> resources. In case the node that is represented by this <node> resource does not contain a service that is represented by a <flexContainer>, this attribute shall not be present. OA mgmtClientAddress 0..1 RW Represents the physical address of management client of the node which is represented by this <node> resource. This attribute is absent if management server is able to acquire the physical address of the management client. OA roamingStatus 0..1 RO Indicates if the M2M Node is currently roaming from the perspective of the underlying network. The allowed values are "Yes" or "No". OA networkID 0..1 RO Configured with the identity of the underlying network which the M2M Node is currently attached to. OA
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.19 Resource Type m2mServiceSubscriptionProfile	The <m2mServiceSubscriptionProfile> resource represents an M2M Service Subscription. It is used to represent all data pertaining to the M2M Service Subscription, i.e. the technical part of the contract between an M2M Application Service Provider and an M2M Service Provider and is only stored on IN-CSE. The data is also represented in <serviceSubscribedNode>, <serviceSubscribedAppRule> and <serviceSubscribedUserProfile> resources as well as <m2mServiceSubscriptionProfile> resource. The relationship among those resource types is depicted as follows. Note that the diagram does not capture all attributes and child resources. Those resource types shall only be instantiated on IN-CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 187 (oneM2M TS-0001 version 4.15.0 Release 4) <serviceSubscribedNode> ruleLinks <m2mServiceSubscriptionProfile> 0..n <serviceSubscribedAppRule> 0..1(L) <serviceSubscribedUserProfile> 0..n M2M-User-ID 1 allowedUsers 0..1(L) ... ... ... ... Figure 9.6.19-1: Relationship among M2M Service Subscription related resources The <m2mServiceSubscriptionProfile> resource shall contain the child resources specified in table 9.6.19-1. Table 9.6.19-1: Child resources of <m2mServiceSubscriptionProfile> resource Child Resources of <m2mServiceSubscriptionProfile> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 [variable] <serviceSubscribedNode> 0..n See clause 9.6.20 [variable] <transaction> 0..n See clause 9.6.48 [variable] <serviceSubscribedUserProfile> 0..n See clause 9.6.68 The <m2mServiceSubscriptionProfile> resource shall contain the attributes specified in table 9.6.19-2. Table 9.6.19-2: Attributes of <m2mServiceSubscriptionProfile> resource Attributes of <m2mServiceSubscriptionProfile> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. dynamicAuthorizationConsultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. M2M-Sub-ID 1 WO The identifier assigned by the M2M Service Provder for this M2M Service Subscription. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 188 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <m2mServiceSubscriptionProfile> Multiplicity RW/ RO/ WO Description M2M-SS-ID 0..1 RW The identifier assigned by the M2M Service Provder to the M2M Service Subscriber associated with this M2M Service Subscription. status 1 RO Indicates the active/inactive status of this M2M Service Subscription. The Hosting CSE shall set this attribute to "ACTIVE" when the value of activate attribute is set to TRUE and "INACTIVE" when the value of the activate attribute is set to FALSE. activate 1 RW Used to activate or deactivate this M2M Service Subscription. When this attribute is set to a value of TRUE, the Hosting CSE shall activate this M2M Service Subscription. When this attribute is set to a value of FALSE, the Hosting CSE shall deactivate this M2M Service Subscription. The default value of the attribute is FALSE. The attribute shall be set to value of FALSE by the Hosting CSE on end of serviceSubscriptionDuration. To activate the service subscription again, this attribute shall be set to a value of TRUE. activationTime 0..1 RO M2M Service Subscription Activation Time. It is the time from which an M2M Service Provider activates the services of an M2M subscriber. The value of this attribute shall be set to current time when activate is set to TRUE. deactivationTime 0..1 RO M2M Service Subscription Deactivation Time. It is the time on which an M2M Service Provider deactivates the services of an M2M subscriber. The value of this attribute shall set to the time when activate transition from TRUE to FALSE. serviceSubscriptionDuration 0..1 RW It indicates the duration of the contract between an M2M Subscriber and M2M Service Provider. When a service subscription reaches the end of this duration, the Hosting CSE shall set the activate attribute to a value of FALSE. When an ACTIVE service subscription is deactivated by setting activate to FALSE, the Hosting CSE shall recalculate the duration of time for which the service subscription was active and update the value of this attribute. currentNumAEs 1 RO For this M2M Service Subscription, the Hosting CSE shall keep track of the current number of <AE> resources created on the Hosting CSE. maxNumAEs 0..1 RW For this M2M Service Subscription, the Hosting CSE shall limit the maximum number of <AE> resources created on the Hosting CSE to this limit, if configured. If a request is received to create an <AE> resource once this limit is reached, the Hosting CSE shall return an error indicating that the maximum number of allowed <AE> resources has been reached. currentNumNodes 1 RO For this M2M Service Subscription, the Hosting CSE shall keep track of the current number of <node> resources created on the Hosting CSE. maxNumNodes 0..1 RW For this M2M Service Subscription, the Hosting CSE shall limit the maximum number of <node> resources created on the Hosting CSE to this limit, if configured. If a request is received to create a <node> resource once this limit is reached, the Hosting CSE shall return an error indicating the maximum number of allowed <node> resources has been reached. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 189 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <m2mServiceSubscriptionProfile> Multiplicity RW/ RO/ WO Description maxNumBytes 0..1 RW For this M2M Service Subscription, the Hosting CSE shall limit the aggregate amount of bytes stored on the Hosting CSE to this limit, if configured. This limit shall be applied to Content Sharing Resources only (i.e. <container>, <contentInstance>, <flexContainer>, <flexContainerInstance>, <timeSeries> and <timeSeriesInstance>). If a request is received to create a Content Sharing Resource that will result in exceeding this limit, the Hosting CSE shall return an error that the maximum number of allowed bytes has been reached. A Hosting CSE may take the value of the maxNumBytes attribute as well as other attributes (e.g. maxNumContainers, maxNumContentInstances, etc.) into account when determining a limit to enforce on the maxByteSize attribute of individual Content Sharing Resources, if applicable. How a Hosting CSE allocates the maxNumBytes across individual Content Sharing Resources is based on local policy. maxNumUsers 0..1 RW Maximum number of allowed M2M Service Users associated with this M2M Service Subscription. maxRequestRate 0..1 RW If a Hosting CSE receives requests for this M2M Service Subscription at a rate which exceeds the limit defined by this attribute, the Hosting CSE may throttle the processing of the requests. The Hosting CSE may throttle processing of requests by delaying responses and/or by returning an error indicating that the maximum allowed request rate has been reached. maxNumContainers 0..1 RW For this M2M Service Subscription, the Hosting CSE shall limit the maximum number of <container> resources created on the Hosting CSE to this limit, if configured. If a request is received to create a <container> resource once this limit is reached, the Hosting CSE shall return an error indicating the maximum number of allowed <container> resources has been reached. maxNumInstancesPerContainer 0..1 RW For this M2M Service Subscription, the Hosting CSE shall limit the value of the maxNrOfInstances attribute of a <container> resource on the Hosting CSE to this limit, if configured. maxNumTimeSeries 0..1 RW For this M2M Service Subscription, the Hosting CSE shall limit the maximum number of <timeSeries> resources created on the Hosting CSE to this limit, if configured. If a request is received to create a <timeSeries> resource once this limit is reached, the Hosting CSE shall return an error indicating the maximum number of <timeSeries> resources has been reached. maxNumInstancesPerTimeSeries 0..1 RW For this M2M Service Subscription, the Hosting CSE shall limit the value of the maxNrOfInstances attribute of a <timeSeries> resource on the Hosting CSE to this limit, if configured. maxMembersPerGroup 0..1 RW For this M2M Service Subscription, the Hosting CSE shall limit the value of the maxNrOfMembers attribute of a <group> resource on the Hosting CSE to this limit, if configured. maxNotificationRate 0..1 The Hosting CSE shall restrict the maximum rate of notifications for this M2M Service Subscription to this limit, if configured. A Hosting CSE shall also restrict the maximum value of the rateLimit attribute of <subscription> resources associated with this M2M Service Subscription to this limit,if configured. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 190 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <m2mServiceSubscriptionProfile> Multiplicity RW/ RO/ WO Description maxNumFlexContainers 0..1 RW For this M2M Service Subscription, the Hosting CSE shall limit the maximum number of <flexContainer> resources created to this limit, if configured. If a request is received to create a <flexContainer> resource once this limit is reached, the Hosting CSE shall return an error indicating the maximum number of allowed <flexContainer> resources has been reached. maxNumInstancesPerFlexContainer 0..1 RW For this M2M Service Subscription, the Hosting CSE shall limit the value of the maxNrOfInstances attribute of a <flexContainer> resource on the Hosting CSE to this limit, if configured. defaultAccessControlPrivileges 0..1(L) RW A list of resource identifiers of default access control policies to link to a resource if/when the accessControlPolicyIDs attribute of a resource created by an entity associated with this M2M Service Subscription is not configured.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.20 Resource Type serviceSubscribedNode	The <serviceSubscribedNode> resource represents M2M Node information that is needed as part of the M2M Service Subscription resource and is only stored on IN-CSE. It contains M2M-Node-ID and optionally CSE-ID running on that Node. The <serviceSubscribedNode> resource shall contain the child resource specified in table 9.6.20-1. Table 9.6.20-1: Child resources of <serviceSubscribedNode> resource Child Resources of <serviceSubscribedNode> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 [variable] <transaction> 0..n See clause 9.6.48 The <serviceSubscribedNode> resource shall contain the attributes specified in table 9.6.20-2. Table 9.6.20-2: Attributes of <serviceSubscribedNode> resource Attributes of <serviceSubscribedNode> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3 lastModifiedTime 1 RO See clause 9.6.1.3. dynamicAuthorizationConsult ationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. nodeID 1 WO M2M-Node-ID of the node that is represented by this instance. CSE-ID 0..1 WO CSE-ID pertaining to this node (for nodes that have a CSE). ETSI ETSI TS 118 101 V4.15.0 (2022-09) 191 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <serviceSubscribedNode> Multiplicity RW/ RO/ WO Description deviceIdentifier 0..1 (L) WO A list of device identifiers that uniquely identify a device. The format of a device identifier is one of the following: • Case 1: Identify a device using the format <OUI> "-" <ProductClass> "-" <SerialNumber> as defined in section 3.4.4 of BBF TR-069 [i.2]. The format of the URN is urn:dev:ops:<OUI> "-" <ProductClass> "-" <SerialNumber>. • Case 2: Identify a device using the format <OUI> "-"<SerialNumber> as defined in section 3.4.4 of BBF TR-069 [i.2]. The format of the URN is urn:dev:os:<OUI> "-"<SerialNumber>. • Case 3: Identify a device using an International Mobile Equipment Identifiers of ETSI TS 123 003 [i.23]. This URN specifies a valid, 15 digit IMEI. The format of the URN is urn:imei:###############. • Case 4: Identify a device using an Electronic Serial Number. The ESN specifies a valid, 8 digit ESN. The format of the URN is urn:esn:########. • Case 5: Identify a device using a Mobile Equipment Identifier. This URN specifies a valid, 14 digit MEID. The format of the URN is urn:meid:##############. • Case 6: Identify a device using an Object IDentifier (OID). This URN specifies a valid OID - see annex H for one possible naming convention. The format of the URN is urn:oid:<OID>. • Case 7: Identify a device using a Universally Unique IDentifier (UUID). The UUID specifies a valid, hex digit character string as defined in IETF RFC 4122 [i.26]. The format of the URN is urn:uuid: ########-####-####-####- ############. ruleLinks 0..1 ((L) RW This attribute contains a list of links towards <serviceSubscribedAppRule> resources pertaining to this <serviceSubscribedNode>. See clause 9.6.29 for an explanation of the <serviceSubscribedAppRule> resource. This attribute shall exist only when the CSE-ID attribute is present. When the list is empty, it means no applications are allowed to register on the CSE which is indicated by the CSE-ID attribute. niddRequired 0..1 RW Controls whether the IN-CSE configures the underlying network to enable Non-IP Data Delivery for this node. Valid values are "TRUE" or "FALSE". If not configured, then IN-CSE default policy shall apply. See ETSI TS 118 126 [15].
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.21 Resource Type pollingChannel	The <pollingChannel> resource represents a channel that can be used for a request-unreachable entity (i.e. an AE or a CSE which is behind NAT so it cannot receive a request from other Nodes). The request-unreachable entity creates a <pollingChannel> resource on a request-reachable CSE, and then polls any type of request(s) for itself from the <pollingChannel> Hosting CSE. EXAMPLE: An AE can retrieve notifications by long polling on the channel when it cannot receive notifications asynchronously from a subscription Hosting CSE. The <pollingChannel> resource shall contain the child resource specified in table 9.6.21-1. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 192 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.21-1: Child resources of <pollingChannel> resource Child Resources of <pollingChannel> Child Resource Type Multiplicity Description Pcu <pollingChannelURI> 1 See clause 9.6.22 [variable] <transaction> 0..n See clause 9.6.48 The <pollingChannel> resource shall contain the attributes specified in table 9.6.21-2. Table 9.6.21-2: Attributes of <pollingChannel> resource Attributes of <pollingChannel> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. expirationTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. requestAggregation 0..1 RW This is a boolean value that controls the content of the response when multiple request primitives are available in the polling channel. TRUE indicates that all available requests shall be returned in a single aggregated response. FALSE indicates that only a single available request shall be returned in a single response. Default value is FALSE.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.22 Resource Type pollingChannelURI	The <pollingChannelURI> virtual resource is the child resource of the <pollingChannel> resource and is used to perform service layer long polling. The AE or CSE which created the <pollingChannel> resource on its Registrar CSE sends a Retrieve request targeting the <pollingChannelURI> resource as a service layer long polling request. The response to the long polling request shall be pending until there are any requests received on the channel or the request reaches the request expiration time.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.23 Resource Type statsConfig	The <statsConfig> resource is used to store policies of statistics for AEs. The <statsConfig> resource may be established by the IN-CSEs or by IN-AEs. The <statsConfig> resource shall be located directly under <CSEBase>. The <statsConfig> resource shall contain the child resources specified in table 9.6.23-1. Table 9.6.23-1: Child resources of <statsConfig> resource Child Resources of <statsConfig> Child Resource Type Multiplicity Description [variable] <eventConfig> 0..n See clause 9.6.24. This resource configures an event for statistics collection. [variable] <subscription> 0..n See clause 9.6.8 where the type of this resource is described. [variable] <transaction> 0..n See clause 9.6.48. The <statsConfig> resource shall contain the attributes specified in table 9.6.23-2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 193 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.23-2: Attributes of <statsConfig> resource Attributes of <statsConfig> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3 creationTime 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. dynamicAuthorizationCo nsultationIDs 0..1 (L) RW See clause 9.6.1.3. creator 0..1 RO See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.24 Resource Type eventConfig	<eventConfig> sub-resource shall be used to define events that trigger statistics collection. Below are some examples of events that can be generated: • Collection based on a certain operation: collects any RETRIEVE operations on the data (i.e. resources) stored in the IN-CSE. • Collection based on storage size: collects the size of storage when a "Content Sharing Resource" stored in the IN-CSE exceeds a quota. • Combined configuration: collects all RETRIEVE operations on the data stored in the IN-CSE during a period of time. The <eventConfig> resource shall contain the child resource specified in table 9.6.24-1. Table 9.6.24-1: Child resources of <eventConfig> resource Child Resources of <eventConfig> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 where this type of resource is described. [variable] <transaction> 0..n See clause 9.6.48. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 194 (oneM2M TS-0001 version 4.15.0 Release 4) The <eventConfig> resource shall contain the attributes specified in table 9.6.24-2. Table 9.6.24-2: Attributes of <eventConfig> resource Attributes of <eventConfig> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. dynamicAuthorizationCons ultationIDs 0..1 (L) RW See clause 9.6.1.3. creator 0..1 RO See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. eventID 1 RO This attribute uniquely identifies the event to be collected for statistics for AEs. eventType 1 RW This attribute indicates the type of the event: timer based, data operation, or storage based. eventStart 0..1 RW This attribute indicates the start time of the event. eventEnd 0..1 RW This attribute indicates the end time of the event. operationType 0..1 (L) RW This attribute defines the type of the operation to be collected by statistics, such as CREATE, RETRIEVE. dataSize 0..1 RW This attribute defines the data size that will trigger a storage based event. For <container> and <timeSeries> currentByteSize is compared. For <contentInstance>, <flexContainer>, <timeSeriesInstance> contentSize is compared. An event is triggered when the compared data size exceeds dataSize size. eventResourceTypes 0..1 (L) RW This attribute indicates the list of resource types for which an event is to be captured and reported. This could be used to differentiate the same operation on different types of resources that triggers the charging activity. If this attribute is specified, then eventResourceIDs shall not be specified. eventResourceIDs 0..1 (L) RW This attribute indicates the list of resourceIDs for which the event is to be captured and reported. Whenever an operation is performed on the resourceIDs in this list, an event will be recorded provided other event criteria are met such as eventResourceType, locationRestriction and the event information based on the type of event. If this attribute is specified, then eventResourceTypes shall not be specified. eventResourceCustodians 0..1 (L) RW This attribute indicates the list of resource custodians for which the event is to be captured and reported. Whenever an operation is performed on a resource having a custodian attribute that matches an AE-ID, M2M-User-ID or CSE-ID specified in this list, an event will be recorded, provided any other specified event criteria have also been met.
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.25 Resource Type statsCollect	The <statsCollect> resource shall be used to collect information for AEs or M2M Service Users using the <eventConfig> resource as the triggers in the IN-CSE. Multiple triggers can be established at the IN-CSE for the same AE or M2M Service User. Each trigger may be activated or de-activated independently of others. The <statsCollect> resource shall be located directly under <CSEBase> of the IN-CSE. The <statsCollect> resource shall contain the child resource specified in table 9.6.25-1. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 195 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.25-1: Child resources of <statsCollect> resource Child Resources of <statsCollect> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 where the type of this resource is described. [variable] <transaction> 0..n See clause 9.6.48. The <statsCollect> resource shall contain the attributes specified in table 9.6.25-2. Table 9.6.25-2: Attributes of <statsCollect> resource Attributes of <statsCollect> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. dynamicAuthorizationCo nsultationIDs 0..1 (L) RW See clause 9.6.1.3. creator 0..1 RO See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. statsCollectID 1 RO This is the unique ID to identify a specific statistics collection scenario. It is created by the IN-CSE when the <statsCollect> resource is first created. collectingEntityID 1 WO This is the unique ID of the entity that requests the collection of statistics. For example, it can be an AE-ID, M2M-User-ID or CSE-ID. collectedEntityID 0..1(L) WO This is the list of unique ID of the entities whose request triggered the configured event for statistics collection. For example, each ID can be an AE-ID, M2M-User-ID or IN- CSE-ID. If no specific value is provided for this attribute, the IN-CSE interprets it as "any entity". statsRuleStatus 1 RW This attribute indicates whether the rule is "active" or "inactive". statModel 1 RW This attribute indicates the collection model, such as "Subscriber based", "event based", etc. collectPeriod 0..1 RW Expresses time periods defined by second, minute, hour day of month, month, and year. Supports repeating periods, and wildcards expressed as a list. eventID 0..1 RW This attribute refers to the <eventConfig> resource that defines the events that can be collected by the IN-CSE. It is mandatory if the statModel attribute is set to "event based".
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.26 Resource Announcement
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.26.1 Overview	A resource can be announced to one or more remote CSEs to inform the remote CSEs of the existence of the original resource. An announced resource can have a limited set of attributes and a limited set of child resources from the original resource. The announced resource includes a link to the original resource hosted by the original resource-Hosting CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 196 (oneM2M TS-0001 version 4.15.0 Release 4) In case that the original resource is deleted, all announced resources for the original resource shall be deleted, except for <AEAnnc> resources that were created during the registration of an AE with AE-ID-Stem starting with "S", which shall not be deleted. If the announced resource is not deleted promptly (e.g. the announced resource is not reachable), the announced resource can be deleted later either by the original resource Hosting CSE or by the expiration of the announced resource itself. The original resource shall store the list of links for the announced resources for those purposes. Synchronization between the attributes announced by the original resource and the announced resource shall be the responsibility of the original resource Hosting CSE and announced resource Hosting CSE depending on the value of the announceSyncType attribute. There shall not be any synchronization for unannounced children created at the original resource and the announced resource. The access control policy for the announced resource shall synchronize with the one from the original resource. In case that the attribute accessControlPolicyIDs is not present in the original resource it is the responsibility of the original resource Hosting CSE to choose the appropriate value depending on the policy for the original resource (e.g. take the parent accessControlPolicyIDs value). The original resource shall have at least announceTo attribute present if the resource itself has been announced. If any of the Optional Announced (OA) attributes are also announced, then announcedAttribute attribute shall also be present. An AE or other CSE can request the original resource Hosting CSE for announcing the original resource to the list of CSE-IDs or the address(es) listed in the announceTo attribute in the announcing request. An Update to the announceTo attribute will trigger new resource announcement(s) or the de-announcement(s) of the announced resource. After a successful announcement procedure the attribute announceTo contains only the list of address(es) of the announced resources. In order to announce an attribute marked as OA (see clause 9.5.0), the attribute shall be included in the announcedAttribute attribute list at the original resource. The attributes included in the announcedAttribute attribute are announced to the announced resource. On successful announcement of the resource, such attributes shall be created at the announced resource; otherwise they shall not be present in the announced resource. Update to the announcedAttribute attribute in the original resource will trigger new attribute announcement or the de-announcement of the announced attribute(s). Synchronization between the value of the announced attributes at the original resource and the announced resource is the responsibility of the original resource Hosting CSE and announced resource Hosting CSE depending on the value of the announceSyncType attribute. If an attribute in the original resource has an identifier type (i.e. CSE-ID, AE-ID, resource identifier), the original resource Hosting CSE shall convert the value of this attribute to an identifier format (see table 7.2-1) required by the Receiver CSE. If an announced resource is updated by an entity other than the original resource Hosting CSE and the announceSyncType attribute of the announced resource has a value of "Bi-directional synchronization", then the announced resource Hosting CSE shall update the original resource to synchronize the values of the announced resource attributes to the original resource. In this case, the original resource Hosting CSE shall UPDATE all other announced resource(s) listed in the announceTo attribute. If an updated announced attribute has an identifier type (i.e. CSE-ID, AE- ID, resource identifier) the announced resource Hosting CSE shall convert the value of this attribute to an identifier format (see table 7.2-1) required by the original resource Hosting CSE. An announced resource may have child resources. In general, a child resource of an announced resource shall be of one of the resource types that are specified as possible child resource types for the original resource or of one of their associate announced resource types. However, for specific announced resource types, specific exceptions apply regarding which child resource types can occur. The details on which child resources are specified for each announced resource type are summarized in table 9.6.26.1-1. Child resources of the original resource can be announced independently as needed. In this case, the child resources at the announced resource shall be of the child resource's associated announced type. When a child resource at the announced resource is created locally at the remote CSE, the child resource shall be of ordinary - i.e. not-announced - child resource type. When a Hosting CSE of an original resource is initiating an announcement, it shall first check if the parent resource is announced to the announcement target CSE by checking the announceTo attribute of the parent resource and if so, create the announced resource as a child of the announced parent resource. If the parent resource is not announced, the Hosting CSE shall check if <CSEBaseAnnc> exists into the announcement target CSE. If it does not exist, the Hosting CSE shall create a <CSEBaseAnnc> resource as a child of the <CSEBase> resource of the announcement target CSE. The Hosting CSE shall then create the announced resource as a child resource of the <CSEBaseAnnc> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 197 (oneM2M TS-0001 version 4.15.0 Release 4) When a Hosting CSE of an original resource is initiating an announcement, the From parameter of the announce request shall contain either a SP-relative-CSE-ID of the Hosting CSE of the original resource if the announcement target CSE resides in the same SP domain or an Absolute-CSE-ID of the Hosting CSE of the original resource if the announcement target CSE resides in a different SP domain. If an attribute is marked as RO and also marked as MA or OA, then only the attribute of the original resource shall be interpreted as RO. The corresponding attribute of the announced resource shall be always writable to the original resource hosting CSE to allow it to properly announce and de-announce the attribute and keep the announced attribute synchronized with the original one. Only the original resource Hosting CSE shall be allowed to update and delete the announced attribute which is created by the original resource Hosting CSE. Table 9.6.26.1-1: Announced Resource Types Announced Resource Type Short Description Child Resource Types Clause accessControlPolicyAnnc Announced variant of accessControlPolicy subscription 9.6.2 AEAnnc Announced variant of AE subscription, container, containerAnnc, flexContainer, flexContainerAnnc, group, groupAnnc, accessControlPolicy, accessControlPolicyAnnc semanticDescriptor, semanticDescriptorAnnc, timeSeries, timeSeriesAnnc 9.6.5 containerAnnc Announced variant of container container, containerAnnc, flexContainer, flexContainerAnnc, contentInstance, contentInstanceAnnc, subscription, semanticDescriptor, semanticDescriptorAnnc, timeSeries, timeSeriesAnnc 9.6.6 contentInstanceAnnc Announced variant of contentInstance semanticDescriptor, semanticDescriptorAnnc 9.6.7 CSEBaseAnnc Announced variant of CSEBase container, containerAnnc, dynamicAuthorizationCons ultationAnnc, flexContainer, flexContainerAnnc, group, groupAnnc, accessControlPolicy, accessControlPolicyAnnc, subscription, scheduleAnnc, semanticDescriptorAnnc, semanticMashupJobProfile Annc, timeSeries, timeSeriesAnnc, remoteCSEAnnc, nodeAnnc, mgmtObjAnnc, AEAnnc, locationPolicyAnnc 9.6.3 dynamicAuthorizationConsul tationAnnc Announced variant of dynamicAuthorizationConsultation None specified 9.6.40 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 198 (oneM2M TS-0001 version 4.15.0 Release 4) Announced Resource Type Short Description Child Resource Types Clause flexContainerAnnc Announced variant of flexContainer container, containerAnnc, flexContainer, flexContainerAnnc, subscription, semanticDescriptor, semanticDescriptorAnnc, timeSeries, timeSeriesAnnc 9.6.35 groupAnnc Announced variant of group subscription, semanticDescriptor, semanticDescriptorAnnc 9.6.13 locationPolicyAnnc Announced variant of locationPolicy None specified 9.6.10 mgmtObjAnnc Announced variant of mgmtObj subscription 9.6.15 nodeAnnc Announced variant of node mgmtObjAnnc, subscription, semanticDescriptor, semanticDescriptorAnnc, scheduleAnnc 9.6.18 remoteCSEAnnc Announced variant of remoteCSE container, containerAnnc, dynamicAuthorizationCons ultationAnnc, flexContainer, flexContainerAnnc, group, groupAnnc, accessControlPolicy, accessControlPolicyAnnc, subscription, scheduleAnnc, semanticDescriptorAnnc, semanticMashupJobProfile Annc, timeSeries, timeSeriesAnnc, remoteCSEAnnc, nodeAnnc, mgmtObjAnnc, AEAnnc, locationPolicyAnnc 9.6.4 scheduleAnnc Announced variant of schedule None specified 9.6.9 semanticDescriptorAnnc Announced variant of semanticDescriptor Subscription 9.6.30 semanticMashupInstanceAn nc Announced variant of semanticMashupInstance None specified 9.6.54 semanticMashupJobProfileA nnc Announced variant of semanticMashupJobProfile None specified 9.6.53 timeSeriesAnnc Announced variant of timeSeries timeSeriesInstance, timeSeriesInstanceAnnc, subscription, semanticDescriptor, semanticDescriptorAnnc 9.6.36 timeSeriesInstanceAnnc Announced variant of timeSeriesInstance None specified 9.6.37 timeSyncBeaconAnnc Announced variant of timeSyncBeacon subscription 9.6.69 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 199 (oneM2M TS-0001 version 4.15.0 Release 4)
2bd691fcce98b96819b9b3b005c72741	118 101	9.6.26.2 Universal Attributes for Announced Resources	Table 9.6.26.2-1 lists the universal attributes for the announced resources. If an attribute is marked "NA" in the original resource type or it is marked "OA" and is not provided by the Originator, then the value for the corresponding attribute in the announced resource is provided by the <remote CSE> resource. Table 9.6.26.2-1: Universal Attributes for Announced Resources Attributes Name Mandatory /Optional Description resourceType Mandatory Resource Type. As specified in clause 9.2, a suffix of "Annc" to the name of the original resource type shall be used to indicate the name for the associated announced resource type. resourceID Mandatory Identifies the resource at the remote CSE. resourceName Mandatory See clause 9.6.1.3 for information on this attribute. parentID Mandatory Identifies the parent resource at the remote CSE. creationTime Mandatory See clause 9.6.1.3 for information on this attribute. lastModifiedTime Mandatory See clause 9.6.1.3 for information on this attribute. expirationTime Mandatory See clause 9.6.1.3.2 for information on this attribute. This attribute cannot exceed the value received from the original resource but it can be overridden by the policies of the remote CSE hosting the announced resource. link Mandatory Provides the URI to the original resource.

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.