hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.39.1 Introduction | The <timeSeriesInstance> resource represents a data instance in the <timeSeries> resource. The detailed description can be found in clause 9.6.37 in ETSI TS 118 101 [6]. Table 7.4.39.1-1: Data type definition of <timeSeriesInstance> resource Data Type ID File Name Note timeSeriesInstance CDT-timeSeriesInstance-v2_7_0.xsd Table 7.4.39.1-2: Universal/Common Attributes of <timeSeriesInstance> resource Attribute Name Request Optionality Create @resourceName O resourceType NP resourceID NP parentID NP creationTime NP expirationTime O lastModifiedTime NP labels O announceTo O announcedAttribute O ETSI ETSI TS 118 104 V2.7.1 (2016-10) 196 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.39.1-3: Resource Specific Attributes of <timeSeriesInstance> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create dataGenerationTime M m2m:absRelTimestamp No default content M xs:anySimpleType No default sequenceNr O xs:nonNegativeInteger No default |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.39.2 <timeSeriesInstance> resource specific procedure on CRUD operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.39.2.0 Introduction | This clause describes <timeSeriesInstance> resource specific behaviour for CRUD operations. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.39.2.1 Create | Originator: No change from the generic procedures in clause 7.2.2.1 with the following exception: The Originator shall maintain an internal counter to generate sequenceNr which is increased by one. When the sequenceNr reaches to the maxNrOfInstances of the direct parent <timeSeries> resource, it shall be set to one. Receiver: Primitive specific operation on Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed": 1) currentNrOfInstances and currentByteSize of direct parent <timeSeries> resource shall be updated. If currentNrOfInstances and/or currentByteSize exceeds maxNrOfInstances and/or maxByteSize of direct parent < timeSeries> resource respectively, the Hosting CSE shall return the response primitive with a Response Status Code indicating " NOT_ACCEPTABLE" error. 2) If the sequenceNr exceeds maxNrOfInstances of direct parent < timeSeries> resource, the Hosting CSE shall return the response primitive with a Response Status Code indicating " NOT_ACCEPTABLE" error. No other changes from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.39.2.2 Retrieve | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.39.2.3 Update | Originator: The <timeSeriesInstance> resource shall not be Updated via API. Receiver: Primitive specific operation on Recv-1.0 "Check the syntax of received message": If the request is received, the Receiver CSE shall execute the following steps in order. 1) "Create an unsuccessful Response primitive" with the Response Status Code indicating "OPERATION_NOT_ALLOWED" error. 2) "Send the Response primitive". ETSI ETSI TS 118 104 V2.7.1 (2016-10) 197 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.39.2.4 Delete | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Primitive specific operation on Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed": 1) currentNrOfInstances and currentByteSize of direct parent <timeSeries> resource shall be updated. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.40 Resource Type <role> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.40.1 Introduction | The <role> resource represents a role that is assigned to an AE or CSE. The detailed description can be found in clause 9.6.38 in ETSI TS 118 101 [6]. Table 7.4.40.1-1: Data type definition of <role> resource Data Type ID File Name Note role CDT-role-v2_7_0.xsd Table 7.4.40.1-2: Universal/Common Attributes of <role> resource Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP parentID NP NP accessControlPolicyI Ds O O expirationTime O O labels O O creationTime NP NP lastModifiedTime NP NP dynamicAuthorization ConsultationIDs O O Table 7.4.40.1-3: Resource Specific Attributes of <role> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update roleID M NP m2m:roleID No default issuer M NP m2m:ID No default holder M NP m2m:ID No default notBefore M NP m2m:timestamp No default notAfter M NP m2m:timestamp No default roleName O NP xs:string No default tokenLink O O xs:anyURI No default Table 7.4.40.1-4: Child Resources of <role> resource Child Resource Type Child Resource Name Multiplicity Ref. to in Resource Type Definition <subscription> [variable] 0..n Clause 7.4.8 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 198 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.40.2 <role> resource specific procedure on CRUD operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.40.2.0 Introduction | This clause describes <role> resource specific behaviour for CRUD operations. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.40.2.1 Create | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.40.2.2 Retrieve | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.40.2.3 Update | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.40.2.4 Delete | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.41 Resource Type <token> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.41.1 Introduction | The <token> resource represents a token that is issued to an AE or CSE. The detailed description can be found in clause 9.6.39 in ETSI TS 118 101 [6]. Table 7.4.41.1-1: Data type definition of <token> resource Data Type ID File Name Note token CDT-token-v2_7_0.xsd ETSI ETSI TS 118 104 V2.7.1 (2016-10) 199 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.41.1-2: Universal/Common Attributes of <token> resource Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP parentID NP NP accessControlPolicyIDs O O expirationTime O O labels O O creationTime NP NP lastModifiedTime NP NP dynamicAuthorizationConsultationIDs O O Table 7.4.41.1-3: Resource Specific Attributes of <token> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update tokenID M NP m2m:tokenID No default tokenObject M NP m2m:dynAuthJWT No default version O NP xs:string No default issuer O NP m2m:ID No default holder O NP m2m:ID No default notBefore O NP m2m:timestamp No default notAfter O NP m2m:timestamp No default tokenName O NP xs:string No default audience O NP List of m2m:ID No default permissions O NP List of m2m:tokenPermission No default extension O NP xs:string No default Table 7.4.41.1-4: Child Resources of <token> resource Child Resource Type Child Resource Name Multiplicity Ref. to in Resource Type Definition <subscription> [variable] 0..n Clause 7.4.8 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.41.2 <token> resource specific procedure on CRUD operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.41.2.0 Introduction | This clause describes <token> resource specific behaviour for CRUD operations. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.41.2.1 Create | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.41.2.2 Retrieve | Originator: No change from the generic procedures in clause 7.2.2.1. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 200 oneM2M TS-0004 version 2.7.1 Release 2 Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.41.2.3 Update | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.41.2.4 Delete | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.42 Resource Type <trafficPattern> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.42.1 Introduction | The <trafficPattern> resource defines the communication pattern and the mobility pattern of a field domain node. Additional description of the <trafficPattern> resource is contained in clauses 9.6.42 and 10.2.37 of ETSI TS 118 101 [6]. Table 7.4.42.1-1: Data type definition of <trafficPattern> resource Data Type ID File Name Note trafficPattern CDT-trafficPattern-v2_7_0.xsd Table 7.4.42.1-2: Universal/Common Attributes of <trafficPattern> resource Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP parentID NP NP accessControlPolicyI Ds O O creationTime NP NP expirationTime O O lastModifiedTime NP NP dynamicAuthorization ConsultationIDs O O labels O O announceTo O O announcedAttribute O O ETSI ETSI TS 118 104 V2.7.1 (2016-10) 201 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.42.1-3: Resource Specific Attributes of <trafficPattern> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update providedToNSE NP NP xs:boolean False periodicIndicator O O m2m:periodicIndicator No default periodicDurationTime O O xs:unsignedInt No default Unit: second periodicIntervalTime O O xs:unsignedInt No default Unit: second stationaryIndication O O m2m:stationaryIndication No default dataSizeIndicator O O xs:positiveInteger No default Unit: Byte validityTime O O m2m:timestamp No default targetNetwork M O m2m:listOfM2MID None Table 7.4.42.1-4: Child Resources of <trafficPattern> resource Child Resource Type Child Resource Name Multiplicity Ref. to in Resource Type Definition <subscription> [variable] 0..n Clause 7.4.8 <schedule> [variable] 0..1 Clause 7.4.9 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.42.2 <trafficPattern> resource specific procedure on CRUD operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.42.2.1 Create | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Primitive specific operation on Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed": The CSE shall: 1) Select a NSE of the target Network for which the traffic pattern is applicable to request for the configuration of the TP parameter sets to Underlying Network, 2) Send a request to provide the TP parameter sets for the Field Domain Node to the NSE, using appropriate Mcn protocols. (See Annex B.2 for parameter mapping details. See clause 8.3.5 in ETSI TS 118 101 [6] for general procedures.) 3) Upon receipt of a successful response to that request the CSE shall internally update the providedToNSE attribute of the <trafficPattern> resource with the value TRUE. Upon receipt of a unsuccessful response to that request the CSE shall internally update the providedToNSE attribute of the <trafficPattern> resource with the value FALSE. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.42.2.2 Retrieve | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 202 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.42.2.3 Update | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Primitive specific operation on Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed": The CSE shall: 1) Select a NSE of the target Network for which the traffic pattern is applicable 2) Send a request to delete the previous TP parameter sets for the Field Domain Node to the NSE, using appropriate Mcn protocols. 3) Send a request to provide the new TP parameter sets for the Field Domain Node to the NSE, using appropriate Mcn protocols. 4) Upon receipt of a successful response to that request the CSE shall internally update the providedToNSE attribute of the <trafficPattern> resource with the value TRUE. Upon receipt of a unsuccessful response to that request the CSE shall internally update the providedToNSE attribute of the <trafficPattern> resource with the value FALSE. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.42.2.4 Delete | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Primitive specific operation on Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed": The CSE shall: 1) Select a NSE of the target Network for which the traffic pattern is applicable 2) Send a request to delete the previous TP parameter sets for the field domain node to the NSE, using appropriate Mcn protocols. 3) Receive the response to that request. Upon receipt of a unsuccessful response to that request the CSE may resend the request to the NSE. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.5 Primitive-specific procedures and definitions | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.5.1 Notification data object and procedures | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.5.1.1 Notification data object | Notification procedures represent a special case of the generic procedures defined in clause 7.2.2, where the Operation parameter of the request primitive is set to value "N" (Notify). In this case, the request primitive is referred to as Notify request primitive, and the associated response primitive is denoted as Notify response primitive. A Notify request primitive shall convey a special notification data object in its Content parameter. This notification data object has no resource type representation in the ETSI TS 118 101 [6], since it does not represent a resource accessible by any M2M entities. The data type of the notification data object is defined in the tables below. The first column of Table 7.5.1.1-2 defines the permitted names the root element the notification data object can take with the data type listed in the third column. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 203 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.5.1.1-1: Data Type Definition of notification data object Data Type ID File Name Note notification CDT-notification-v2_7_0.xsd Table 7.5.1.1-2: Data Types for notification data objects Root Element Name Request Optionality Data Type Default Value and Constraints N notification O m2m:notification aggregatedNotification O m2m:aggregatedNotification responsePrimitive O m2m:responsePrimitive securityInfo O m2m:securityInfo When an Originator sends a Notify primitive to an AE Receiver, it shall use one of the serializations specified in that AE's contentSerialization attribute. If the AE has no contentSerialization attribute, the Originator is free to choose the serialization format itself. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.5.1.2 Notification procedures | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.5.1.2.1 Introduction | Notification procedures shall be employed for the following use cases: • to notify Receiver(s) of modifications of a resource for an associated <subscription> resource, • to request Receiver(s) to perform resource subscription verification, • to notify deletion of the <subscription> resource, • to notify Receiver(s) for Asynchronous Non-blocking Request, • to notify Receiver(s) of modifications of a resource when the subscription relationship is established through the <group> resource. • to send the response corresponding to a request delivered via service layer long polling (clause 7.4.22.2.2 Retrieve <pollingChannelURI>). • to notify Receiver(s)(i.e. IPE) for on-demand discovery request. • to notify Receiver(s) of the missing Time Series Data points for an associated <subscription> resource. • to notify Receiver(s) of a security related request (e.g. dynamic authorization and end-to-end security). The following sub-clauses specify the notification procedures for each of the above use cases. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.5.1.2.2 Notification for modification of subscribed resources | When the notification message is forwarded or aggregated by transit CSEs, the Originator or a transit CSE shall check whether there are notification policies to enforce between subscription resource Hosting CSE and the notification target. In that case, the transit CSE as well as the Originator shall process Notify request primitive(s) by using the corresponding policy and send processed Notify request primitive(s) to the next CSE with notification policies related to the enforcement so that the transit CSE is able to enforce the policy defined by the subscriber. The notification policies related to the enforcement at this time is verified by using the subscription reference in the Notify request primitive. In the notification policies, the latestNotify attribute is only enforced in the transit CSE as well as the Originator. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 204 oneM2M TS-0004 version 2.7.1 Release 2 If Event Category parameter is set to 'latest' in the notification request primitive, the transit CSE as well as Originator shall cache the most recent Notify request. That is, if a new Notify request is received by the CSE with a subscription reference that has already been buffered for a pending Notify request, the newer Notify request will replace the buffered older Notify request. Originator: When an event is generated, the Originator shall execute the following steps in order: Step 1.0 Check the eventNotificationCriteria attribute of the <subscription> resource associated with the modified resource: • If the eventNotificationCriteria attribute is set, then the Originator shall check whether the corresponding event matches with the event criteria. • If notificationEventType is not set within the eventNotificationCriteria attribute, the Originator shall use the default setting of Update_of_Resource to compare against the event. • If the notificationEventType has either an explicit or default value of "Update_of_Resource" and the attribute condition is also present then the matching event shall only be detected if one of the attributes in the list has been updated. If the attribute condition is not present then a matching event is generated whenever any attribute has been updated. • If the event matches, go to the step 2.0. Otherwise, the Originator shall discard the corresponding event. • If the eventNotificationCriteria attribute is not configured, the Originator shall use the default setting of Update_of_Resource for notificationEventType and then continue with the step 2.0. Step 2.0 The Originator shall check the notification policy as described in the below steps, but the notification policy may be checked in different order. After checking the notification policy in step 2.0 (i.e. from step 2.1to step 2.6), then continue with step 3.0 Step 2.1 The Originator shall determine the type of the notification per the notificationContentType attribute. The possible values of for notificationContentType attribute are 'Modified Attributes', 'All Attributes', and or optionally 'ResourceID'. This attribute may be used joint with eventType attribute in the eventNotificationCriteria to determine if it is the attributes of the subscribed-to resource or the attributes of the child resource of the subscribed-to resource that shall be returned in the notification. • If the value of notificationContentType is set to 'Modified Attribute', the Notify request primitive shall include the modified attribute(s) only • If the value of notificationContentType is set to 'All Attributes', the Notify request primitive shall include the whole subscribed-to resource • If the value of notificationContentType is set to 'ResourceID', the Notify request primitive shall include the resourceID of the subscribed-to resource Step 2.2 Check the notificationEventCat attribute: • If the notificationEventCat attribute is set, the Notify request primitive shall employ the Event Category parameter as given in the notificationEventCat attribute. Then continue with the step 2.3. • If the notificationEventCat attribute is not configured, then continue with step 2.3. Step 2.3 Check the latestNotify attribute: • If the latestNotify attribute is set, the Originator shall assign Event Category parameter of value 'latest' of the notifications generated pertaining to the subscription created. Then continue with step 3.0. NOTE: The use of some attributes such as rateLimit, batchNotify and preSubscriptionNotify is not supported in the present document. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 205 oneM2M TS-0004 version 2.7.1 Release 2 Step 3.0 The Originator shall check the notification and reachability schedules, but the notification schedules may be checked in different order. If the <subscription> resource associated with the modified resource includes a <notificationSchedule> child resource, the Originator shall check the time periods given in the scheduleElement attribute of the <notificationSchedule> child resource. Also, the Originator shall check the reachability schedule associated with the Receiver by exploring its <schedule> resource. If reachability schedules are not present in a Node then that Entity is considered to be always reachable If notificationSchedule and reachability schedule indicate that message transmission is allowed, then proceed with step 5.0. Otherwise, proceed with step 4.0 In particular, if the notificationEventCat attribute is set to 'immediate' and the <notificationSchedule> resource does not allow transmission, then go to step 5.0 and send the corresponding Notify request primitive by temporarily ignoring the Originator's notification schedule Step 4.0 Check the pendingNotification attribute: If the pendingNotification attribute is set, then the Originator shall cache pending Notify request primitives according to the pendingNotification attribute. The possible values are 'sendLatest' and 'sendAllPending'. If the value of pendingNotification is set to 'sendLatest', the most recent Notify request primitive shall be cached by the Originator and it shall set the Event Category parameter to 'latest'. If pendingNotification is set to 'sendAllPending', all Notify request primitives shall be cached by the Originator. If the pendingNotification attribute is not configured, the Originator shall discard the corresponding Notify request primitive. The processed Notify request primitive by the pendingNotification attribute is sent to the Receiver after the reachability recovery (see the step 6.0) Step 5.0 Check the expirationCounter attribute: If the expirationCounter attribute is set, then it shall be decreased by one when the Originator successfully sends the Notify request primitive. If the counter equals to zero('0'), the corresponding <subscription> resource shall be deleted. Then end the 'Compose Notify Request Primitive' procedure If the expirationCounter attribute is not configured, then end the 'Compose Notify Request Primitive' procedure Originator: After reachability recovery, the Originator shall execute the following steps in order: Step 6.0 If the pendingNotification attribute is set, the Originator shall send the processed Notify request primitive by the pendingNotification attribute and, then continue with the step 7.0 Step 7.0 Check the expirationCounter attribute: If the expirationCounter attribute is set, then its value shall be decreased by one when the Originator successfully sends the Notify request primitive. If the counter meets zero, the corresponding <subscription> resource shall be deleted. Then end the 'Compose Notify Request Primitive' procedure. If the expirationCounter attribute is not configured, then end the 'Compose Notify Request Primitive' procedure ETSI ETSI TS 118 104 V2.7.1 (2016-10) 206 oneM2M TS-0004 version 2.7.1 Release 2 Receiver: When the Hosting CSE receives a Notify request primitive, the Hosting CSE shall check validity of the primitive parameters. In case the Receiver is a transit CSE which forwards or aggregates Notify request primitives before sending to the subscriber or other transit CSEs, upon receiving the Notify request primitive with the Event Category parameter set to 'latest', the Receiver shall identify the latest Notify request primitive with the same subscription reference while storing Notify request primitives locally. When the Receiver as a transit CSE needs to send pending Notify request primitives, it shall send the latest Notify request primitive. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.5.1.2.3 Subscription Verification during Subscription Creation | Originator: When the Originator is triggered to perform subscription verification (clause 7.4.8.2.1) during <subscription> creation procedure, it performs the following steps in order. 1) Set the verificationRequest element of the notification data object as TRUE in the Notify request primitive. 2) Set the creator element of the notification data object as the Originator ID of the <subscription> creation in the primitive. 3) Set the to parameter as notificationURI in the primitive. If the notificationURI contains more than one value, then set the other value to the duplicated primitives from step 2). 4) Send the Notify request primitive(s). Receiver: When the Hosting CSE receives a Notify request primitive which includes verificationRequest element of the notification data object set as TRUE, the Hosting CSE shall check if the creator and the Originator have NOTIFY privilege to the notificationURI. If it fails, the Hosting CSE shall return a Response Status Code indicating "SUBSCRIPTION_CREATOR_HAS_NO_PRIVILEGE" or "SUBSCRIPTION_HOST_HAS_NO_PRIVILEGE" error, respectively, with the Notify response primitive. Otherwise, it shall return successful response primitive. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.5.1.2.4 Notification for Subscription Deletion | Originator: When the <subscription> resource is deleted and subscriberURI of the <subscription> resource is configured , the Originator shall send a Notify request primitive with subscriptionDeletion element of the notification data object set as TRUE and subscriptionReference element set as the URI of the <subscription> resource to the entity indicated in subscriberURI. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.5.1.2.5 Notification for Asynchronous Non-blocking Request | Originator: When the requested operation for a nonBlockingAsynch request is completed, the Originator (=Hosting CSE of the resource) shall send a Notify request primitive to inform the final result of requested operation against the oneM2M resource. When the notificationURI was present and empty in the Response Type parameter in the previously received nonBlockingAsync request, no notification with the result of the requested operation shall be sent at all by the Originator. Otherwise, the Originator shall send a Notify request primitive as follows: (If the notificationURI was present and contains multiple entries, then the Originator shall repeat the following steps for each entry in the notificationURI list.)The Originator shall compose a Request primitive with following parameter settings: a. The From parameter shall be set to the ID of the Originator (i.e. Hosting CSE which hosts the resource targeted by the previously received nonBlockingAsynch request). b. If the notificationURI was not present in the Response Type parameter in the previously received nonBlockingAsync request, then the To parameter shall be set to the Originator of the previously received nonBlockingAsynch request. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 207 oneM2M TS-0004 version 2.7.1 Release 2 If the notificationURI was present and not empty in the Response Type parameter in the previously received nonBlockingAsync request, then the To parameter shall be set to the next notificationURI list entry c. The Response Type : If the Originator chooses to send the Notification in nonBlockingAsynch mode, the Originator shall include a notificationURI in the Response Type and set it to empty. d. The Content parameter shall be set to the response to the previously received nonBlockingAsynch request as m2m:responsePrimitive. 5) The Originator shall send the Request primitive. See clause 7.3.1.2 for detail. Receiver: No change from the generic procedure in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.5.1.2.6 Notification for subscription via group | Whenever the subscribed to resources' modification triggers a notification procedure as defined in clause 7.5.1.2.2 and the subscription relationship is established through group resource, the following procedure shall be performed. The Member hosting CSE shall perform the steps defined in clause 7.5.1.2.2. The Group hosting CSE shall perform the following steps in order: 1) Validate if the notification is sent from its own member resources when it gets a notification at the notificationURI. The group hosting CSE shall return a response primitive with the Response Status Code indicating "ORIGINATOR_HAS_NO_PRIVILEGE" error if the validation fails. 2) Upon successful validation, the group hosting CSE shall collect notification requests targeted at the same subscriber according to the notificationForwardingURI element of each notification data object. The group hosting CSE shall aggregate the notification requests into an aggregatedNotification element of the notification data object. The timing of aggregation is done as per the group hosting CSE's local policy which is out of scope of the present document. 3) Send the aggregated notification to the notificationURI according to the notificationForwardingURI element in the notification data object. In case the group hosting CSE is member of another group hosting CSE through which the subscription is created, the notification request shall be sent according to the mapping of the notificationURI of the two group hosting CSEs. When aggregating the notification requests, the group hosting CSE may utilize the Request Expiration Timestamp parameter of the notification request primitive to determine the time by which the aggregated notifications need to be sent. 4) "Wait for Response primitive" procedure. 5) Upon receiving the response, the group hosting CSE shall send the response separately to each individual member hosting CSEs to respond their corresponding notify request. The group hosting CSE may also stop aggregating notification requests depending on its own policy. The group hosting CSE shall not stop aggregating notification requests before the corresponding subscription expires. The Subscriber shall perform the following steps in order: 1) Extract each notification from the aggregated notification; 2) Treat the notification as if it is sent from the original subscribed-to resource; 3) "Create a success response" procedure; 4) "Send the Response primitive" procedure. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.5.1.2.7 Notification for service layer long polling | When a CSE gets a request for itself via service layer long polling (clause 7.4.22.2.2 Retrieve <pollingChannelURI>), it shall send the corresponding response in a Notify request targeting <pollingChannelURI> resource on its registrar CSE. For more details, see the clause 7.4.22.2.5 Notify <pollingChannelURI> resource. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 208 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.5.1.2.8 Notification for on-demand discovery request | In this procedure, the Originator is the Hosting CSE which performs resource discovery and the Receiver is the IPE. Originator: The Hosting CSE shall include the Originator ID of the original discovery request and the Filter Criteria in the Notify request. The To parameter of this request shall be set to the pointOfAccess of the <AE> resource of the IPE. Receiver: When the IPE receives the Notify request, it shall check the Originator ID and determines whether it performs external discovery. If the IPE does not accept the discovery, it shall send the unsuccessful response with the Response Status Code indicating "DISCOVERY_DENIED_BY_IPE". If the IPE accepts the discovery, it performs external discovery. If the discovery result contains one or more match, the IPE shall create resource(s) for the result and send the Notify response including the list of created resource(s) in the Content parameter. The IPE may configure "Discover" privilege for the original discovery request Originator for the newly created resource(s). |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.5.1.2.9 Notification for the missing Time Series Data | When an AE wants to be informed of the number of missing data points in a given renewable time duration, the AE should request the creation of a <subscription> resource and set the missingData in the eventNotificationCriteria conditions to specify the reporting policy. This enables the AE to keep track of the number of missing data points and the corresponding time-stamps over a predefined but renewable duration (i.e. the "duration" of the missingData). Originator(Hosting CSE): No change from the procedures in clause 7.2.2.1 except the following addition in Step1.0: When the first missing data point is detected (i.e. a detection of the first discontinuous time-stamp), following the creation of the subscription, the Hosting CSE shall start a timer, and keep counting the number of the missing data points. The timer is set according to the "duration" in the missingData. The reporting policy is governed by the rules below: • If the total number of missing data points becomes equal to or greater than the "number" specified in missingData before the timer expires, a NOTIFY request shall be sent with the missingDataList and currentMissingDataNr included in the NOTIFY request. The missing data points counter is reset back to 0 and counting resumes while the timer continues to run (since it did not expire). Initiating NOTIFY request to report missing data points, as well as counter reset, shall follow the same logic described above until such time as the timer expires (see next bullet for behaviour when the timer expires). • If the total number of missing data points does not exceed the "number" specified in missingData at timer expiry, a NOTIFY Request shall not be sent with the missing data points and the timer is restarted, and the missing data points counter is rest back to 0. • If no missing points have been detected at all during the life time of a subscription, then no timer shall be started at all. But once a timer is started triggered by the first missing data point, then the above rules in the previous bullets shall apply. • The renewal of the timer and the missing data points counter upon timer expiry shall continue until such time as the subscription is cancelled or terminated. Once a subscription is terminated, a final NOTIFY request is sent out with the current number of missing data points and the timer is stopped. No change for the remaining steps from the procedures in clause 7.5.1.2.2. 7.5.1.2.10 Notification for Dynamic Authorization Dynamic Authorization uses a two-way exchange of information between a Hosting CSE (i.e. Originator) and a Dynamic Authorization System (DAS) Server (i.e. Receiver). This two-way handshake is performed using a Notification request and response. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 209 oneM2M TS-0004 version 2.7.1 Release 2 Originator: When the Originator (i.e. Hosting CSE) is triggered to perform dynamic authorization for an incoming request that it receives, then it performs the following steps in order: 1) Configure the To parameter with the address of the corresponding DAS Server associated with the resource targeted by the received request. The Hosting CSE shall use the DAS Server address information configured within the dynamicAuthorizationPoA attribute of the <dynamicAuthorizationConsultation> resource associated with the targeted resource. The Hosting CSE shall determine the corresponding <dynamicAuthorizationConsultation> resource using the dynamicAuthorizationConsultationIDs attribute of the targeted resource. If the attribute is not supported by the targeted resource, or it is not set, or it has a value that does not correspond to a valid <dynamicAuthorizationConsultation> resource(s), or it refers to a <dynamicAuthorizationConsultation> resource(s) that is not reachable, then based on system policies, the dynamicAuthorizationConsultationIDs associated with the parent may apply to the child resource if present, or a system default <dynamicAuthorizationConsultation> may apply if present. If a dynamicAuthorizationConsultationID attribute and corresponding <dynamicAuthorizationConsultation> resource can not be found or if the dynamicAuthorizationEnabled of a <dynamicAuthorizationConsultation> has a value of FALSE, the Hosting CSE shall reject the request by returning an "ORIGINATOR_HAS_NO_PRIVILEGE" Response Status Code to the Originator of the received request and no additional steps shall be performed. 2) Configure the From parameter with the ID of the Hosting CSE which hosts the resource targeted by the received request. 3) Configure the mandatory sub-elements of the securtyInfo element of the notification data a. The securityInfoType element shall be configured as "1" (Dynamic Authorization Request) in the Notify request primitive. b. The originator element shall be configured with the ID of the Originator of the received request. c. The targetedResourceType element shall be configured with the type of resource targeted by the received request. d. The operation element shall be configured with the type of operation targeted by the received request. 4) Optionally configure one or more optional sub-elements of the securityInfo element of the notification data e. The originatorIP element may be configured with the IP address of the Originator of the received request. f. The originatorLocation may be configured with the location of the Originator of the received request. g. The originatorRole may be configured with the role of the Originator of the received request. h. The requestTimestamp may be configured with the time at which the request was received. i. The targetedResourceID may be configured with the identifier of the targeted resource of the received request. j. The proposedPrivilegesLifetime may be configured with a time duration for which the Hosting CSE is requesting privileges be granted to the Originator of the received request. k. The rolesFromACPs may be configured with a list of roles specified in the ACPs associated with the resource targeted by the received request. l. The tokenIds may be configured with a list of token identifiers specified by the Originator of the received request. 5) The Hosting CSE shall send the notification request for dynamic authorization to the targeted DAS Server. Receiver: When the DAS Server receives a notification request for dynamic authorization, it processes the request and returns a notification response for dynamic authorization to the originating Hosting CSE. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 210 oneM2M TS-0004 version 2.7.1 Release 2 NOTE: The details of how the DAS Server processes the notification request for dynamic authorization are not visible to the oneM2M system, and are not addressed in the present document. Originator: When the Hosting CSE receives a notification response for dynamic authorization, it performs the following steps in order: 1) The Hosting CSE shall verify that the securityInfoType element of the securtyInfo element of the notification is configured as "2" (Dynamic Authorization Response). If it is not, the Hosting CSE shall not grant privileges to the Originator of the request for which the Hosting CSE was attempting dynamic authorization. The Hosting CSE shall reject the request by returning an "ORIGINATOR_HAS_NO_PRIVILEGE" Response Status Code to the Originator of the received request and no additional steps shall be performed. 2) The Hosting CSE shall check whether the response contains a dynamicACPInfo element. If present, the Hosting CSE shall create a <accesscontrolPolicy> child resource under the targeted resource and configure its privileges using the dynamicACPInfo. In this case, the Hosting CSE shall configure the privileges attribute with the grantedPriviliges and the expirationTime attribute with the privilegesLifetime. The Hosting CSE shall also configure the selfPrivileges attribute to allow itself to perform Update/Retrieve/Delete operations on the newly created <accesscontrolPolicy> resource. 3) The Hosting CSE shall check whether the response contains a tokens element. If present the Hosting CSE shall perform verification and caching of the token as specified in clause 7.3.2 in ETSI TS 118 103 [7]. NOTE: The Hosting CSE uses the information in the DAS response for authorization, see clause 7.3.3.15. 7.5.1.2.11 Notification for receiverESPrimRandObject Generation Originator: When the Originator is triggered to perform receiverESPrimRandObject generation as part of establishing sessionESPrimKey with a Receiver, it performs the following steps in order: 1) Configure the To parameter with the address of the Receiver's <CSEBase> or <AE> resource. 2) Configure the From parameter with the ID of the Originator. 3) The securityInfoType element of the securityInfo element of the notification data shall be configured as "3" (receiverESPrimRandObject Request) in the Notify request primitive 4) The Originator shall send the notification request for dynamic authorization to the targeted Receiver. Receiver: When a Receiver receives a notification request, it processes the securityInfoType element of the securityInfo element and determines that the notification is for receiverESPrimRandObject generation. The Receiver generates an receiverESPrimRandObject as specified in ETSI TS 118 103 [7]. Then the Receiver sends a notification response to the Originator, with the securityInfo element containing the following elements • The securityInfoType element shall be configured as "4" (receiverESPrimRandObject Response) in the Notify request primitive • The esprimRandObject shall contain the receiverESPrimRandObject. When the Originator receives a notification response for dynamic authorization, it performs the following steps in order: 1) The Originator shall verify that the securityInfoType element of the securityInfo element of the notification is as configured as "4" (receiverESPrimRandObject Response). 2) The Originator shall check whether the securityInfo element contains an esprimRandObject element. If it does, the Originator shall use the receiverESPrimRandObject in esprimRandObject element in the generation of sessionESPrimKey. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 211 oneM2M TS-0004 version 2.7.1 Release 2 7.5.1.2.12 Notification for End-to-End Security Certificate-based Key Establishment (ESCertKE) The End-to-End Security Certificate-based Key Establishment (ESCertKE) uses a four-way exchange of messages to establish a symmetric key for end-to-end security between the Originator and Receiver. This four-way exchange consists of two sequential two-way (request and response) exchanges using Notification for transport Originator: When the Originator is to perform ESCertKE with the Receiver, then the Originator performs following steps in order: 1) The Originator shall form the ESCertKE Message 1 as specified in ETSI TS 118 103 [7]. 2) The Originator performs the general procedure for an Originator as described in clause 7.2.2.1 with the following additional details a. In step Orig-1.0, described in step 7.3.1.1, a Notify Request primitive shall be formed with the Notification data comprising a securityInfo element with securityInfoType element set to "6" (ESCertKE Message) and escertkeMessage element set to the value of the ESCertKE message 1. Receiver: When a Receiver receives the Request, then the Receiver performs the general procedure for a Receiver with the following additional steps performed as part of Recv-6.5 for Notify Retargeting described in clause 7.3.3.9: 1) The Receiver extracts the securityInfo element from the notification data. 2) The Receiver examines the securityInfoType element of the securityInfo element and determines from its value "6" (ESCertKE Message) that the notification is for ESCertKE. 3) The Receiver extracts the ESCertKE message 1 contained in escertkeMessage element of the securityInfo element. 4) The Receiver processes ESCertKE message 1 as specified in clause 8.7 of ETSI TS 118 103 [7], resulting in ESCertKEY message 2. 5) The Receiver forms the Response content comprising a securityInfo element with securityInfoType element set to "6" (ESCertKE Message) and escertkeMessage element set to the value of the ESCertKE message 2. Originator: The Originator performs the following steps at Orig-6.0 "Process Response Primitive": 1) The Originator extracts the securityInfo element from the Response Content parameter. 2) The Originator examines the securityInfoType element of the securityInfo element and verifies that from its value is "6" (ESCertKE Message). 3) The Originator extracts the ESCertKE message 2 contained in escertkeMessage element of the securityInfo element. 4) The Originator processes ESCertKE message 2 as specified in clause 8.7 of ETSI TS 118 103 [7], resulting in ESCertKEY message 3. The Originator and Receiver now repeat steps 2) to 10), with ESCertKE message 3 replacing ESCertKE message 1, and ESCertKE message 4 replacing ESCertKE message 2. Following the repeat of Steps 2) to 10), the following step is performed to conclude the procedure: 1) The Originator processes ESCertKE message 2 as specified in clause 8.7 of ETSI TS 118 103 [7]. 7.5.1.2.13 Using Notify for transport of ESPrim Objects The Notify operation is used for transport of ESPrim Objects protecting an exchange of inner primitives, as part of clause 7.6.2 "Procedure for applying End-to-End Security of Primitives (ESPrim)". ETSI ETSI TS 118 104 V2.7.1 (2016-10) 212 oneM2M TS-0004 version 2.7.1 Release 2 NOTE: The inner request primitive can request any operation (Create, Retrieve, Update, Delete, Notify) allowed by the resource addressed by the inner request primitive. The composing or processing of the inner request primitive and the corresponding inner response primitive follows the general procedures in clause 7.2.2, and is not addressed further in the present clause. Originator: When the originator is to secure an exchange of inner primitives, then the Receiver shall apply the following steps in order: 1) Encrypt the inner request primitive to form an ESPrim Object as described in step E of clause 7.6.2. 2) Form the Notify request from the ESPrim Object as described in step F of clause 7.6.2. 3) Deliver the Notify request to the Receiver as described in step G and H of clause 7.6.2. Receiver: When a Receiver receives a Notify request transporting an ESPrim Object, then the Receiver shall apply the following steps in order: 1) Process the Notify request to extract the ESPrim Object as described in step I of clause 7.6.2. 2) Decrypt the ESPrim Object to form the inner request primitive as described in step J of clause 7.6.2. 3) The inner request primitive is processed, resulting in an inner response primitive. See note. 4) Encrypt the inner response primitive to form an ESPrim Object as described in step L of clause 7.6.2. 5) Form a successful Notify response as described in step M of clause 7.6.2. 6) Deliver the Notify request to the Originator as described in step N of clause 7.6.2. Originator: When the Originator receives a Notify response transporting an ESPrim Object, then the Receiver shall perform the following steps in order: 1) Process the Notify request to extract the ESPrim Object as described in step O of clause 7.6.2. 2) Decrypt the ESPrim Object to form the inner request primitive as described in step P of clause 7.6.2. 3) The inner response primitive is processed. See note. Error cases are addressed in clause 7.6.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.5.2 Elements contained in the Content primitive parameter | Clauses 7.2.1.1 and 7.2.1.2 enumerate the forms that the Content primitive parameter takes in various Request and Response cases. Note that the Content primitive parameter is denoted as primitiveContent in both, CDT- requestPrimitive-v2_7_0.xsd and CDT-responsePrimitive-v2_7_0.xsd. This clause details the Objects (elements) used in some of these cases. in the tables below. The following elements are defined for use in the Content parameter of a request: ETSI ETSI TS 118 104 V2.7.1 (2016-10) 213 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.5.2-1: Elements used for request content Element Name Applicable Operations Data Type Defined in m2m:<resourceType> {other namespace identifier}:<resourceType> C U m2m:<resourceType> {other namespace identifier}:<resourceType> CDT-<resourceType>-v2_7_0.xsd m2m:notification N m2m:notification CDT-notification-v2_7_0.xsd m2m:aggregatedNotification N m2m:aggregatedNotification CDT-notification-v2_7_0.xsd m2m:securityInfo N m2m:securityInfo CDT-notification-v2_7_0.xsd m2m:attributeList R m2m:attributeList CDT-requestPrimitive-v2_7_0.xsd m2m:responsePrimitive N m2m:responsePrimitive CDT-responsePrimitive-v2_7_0.xsd The following elements are defined for use in the Content parameter of a response sent in reply to a request message with Operation and Result Content (rcn) parameters as given in the column "Applicable Operations" (the settings of the Result Content parameters are defined in clause 6.3.4.2.7; NP means the rcn parameter is not present). Table 7.5.2-2: Elements used for response content Element Name Applicable Operations/rcn Data Type Element is Defined in m2m:<resourceType> {other namespace identifier}:<resourceType> NOTE 6 C/1, NP R/1,4,5,6,7,NP U/1,NP D/1,NP See note1 m2m:<resourceType> {other namespace identifier}:<resourceType> CDT-<resourceType>-v2_7_0.xsd m2m:resource C/3 m2m:resourceWrapper CDT-responsePrimitive-v2_7_0.xsd m2m:URIList R/NP See note 2 m2m:listOfURIs CDT-responsePrimitive-v2_7_0.xsd m2m:resourceRefList R/6 See note 2 m2m:listOfChildResourceRef CDT-responsePrimitive-v2_7_0.xsd m2m:aggregatedResponse C R U D See note 3 m2m:aggregatedResponse CDT-responsePrimitive-v2_7_0.xsd m2m:URI C/2 See note 4 xs:anyURI CDT-responsePrimitive-v2_7_0.xsd m2m:debugInfo See note 5 xs:string CDT-responsePrimitive-v2_7_0.xsd m2m:securityInfo N/NP m2m:securityInfo CDT-notification-v2_7_0.xsd NOTE 1: The case rcn = 7 applies to Retrieve operation only (R/7). It retrieves the original resource in case the To parameter points to an announced resource. The case R/NP applies to Retrieve operation (Non-Discovery) only. NOTE 2: This applies to discovery operation only. For discovery, the format of the address (structured, unstructured) depends on the Discovery Result Type parameter setting (see clause 6.3.4.2.8). NOTE 3: This applies to CRUD operations on a <fanOutPoint> child resource of a <group> parent resource. The Content parameter of each response primitive included in aggregatedResponse is set as given in one of the other rows of this table. NOTE 4: This also applies to the response ("acknowledgement") to non-blocking requests in asynchronous mode for any CRUD operation. NOTE 5: This is a plain text messages which can optionally be included as debugging information in error responses. The language and content of the message is determined by the Service Provider. NOTE 6: "{other namespace identifier}" refers to a namespace other than m2m. The XML schema definition of the Content primitive parameter (i.e. datatype m2m:primitiveContent) allows to include XML wildcard elements. An XML representation of the Content primitive parameter shall include a root element which is associated with an XSD Global Element. The root element shall be prefixed with a namespace prefix identifier (e.g. m2m:) specified in the associated XSD which defines the respective Global Element. The Content primitive parameter allows to include namespaces other than m2m. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 214 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.6 Security Procedures | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.6.1 Introduction | ETSI TS 118 103 [7] specifies a range of security procedures. Clause 7.6 describes how to use the security procedures as part of the general procedures, common operations, resource type-specific procedures and primitive-specific procedures. The following security procedures are described: • End-to-End security of primitives (ESPrim): securing a primitive so that CSEs (forwarding the primitive) do not need to be trusted with the confidentiality and integrity of the primitive. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.6.2 Procedure for applying End-to-End Security of Primitives (ESPrim) | End-to-End Security of Primitives (ESPrim) provides an interoperable framework for securing oneM2M primitives so CSEs (forwarding the primitive) do not need to be trusted with the confidentiality and integrity of the primitive. ESPrim provides mutual authentication, confidentiality, integrity protection and a freshness guarantee (bounding the age of ESPrims). Credential management aspects and data protection aspects for ESPrim are specified in oneM2M ETSI TS 118 103 [7]. Architecture-level-details for the transport of ESPrim are specified in ETSI TS 118 101 [6]. The primitive to be secured is called the inner primitive. All operations (Create, Retrieve, Update, Delete, or Notify) are allowed for an inner request primitive and inner response primitive. The inner primitives are encrypted to form an ESPrim Object. A Notify Request and corresponding Notify Response primitives (called the outer request primitive and outer response primitive) are used to transport the ESPrim Objects containing this encrypted inner request primitive and inner response primitive respectively. There are three parallel procedures which shall be considered when using ESPrim to protect primitives: • Inner primitive processing: The general procedure for the inner request primitive and corresponding inner response primitive. • ESPrim processing: Encrypting inner primitives to form ESPrim objects, and decrypting ESPrim objects to obtain the inner primitives. • Outer primitive processing: The general procedure for the outer request primitive and corresponding outer response primitive used to transport the ESPrim objects. There are three actors impacted: • Originator: The CSE or AE which originates the inner primitive procedure, the ESPrim protocol and the outer Notify primitive procedure. • Hosting CSE: The Hosting CSE from the perspective of the outer primitive procedure, hosting the <CSEBase> or <AE> resource of the Target. • Target CSE or AE: The CSE or AE terminating the ESPrim protocol and inner primitive procedure. The Target shall be either the Hosting CSE or an AE registered to the Hosting CSE. The Target also applies some processing of the outer primitive procedure: extracting the ESPrim objects form the outer request primitives, and composing the outer response primitives. Other Receiver CSEs on the delivery path (apart from the Originator and Hosting CSE) process and forward the outer Notify primitives according to the general procedure in clause 7.2.2.2. These Receiver CSEs do not process the ESPrim Objects nor the inner primitives. The procedures for these Receiver CSEs are not affected when ESPrim is being used. The present clause describes the relationship between the steps of the general procedures applied to the inner primitives, the ESPrim processing and the general procedures applied to the outer primitives. Figure 7.6.2-1 and the following text describe the procedure for applying ESPrim to protect an exchange of inner primitives. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 215 oneM2M TS-0004 version 2.7.1 Release 2 Originator Target (Hosting CSE or AE) Inner Primitive Processing Outer Primitive Processing ESPrim Processing Hosting CSE Outer Primitive Processing Inner Primitive Processing ESPrim Processing A. Orig 1.0 “Compose of a Request Primitive” B. Orig 2.0 "Send a Request primitive to the Receiver CSE" C. Orig 3.0 "Check Response Type" D. Orig 4.0 "Wait for Response primitive" E. Encrypt inner request primitive to ESPrim Object F. Orig 1.0 “Compose of a Request primitive”: a Notify request G. Delivery to Hosting CSE H. Recv-6.5 “Create/ .../Notify operation is performed” ESPrim Object outer request primitive inner request primitive inner request primitive K. Process inner request primitive inner response primitive L. Encrypt inner response primitive to ESPrim Object outer response primitive N. Delivery to Originator O. Orig 6.0 “Process Response primitive” ESPrim Object P. Decrypt ESPrim Object to inner response primitive inner response primitive Q. Orig 6.0 “Process Response primitive” Outer Primitive Processing I. Extract ESPrim Object from Notify Request ESPrim Object J. Decrypt ESPrim Object to inner request primitive M. Recv-6.7 “Create success response”: Notify response ESPrim Object Pre-condition: pairwiseESPrimKey established and sessionESPrimKey established at Originator Figure 7.6.2-1: Procedure for applying End-to-End Security of Primitives (ESPrim) to protect an exchange of inner primitives Pre-Condition: The Originator and Target have established a pairwiseESPrimKey and steps have been performed for establishing a sessionESPrimKey at the Originator (phases A and B in clause 8.4.2 of ETSI TS 118 103 [7]). Originator: A. The Originator's inner primitive processing shall apply Orig-1.0 "Compose of a Request primitive" to compose the inner request primitive. The inner request should not include the delivery-related parameters Response Type, Event Category, and Delivery Aggregation. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 216 oneM2M TS-0004 version 2.7.1 Release 2 NOTE 1: Delivery-related parameters Response Type, Event Category, and Delivery Aggregation in the inner request (composed at step A) will be ignored – see step K. When appropriate, these parameters are provided in the outer request primitive only (composed at step F). B. The Originator shall not apply Orig-2.0 "Send a Request primitive to the Receiver CSE", but instead shall pass the inner request primitive to the Originator's ESPrim processing for further processing in Step E. C. The Originator's inner primitive processing shall apply Orig-3.0 "Check Response Type". The Response Type is blockingRequest, see step A. D. The Originator's inner primitive processing shall apply Orig-4.0 "Wait for Response primitive", entering a waiting state until the inner response primitive is received (at step P). E. The Originator's ESPrim processing shall apply ESPrim encryption to the inner request primitive, resulting in an ESPrim Object. The ESPrim encryption process is specified in ETSI TS 118 103 [7]. The ESPrim Object is passed to the Originator's outer primitive processing. The Originator's ESPrim processing enters waiting state until the corresponding ESPrim Object is received (at step O) F. The Originator's outer primitive processing shall apply Orig-1.0 "Compose of a Request primitive" to compose the outer request primitive. The outer request primitive shall include the following parameters: • Operation: Notify (N) • To: An address of the <CSEBase> or <AE> resource associated with the Target. • From: An address of the Originator. • Request Identifier: may be independent of the Request Identifier in the inner request primitive. • Content: a securityInfo element with child elements o securityInfoType: "5" (ESPrim Object). o esprimObject: the ESPrim Object generated at step E. The outer request primitive may include further optional parameters as described in clause 11.4.2 of ETSI TS 118 101 [6], including the delivery-related parameters Response Type, Event Category, and Delivery Aggregation. G. The general procedures in clause 7.2.2.1 and clause 7.2.2.2 are followed for delivering the outer Notify request primitive from the Originator to the Hosting CSE of the addressed resource, in accordance with the communication mode of the outer request primitive. The outer Notify request primitive may be forwarded by one or more transit CSEs, which are not shown in Figure 7.6.2-1. The Originator's outer primitive processing enters a waiting state until the corresponding outer response primitive is received (at step N). The details of the delivery to and from the Hosting CSE have no impact on any other steps. The present step includes all Receiver steps in clause 7.2.2.2 up to Recv-6.4. If any errors are encountered during this step, then the Notify request primitive is rejected with a Response Status Code indicating the appropriate error code. Hosting CSE: H. The Hosting CSE's outer primitive processing applies Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed" to the outer Notify request primitive. This triggers "Notify processing" (clause 7.3.3.9), and the Hosting CSE passes the outer request primitive to the Target identified by the To parameter: • If the To parameter is an address for the Hosting CSE's <CSEBase> resource, then the Target is the Hosting CSE. • If the To parameter is an address for an <AE> resource, then the Target is the associated AE. If any errors are encountered during this step, then the Notify request primitive is rejected with a Response Status Code indicating the appropriate error code. The Hosting CSE's outer request processing enters waiting state until the corresponding outer response primitive is received at step M. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 217 oneM2M TS-0004 version 2.7.1 Release 2 Target: I. The Target's outer primitive processing shall examine the securityInfoType element of the securityInfo element in the Content parameter of the outer Notify request primitive. The value "5" of the securityInfoType indicates that the securityInfo element contains an ESPrim object. The Target shall extract the ESPrim Object contained in the esprimObject element of the securityInfo element and pass the ESPrim Object to the Target's ESPrim processing. J. The Target's ESPrim processing shall apply ESPrim decryption to the ESPrim Object, resulting in the verified inner request primitive. The ESPrim decryption process is specified in ETSI TS 118 103 [7]. • If the Target's ESPrim processing encounters one of the error cases in Table 7.6.2-1, then the corresponding Response Status Code is returned to the Hosting CSE's outer primitive processing, and the call flow skips to step M. • If decryption is successful, then the verified inner request primitive is passed to the Target's inner primitive processing, and the Target's ESPrim processing enters waiting state until the corresponding inner response primitive processing Object is received (at step M). K. The Target shall process the verified inner request primitive according to the general procedure for Receiver, see clause 7.2.2.2. • The Target shall ignore delivery-related parameters in the inner primitive, such as the Response Type, Event Category, or Delivery Aggregation. See Note 1. An inner response primitive is returned to the Target's ESPrim processing. NOTE 2: This call flow does not distinguish between successful and unsuccessful inner response primitives. Both will have ESPrim encryption applied prior to delivery back to the Originator. L. The Target's ESPrim processing shall apply ESPrim encryption to the inner response primitive, resulting in an ESPrim Object. The ESPrim encryption process is specified in ETSI TS 118 103 [7]. If the Target's ESPrim processing encounters one of the error cases in Table 7.6.2-1, then the corresponding Response Status Code returned to the Hosting CSE's outer primitive processing and the call flow skips to step M. If the ESPrim processing is successful, then the ESPrim Object is passed to the Hosting Target's outer primitive processing. M. If the Target's ESPrim processing returned a Response Status Code indicating an error, then the Hosting CSE's outer primitive processing forms an error Notify response as described in clause 7.3.3.13. If the Target's ESPrim processing returned an ESPrim Object, then the Target's outer primitive processing forms a successful Notify Response as described in clause 7.3.3.12, with the Content containing a securityInfo element with the following child elements: • securityInfoType: "5" (ESPrim Object). • esprimObject: the ESPrim Object received from the Target's ESPrim processing. The outer response primitive is passed to the Hosting CSE's outer primitive processing. Hosting CSE: N. The general procedures in clauses, 7.2.2.1 and 7.2.2.2 are followed for delivering the outer response primitive from the Hosting CSE to the Originator, in accordance with the communication mode of the outer response primitive. The outer Notify response primitive may be forwarded by one or more transit CSEs, which are not shown in Figure 7.6.2-1. Originator: O. The Originator's outer primitive processing shall apply Orig-6.0 "Process Response primitive" to the outer response primitive, extracting the ESPrim Object and forwarding this to the Originator's ESPrim processing. P. The Originator's ESPrim processing shall apply ESPrim decryption to the ESPrim Object, resulting in the verified inner response primitive. The ESPrim decryption process is specified in ETSI TS 118 103 [7]. If decryption is successful, then the verified inner response primitive is passed to the Originator's inner primitive processing. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 218 oneM2M TS-0004 version 2.7.1 Release 2 Q. The Originator's inner primitive processing shall apply Orig-6.0 "Process Response primitive" to the verified inner response primitive. Table 7.6.2-1: End-to-End security of Primitives (ESPrim) processing error cases with corresponding error message Error Case Error message The Target was unable to parse the ESPrim Object. BAD_REQUEST The Target does not support either the combination of protocol and AEAD algorithm used for the ESPrim Object in the Request, or the sessionESPrimKey derivation algorithm identified in the originatorESPrimRandObject ESPRIM_UNSUPPORTED_OPTION The pairwiseESPrimKey Identifier in the ESPrim header is not known to the Target, or is expired ESPRIM_UNKNOWN_KEY_ID The esprimRandID of the originatorESPrimRandObject in the ESPrim header is not known to the Target, or the Target decides that the originatorESPrimRandObject is expired (see Note 1) ESPRIM_UNKNOWN_ORIG_RAND_ID The esprimRandID of the receiverESPrimRandObject in the ESPrim header is not known to the Target, or the Target decides that the receiverESPrimRandObject is expired. (see Note 2) ESPRIM_UNKNOWN_RECV_RAND_ID The integrity verification of the ESPrim payload failed. ESPRIM_BAD_MAC The Target encountered some other problem while decrypting the ESPrim Object and could not obtain the inner request primitive. ESPRIM_DECRYPTION_ERROR The Target successfully decrypted the ESPrim Object to form the inner request primitive, but encountered a problem while encrypting the inner response primitive and could not form an ESPrim Object. ESPRIM_ENCRYPTION_ERROR NOTE 1: The Target may use the esprimRandExpiry in the originatorESPrimRandObject, or the Target's own local policy, for deciding if the originatorESPrimRandObject is expired. NOTE 2: The Target may use the esprimRandExpiry in the receiverESPrimRandObject, or the Target's own local policy, for deciding if the receiverESPrimRandObject is expired. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8 Representation of primitives in data transfer | 8.1 Introduction This clause defines the representation of request and response primitives as XML documents, JSON texts or CBOR data format. The process of translating objects (i.e. primitives in the present context) into a format that can be stored or exchanged between network entities is commonly denoted as serialization or marshalling. The serialization described here is used in two places: 1) It can be used when transmitting primitives over communication protocols such as HTTP, CoAP or MQTT. When applying a particular protocol binding, it is permitted to adapt the serialization approach, in order to make use of protocol-specific features. For example, a particular protocol binding may require that one or more primitive parameters be mapped to protocol-specific header fields rather than being included in the protocol-specific serialized JSON, XML or CBOR which represents the message body. 2) Certain instances of resource types, e.g. instances of the <delivery> resource, include serialized primitives embedded in one of their resource attributes. In order to enable efficient communication, the short names introduced in clause 8.2 shall be applied in XML and JSON serializations to identify primitive parameters and resource attribute names. This implies that short names are applied in any communication over the Mca, Mcc and Mcc' reference points. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 219 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8.2 Short names | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8.2.1 Introduction | XML and JSON representations require the explicit encoding of the names of primitive parameters, resource attributes, (in the case of XML) resource types and complex data types members. Whenever a protocol binding transfers such a name over a oneM2M reference point, it shall use a shortened form of that name, rather than the full name that is used elsewhere in this and other oneM2M specifications. Short names enable payload reduction on involved telecommunication interfaces. The mapping between the full names and their shortened form is given in the clauses 8.2.2 to 8.2.5. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8.2.2 Primitive parameters | In protocol bindings primitive parameter names shall be translated into short names of Table 8.2.2-1. Table 8.2.2-1: Primitive parameter short names Parameter Name XSD long name Occurs in Short Name Operation operation Request op To to Request, Response to From from Request, Response fr Request Identifier requestIdentifier Request, Response rqi Resource Type resourceType Request ty Content primitiveContent Request, Response pc Role IDs roleIDs Request rids Originating Timestamp originatingTimestamp Request, Response ot Request Expiration Timestamp requestExpirationTimestamp Request rqet Result Expiration Timestamp resultExpirationTimestamp Request, Response rset Operation Execution Time operationExecutionTime Request oet Response Type responseType Request rt Result Persistence resultPersistence Request rp Result Content resultContent Request rcn Event Category eventCategory Request, Response ec Delivery Aggregation deliveryAggregation Request da Group Request Identifier groupRequestIdentifier Request gid Filter Criteria filterCriteria Request fc Discovery Result Type discoveryResultType Request drt Response Status Code responseStatusCode Response rsc Tokens tokens Request ts Token IDs tokenIDs Request tids Token Request Indicator tokenReqIndicator Request tqi Local Token IDs localTokenIDs Request ltids Assigned Token Identifiers assignedTokenIdentifiers Response ati Token Request Information tokenReqInfo Response tqf Content Status contentStatus Response cnst Content Offset contentOffset Response cnot XML serialized representations of primitives employ root element names to differentiate between request and response primitive types (see clause 8.3). These root element names shall be translated into short names as in Table 8.2.2-2. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 220 oneM2M TS-0004 version 2.7.1 Release 2 Table 8.2.2-2: Primitive root element short names Root Element Name Occurs in Short Name requestPrimitive Request rqp responsePrimitive Response rsp |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8.2.3 Resource attributes | In protocol bindings, resource attributes names shall be translated into short names shown in the following tables. Table 8.2.3-1: Resource attribute short names (1/6) Attribute Name Occurs in Short Name accessControlPolicyIDs All except accessControlPolicy, contentInstance acpi announcedAttribute accessControlPolicy, AE, container, contentInstance, group, locationPolicy, mgmtObj, node, remoteCSE, schedule, semanticDescriptor, trafficPattern aa announceTo accessControlPolicy, AE, container, contentInstance, group, locationPolicy, mgmtObj, node, remoteCSE, schedule, semanticDescriptor, trafficPattern at creationTime All ct expirationTime All except contentInstance, CSEBase et labels All (optional) lbl lastModifiedTime All lt Link All lnk parentID All pi resourceID All ri resourceType All ty* stateTag container, contentInstance, delivery, request st resourceName All rn privileges accessControlPolicy pv selfPrivileges accessControlPolicy pvs App-ID AE api AE-ID AE aei appName AE apn pointOfAccess AE, CSEBase, remoteCSE poa ontologyRef AE, container, contentInstance, semanticDescriptor. flexContainer, timeSeries or nodeLink AE, CSEBase, remoteCSE nl contentSerialization AE csz creator container, contentInstance,eventConfig, group, pollingChannel, statsCollect, statsConfig, subscription, semanticDescriptor, notificationTargetPolicy, flexContainer, timeSeries cr maxNrOfInstances container, timeSeries mni maxByteSize container, timeSeries mbs maxInstanceAge container, timeSeries mia currentNrOfInstances container, timeSeries cni ETSI ETSI TS 118 104 V2.7.1 (2016-10) 221 oneM2M TS-0004 version 2.7.1 Release 2 Table 8.2.3-2: Resource attribute short names (2/6) Attribute Name Occurs in Short Name currentByteSize container cbs locationID container li disableRetrieval container disr contentInfo contentInstance cnf contentSize contentInstance cs contentRef contentInstance conr containerDefinition flexContainer cnd primitiveContent request pc* content contentInstance, timeSeriesInstance con cseType CSEBase, remoteCSE cst CSE-ID CSEBase, remoteCSE, service SubscribedNode csi supportedResourceType CSEBase srt notificationCongestionPolicy CSEBase ncp source delivery sr target delivery, request tg lifespan delivery Ls eventCat delivery ec deliveryMetaData delivery dmd aggregatedRequest delivery arq eventID eventConfig, statsCollect evi eventType eventConfig evt evenStart eventConfig evs eventEnd eventConfig eve operationType eventConfig opt dataSize eventConfig ds execStatus execInstance exs execResult execInstance exr execDisable execInstance exd execTarget execInstance, mgmtCmd ext execMode execInstance, mgmtCmd exm execFrequency execInstance, mgmtCmd exf execDelay execInstance, mgmtCmd exy execNumber execInstance, mgmtCmd exn execReqArgs execInstance, mgmtCmd exra execEnable mgmtCmd exe memberType group mt currentNrOfMembers group cnm maxNrOfMembers group mnm memberIDs group mid membersAccessControlPolicyIDs group macp memberTypeValidated group mtv consistencyStrategy group csy groupName group, subscription gn locationSource locationPolicy los locationUpdatePeriod locationPolicy lou locationTargetID locationPolicy lot locationServer locationPolicy lor locationContainerID locationPolicy loi locationContainerName locationPolicy lon locationStatus locationPolicy lost serviceRoles m2mServiceSubscriptionProfile svr description mgmtCmd, mgmtObj, all management resources from firmware dc cmdType mgmtCmd cmt mgmtDefinition mgmtObj, all management resources from firmware mgd objectIDs mgmtObj obis ETSI ETSI TS 118 104 V2.7.1 (2016-10) 222 oneM2M TS-0004 version 2.7.1 Release 2 Table 8.2.3-3: Resource attribute short names (3/6) Attribute Name Occurs in Short Name objectPaths mgmtObj obps nodeID node ni hostedCSELink node hcl CSEBase remoteCSE cb* M2M-Ext-ID remoteCSE mei Trigger-Recipient-ID remoteCSE tri requestReachability remoteCSE rr triggerReferenceNumber remoteCSE trn originator request org metaInformation request mi requestStatus request rs operationResult request ors operation request op* requestID request rid scheduleElement schedule se deviceIdentifier serviceSubscribedNode di ruleLinks serviceSubscribedNode rlk statsCollectID statsCollect sci collectingEntityID statsCollect cei collectedEntityID statsCollect cdi devStatus areaNwkDeviceInfo ss statsRuleStatus statsCollect srs statModel statsCollect sm collectPeriod statsCollect cp eventNotificationCriteria subscription enc expirationCounter subscription exc notificationURI subscription nu groupID subscription gpi notificationForwardingURI subscription nfu batchNotify subscription bn rateLimit subscription rl preSubscriptionNotify subscription psn pendingNotification subscription pn notificationStoragePriority subscription nsp latestNotify subscription ln notificationContentType subscription nct notificationEventCat subscription nec subscriberURI subscription su version firmware, software, token vr URL firmware, software url update firmware ud updateStatus firmware uds install software in uninstall software un installStatus software ins activate software act deactivate software dea activeStatus software, areaNwkInfo acts memAvailable memory mma memTotal memory mmt ETSI ETSI TS 118 104 V2.7.1 (2016-10) 223 oneM2M TS-0004 version 2.7.1 Release 2 Table 8.2.3-4: Resource attribute short names (4/6) Attribute Name Occurs in Short Name areaNwkType areaNwkInfo ant listOfDevices areaNwkInfo ldv devId areaNwkDeviceInfo dvd devType areaNwkDeviceInfo dvt areaNwkId areaNwkDeviceInfo awi sleepInterval areaNwkDeviceInfo sli sleepDuration areaNwkDeviceInfo sld listOfNeighbors areaNwkDeviceInfo lnh batteryLevel battery btl batteryStatus battery bts deviceLabel deviceInfo dlb manufacturer deviceInfo man model deviceInfo mod deviceType deviceInfo dty fwVersion deviceInfo fwv swVersion deviceInfo swv hwVersion deviceInfo hwv capabilityName deviceCapability can attached deviceCapability att capabilityActionStatus deviceCapability cas enable deviceCapability, allJoynSvcObject ena disable deviceCapability dis currentState deviceCapability cus reboot reboot rbo factoryReset reboot far logTypeId eventLog lgt logData eventLog lgd logStatus eventLog lgst logStart eventLog lga logStop eventLog lgo firmwareName firmware fwnnam softwareName software swn cmdhPolicyName cmdhPolicy cpn mgmtLink cmdhPolicy, activeCmdhPolicy, cmdhDefaults, cmdhNetworkAccessRules, cmdhNwAccessRule cmlk activeCmdhPolicyLink activeCmdhPolicy acmlk order cmdhDefEcValue, cmdhLimits od defEcValue cmdhDefEcValue dev requestOrigin cmdhDefEcValue, cmdhLimits ror requestContext cmdhDefEcValue, cmdhLimits rct requestContextNotification cmdhDefEcValue, cmdhLimits rctn requestCharacteristics cmdhDefEcValue, cmdhLimits rch applicableEventCategories cmdhNetworkAccessRules aecs applicableEventCategory cmdhEcDefParamValues, cmdhBuffer aec defaultRequestExpTime cmdhEcDefParamValues dqet defaultResultExpTime cmdhEcDefParamValues dset defaultOpExecTime cmdhEcDefParamValues doet defaultRespPersistence cmdhEcDefParamValues drp defaultDelAggregation cmdhEcDefParamValues dda limitsEventCategory cmdhLimits lec limitsRequestExpTime cmdhLimits lqet limitsResultExpTime cmdhLimits lset limitsOpExecTime cmdhLimits loet limitsRespPersistence cmdhLimits lrp limitsDelAggregation cmdhLimits lda targetNetwork cmdhNwAccessRule, trafficPattern ttn ETSI ETSI TS 118 104 V2.7.1 (2016-10) 224 oneM2M TS-0004 version 2.7.1 Release 2 Table 8.2.3-5: Resource attribute short names (5/6) Attribute Name Occurs in Short Name minReqVolume cmdhNwAccessRule mrv spreadingWaitTime cmdhNwAccessRule swt backOffParameters cmdhNwAccessRule bop otherConditions cmdhNwAccessRule ohc maxBufferSize cmdhBuffer mbfs storagePriority cmdhBuffer sgp applicableCredIDs serviceSubscribedAppRule apci allowedApp-IDs serviceSubscribedAppRule aai allowedAEs serviceSubscribedAppRule aae notificationTargetURI notificationTargetMgmtPolicyRef ntu notificationlPolicyID notificationTargetMgmtPolicyRef npi action notificationTargetPolicy ac policyLabel notificationTargetPolicy plbl rulesRelationship notificationTargetPolicy rrs creator notificationTargetPolicy cr deletionRules policyDeletionRules dr deletionRulesRelation policyDeletionRules drr dynamicAuthorizationConsultationIDs All resources having an accessControlPolicyID attribute daci dynamicAuthorizationEnabled dynamicAuthorizationConsultation dae dynamicAuthorizationPoA dynamicAuthorizationConsultation dap dynamicAuthorizationLifetime dynamicAuthorizationConsultation dal descriptorRepresentation semanticDescriptor dcrp semanticOpExec semanticDescriptor soe descriptor semanticDescriptor dsp relatedSemantics semanticDescriptor rels periodicInterval timeSeries pei missingDataDetect timeSeries mdd missingDataMaxNr timeSeries mdn missingDataList timeSeries mdlt missingDataCurrentNr timeSeries mdc missingDataDetectTimer timeSeries mdt dataGenerationTime timeSeriesInstance dgt sequenceNr timeSeriesInstance snr providedToNSE trafficPattern ptn periodicIndicator trafficPattern pri periodicDurationTime trafficPattern pdt periodicIntervalTime trafficPattern pit stationaryIndication trafficPattern sti dataSizeIndicator trafficPattern dsi validityTime trafficPattern vdt roleID role rlid roleName role rlnm tokenLink role rltl tokenID token tkid tokenObject token tkob issuer token, role tkis holder token, role tkhd notBefore token, role tknb notAfter token, role tkna tokenName token tknm audience token tkau permissions token tkps extension token tkex e2eSecInfo CSEBase, remoteCSE, AE esi ETSI ETSI TS 118 104 V2.7.1 (2016-10) 225 oneM2M TS-0004 version 2.7.1 Release 2 Table 8.2.3-6: Resource attribute short names (6/6) Attribute Name Occurs in Short Name serviceName genericInterworkingService gisn operationName genericInterworkingOperationInstance gion inputDataPointLinks genericInterworkingService, genericInterworkingOperationInstance giip outputDataPointLinks genericInterworkingService, genericInterworkingOperationInstance giop inputLinks genericInterworkingOperationInstance giil outputLinks genericInterworkingOperationInstance giol operationState genericInterworkingOperationInstance gios direction allJoynApp dir objectPath allJoynSvcObject ajop interfaceIntrospectXmlRef allJoynInterface ajir input allJoynMethodCall inp callStatus allJoynMethodCall clst output allJoynMethodCall out currentValue allJoynProperty crv requestedValue allJoynProperty rqv NOTE: * marked short names have been already assigned in Table 8.2.2-1. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8.2.4 Resource types | In protocol bindings resource type names shall be translated into short names of Table 8.2.4-1. Table 8.2.4-1: Resource and specialization type short names Resource Type Name Short Name accessControlPolicy acp accessControlPolicyAnnc acpA AE ae AEAnnc aeA container cnt containerAnnc cntA latest la oldest ol contentInstance cin contentInstanceAnnc cinA CSEBase cb delivery dlv eventConfig evcg execInstance exin fanOutPoint fopt group grp groupAnnc grpA locationPolicy lcp locationPolicyAnnc lcpA m2mServiceSubscriptionProfile mssp mgmtCmd mgc node nod nodeAnnc nodA pollingChannel pch pollingChannelURI pcu remoteCSE csr remoteCSEAnnc csrA request req schedule sch scheduleAnnc schA serviceSubscribedAppRule asar serviceSubscribedNode svsn statsCollect stcl statsConfig stcg subscription sub ETSI ETSI TS 118 104 V2.7.1 (2016-10) 226 oneM2M TS-0004 version 2.7.1 Release 2 Resource Type Name Short Name firmware fwr firmwareAnnc fwrA software swr softwareAnnc swrA memory mem memoryAnnc memA areaNwkInfo ani areaNwkInfoAnnc aniA areaNwkDeviceInfo andi areaNwkDeviceInfoAnnc andiA battery bat batteryAnnc batA deviceInfo dvi deviceInfoAnnc dviA deviceCapability dvc deviceCapabilityAnnc dvcA reboot rbo * rebootAnnc rboA eventLog evl eventLogAnnc evlA cmdhPolicy cmp activeCmdhPolicy acmp cmdhDefaults cmdf cmdhDefEcValue cmdv cmdhEcDefParamValues cmpv cmdhLimits cml cmdhNetworkAccessRules cmnr cmdhNwAccessRule cmwr cmdhBuffer cmbf notificationTargetMgmtPolicyRef ntpr notificationTargetPolicy ntp policyDeletionRules pdr notificationTargetSelfReference ntsr dynamicAuthorizationConsultation dac semanticDescriptor smd semanticDescriptorAnnc smdA semanticFanOutPoint sfop timeSeries ts timeSeriesAnnc tsa timeSeriesInstance tsi timeSeriesInstanceAnnc tsia trafficPattern trpt trafficPatternAnnc trptA role rol token tk genericInterworkingService gis genericInterworkingServiceAnnc gisa genericInterworkingOperationInstance gio genericInterworkingOperationInstanceAnnc gioa svcObjWrapper ajsw ETSI ETSI TS 118 104 V2.7.1 (2016-10) 227 oneM2M TS-0004 version 2.7.1 Release 2 Resource Type Name Short Name svcObjWrapperAnnc ajswa svcFwWrapper ajfw svcFwWrapperAnnc ajfwa allJoynApp ajap allJoynAppAnnc ajapa allJoynSvcObject ajso allJoynSvcObjectAnnc ajsoa allJoynInterface ajif allJoynInterfaceAnnc ajifa allJoynMethod ajmd allJoynMethodAnnc ajmda allJoynMethodCall ajmc allJoynMethodCallAnnc ajmca allJoynProperty ajpr allJoynPropertyAnnc ajpra NOTE: * marked short names have been already assigned in attribute Tables 8.2.3-1 to 8.2.3-5. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8.2.5 Complex data types members | In protocol bindings complex data types member names shall be translated into short names of Table 8.2.5-1. Table 8.2.5-1: Complex data type member short names Member Name Occurs in Short Name createdBefore filterCriteria, eventNotificationCriteria crb createdAfter filterCriteria, eventNotificationCriteria cra modifiedSince filterCriteria, eventNotificationCriteria ms unmodifiedSince filterCriteria, eventNotificationCriteria us stateTagSmaller filterCriteria, eventNotificationCriteria sts stateTagBigger filterCriteria, eventNotificationCriteria stb expireBefore filterCriteria, eventNotificationCriteria exb expireAfter filterCriteria, eventNotificationCriteria exa labels filterCriteria, eventNotificationCriteria lbl * resourceType filterCriteria ty * sizeAbove filterCriteria, eventNotificationCriteria sza sizeBelow filterCriteria, eventNotificationCriteriay szb contentType filterCriteria cty limit filterCriteria lim attribute filterCriteria, eventNotificationCriteria atr contentFilterSyntax filterCriteria cfs contentFilterQuery filterCriteria cfq level filterCriteria lvl offset filterCriteria ofst notificationEventType eventNotificationCriteria net operationMonitor eventNotificationCriteria, notificationEvent om representation notificationEvent rep filterUsage filterCriteria fu eventCatType eventCat ect eventCatNo eventCat ecn number batchNotify num duration batchNotify dur notification aggregatedNotification, Request Primitive Content sgn notificationEvent notification nev verificationRequest notification vrq subscriptionDeletion notification sud subscriptionReference notification sur creator notification cr* notificationForwardingURI notification nfu* IPEDiscoveryRequest notification idr filterCriteria IPEDiscoveryRequest fc* operation operationMonitor, dynAuthDasRequest op* ETSI ETSI TS 118 104 V2.7.1 (2016-10) 228 oneM2M TS-0004 version 2.7.1 Release 2 Member Name Occurs in Short Name originator operationMonitor, IPEDiscoveryRequest, dynAuthDasRequest or* accessId externalID aci MSISDN externalID msd action actionStatus can status actionStatus sus childResource All except execInstance, announced resource, management resources from firmware ch accessControlRule privileges, selfPrivileges acr accessControlOriginators accessControlRule acor accessControlOperations accessControlRule acop accessControlContexts accessControlRule acco accessControWindow accessControlContexts actw accessControlIpAddresses accessControlContexts acip ipv4Addresses accessControlIpAddress ipv4 ipv6Addresses accessControlIpAddress ipv6 accessControlLocationReg ion accessControlContexts aclr countryCode accessControlLocationRegion accc circRegion accessControlLocationRegion accr name attribute, anyArgType, mgmtLinkRef, childResourceRef, contentRef nm* specializationID childResourceRef spid value attribute val type anyArgType typ maxNrOfNotify rateLimit mnn timeWindow rateLimit tww scheduleEntry scheduleElement sce aggregatedNotification Request Primitive Content agn attributeList Request Primitive Content atrl securityInfo Request Primitive Content, Response Primitive Content seci aggregatedResponse Response Primitive Content agr resource Response Primitive Content rce URIList Response Primitive Content uril debugInfo Response Primitive Content dbg anyArg resetArgsType, rebootArgsType, uploadArgsType, downloadArgsType, softwareInstallArgsType softwareUpdateArgsType, softwareUninstallArgsType, execReqArgsListType any fileType downloadArgsType ftyp URI resourceWrapper, dynAuthTokenReqInfo uri URL downloadArgsType url* username uploadArgsType, downloadArgsType, softwareUpdateArgsType, softwareUninstallArgsType, unm password uploadArgsType, downloadArgsType, softwareUpdateArgsType, softwareUninstallArgsType, pwd filesize downloadArgsType fsi targetFile downloadArgsType tgf delaySeconds downloadArgsType dss successURL downloadArgsType surl startTime downloadArgsType stt completeTime downloadArgsType cpt UUID softwareInstallArgsType softwareUpdateArgsType, softwareUninstallArgsType, uuid executionEnvRef softwareInstallArgsType softawareUpdateArgsType, softwareUninstallArgsType, eer version softwareUninstallArgsType, tokenClaimSet vr* reset execReqArgsListType rst ETSI ETSI TS 118 104 V2.7.1 (2016-10) 229 oneM2M TS-0004 version 2.7.1 Release 2 Member Name Occurs in Short Name reboot execReqArgsListType rbo* upload execReqArgsListType uld download execReqArgsListType dld softwareInstall execReqArgsListType swin softwareUpdate execReqArgsListType swup softwareUninstall execReqArgsListType swun tracingOption deliveryMetaData tcop tracingInfo deliveryMetaData tcin responseTypeValue responseTypeInfo rtv notificationURI responseTypeInfo nu timeOfDay deletionContexts tod locationRegions deletionContexts lr URIReference contentRef urir semanticsFilter filterCriteria smf missingDataList timeSeries mdl missingData eventNotificationCriteria md tokenID tokenClaimSet, dynAuthLocalTokenIdAssignments tkid holder tokenClaimSet tkhd* issuer tokenClaimSet tkis* notBefore tokenClaimSet tknb* notAfter tokenClaimSet tkna* tokenName tokenClaimSet tknm* audience tokenClaimSet tkau* permissions tokenClaimSet tkps* extension tokenClaimSet tkex* permission tokenPermissions pm resourceIDs tokenPermission ris privileges tokenPermission pv* roleIDs tokenPermission rids* localTokenIdAssignment dynAuthLocalTokenIdAssignments ltia localTokenID dynAuthLocalTokenIdAssignment lti dasInfo dynAuthTokenReqInfo dasi dasRequest dynAuthTokenReqInfo daq securedDasRequest dynAuthTokenReqInfo sdr filterOperation filterCriteria fo targetedResourceType dynAuthDasRequest trt originatorIP dynAuthDasRequest oip ipv4Address dynAuthDasRequest ip4 ipv6Address dynAuthDasRequest ip6 originatorLocation dynAuthDasRequest olo originatorRoleIDs dynAuthDasRequest orid requestTimestamp dynAuthDasRequest rts targetedResourceID dynAuthDasRequest trid proposedPrivilegesLifetime dynAuthDasRequest ppl roleIDsFromACPs dynAuthDasRequest rfa tokenIDs dynAuthDasRequest tids dynamicACPInfo dynAuthDasResponse dai grantedPrivileges dynAuthDasResponse gp privilegesLifetime dynAuthDasResponse pl tokens dynAuthDasResponse tkns securityInfoType securityInfo sit dasRequest securityInfo dreq dasResponse securityInfo dres esprimRandObject securityInfo ero esprimObject securityInfo epo escertkeMessage securityInfo eckm resourceRef listOfChildResourceRef rrf resourceRefList Response Primitive Content rrl esprimRandID originatorESPrimRandObject, receiverESPrimRandObject, esri ETSI ETSI TS 118 104 V2.7.1 (2016-10) 230 oneM2M TS-0004 version 2.7.1 Release 2 Member Name Occurs in Short Name esprimRandValue originatorESPrimRandObject, receiverESPrimRandObject, esrv esprimRandExpiry originatorESPrimRandObject, receiverESPrimRandObject, esrx esprimKeyGenAlgID originatorESPrimRandObject, esk esprimKeyGenAlgIDs receiverESPrimRandObject, esks esprimProtocolAndAlgIDs originatorESPrimRandObject, receiverESPrimRandObject, espa supportede2ESecFeatures e2eSecInfo esf certificates e2eSecInfo escert sharedReceiverESPrimRa ndObject e2eSecInfo esro networkAction backOffParameters nwa initialBackoffTime backOffParameters ibt additionalBackoffTime backOffParameters abt maximumBackoffTime backOffParameters mbt optionalRandomBackoffTi me backOffParameters rbt backOffParametersSet backOffParameters bops dataLink listOfDataLinks dali attributeName dataLink atn dataContainerID dataLink dcid accessControlAuthenticati onFlag accessControlRule acaf dataLinkEntry listOfDataLinks dle NOTE: * marked short names have been already assigned in attribute Table 8.2.3-1. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8.3 XML serialization | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8.3.1 Method | XML serialization of request or response primitives refers to the process of representing the primitive as an XML document. The XML document shall be a well-formed XML document compliant with W3C XML 1.0 [1]. It shall be restricted to Unicode characters and encoded using UTF-8 as described in IETF RFC 3629 [21]. The structure and data types of XML serialized request and response primitives shall be consistent with the XSD defined in CDT-requestPrimitive-v2_7_0.xsd and CDT-responsePrimitive-v2_7_0.xsd, respectively. The data types used in these XSD files comply with the definitions in clause 6 and clause 7 of the present document. XML serializations shall comply with the order of resource attributes and elements imposed by the XML schema definition. If an implementation uses modified XSD modified from the original files for schema validation of partial resource representations (see note 2 in clause 6.1), the order of resource attributes shall not be changed. Note that the XSD files included in the present release employ the long names for primitive parameters and other XML elements and attributes, but the primitive serialization is required to use the corresponding short names (as defined clause 8.2 of the present document). NOTE: XML Schema files are available with both long and short names. The primitive Content parameter is serialized just like any other element of complex type. Generally, the Content parameter may include only a partial set of attributes specified for the resource type as indicated in the Resource Type parameter, e.g. for partial Update or Retrieve Request procedures. For Notification Request primitives, the Content parameter includes a Notification data object as defined in clause 7.5.1.1 and the datatype definition given in CDT- notification-v2_7_0.xsd. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 231 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8.3.2 Examples | An example that shows a request primitive serialized into an XML document is shown below. This example shows the create request for an instance of a <contentInstance> resource. Only mandatory primitive parameters and resource attributes are shown. <?xml version="1.0" encoding="UTF-8"?> <m2m:rqp xmlns:m2m="http://www.onem2m.org/xml/protocols"> <op>1</op> <to>//cse1.mym2msp.org/</to> <fr>/cse1234/app567</fr> <rqi>0002bf63</rqi> <ty>4</ty> <pc> <m2m:cin> <cnf>application/xml:1</cnf> <con>PHRpbWU+MTc4ODkzMDk8L3RpbWU+PHRlbXA+MjA8L3RlbXA+DQo=</con> </m2m:cin> </pc> </m2m:rqp> The XML elements have the following meaning: • rqp: Root element of the Request primitive, which includes a reference to an XSD file which defines its datatype. • op: Operation parameter of datatype m2m:operation: in this example value = 1 indicates a "Create" operation. • to: To parameter of type m2m:anyURI: URI of the target resource. • fr: From parameter of type m2m:ID: ID of the Originator (either AE-ID or CSE-ID). • rqi: Request Identifier parameter of type m2m:requestID: this could e.g. represent a counter number. • ty: Resource Type parameter of datatype m2m:resourceType: indicating type of the resource to be created (value = 4 indicates that a <contentInstance> resource shall be created). • pc: Content parameter of datatype m2m:primitiveContent: the attributes of the resource to be provided by the Originator. • cin: Root element of the <contentInstance> resource of datatype m2m:contentInstance: this includes the mandatory attributes (and optional attributes not shown in this example) supplied by the request Originator. In this example, the Content parameter includes an instance of a <contentInstance> resource which consists of two attributes: contentInfo (cnf) – which specifies base64 encoding - and the content (con) itself. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8.4 JSON serialization | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8.4.1 Terminology | The following conventions are used in the clause that follows. • The italicized terms object, member, name, array, number, string, boolean and null are to be interpreted as in IETF RFC 7159 [19]. • The italicized term element is to be interpreted to encompass oneM2M Primitive Parameters, Resource Attributes and other elements or attributes used inside oneM2M complex type definitions. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 232 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8.4.2 Method | The primitive shall be encoded as a JSON object, conforming to the requirements of IETF RFC 7159 [19]. This JSON object shall be restricted to Unicode characters defined in The Unicode Standard and encoded using UTF-8 as described in IETF RFC 3629 [21]. The names in each object in the JSON shall be unique. The structure of the top-level primitive object shall be determined by the data type definitions in clause 6 and clause 7 of the present document, as follows: 1) All member's names shall be the short name defined in clause 8.2. 2) If an element is defined in the present document as having a complex type, then it is serialized in the JSON member as an object and its children are recursively serialized as members of that object, using short names as defined in clause 8.2. 3) The membership of each nested object shall respect the cardinality constraints from the corresponding XSD complex type definition, 4) If an element is defined in the present document as having an atomic data type that is numeric (including enumeration data types in clause 6.3.4) then its value is serialized into the JSON member as a number. 5) If an element is defined as having an atomic data type that is non-numeric then its value is serialized into the JSON member as a string. 6) If an element is defined as xs:boolean (or a type derived from xs:boolean) then it is serialized in the JSON member as a boolean. 7) If an element is defined as having an xs:list type in the corresponding XSD then it is serialized in the JSON member as an array. 8) If an element instance has a null value then it is serialized into the JSON member as a null, regardless of the data type that it has in the corresponding XSD. 9) If an element is defined as having maxOccurs > 1 in the corresponding XSD then its occurrences are serialized in a single JSON member as an array. 10) If an element has an XSD data type that is a simple type with XML attributes, then it is serialized in the JSON member as an object. The XML attributes appear as members of that object (using their short names) and the value of the element is serialized as a member of that object with the special name "val". 11) The members (at each level) may be serialized in any order. The order in which they appear in the corresponding XSD file is immaterial. 12) If an element has an XSD data type that is a complex type with XML attributes, then it is serialized in JSON as an object. The XML attributes appear as members of that object (using their short names) as do the XML elements. The Content parameter is treated just like any other parameter of complex type. It is serialized as an object and its members are the attributes and/or child resource references of the Resource that is being transferred. The Content parameter is not required to contain all the attributes of the Resource. The JSON representation of the Content parameter shall be encapsulated by a member name as defined in the first column of Tables 7.5.2-1 and 7.5.2-2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8.4.3 Examples | Here is an example that shows the payload of a request message serialized using JSON: {"op": "1", "fr": "//xxxxx/2345", "to": "//xxxxx/99", "rqi": "A1234", "pc": {"m2m:sch": {"se": "* 0-5 2,6,10 * * * *"}}, "ty": 18} • op: operation (in this case it is Create) • fr: ID of the Originator (either the AE or CSE) • to: URI of the target resource ETSI ETSI TS 118 104 V2.7.1 (2016-10) 233 oneM2M TS-0004 version 2.7.1 Release 2 • rqi: request identifier (this is a string) • pc: attributes of the <schedule> resource with member name "m2m:sch" to be provided by Originator. This is serialized as a nested JSON object • ty: type of resource to be created (in this case a Schedule resource). This is a number. Note that the Operation (op) parameter is present only in Request primitives. The presence of this parameter in JSON serialized primitive representations allows to differentiate Request primitives from Response primitives. The example below shows an <AE> resource serialized using JSON where m2m:ae is a Global Element having an XML attribute "rn" defined in the XSD file with short names associated with the <AE> resource: { "m2m:ae": { "rn": "appname", "aei": "CAE01", "ct": "20160404T132648", "et": "20160408T004648", "lt": "20160404T132648", "pi": "ONET-CSE-02", "ri": " REQID1", "ty": 2 } } |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8.5 CBOR serialization | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8.5.1 Method | Concise Binary Object Representation (CBOR) is a binary serialization format of structured data specified in IETF RFC 7049 [38]. CBOR provides unambiguous encoding of structured data into a binary representation and reverse decoding. The specifics on how CBOR can be negotiated between protocol endpoints is protocol specific and defined by the individual bindings. This clause defines the relationship between JSON objects as defined in clause 8.4 and CBOR representations. Section 2 of IETF RFC 7049 [38] specifies the applicable CBOR encoding rules. In particular, the following rules shall apply when using CBOR serialization: • Text strings (i.e. any names/keys and text string values) shall be encoded as UTF-8 strings, CBOR major type 3. • Integer numbers shall be encoded as CBOR major types 0 or 1. • Floating point numbers shall be encoded as CBOR major type 7 with Additional Information 26 for single precision (32-bit) and Additional Information 27 for double precision (64-bit) formats. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 234 oneM2M TS-0004 version 2.7.1 Release 2 Note that CBOR ignores whitespace characters (including space, LF/CR) if used for formatting of JSON objects in textual representations. If decoding of CBOR serializations results in values not compliant with the underlying XSD, this shall be interpreted as an error by the receiver of the primitive. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8.5.2 Examples | This clause presents some examples of CBOR serialized primitives. Note that due to given encoding options, a CBOR encoder may produce somewhat different binary serializations. However, in any case the CBOR decoding shall produce an equivalent representation in JSON format as shown in the examples below. Example 1: JSON representation (a request primitive of message length: 173 bytes): {"m2m:rqp":{"op":1,"to":"//example.net/mncse1234","rqi":"A1000", "rcn":7,"pc":{"m2m:ae":{"rn":"SmartHomeApplication", "api":"Na56", "apn":"app1234"}},"ty":2}} CBOR representation as sequence of hexadecimal characters (length: 117 bytes): a1476d326d3a727170a6427063a1466d326d3a6165a342726e54536d617274486f6d654170706c69636174696f6e436 17069444e6135364361706e47617070313233344274790242746f572f2f6578616d706c652e6e65742f6d6e63736531 3233344372636e07426f700143727169454131303030 Example 2: JSON representation (a response primitive of message length: 234 bytes): {"m2m:rsp":{"rsc":2001,"rqi":"A1000","pc":{"m2m:ae":{"rn":"SmartHomeApplication","ty": 2,"ri":"ae1","api":"Na56","apn":"app1234","pi":"cb1","ct":"20160506T153208", "lt":"20160506T153208","acpi":["acp1","acp2"],"et":"20180506T153208", "aei":"S_SAH25"}}}} CBOR representation as sequence of hexadecimal characters (length: 187 bytes): a1476d326d3a727370a3427063a1466d326d3a6165ab43617069444e6135364361706e47617070313233344265744f 3230313830353036543135333230384263744f3230313630353036543135333230384274790242726943616531426 c744f3230313630353036543135333230384361656947535f534148323542726e54536d617274486f6d654170706c6 9636174696f6e427069436362314461637069824461637031446163703243727169454131303030437273631907d1 Example 3: JSON representation (request primitive of message length: 187 bytes): {"m2m:rsp":{"rsc":2001,"rqi":"A1000","pc":{"m2m:ae":{"rn":"SmartHomeApplication","ty": 2,"ri":"ae1","api":"Na56","apn":"app1234","pi":"cb1","ct":"20160506T153208", "lt":"20160506T153208","acpi":["acp1","acp2"],"et":"20180506T153208", "aei":"S_SAH25"}}}} CBOR representation as sequence of hexadecimal characters (length: 133 bytes): a1476d326d3a727170a6427063a1476d326d3a636e74a3436d6e691901f442726e52536d617274486f6d65436f6e746 1696e6572436d62731a000186a04274790342746f582c2f2f6578616d706c652e6e65742f6d6e637365313233342f536 d617274486f6d654170706c69636174696f6e4372636e07426f700143727169454131303031 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 235 oneM2M TS-0004 version 2.7.1 Release 2 Example 4: JSON representation (response primitive of message length: 306 bytes): {"m2m:rsp":{"rsc":2001,"rqi":"A1001","pc":{"m2m:cnt":{"rn":"SmartHomeContainer", "ty":3,"ri":"cnt1","pi":"ae1","ct":"20160506T154048", "lt":"20160506T154048","acpi":["acp1"],"et":"20180506T154048","cr":" S_SAH25","st":0,"mni":500,"mbs":100000,"cni":0,"cbs":0,"mia":3600}}}} CBOR representation as sequence of hexadecimal characters (length: 197 bytes): a1476d326d3a727370a3427063a1476d326d3a636e74af436362730042726944636e7431436d6e691901f442637247535f 53414832354265744f3230313830353036543135343034384263744f323031363035303654313534303438436d62731a0 00186a042747903436d6961190e1042737400426c744f32303136303530365431353430343842726e52536d617274486f 6d65436f6e7461696e657242706943616531446163706981446163703143636e690043727169454131303031437273631 907d1 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 236 oneM2M TS-0004 version 2.7.1 Release 2 Annex A (normative): Binding Mch to Diameter for Charging A.1 Introduction Present clause provides Diameter binding of Mch. A.2 Diameter Commands on Mch A.2.1 Accounting Request Command The ACR command is sent from the Charging Function (CHF included within the SCA CSF) embedded within the M2M IN to the Charging Server using the Mch reference point. This command is used for Event Based requests. The ACR message format is defined according to the Diameter Base Protocol in IETF RFC 3588 [13] as follows: <ACR> ::= < Diameter Header: 271, REQ, PXY > < Session-Id > { Origin-Host } { Origin-Realm } { Destination-Realm } { Accounting-Record-Type } { Accounting-Record-Number } [ Acct-Application-Id ] [ Destination-Host ] [ Origin-State-Id ] [ Event-Timestamp ] * [ Proxy-Info ] * [ Route-Record ] [ Service-Context-Id ] [ Service-Information ] * [ AVP ] A.2.2 Accounting Answer Command The ACR command is sent from the Charging Server to the Charging Function (CHF included within the SCA CSF) embedded within the M2M IN in response to the ACR command and is used to acknowledge reception of the charging data. This command is used for Event Based responses. The ACA message format is defined according to the Diameter Base Protocol in IETF RFC 3588 [13] as follows: <ACA> ::= < Diameter Header: 271, PXY > < Session-Id > { Result-Code } { Origin-Host } { Origin-Realm } { Accounting-Record-Type } { Accounting-Record-Number } [ Acct-Application-Id ] [ User-Name ] [ Origin-State-Id ] [ Event-Timestamp ] * [ Proxy-Info ] * [ AVP ] ETSI ETSI TS 118 104 V2.7.1 (2016-10) 237 oneM2M TS-0004 version 2.7.1 Release 2 A.3 Mapping of M2M Recorded Information Elements to AVPs The following table describes the mapping of the M2M Recorded Information Elements identified in ETSI TS 118 101 to the Diameter AVPs. Table A.3-1: Mapping of Recorded M2M Information Elements to Diameter AVPs M2M Recorded Information Elements Diameter AVP M2M Service Subscription Identifier Subscription-Id Application Entity ID Application-Entity-ID External ID External-ID Receiver Receiver Originator Originator Hosting CSE-ID Hosting-CSE-ID Target ID Target-ID Protocol Type Protocol-Type Request Operation Request-Operation Request Headers size Request-Headers-Size Request Body size Request-Body-Size Response Headers size Response-Headers-Size Response Body size Response-Body-Size Response Status Code Response-Status-Code Time Stamp M2M-Event-Record-Timestamp M2M-Event-Record-Tag Rating-Group Control Memory Size Control-Memory-Size Data Memory Size Data-Memory-Size Access Network Identifier Access-Network-Identifier Additional Information AVP Occupancy Occupancy Group Name Group-Name maxNrOfMembers Maximum-Number-Members currentNrOfMembers Current-Number-Members Subgroup Name Subgroup-Name M2M-Node-Id Node-Id M2M Service Subscription Identifier Subscription-Id Application Entity ID Application-Entity-ID A.4 Summary of AVPs used The following table lists the Diameter AVPs specifically used for the offline charging interface. In Table A.4-1, columns "Used in ACR" and "Used in ACA" identify at a protocol level if the AVP is mandatory, optional, or not allowed. When identified as optional here, an AVP may be considered mandatory for certain conditions as identified in Table 12.1.2.2-1 of ETSI TS 118 101 [6]. AVPs defined for oneM2M specific usage are assigned Vendor-Id of 45687. The formats and usage of oneM2M specific AVPs are defined in the present document in clause A.5. The table contains the following information: • AVP Name: The name used in Diameter. • AVP Vendor ID: The entity defining the AVP code in the next column. • AVP Code: The AVP Code used in the Diameter AVP Header. • Used in ACR: Indicates if it is mandatory, optional or not used in the ACR command. • Used in ACA: Indicates if it is mandatory, optional or not used in the ACA command. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 238 oneM2M TS-0004 version 2.7.1 Release 2 • Used in CCR: Not in the present document. • Used in CCA: Not in the present document. • AVP Defined: A reference to where this AVP is defined. • Value Type: The Diameter format of the AVP data as defined in Basic or Derived AVP Data Format. • AVP Flag Rules: The rules for how the AVP Flags in the AVP Header may be set. • May Encrypt: Indicates if the AVP may be encrypted or not. Table A.4-1: Use Of Diameter AVPs AVP Name AVP Vend or Id AVP Cod e Used in Reference Value Type AVP Flag rules AC R AC A CC R CC A Mus t Ma y Shoul d not Mus t not May Encr . Access-Network-Identifier 45687 1000 O - - - [A.5.1] Unsigned3 2 M P - V Y Acct-Application-Id 0 259 O O - - [5.5.1] Unsigned3 2 M P - V N Accounting-Record-Number 0 485 M M - - IETF RFC 3588 [13] Unsigned3 2 M P - V Y Accounting-Record-Type 0 480 M M - - [5.4.2] Enumerate d M P - V Y Application-Entity-ID 45687 1001 O - - - A.5.2. ] UTF8String M P - V Y Control-Memory-Size 45687 1002 O - - - [A.5.5. ] Unsigned3 2 M P - V Y Current-Number-Members 45687 1003 O - - - [A.5.6. ] Unsigned3 2 M P - V Y Data-Memory-Size 45687 1004 O - - - [A.5.7. ] Unsigned3 2 M P - V Y Destination-Host 0 293 O - - - IETF RFC 3588 [13] DiamIdent M P - V N Event-Timestamp 0 55 O O - - IETF RFC 3588 [13] Time M P - V N External-ID 45687 1005 O - - - [A.5.8. ] UTF8String M P - V Y Group-Name 45687 1006 O - - - [A.5.9. ] UTF8String M P - V Y Hosting-CSE-ID 45687 1007 O - - - [A.5.10. ] UTF8String M P - V Y Originator 45687 1008 M - - - [A.5.11. ] UTF8String M P - V Y Maximum-Number-Members 45687 1009 O - - - [A.5.12. ] Unsigned3 2 M P - V Y M2M-Event-Record- Timestamp 45687 1010 M - - - [A.5.13. ] Time M P - V Y M2M-Information 45687 1011 M - - - [A.5.14. ] Grouped M P - V Y Node-Id 10415 2064 M - - - ETSI TS 132.299 [31] UTF8String V,M P - - N Occupancy 45687 1012 O - - - [A.5.16. ] Unsigned3 2 M P - V Y Origin-Host 0 264 M M - - IETF RFC 3588 [13] DiamIdent M P - V N Origin-Realm 0 296 M M - - IETF RFC 3588 [13] DiamIdent M P - V N Origin-State-Id 0 278 O O - - IETF RFC 3588 [13] Unsigned3 2 M P - V N Protocol-Type 45687 1013 O - - - [A.5.17. ] Enumerate d M P - V Y Proxy-Info 0 284 O O - - IETF RFC 3588 [13] Grouped M - - P,V N Rating-Group 0 432 O - - - IETF RFC 4006 [32] Unsigned3 2 M P - V Y Receiver 45687 1014 O - - - [A.5.19. ] UTF8String M P - V Y ETSI ETSI TS 118 104 V2.7.1 (2016-10) 239 oneM2M TS-0004 version 2.7.1 Release 2 AVP Name AVP Vend or Id AVP Cod e Used in Reference Value Type AVP Flag rules AC R AC A CC R CC A Mus t Ma y Shoul d not Mus t not May Encr . Request-Body-Size 45687 1015 O - - - [A.5.20. ] Unsigned3 2 M P - V Y Request-Headers-Size 45687 1016 O - - - [A.5.21. ] Unsigned3 2 M P - V Y Request-Operation 45687 1017 O - - - [A.5.22. ] Enumerate d M P - V Y Response-Body-Size 45687 1018 O - - - [A.5.23. ] Unsigned3 2 M P - V Y Response-Headers-Size 45687 1019 O - - - [A.5.24. ] Unsigned3 2 M P - V Y Response-Status-Code 45687 1020 O - - - [A.5.25. ] Enumerate d M P - V Y Result-Code 0 268 - M - - IETF RFC 3588 [13] Unsigned3 2 M P - V N Route-Record 0 282 O - - - IETF RFC 3588 [13] DiamIdent M - - P,V N Service-Context-Id 0 461 O - - - [A.5.26. ] Grouped M P - V N Service-Information 10415 873 O - - - ETSI TS 132 299 [31] Grouped M P - V N Session-Id 0 263 M M - - IETF RFC 3588 [13] UTF8String M P - V Y Subgroup-Name 45687 1021 O - - - [A.5.28. ] UTF8String M P - V Y Subscription-Id 0 443 M - - - IETF RFC 4006 [32] Grouped M P - V Y Subscription-Id-Data 0 444 M - - - IETF RFC 4006 [32] UTF8String M P - V Y Subscription-Id-Type 0 450 M - - - IETF RFC 4006 [32] Enumerate d M P - V Y Target-ID 45687 1022 O - - - [A.5.32. ] UTF8String M P - V Y A.5 oneM2M Specific AVP Usage A.5.1 Access-Network-Identifier AVP The Access-Network-Identifier AVP (AVP Code 1000) is of type Unsigned32 and identifies the access network associated with the request triggering the M2M Event Record. The IN-CSE detects the link on which a request came from or was sent to and that link maps to a specific Network and locally configured identifier. A.5.2 Acct-Application-Id AVP Since the protocol used on Mch is Diameter Accounting, this AVP shall contain the value of 3 as defined in IETF RFC 3588 [13]. A.5.3 Accounting-Record-Type AVP The Accounting-Record-Type AVP (AVP Code 480) is of type Enumerated and contains the type of accounting record being sent. The following value is currently defined for the Accounting-Record-Type AVP: EVENT_RECORD (value 1) for an Event Based request. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 240 oneM2M TS-0004 version 2.7.1 Release 2 A.5.4 Application-Entity-ID AVP The Application-Entity-ID AVP (AVP Code 1001) is of type UTF8String and represents the identity of the M2M Application Entity when it is applicable. The format of the AE-ID is specified in clause 6.2.3. A.5.5 Control-Memory-Size AVP The Control-Memory-Size AVP (AVP Code 1002) is of type Unsigned32 and represents the storage memory (in bytes) used to store control related information associated with the M2M event record (excludes data storage associated with container related operations). A.5.6 Current-Number-Members AVP The Current-Number-Members AVP (AVP Code 1003) is of type Unsigned32 and represents the current number of members in a group as determined by the responses to a request transmitted to a group. This is the same as the attribute "currentNrOfMembers" for the group as described in Table 7.4.13.2-3. A.5.7 Data-Memory-Size AVP The Data-Memory-Size AVP (AVP Code 1004) is of type Unsigned32 and represents the storage memory in bytes, where applicable, to store data associated with container related operations. A.5.8 External-ID AVP The External-ID AVP (AVP Code 1005) is of type UTF8String and contains the external ID used to communicate over Mcn where applicable. The format is the same as the M2M-Ext-ID in clause Addressing. A.5.9 Group-Name AVP The Group-Name AVP (AVP Code 1006) is of type UTF8String and identifies the group associated with a request. It shall be included when the IN initiates a fanning operation. This is the same as the attribute "groupName" for the group as described in Table 7.4.13.2-3. A.5.10 Hosting-CSE-ID AVP The Hosting-CSE-ID AVP (AVP Code 1007) is of type UTF8String and represents the identity of the Hosting CSE for the request in case the receiver is not the host. The format of the CSE-ID is specified in clause 6.2.3. A.5.11 Originator AVP The Originator AVP (AVP Code 1008) is of type UTF8String and identifies the originator (i.e. from party) of the M2M request. This can be any M2M Node with format as per clause 6.2.3. A.5.12 Maximum-Number-Members AVP The Maximum-Number-Members AVP (AVP Code 1009) is of type Unsigned32 and represents the maximum number of members of the group for the Create and Update operations. This is the same as the attribute "maxNrOfMembers" for the group as described in Table 7.4.13.2-3. A.5.13 M2M-Event-Record-Timestamp AVP The M2M-Event-Record-Timestamp AVP (AVP code 1010) is of type Time and represents the time for recording the M2M event record. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 241 oneM2M TS-0004 version 2.7.1 Release 2 A.5.14 M2M-Information AVP The M2M-Information AVP (AVP code 1011) is of type Grouped. Its purpose is to allow the transmission of service information elements used for OneM2M specific charging. It has the following ABNF grammar: M2M-Information :: = < AVP Header: 1011> [ Application-Entity-ID ] [ External-ID ] [ Receiver ] [ Originator ] [ Hosting-CSE-ID ] [ Target-ID ] [ Protocol-Type ] [ Request-Operation ] [ Request-Headers-Size ] [ Request-Body-Size ] [ Response-Headers-Size ] [ Response-Body-Size ] [ Response-Status-Code ] [ Rating-Group ] [ M2M-Event-Record-Timestamp ] [ Control-Memory-Size ] [ Data-Memory-Size ] [ Access-Network-Identifier ] [ Occupancy ] [ Group-Name ] [ Maximum-Number-Members ] [ Current-Number-Members ] [ Subgroup-Name ][ Node-Id ] * [ AVP ] A.5.15 Node-ID AVP The Node-Id AVP (AVP Code 2064) is of type UTF8String and includes an optional, operator configurable identifier string for the node generating the Accounting-Record-Number for the Diameter ACR. A.5.16 Occupancy AVP The Occupancy AVP (AVP Code 1012) is of type Unsigned32 and represents the overall size (in bytes) of the containers generated by a set of AEs identified by the M2M Service Subscription Identifier A.5.17 Protocol-Type AVP The Protocol-Type AVP (AVP Code 1013) is of type Enumerated and indicates the protocol used for the request. The values are given below: 0 HTTP 1 CoAP 2 MQTT 3 .. 99 Reserved for OneM2M defined protocol types 100 .. 199 Operator and vendor specific protocol types A.5.18 Rating-Group AVP The Rating-Group AVP (AVP Code 432) is of type Unsigned32 and represents a classification of M2M event records for charging purposes. This is assigned by the IN and is M2M SP specific. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 242 oneM2M TS-0004 version 2.7.1 Release 2 A.5.19 Receiver AVP The Receiver AVP (AVP Code 1014) is of type UTF8String and identifies the receiver (i.e. to party) of the M2M request. This can be any M2M Node with format as per clause 6.2.3. A.5.20 Request-Body-Size AVP The Request-Body-Size AVP (AVP Code 1015) is of type Unsigned32 and represents the number of bytes of the body transported in the Request. A.5.21 Request-Headers-Size AVP The Request-Headers-Size AVP (AVP Code 1016) is of type Unsigned32 and represents the number of bytes in the control information header in the Request. A.5.22 Request-Operation AVP The Request-Operation AVP (AVP Code 1017) is of type Enumerated and identifies the type of operation requested. The values are defined in Table 6.3.4.2.5-1. A.5.23 Response-Body-Size AVP The Response-Body-Size AVP (AVP Code 1018) is of type Unsigned32 and represents the number of bytes of the body transported in the Response. A.5.24 Response-Headers-Size AVP The Response-Headers-Size AVP (AVP Code 1019) is of type Unsigned32 and represents the number of bytes in the control information header in the Response. A.5.25 Response-Status-Code AVP The Response-Status-Code AVP (AVP Code 1020) is of type Enumerated and identifies the value of returned in the Response Status Code parameter of the Response. The values are defined in clause 6.6.3. A.5.26 Service-Context-Id AVP This AVP is of type UTF8String and contains a unique identifier of the Diameter charging specific document that applies the request. This is an identifier allocated by the service provider, by the service element manufacturer, or by a standardization body, and shall uniquely identify a given Diameter charging specific document. The format of the Service-Context-Id is: "extensions"."Release"."service-context" "@" "domain" The OneM2M specific values "service-context" "@" "domain" are: ts0004@oneM2M.org for OneM2M charging The "Release" indicates the OneM2M Release the service specific document is based upon e.g. 1 for Release 1. The "extensions" is operator specific information to any extensions in a service specific document. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 243 oneM2M TS-0004 version 2.7.1 Release 2 A.5.27 Service-Information AVP The Service-Information AVP (AVP code 873) is of type Grouped. Its purpose is to allow the transmission of additional OneM2M specific information elements. The complete ABNF syntax is defined and maintained in ETSI TS 132 299 [31]. The group structure includes zero or more occurrences of the Subscription-Id AVP and the M2M-Information AVP. The format and content of the M2M-Information AVP which includes the OneM2M specific AVPs are specified in the present document. A.5.28 Subgroup-Name AVP The Subgroup-Name AVP (AVP Code 1021) is of type UTF8String and identifies the subgroup associated with a request. It shall be included when the IN initiates a fanning operation and one of the members of the group is a. This is the same as the attribute "groupName" for the subgroup as described in Table 7.4.13.2-3. A.5.29 Subscription-Id AVP The Subscription-Id AVP (AVP Code 443) is of type Grouped with structure defined in IETF RFC 4006 [30]. The Subscription-Id AVP includes a Subscription-Id-Data AVP that holds the identifier and a Subscription-Id-Type AVP that defines the identifier type. For M2M, this identifies the M2M Service Subscription ID associated with the request. This is determined by association maintained by the M2M SP as per clause 12.1.3 in ETSI TS 118 101 [6]. A.5.30 Subscription-Id-Data AVP The Subscription-Id-Data AVP (AVP Code 444) is of type UTF8String as defined in IETF RFC 4006 [32]. The Subscription-Id-Data is used to identify the M2M Service Subscription. The Subscription-Id-Type AVP defines which type of identifier is used. A.5.31 Subscription-Id-Type AVP The Subscription-Id-Type AVP (AVP Code 450) is of type Enumerated as defined in IETF RFC 4006 [32]. It is used to determine which type of identifier is carried by the Subscription-Id AVP. The type(s) to be supported is(are) determined by the M2M SP. A.5.32 Target-ID AVP The Target-ID AVP (AVP Code 1022) is of type UTF8String and identifies the target URL for the M2M request if available. Alternatively the Target-ID AVP can identify the target resource identifier with format defined in clause 6.3.4. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 244 oneM2M TS-0004 version 2.7.1 Release 2 Annex B (normative): 3GPP MTC Interworking Device triggering B.1 Device triggering B.1.1 Providing device triggering service by means of 3GPP networks B.1.1.1 Introduction 3GPP Underlying Network has defined a dedicated interface for requesting device triggering. The normative references for applicable interfaces are as follows: ETSI TS 123 682 [15]. The specification for the interface Tsp is described in ETSI TS 129 368 [16]. Tsp interface uses Diameter Base Protocol as specified in IETF RFC 3588 [13], in order to use such an interface the CSE shall act as a Diameter client as described in IETF RFC 6733 [14]. Before the CSE initiates the device triggering, the CSE and MTC-IWF shall execute the procedures once as specified in 3GPP TS29.368 [16]. B.1.1.2 Device action request command When a CSE needs to issue a device triggering request to the MTC-IWF, the CSE shall send a Device-Action-Request (DAR) command (for detail, see ETSI TS 129 368 [16]). The following list provides the parameters mapping between the oneM2M and 3GPP. Either External-Id or MSISDN: the CSE maps it to the M2M-Ext-ID, see clause 6.2. SCS identifier: the CSE maps it to the CSE-ID, see clause 6.2. Application Port Identifier: the CSE maps it to Trigger-Recipient-ID, see clause 6.2. B.1.1.3 Device action answer command As a result of device triggering request to MTC-IWF, the CSE receives a Device-Action-Answer (DAA) command (for detail, see ETSI TS 129 368 [16]). B.1.1.4 Device notification request command As a report of the result for device triggering delivery by 3GPP network, the CSE receives a Device-Notification- Request (DNR) command (for detail, see ETSI TS 129 368 [16]). B.1.1.5 Device notification answer command As a result of device notification request to MTC-IWF, the CSE sends a Device-Notification-Answer (DNA) command (for detail, see ETSI TS 129 368 [16]). ETSI ETSI TS 118 104 V2.7.1 (2016-10) 245 oneM2M TS-0004 version 2.7.1 Release 2 B.2 Configuration of AESE Communication Patterns B.2.1 Direct Mode: Configuration of AESE Communication Patterns B.2.1.1 Introduction A 3GPP Underlying Network has dedicated interfaces for requesting to configure of Application Enablement Service Exposure (AESE) Communication Patterns. The normative references for applicable interfaces are found in ETSI TS 123 682 [15]. The specification for the interface S6t is described in ETSI TS 129 336 [37]. S6t interface uses Diameter Base Protocol as specified in IETF RFC 3588 [13].Through the interface, the CSE shall act as a Diameter client as described in IETF RFC 6733 [14]. In this direct mode, the CSE works as a 3GPP SCEF to configure/delete communication patterns of nodes. (See clause 7 and 8 in ETSI TS 129 336 [37] for procedures and protocol details.) B.2.1.2 Configuration Information Request command When a CSE issues a configuration information request for AESE Communication Patterns to the HSS, the CSE shall send a Configuration-Information-Request (CIR) command (see ETSI TS 129 336 [37] for details). The following table provides the parameters mapping between oneM2M and 3GPP. The data format needs to be converted accordingly. Table B.2.1.2-1: Mapping between oneM2M resource and 3GPP AVP oneM2M <trafficPattern> Resource Attribute or Child Resource 3GPP Communication-Pattern-Set AVP Reference periodicIndicator Periodic-Communication-Indicator clause 7.4.42 periodicDurationTime Communication-Duration-Time clause 7.4.42 periodicIntervalTime Periodic-Time clause 7.4.42 stationaryIndication Stationary-Indication clause 7.4.42 validityTime Validity-Time clause 7.4.42 dataSizeIndicator n/a in Rel-13 clause 7.4.42 targetNetwork n/a (only for oneM2M use) clause 7.4.42 <schedule> Scheduled-Communication-Time clause 7.4.9 B.2.1.3 Configuration Information Answer command As a result of configuration information request for AESE Communication Patterns to HSS, the CSE receives a Configuration-Information-Answer (CIA) command (see ETSI TS 129 336 [37] for details). The following table provides the parameters mapping between the oneM2M and 3GPP. The data format needs to be converted accordingly. Table B.2.1.3-1: Mapping between oneM2M resource and 3GPP AVP oneM2M <trafficPattern> Resource Attribute 3GPP AESE-Communication-Pattern-Config- Status AVP Reference providedToNSE AESE-Error-Report clause 7.4.42 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 246 oneM2M TS-0004 version 2.7.1 Release 2 Annex C (informative): XML examples C.1 XML schema for container resource type <?xml version="1.0" encoding="UTF-8"?> <!-- Copyright Notification The oneM2M Partners authorize you to copy this document, provided that you retain all copyright and other proprietary notices contained in the original materials on any copies of the materials and that you comply strictly with these terms. This copyright permission does not constitute an endorsement of the products or services, nor does it encompass the granting of any patent rights. The oneM2M Partners assume no responsibility for errors or omissions in this document. © 2015, oneM2M Partners Type 1 (ARIB, ATIS, CCSA, ETSI, TIA, TSDSI, TTA, TTC). All rights reserved. Notice of Disclaimer & Limitation of Liability The information provided in this document is directed solely to professionals who have the appropriate degree of experience to understand and interpret its contents in accordance with generally accepted engineering or other professional standards and applicable regulations. No recommendation as to products or vendors is made or should be implied. NO REPRESENTATION OR WARRANTY IS MADE THAT THE INFORMATION IS TECHNICALLY ACCURATE OR SUFFICIENT OR CONFORMS TO ANY STATUTE, GOVERNMENTAL RULE OR REGULATION, AND FURTHER, NO REPRESENTATION OR WARRANTY IS MADE OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR AGAINST INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS. NO oneM2M PARTNER TYPE 1 SHALL BE LIABLE, BEYOND THE AMOUNT OF ANY SUM RECEIVED IN PAYMENT BY THAT PARTNER FOR THIS DOCUMENT, WITH RESPECT TO ANY CLAIM, AND IN NO EVENT SHALL oneM2M BE LIABLE FOR LOST PROFITS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES. oneM2M EXPRESSLY ADVISES ANY AND ALL USE OF OR RELIANCE UPON THIS INFORMATION PROVIDED IN THIS DOCUMENT IS AT THE RISK OF THE USER. --> <xs:schema targetNamespace="http://www.onem2m.org/xml/protocols" xmlns:m2m="http://www.onem2m.org/xml/protocols" elementFormDefault="unqualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:include schemaLocation="CDT-commonTypes-v2_7_0.xsd"/> <xs:include schemaLocation="CDT-contentInstance-v2_7_0.xsd"/> <xs:include schemaLocation="CDT-subscription-v2_7_0.xsd"/> <xs:include schemaLocation="CDT-semanticDescriptor-v2_7_0.xsd"/> <xs:element name="container"> <xs:complexType> <xs:complexContent> <xs:extension base="m2m:announceableResource"> <xs:sequence> <!-- Common Attribute, specific to <container>, <contentInstance>, <request> and <delivery> and other resources --> <xs:element name="stateTag" type="xs:nonNegativeInteger"/> <xs:element name="creator" type="m2m:ID" minOccurs="0"/> <!-- Resource Specific Attributes --> <xs:element name="maxNrOfInstances" type="xs:nonNegativeInteger" minOccurs="0"/> <xs:element name="maxByteSize" type="xs:nonNegativeInteger" minOccurs="0"/> <xs:element name="maxInstanceAge" type="xs:nonNegativeInteger" minOccurs="0"/> <xs:element name="currentNrOfInstances" type="xs:nonNegativeInteger"/> <xs:element name="currentByteSize" type="xs:nonNegativeInteger"/> <xs:element name="locationID" type="xs:anyURI" minOccurs="0"/> <xs:element name="ontologyRef" type="xs:anyURI" minOccurs="0"/> <xs:element name="disableRetrieval" type="xs:boolean" minOccurs="0"/> <!-- Child Resources --> <xs:choice minOccurs="0" ETSI ETSI TS 118 104 V2.7.1 (2016-10) 247 oneM2M TS-0004 version 2.7.1 Release 2 maxOccurs="1"> <xs:element name="childResource" type="m2m:childResourceRef" minOccurs="1" maxOccurs="unbounded"/> <xs:choice minOccurs="1" maxOccurs="unbounded"> <xs:element ref="m2m:contentInstance"/> <xs:element ref="m2m:container"/> <xs:element ref="m2m:subscription"/> <xs:element ref="m2m:semanticDescriptor"/> </xs:choice> </xs:choice> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element> <xs:element name="containerAnnc"> <xs:complexType> <xs:complexContent> <xs:extension base="m2m:announcedResource"> <xs:sequence> <!-- Common Attribute, specific to <container>, <contentInstance>, <request> and <delivery> resources --> <xs:element name="stateTag" type="xs:nonNegativeInteger"/> <!-- Resource Specific Attributes --> <xs:element name="maxNrOfInstances" type="xs:nonNegativeInteger" minOccurs="0"/> <xs:element name="maxByteSize" type="xs:nonNegativeInteger" minOccurs="0"/> <xs:element name="maxInstanceAge" type="xs:nonNegativeInteger" minOccurs="0"/> <xs:element name="currentNrOfInstances" type="xs:nonNegativeInteger" minOccurs="0"/> <xs:element name="currentByteSize" type="xs:nonNegativeInteger" minOccurs="0"/> <xs:element name="locationID" type="xs:anyURI" minOccurs="0"/> <xs:element name="ontologyRef" type="xs:anyURI" minOccurs="0"/> <xs:element name="disableRetrieval" type="xs:boolean" minOccurs="0"/> <!-- Child Resources --> <xs:choice minOccurs="0" maxOccurs="1"> <xs:element name="childResource" type="m2m:childResourceRef" minOccurs="1" maxOccurs="unbounded"/> <xs:choice minOccurs="1" maxOccurs="unbounded"> <xs:element ref="m2m:contentInstance"/> <xs:element ref="m2m:contentInstanceAnnc"/> <xs:element ref="m2m:container"/> <xs:element ref="m2m:containerAnnc"/> <xs:element ref="m2m:subscription"/> <xs:element ref="m2m:semanticDescriptor"/> <xs:element ref="m2m:semanticDescriptorAnnc"/> </xs:choice> </xs:choice> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element> </xs:schema> C.2 Container resource that conforms to the Schema given above (see clause C.1) <?xml version="1.0" encoding="UTF-8"?> <m2m:container xmlns:m2m="http://www.onem2m.org/xml/protocols" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation= "http://www.onem2m.org/xml/protocols CDT-container-v2_7_0.xsd" resourceName="12xx"> <resourceType>3</resourceType> <resourceID>//IN-CSEID.m2m.myoperator.org/96719</resourceID> <parentID>//IN-CSEID.m2m.myoperator.org/96734</parentID> <creationTime>20141003T112032</creationTime> ETSI ETSI TS 118 104 V2.7.1 (2016-10) 248 oneM2M TS-0004 version 2.7.1 Release 2 <lastModifiedTime>20141003T112032</lastModifiedTime> <labels>label1 label2</labels> <accessControlPolicyIDs > l//IN-CSEID.m2m.myoperator.org/93405 </accessControlPolicyIDs/> <expirationTime>20141130T120000</expirationTime> <stateTag>0 </stateTag> <creator>//IN-CSEID.m2m.myoperator.org/9125</creator> <maxNrOfInstances>5</maxNrOfInstances> <maxByteSize>104857600</maxByteSize> <maxInstanceAge>3600</maxInstanceAge> <currentNrOfInstances>2</currentNrOfInstances> <currentByteSize>6</currentByteSize> <locationID>//IN-CSEID.m2m.myoperator.org/1112</locationID> <ontologyRef>http://tempuri.org/ontologies/xyz</ontologyRef> <childResource name="instance1234" type="4">//IN- CSEID.m2m.myoperator.org/1722</childResource> <childResource name="instance1235" type="4">//IN- CSEID.m2m.myoperator.org/34722</childResource> <childResource name="1923" type="23">//IN-CSEID.m2m.myoperator.org/2323</childResource> </m2m:container> ETSI ETSI TS 118 104 V2.7.1 (2016-10) 249 oneM2M TS-0004 version 2.7.1 Release 2 Annex D (normative): <mgmtObj> Resource specializations D.1 Introduction The Annex defines the structure and procedure for the <mgmtObj> resource specializations. The resource specializations specified in the following sub-clauses of this Annex shall be created on the IN-CSE when the management request is performed using external technology specific protocols. The IN-CSE further interacts with the management server to perform management requests towards the managed entity. If the management request is performed solely over the M2M Service Layer, the <mgmtObj> resource specializations are created on the managed entity if the managed entity is equipped with a CSE. If the managed entities are non-oneM2M Nodes, the resources are created on the MN-CSE of the managed entity. The details can be found in the ETSI TS 118 101 [6]. D.2 Resource [firmware] D.2.1 Introduction The detailed description of the [firmware] resource can be found in clause D.2 of the ETSI TS 118 101 [6]. Table D.2.1-1: Data Type Definition of [firmware] Data Type ID File Name Note firmware, firmwareAnnc CDT-firmware-v2_7_0.xsd Table D.2.1-2: Resource specific attributes of [firmware] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1001 (firmware) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 version M O xs:string firmwareName M O xs:string URL M O xs:anyURI update M O xs:boolean updateStatus NP O m2m:actionStatus D.2.2 Resource specific procedure on CRUD operations D.2.2.1 Introduction When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 <mgmtObj> specific procedures shall be used. The following clauses define additional procedures besides the generic procedure defined in clause 7.2.2. D.2.2.1.1 Create Originator: No change from the generic procedures in clause 7.2.2.1. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 250 oneM2M TS-0004 version 2.7.1 Release 2 Receiver: Primitive specific step after generic procedure defined in clause 7.2.2.2. May start to download the firmware image from the location indicated by attribute URL in the firmware resource. D.2.2.1.2 Update Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Primitive specific operation additional to Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed": When the attribute update of the firmware resource is updated to TRUE, use the downloaded firmware image to update the current using firmware. The Receiver may need to update the fwVersion attribute of the [deviceInfo] resource if needed. D.2.2.1.3 Retrieve Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.2.2.1.4 Delete Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Primitive specific step after generic procedure defined in clause 7.2.2.2: Delete the downloaded firmware image locally. D.3 Resource [software] D.3.1 Introduction The detailed description of the [software] resource can be found in clause D.3 of ETSI TS 118 101 [6]. Table D.3.1-1: Data Type Definition of [software] Data Type ID File Name Note software, softwareAnnc CDT-software-v2_7_0.xsd ETSI ETSI TS 118 104 V2.7.1 (2016-10) 251 oneM2M TS-0004 version 2.7.1 Release 2 Table D.3.1-2: Resource specific attributes of [software] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1002 (software) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 version M O xs:string softwareName M O xs:string URL M O xs:anyURI install NP O xs:boolean uninstall NP O xs:boolean installStatus NP NP m2m:actionStatus activate NP O xs:boolean deactivate NP O xs:boolean activeStatus NP NP m2m:actionStatus D.3.2 Resource specific procedure on CRUD operations D.3.2.1 Introduction When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 <mgmtObj> resource specific procedures shall be used. The following clauses define additional procedures besides the generic procedure defined in clause 7.2.2. D.3.2.2 Create Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. May start to download the software package from the location indicated by attribute URL in the software resource. D.3.2.3 Update Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Primitive specific operation additional to Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed": When the attribute install of the [software] resource is updated to TRUE, install the software package downloaded from the address indicated by attribute URL of the [software] resource. When the attribute uninstall of the [software] resource is updated to TRUE, uninstall the corresponding software of the [software] resource. When the attribute activate of the [software] resource is updated to TRUE, activate the corresponding software of the [software] resource. When the attribute deactivate of the [software] resource is updated to TRUE, deactivate the corresponding software of the [software] resource. The Receiver may need to update the swVersion attribute of the [deviceInfo] resource if needed. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 252 oneM2M TS-0004 version 2.7.1 Release 2 D.3.2.4 Retrieve Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.3.2.5 Delete Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Primitive specific step after generic procedure defined in clause 7.2.2.2. Delete the downloaded software package locally. D.4 Resource [memory] D.4.1 Introduction The detailed description of the [memory] resource can be found in clause D.4 of ETSI TS 118 101 [6]. Table D.4.1-1: Data Type Definition of [memory] Data Type ID File Name Note memory, memoryAnnc CDT-memory-v2_7_0.xsd Table D.4.1-2: Resource specific attributes of [memory] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1003 (memory) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 memAvailable M O xs:unsignedLong Unit: Byte. memTotal M O xs:unsignedLong Unit: Byte. D.4.2 Resource specific procedure on CRUD operations D.4.2.1 Introduction When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 <mgmtObj> specific procedures shall be used. The following clauses define additional procedures besides the generic procedure defined in clause 7.2.2. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 253 oneM2M TS-0004 version 2.7.1 Release 2 D.4.2.2 Create Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.4.2.3 Update Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.4.2.4 Retrieve Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.4.2.5 Delete Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.5 Resource [areaNwkInfo] D.5.1 Introduction The detailed description of the [areaNwkInfo] resource can be found in clause D.5 of ETSI TS 118 101 [6]. Table D.5.1-1: Data Type Definition of [areaNwkInfo] Data Type ID File Name Note areaNwkInfo, areaNwkInfoAnnc CDT-areaNwkInfo-v2_7_0.xsd ETSI ETSI TS 118 104 V2.7.1 (2016-10) 254 oneM2M TS-0004 version 2.7.1 Release 2 Table D.5.1-2: Resource specific attributes of [areaNwkInfo] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1004 (areaNwkInfo) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 areaNwkType M O xs:string listOfDevices M O list of xs:anyURI D.5.2 Resource specific procedure on CRUD operations D.5.2.1 Introduction When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 <mgmtObj> specific procedures shall be used. The following clauses define additional procedures besides the generic procedure defined in clause 7.2.2. D.5.2.2 Create Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.5.2.3 Update Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.5.2.4 Retrieve Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.5.2.5 Delete Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 255 oneM2M TS-0004 version 2.7.1 Release 2 D.6 Resource [areaNwkDeviceInfo] D.6.1 Introduction The detailed description of the [areaNwkDeviceInfo] resource can be found in clause D.6 of ETSI TS 118 101 [6]. Table D.6.1-1: Data Type Definition of [areaNwkDeviceInfo] Data Type ID File Name Note areaNwkDeviceInfo, areaNwkDeviceInfoAnnc CDT-areaNwkDeviceInfo-v2_7_0.xsd Table D.6.1-2: Resource specific attributes of [areaNwkDeviceInfo] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1005 (areaNwkDeviceInfo) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 devID M O xs:string devType M O xs:string areaNwkId M O xs:anyURI sleepInterval O O xs:nonNegativeInteger Unit: second sleepDuration O O xs:nonNegativeInteger Unit: second devStatus O O xs:string listOfNeighbors M O list of xs:anyURI D.6.2 Resource specific procedure on CRUD operations D.6.2.1 Introduction When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 <mgmtObj> specific procedures shall be used. The following clauses define additional procedures besides the generic procedure defined in clause 7.2.2. D.6.2.2 Create Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.6.2.3 Update Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Primitive specific operation additional to Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed". ETSI ETSI TS 118 104 V2.7.1 (2016-10) 256 oneM2M TS-0004 version 2.7.1 Release 2 When the attribute listOfNeighbors of the [areaNwkDeviceInfo] resource is updated, the receiver shall modify the corresponding connection relationship among devices in the M2M Area Network by sending signals to non-oneM2M Nodes which is out of scope of oneM2M. According to the response from the non-oneM2M nodes of the modify signal, the receiver shall corresponding update the [areaNwkDeviceInfo] resource which may include the update of the listOfNeighbors and the devType attribute. The modification may include change of the attach point of the device or removal from the area network. D.6.2.4 Retrieve Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.6.2.5 Delete Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.7 Resource [battery] D.7.1 Introduction The detailed description of the [battery] resource can be found in clause D.7 of ETSI TS 118 101 [6]. Table D.7.1-1: Data Type Definition of [battery] Data Type ID File Name Note battery, batteryAnnc CDT-battery-v2_7_0.xsd Table D.7.1-2: Resource specific attributes of [battery] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1006 (battery) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 batteryLevel M O xs:unsignedInt Range: 0-100 Unit: percent batteryStatus M O m2m:batteryStatus ETSI ETSI TS 118 104 V2.7.1 (2016-10) 257 oneM2M TS-0004 version 2.7.1 Release 2 D.7.2 Resource specific procedure on CRUD operations D.7.2.1 Introduction When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 <mgmtObj> specific procedures shall be used. The following clauses define additional procedures besides the generic procedure defined in clause 7.2.2. D.7.2.2 Create Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.7.2.3 Update Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.7.2.4 Retrieve Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.7.2.5 Delete Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.8 Resource [deviceInfo] D.8.1 Introduction The resource [deviceInfo] is used to provide information regarding the device. The detailed description of the [deviceInfo] resource can be found in clause D.8 of ETSI TS 118 101 [6]. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 258 oneM2M TS-0004 version 2.7.1 Release 2 Table D.8.1-1: Data Type Definition of [deviceInfo] Data Type ID File Name Note deviceInfo, deviceInfoAnnc CDT-deviceInfo-v2_7_0.xsd Table D.8.1-2: Resource specific attributes of [deviceInfo] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1007 (deviceInfo) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 deviceLabel M O xs:string manufacturer M O xs:string model M O xs:string deviceType M O xs:string fwVersion M O xs:string swVersion M O xs:string hwVersion M O xs:string D.8.2 Resource specific procedure on CRUD operations D.8.2.1 Introduction When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 <mgmtObj> specific procedures shall be used. The following clauses define additional procedures besides the generic procedure defined in clause 7.2.2. D.8.2.2 Create Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.8.2.3 Update Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.8.2.4 Retrieve Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 259 oneM2M TS-0004 version 2.7.1 Release 2 D.8.2.5 Delete Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.9 Resource [deviceCapability] D.9.1 Introduction The resource [deviceCapability] is used to provide information regarding the device. The detailed description of the [deviceCapability] resource can be found in clause D.9 of ETSI TS 118 101 [6]. Table D.9.1-1: Data Type Definition of [deviceCapability] Data Type ID File Name Note deviceCapability, deviceCapabilityAnnc CDT-deviceCapability-v2_7_0.xsd Table D.9.1-2: Resource specific attributes of [deviceCapability] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1008 (deviceCapability) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 capabilityName M O xs:string attached M O xs:boolean 1. true: currently attached to the device 2. false: currently detached to the device capabilityActionStatus M O m2m:actionStatus The action (i.e. enable, disable) and the related status. See the Table 6.3.2.3 1 currentState M O xs:boolean • true: the device capability is enabled • false: the device capability is disabled enable O O xs:boolean the value of this attribute is always "true" disable O O xs:boolean the value of this attribute is always "true" ETSI ETSI TS 118 104 V2.7.1 (2016-10) 260 oneM2M TS-0004 version 2.7.1 Release 2 D.9.2 Resource specific procedure on CRUD operations D.9.2.1 Introduction When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 <mgmtObj> specific procedures shall be used. The following clauses define additional procedures besides the generic procedure defined in clause 7.2.2. D.9.2.2 Create Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.9.2.3 Update Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Primitive specific operation additional to Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed": When the attribute enable of the [deviceCapability] resource is updated to TRUE, enable the device capability of the [deviceCapability] resource. When the attribute disable of the [deviceCapability] resource is updated to TRUE, disable the device capability of the [deviceCapability] resource. D.9.2.4 Retrieve Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.9.2.5 Delete Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.10 Resource [reboot] D.10.1 Introduction The resource [reboot] is used to provide information regarding the device. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 261 oneM2M TS-0004 version 2.7.1 Release 2 The detailed description of the [reboot] resource can be found in clause D.10 of ETSI TS 118 101 [6]. Table D.10.1-1: Data Type Definition of [reboot] Data Type ID File Name Note reboot, rebootAnnc CDT-reboot-v2_7_0.xsd Table D.10.1-2: Resource specific attributes of [reboot] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1009 (reboot) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 reboot O O xs:boolean the value of this attribute is always "True" factoryReset O O xs:boolean the value of this attribute is always "True" D.10.2 Resource specific procedure on CRUD operations D.10.2.1 Introduction When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 <mgmtObj> specific procedures shall be used. The following clauses define additional procedures besides the generic procedure defined in clause 7.2.2. D.10.2.2 Create Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.10.2.3 Update Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Primitive specific operation additional to Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed": When the attribute reboot of the [reboot] resource is updated to TRUE, reboot the corresponding node. When the attribute factoryReset of the [reboot] resource is updated to TRUE, factory reset the corresponding node shall be applied. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 262 oneM2M TS-0004 version 2.7.1 Release 2 D.10.2.4 Retrieve Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.10.2.5 Delete Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.11 Resource [eventLog] D.11.1 Introduction The Resource [eventLog] is used to provide information regarding the device. The detailed description of the [eventLog] resource can be found in clause D.11 of ETSI TS 118 101 [6]. Table D.11.1-1: Data Type Definition of [eventLog] Data Type ID File Name Note eventLog, eventLogAnnc CDT-eventLog-v2_7_0.xsd Table D.11.1-2: Resource specific attributes of [eventLog] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1010 (eventLog) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 logTypeId M O m2m:logTypeId See Table 6.3.4.2.23-1 logData M O xs:string The content and format of this attribute is out of the present document. logStatus M O m2m:logStatus See Table 6.3.4.2.24-1 logStart O O xs:boolean the value of this attribute is always "True" logStop O O xs:boolean the value of this attribute is always "True" ETSI ETSI TS 118 104 V2.7.1 (2016-10) 263 oneM2M TS-0004 version 2.7.1 Release 2 D.11.2 Resource specific procedure on CRUD operations D.11.2.1 Introduction When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 <mgmtObj> specific procedures shall be used. The following clauses define additional procedures besides the generic procedure defined in clause 7.2.2. D.11.2.2 Create Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.11.2.3 Update Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Primitive specific operation additional to Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed": When the attribute logStart of the [eventLog] resource is updated to TRUE, start the logging. When the attribute logStop of the [eventLog] resource is updated to TRUE, stop the logging. D.11.2.4 Retrieve Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.11.2.5 Delete Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. D.12 Resource [cmdhPolicy] D.12.1 Introduction The resource [cmdhPolicy] represents a set of rules associated with a specific CSE that govern the behaviour of that CSE regarding rejecting, buffering and sending request or response messages via the Mcc reference point. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 264 oneM2M TS-0004 version 2.7.1 Release 2 The detailed description can be found in clause D.12 of ETSI TS 118 101 [6]. Table D.12.1-1: Data Type Definition of [cmdhPolicy] Data Type ID File Name Note cmdhPolicy CDT-cmdhPolicy-v2_7_0.xsd Note that the optional <subscription> child resources are not used for CMDH policies. Table D.12.1-2: Resource specific attributes of [cmdhPolicy] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1011 (cmdhPolicy) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 cmdhPolicyName M O xs:string None mgmtLink M O m2m:mgmtLinkRef 1 link to [cmdhDefaults] resource instance, 1 or more link(s) to [cmdhLimits] resource instance(s), 1 or more link(s) to [cmdhNetworkAccess Rules] resource instance(s), 1 or more link(s) to [cmdhBuffer] resource instance(s) The Resource Specific Procedure on CRUD Operations as specified in clause 7.4.15 for the generic <mgmtObj> resource type apply. D.12.2 Resource [activeCmdhPolicy] The resource [activeCmdhPolicy] provides a link to the currently active set of CMDH policies. The detailed description can be found in clause D.12.1 of ETSI TS 118 101 [6]. Table D.12.2-1: Data Type Definition of [activeCmdhPolicy] Data Type ID File Name Note activeCmdPolicy CDT-activeCmdhPolicy-v2_7_0.xsd ETSI ETSI TS 118 104 V2.7.1 (2016-10) 265 oneM2M TS-0004 version 2.7.1 Release 2 Table D.12.2-2: Resource specific attributes of [activeCmdhPolicy] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1012 (activeCmdhPolicy) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 activeCmdhPolicyLin k M O m2m:ID The resource ID of the [cmdhPolicy] resource instance containing the CMDH policies that are currently active for the associated CSE. D.12.3 Resource [cmdhDefaults] The resource [cmdhDefaults] defines which CMDH related parameters will be used by default when a request or response message contains the Event Category parameter but not any other CMDH related parameters and which default Event Category parameter shall be used when none is given in the request or response message. The detailed description can be found in clause D.12.2 of ETSI TS 118 101 [6]. Table D.12.3-1: Data Type Definition of [cmdhDefaults] Data Type ID File Name Note cmdhDefaults CDT-cmdhDefaults-v2_7_0.xsd Table D.12.3-2: Resource specific attributes of [cmdhDefaults] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1013 (cmdhDefaults) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 mgmtLink M O m2m:mgmtLinkRef 1 or more link(s) to [cmdhDefEcValue] resource instance(s); 1 or more link(s) to [cmdhEcDefParamVal ues] resource instance(s) D.12.4 Resource [cmdhDefEcValue] The resource [cmdhDefEcValue] represents a default value for the Event Category parameter of an incoming request or response message. This default Event Category becomes applicable when certain conditions are matched which are defined by the other attributes of this resource. The detailed description can be found in clause D.12.3 of oneM2M ETSI TS 118 101 [6]. Table D.12.4-1: Data Type Definition of [cmdhDefEcValue] Data Type ID File Name Note cmdhDefEcValue CDT-cmdhDefEcValue-v2_7_0.xsd ETSI ETSI TS 118 104 V2.7.1 (2016-10) 266 oneM2M TS-0004 version 2.7.1 Release 2 Table D.12.4-2: Resource specific attributes of [cmdhDefEcValue] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1014 (cmdhDefEcValue) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 order M O xs:positiveInteger None defEcValue M O m2m:eventCat None requestOrigin M O m2m:listOfM2MID None requestContext O O xs:anyType None requestContextNotification O O xs:boolean None requestCharacteristics O O xs:anyType None D.12.5 Resource [cmdhEcDefParamValues] The resource [cmdhEcDefParamValues] represents a specific set of default values for the CMDH related parameters Request Expiration Timestamp, Result Expiration Timestamp, Operational Execution Time, Result Persistence and Delivery Aggregation that are applicable for a given Event Category if these parameters are not specified in the message. The detailed description can be found in clause D.12.4 of ETSI TS 118 101 [6]. Table D.12.5-1: Data Type Definition of [cmdhEcDefParamValues] Data Type ID File Name Note cmdhEcDefParamValues CDT-cmdhEcDefParamValues-v2_7_0.xsd Table D.12.5-2: Resource specific attributes of [cmdhEcDefParamValues] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1015 (cmdhEcDefParamValues) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 applicableEventCategory M O list of m2m:eventCatWithDef Exactly one instance of this [cmdhEcDefParamValues] resource shall be provisioned which contains a value "0" (default) setting for this attribute. defaultRequestExpTime M O xs:long -1 means infinity, unit: ms defaultResultExpTime M O xs:long -1 means infinity, unit: ms defaultOpExecTime M O xs:long -1 means infinity, unit: ms defaultRespPersistence M O xs:long -1 means infinity, unit: ms defaultDelAggregation M O xs:boolean None D.12.6 Resource [cmdhLimits] The resource [cmdhLimits] represents limits for CMDH related parameter values. The detailed description can be found in clause D.12.5 of ETSI TS 118 101 [6]. Table D.12.6-1: Data Type Definition of [cmdhLimits] Data Type ID File Name Note cmdhLimits CDT-cmdhLimits-v2_7_0.xsd ETSI ETSI TS 118 104 V2.7.1 (2016-10) 267 oneM2M TS-0004 version 2.7.1 Release 2 Table D.12.6-2: Resource specific attributes of [cmdhLimits] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1016 (cmdhLimits) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 order M O xs:positiveInteger None requestOrigin M O m2m:listOfM2MID None requestContext O O xs:anyType None requestContextNotification O O xs:boolean None requestCharacteristics O O xs:anyType None limitsEventCategory M O list of m2m:eventCat None limitsRequestExpTime M O m2m:listOfMinMax -1 means infinity, unit: ms limitsResultExpTime M O m2m:listOfMinMax -1 means infinity, unit: ms limitsOpExecTime M O m2m:listOfMinMax -1 means infinity, unit: ms limitsRespPersistence M O m2m:listOfMinMax -1 means infinity, unit: ms limitsDelAggregation M O restricted list of xs:boolean This attribute defines the permitted settings of the DeliveryAggregation parameter of request primitives. '0' means 'False' '1' means 'True' '0 1' means 'False' or 'True' D.12.7 Resource [cmdhNetworkAccessRules] The resource [cmdhNetworkAccessRules] defines the usage of underlying networks for forwarding information to other CSEs during processing of CMDH-related requests in a CSE. The detailed description can be found in clause D.12.6 of ETSI TS 118 101 [6]. Table D.12.7-1: Type Definition of [cmdhNetworkAccessRules] Data Type ID File Name Note cmdhNetworkAccessRules CDT-cmdhNetworkAccessRules-v2_7_0.xsd Table D.12.7-2: Resource specific attributes of [cmdhNetworkAccessRules] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1017 (cmdhNetworkAccess Rules) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 applicableEventCate gories M O list of m2m:eventCatWithDef Exactly one instance of this [cmdhNetworkAccess Rules] resource shall be provisioned which contains a value "0" (default) setting for this attribute. mgmtLink O O m2m:mgmtLinkRef Zero or more links to [cmdhNwAccessRule] resource instance(s) ETSI ETSI TS 118 104 V2.7.1 (2016-10) 268 oneM2M TS-0004 version 2.7.1 Release 2 D.12.8 Resource [cmdhNwAccessRule] The resource [cmdhNwAccessRule] defines limits in usage of specific underlying networks for forwarding information to other CSEs during processing of CMDH-related requests. The detailed description can be found in clause D.12.7 of ETSI TS 118 101 [6]. Table D.12.8-1: Data Type Definition of [cmdhNwAccessRule] Data Type ID File Name Note cmdhNwAccessRule CDT-cmdhNwAccessRule-v2_7_0.xsd Table D.12.8-2: Resource specific attributes of [cmdhNwAccessRule] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1018 (cmdhNwAccessRule) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 targetNetwork M O m2m:listOfM2MID None minReqVolume M O xs:nonNegativeInteger Unit: byte spreadingWaitTime M O xs:nonNegativeInteger Unit: ms backOffParameters M O m2m:backOffParameter s Parameters that define how usage of any of the Underlying Networks matching with the targetNetwork attribute of this [cmdhNwAccessRule] resource shall be handled when attempts to use such networks have failed. only for the specified actions. See clause D.12.7 of ETSI TS 118 101 [6]. otherConditions O O xs:anyType None mgmtLink M O m2m:mgmtLinkRef Link to an instance "allowedSchedule" of a <schedule> resource D.12.9 Resource [cmdhBuffer] The resource [cmdhBuffer] represents limits in usage of buffers for temporarily storing information that needs to be forwarded to other CSEs during processing of CMDH-related requests in a CSE. The detailed description can be found in clause D.12.8 of ETSI TS 118 101 [6]. Table D.12.9-1: Data Type Definition of [cmdhBuffer] Data Type ID File Name Note cmdhBuffer CDT-cmdhBuffer-v2_7_0.xsd ETSI ETSI TS 118 104 V2.7.1 (2016-10) 269 oneM2M TS-0004 version 2.7.1 Release 2 Table D.12.9-2: Resource specific attributes of [cmdhBuffer] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 1019 (cmdhBuffer) objectID O NP See clause 7.4.15 objectPaths O NP See clause 7.4.15 description O O See clause 7.4.15 applicableEventCate gory M O list of m2m:eventCatWithDef Exactly one instance of this [cmdhBuffer] resource shall be provisioned which contains a value "0" (default) setting for this attribute. maxBufferSize M O xs:nonNegativeInteger Unit: byte storagePriority M O xs:positiveInteger The range of storage priority is from 1 to 10. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 270 oneM2M TS-0004 version 2.7.1 Release 2 Annex E (informative): Procedures for accessing resources E.1 Accessing resources in CSEs – blocking requests The result of a Request is sent back to the Originator as part of the Response of the Request. This communication mode could result in long blocking times. The interaction employing blocking involves the following steps in this order: Figure E.1-1: Blocking access to resource 1) The Originator sends a request to accessing a resource. The Response Type parameter of the request is set to 'blockingRequest'. The Response Type parameter can be omitted in this case since 'blockingRequest' is its default value. 2) The Hosting CSE receives the request, and it completes the requested processing of resources. 3) The Hosting CSE responds to Originator, the response contains the requested results in resource content, and the Response Status Code parameter of response is set to "OK". ETSI ETSI TS 118 104 V2.7.1 (2016-10) 271 oneM2M TS-0004 version 2.7.1 Release 2 E.2 Accessing Resources in CSEs - non-blocking requests E.2.1 Non-blocking models If the Originator chooses the Blocking mode described in clause E.1, it might have to wait a long time for a response from the Receiver. To avoid this possibility it can choose a Non-Blocking mode. In Non-blocking modes, the Receiver sends an Acknowledgement of the request, which provides a reference to the result of the requested operation. The Originator can retrieve the result at a later time. There are two forms of Non-blocking mode: Synchronous and Asynchronous. E.2.2 Synchronous case The Originator asks for non-Blocking Communication by setting the Response Type parameter of the Request to 'nonBlockingRequestSynch'. The Receiver CSE responds after acceptance with an Acknowledgement confirming, that it will process the Request further. The Receiver CSE creates a local <request> resource pertaining to the Request received and returns a reference to this created <request> resource as the Content of the acknowledgement Response. Then the Receiver needs to forward the Request to the next CSE if the Receiver CSE is not the Hosting CSE of the addressed resource. Or the Hosting CSE needs to start handling the Request if the Receiver CSE is the Hosting CSE of the addressed resource. The Originator of the Request may retrieve the <request> resource afterwards to check on the status of its Request and to inspect the final result of the Request when this is available. Figure E.2.2-1 illustrates the steps involved in a synchronous non-blocking interaction. In this example the Receiver CSE is the CSE that hosts the resource that is the target of the Originator's request. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 272 oneM2M TS-0004 version 2.7.1 Release 2 Figure E.2.2.-1: Non-Blocking access to resource in synchronous mode (no hop) 1) The originator sends a request to access a resource, setting the Response Type parameter of request to 'nonblockingRequestSynch'. 2) If the Receiver CSE supports non-blocking synchronous interactions (this is indicated by its support for the <request> resource), it creates an instance of <request> resource. The requestStatus attribute of the <request> resource is set to " ACCEPTED". Please refer to Table 7.3.2.2-1 and Table 7.3.2.2-2 for other attributes. 3) The Hosting CSE sends a response to the Originator, the Response Status Code parameter of its response is set to "ACCEPTED" , and a reference to the <request> resource is provided in the Content. 4) The Hosting CSE processes the resource according to the requested operation. When the requested operation has finished, the Hosting CSE will UPDATE the <request> resource, putting the results of the operation into the operationResult attribute, and updating the value of requestStatus to "COMPLETED", also the values of stateTag and lastModifiedTime. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 273 oneM2M TS-0004 version 2.7.1 Release 2 5) The Originator requests to RETRIEVE the original requested results by addressing the <request> resource. 6) The Hosting CSE responds to Originator. The response contains the <request> resource as its Content, and the Originator can examine the <request> resource's requestStatus attribute to check that the operation has completed and retrieve its results from the operationResult attribute. A variation of synchronous case is depicted in the following clauses. In this variation it is assumed that the addressed resource is not stored in the Registrar CSE, then the Registrar CSE needs to be a Transit CSE to forward the request to the Hosting CSE. Figure E.2.2-2 illustrates this case. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 274 oneM2M TS-0004 version 2.7.1 Release 2 2.If <request> resource type is supported, <request> resource shall be created, requestStatus is set to “PENDING”. Originator Transit CSE (Registrar CSE) 1.Request (rt:non-blockingRequestSynch) 3.Response ( rsc: Locally accepted, cn: reference to <request>) 11. Request ( op:RETRIEVE, to: reference to <request>) 12.Response (rsc:OK, cn: <request> resource) 5.If <request> resource type is supported, <request> resource shall be created, requestStatus is set to “ACCEPTED”. The addressed resource is stored here Hosting CSE 10. Requested results is available, UPDATE <request> resource, containing results in operationResult attribute, updating the values of requestStatus stateTag and lastModificationTime 4.Forwarding Request 7. Processing resources completes. UPDATE <request> resource, containing results in operationResult attribute, updating the values of requestStatus stateTag and lastModificationTime 8.Request ( op:RETRIEVE, to: reference to <request>) 9.Response (rsc: succesful,cn: <request> resource) 6. Response ( rsc: ACCEPTED, cn: reference to <request>) Figure E.2.2-2: Non-Blocking access to resource in synchronous mode (one hop) ETSI ETSI TS 118 104 V2.7.1 (2016-10) 275 oneM2M TS-0004 version 2.7.1 Release 2 1) The Originator sends a request to its Registrar CSE (this is aTransit CSE, not the Hosting CSE), setting the Response Type parameter of the request to 'nonblockingRequestSynch'.2. If the Transit CSE supports non- blocking synchronous interactions (this is indicated by its support for the <request> resource), it creates an instance of <request> resource. The requestStatus attribute of the <request> resource is set to "ACCEPTED". The Please refer to Table 7.4.12.1-3 for other attributes. 2) The Transit CSE sends a response to the Originator, the Response Status Code parameter of its response is set to acknowledgement, and a reference to the <request> resource is provided in the Content. 3) The Transit CSE forwards the original request to the Hosting CSE. 4) If the Hosting CSE supports non-blocking synchronous interactions (this is indicated by its support for the <request> resource), it creates an instance of <request> resource. The requestStatus attribute of the <request> resource is set to "ACCEPTED". Please refer to Table 7.3.2.2-1 and Table 7.3.2.2-2 for other attributes. 5) The Hosting CSE sends a response to the Transit CSE, the Response Status Code parameter of its response is set to"ACCEPTED" and a reference to the <request> resource is provided in the Content. 6) The Hosting CSE processes the resource according to the requested operation. When the requested operation has finished, the Hosting CSE will UPDATE the <request> resource, putting the results of the operation into the operationResult attribute, and updating the values of requestStatus to "COMPLETED", also the values of stateTag and lastModifiedTime. 7) The Transit CSE requests to RETRIEVE the original requested results by addressing the <request> resource 8) The Hosting CSE sends a response to the Transit CSE. The response contains the <request> resource as its Content. 9) The Transit CSE UPDATEs its <request> resource, copying the operationResult from the response that it received from the Hosting CSE. It also updates the values of requestStatus, stateTag and lastModifiedTime. 10) The Originator requests to RETRIEVE the original requested results by addressing the <request> resource. 11) The Transit CSE responds to Originator. The response contains the <request> resource as its Content, and the Originator can examine the <request> resource's requestStatus attribute to check that the operation has completed and retrieve its results from the operationResult attribute. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 276 oneM2M TS-0004 version 2.7.1 Release 2 Annex F (informative): Guidelines for oneM2M resource type XSD This annex contains rules to be followed when creating XML Schemas Definition (XSD files to represent the oneM2M resources). The XSD files themselves form part of the oneM2M protocol specification, but the rules used to construct them do not, hence this Annex is informative, although it contains normative language. The purpose of these rules is: • To keep a consistent style between the schemas for different resources • To keep the XSD simple • To allow individual resource schemas to be authored and maintained separately, while minimizing the risk of conflict when they are all used together 1) Each XSD file should include a schema element with following namespace declaration: <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.onem2m.org/xml/protocols" xmlns:m2m=http://www.onem2m.org/xml/protocols xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" elementFormDefault="unqualified" attributeFormDefault="unqualified" > This defines the prefix xs: for the XML Schema namespace, a target namespace http://www.onem2m.org/xml/protocols, and the prefix m2m: as equivalent for the target namespace. The xsi: namespace can be omitted if the resource has no nillable attributes (see below). Locally declared elements and attributes shall be unqualified (elementFormDefault and attributeFormDefault declarations are not strictly required since "unqualified" is the default value setting). 2) Each Resource XSD file will contain a Global Element Declaration whose name is the name of the Resource Type in accordance with ETSI TS 118 101 [6]. This means that the root element of a Resource (when represented as an XML instance) contains an m2m: (or equivalent) namespace prefix. If the Resource is announceable, the XSD file will contain a second Global Element Declaration that is used for the Announced variant of the resource. The name of that element will be formed by adding the suffix Annc to the name of the first Global Element. The XSD should not contribute anything to the m2m: namespace other than these root elements. 3) The root element of each resource shall have a required attribute called "resourceName" which gives an identifier for that particular resource instance. A URI to the resource instance can be constructed by taking the URI of its parent and appending /<name> where <name> is the value of the resourceName attribute. 4) Each resource attribute of the Resource Type in accordance with ETSI TS 118 101 Functional Architecture [6] is represented as a child element of the top level element. It shall be declared as an element that is local to the resource that contains it, and so does not have a namespace prefix in any XML instance representation of the resource. 5) Each child resource shall be represented as a child element of the top level element by referring to the global element definition of the child Resource (this allows the child Resource representation to be returned inline). The resource schemas will also include – as an alternative – an element called 'childResource' which is used to return a non-hierarchical URI for the associated child resource, if this has been requested. This element shall have two attributes (in XSD) : a) type; Data type ID of instances, b) name; the name of a child resource instance. 6) Each Resource attribute shall be declared to use one of the following data types: a. A data type listed in clause 6.3.2 or 6.3.3. b. A list of one of the data types listed in clause 6.3.2 or 6.3.3. If the list type is not already included in clause 6.3.3 it may be defined inside the XSD file for the resource, but if so it will be defined as an anonymous type in the attribute declaration itself. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 277 oneM2M TS-0004 version 2.7.1 Release 2 c. A data type derived by restriction from one of the types listed in clause 6.3.2 or 6.3.3. This may be added to clause 6.3.3, or defined inside the XSD file for the resource, but in the latter case it will be defined as an anonymous type in the attribute declaration itself. d. An anonymous complex type defined as part of the attribute declaration (inside the XSD file for the resource). The complex type should only be composed out of the types listed in clause 6.3.2 or 6.3.3. 7) If a data type is used by more than one attribute (either in the same resource or in two different resources) it will be included in 6.3.3, and referenced by each attribute that uses it. Options 6b, 6c, 6d should only be used in cases where the type is only used by one attribute. 8) All Resource types will extend one of the XML complex types described in clause 6.5 and included in the file CDT-commonTypes-v2_7_0.xsd. 9) The resource-specific attributes and child resources shall appear as a sequence of elements in the XSD file, with their order being determined by the order shown in the tables in clause 7.4. 10) Each XSD file shall include an XML comment that contains a oneM2M Copyright Notification Notice of Disclaimer & Limitation of Liability, and a change history. The change history is to be filled in only after the initial release. 11) To enable distinction between element names used for resource attributes and their data types in the m2m: namespace, it shall be avoided to use identical names. It is recommended to use the text suffix 'Type' in data type names. Example: <xs:element name="status" type="m2m:statusType /> 12) Each mgmtLink shall be represented as a child element 'mgmtLink' which is used to return a non-hierarchical URI for the associated management resource. This element has two attributes (in XSD): a) type; Data type ID of instances, b) name; the name of a child resource instance. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 278 oneM2M TS-0004 version 2.7.1 Release 2 Annex G (normative): Location request G.1 Introduction Location Request is a means by which a CSE requests the geographical or physical location information of a target Node to the location server located in the Underlying Network over Mcn reference point. This annex describes only the case of location request when the attribute locationSource of <locationPolicy> resource type is set to Network Based. Please see clause 7.4.10. The specific interface used for this request depends on the capabilities of the Underlying Network and other factors. This annex provides the interfaces for location request used for the communication between the CSE and the location server. G.2 Location request by means of OMA-REST-NetAPI- TerminalLocation interface G.2.1 Introduction This OMA REST Network API for Terminal Location specification v1.0 [28] is generally used to open up service capabilities, especially location capability, in the underlying network toward applications. This clause introduces the resources structure and procedures to handle the oneM2M-specified location request. In addition, since this OMA Network API uses only HTTP as underlying message protocol, some binding mapping are mentioned in the procedures in the clause G.2.3. G.2.2 Resource structure of OMA NetAPI for terminal location When a CSE needs to request the geographical or physical location information of a target CSE or AE hosted in a M2M Node toward a location server located in the Underlying Network over Mcn reference point. The CSE shall request Terminal Location Query following Procedures for Terminal Location (see clause G.2.3). The OMA REST NetAPI for Terminal Location allows CSE to obtain information about geographical location of a terminal (e.g. Node in ETSI TS 118 101 [6]). In order to obtain location information, CSE shall use one of two services of the Terminal Location API: • request the current Terminal Location in a single query toward a Location Server; • subscribe to notifications of periodic Terminal Location updates. Additionally, in order to track the terminal's movement in relation to the geographic area (circle), crossing in and out (more detail usage is defined in the annex E of ETSI TS 118 103) it is also proposed to use a service of the Terminal Location API: • subscribe to notification of area updates. Since oneM2M system utilizes the three services mentioned above, this clause introduces the capabilities that is related to the services from OMA REST NetAPI for Terminal Location [28]. A CSE and a Node shall act as an application and a terminal respectively as described in [28]. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 279 oneM2M TS-0004 version 2.7.1 Release 2 /queries //{serverRoot}/location/{apiVersion} /subscriptions /location /periodic /periodic /area/circle Figure G.2.2-1: Resource Structure defined by NetAPI for Terminal Location The two capabilities used for oneM2M system location request are 'Terminal location'. 'Periodic location notification subscriptions' and 'area notification subscriptions'. The table below describes the URL structure, data structure and mapping with CRUD operation of each resource. Table G.2.2-1: Applicable NetAPI for Terminal Location Capability URL Base URL: Resource Type Operations C R U D Terminal location /location TerminalLocation no return current location of the terminal no no Periodic location notification subscriptions /periodic PeriodicNotificationSubscr iption (used for CREATE) create new subscription return all subscriptio ns no No Area notification subscription /area/circle CircleNotificationSubscript ion (used for CREATE) create a new subscription return all subscriptio ns No no Based on Table G.2.2-1, three resource types, TerminalLocation, PeriodicNotificationSubscription and CircleNotificationSubscription shall be used for the location request specified in the oneM2M system. The resource types are described in the tables below. The table also contains the relevant attributes column that is correlated with either <locationPolicy> or <accessControlPolicy> resource type defined (ETSI TS 123 003 [17]). Only attributes that may be utilized by oneM2M system are described. For the detailed information, see the [28]. Table G.2.2-2: Resource Type Definition - TerminalLocation Attributes OMA NetAPI Defined Type Description Relevant Attribute defined by oneM2M Address xsd:anyURI Address of the terminal to which the location information applies locationTargetID in the <locationPolicy> resource type locationRetrievalStatus common:RetrievalStatus Status of retrieval for this terminal address. locationStatus in the <locationPolicy> resource type currentLocation LocationInfo Location of terminal. Content in the <contentInstance> resource type ETSI ETSI TS 118 104 V2.7.1 (2016-10) 280 oneM2M TS-0004 version 2.7.1 Release 2 Table G.2.2-3: Resource Type Definition - PeriodicNotificationSubscription Attributes OMA NetAPI Defined Type Description Relevant Attribute defined by oneM2M address xsd:anyURI Addresses of terminals to monitor locationTargetID in the <locationPolicy> resource type frequency xsd:int Maximum frequency (in seconds) of notifications (can also be considered minimum time between notifications) per subscription. locationUpdatePeriod in the <locationPolicy> resource type duration xsd:int Period of time (in seconds) notifications are provided for. If set to "0" (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications. locationUpdatePeriod in the <locationPolicy> resource type Table G.2.2-4: Resource Type Definition – CircleNotificationSubscription Attributes OMA NetAPI Defined Type Description Relevant Attribute defined by oneM2M Latitude xsd:float Latitude of center point. accessControlLocationRe gion in the <accessControlPolicy> resource type longitude xsd:float Longitude of center point. accessControlLocationRe gion in the <accessControlPolicy> resource type Radius xsd:float Radius of circle around center point in meters. accessControlLocationRe gion in the <accessControlPolicy> resource type checkImmediate xsd:boolean Check location immediately after establishing subscription. G.2.3 Procedures for terminal location G.2.3.1 Request in a single query toward a location server This procedure shows how to request and return location for a M2M Node. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 281 oneM2M TS-0004 version 2.7.1 Release 2 CSE Location Server OMA REST NetAPI for Terminal Location Interface 1. Request Single or Multiple Terminal Location 3. Response: Terminal Location 2. Retrieve terminal location Figure G.2.3.1-1: Single Query Toward Location Server 1) A Hosting CSE requests location for a single terminal (Node) by means of OMA REST NetAPI for terminal location API. This request message shall contain terminal address and Request URL with the address of Location Server using RETRIEVE operation. In this step, the TerminalLocation resource type described in Table G.2.2-1 shall be used with RETRIEVE operation. NOTE: GET operation shall be used for this RETRIEVE operation. 2) The Location Server shall retrieve the location information of the terminal. 3) After the successful retrieve, the Hosting CSE receives the location information. G.2.4 Subscribe to notifications for periodic location updates This procedure shows how to control subscriptions for periodic notifications about terminal location. CSE Location Server OMA REST NetAPI for Terminal Location Interface 1. Create new periodic notification subscription 2. Response the subscription Timer Expiration 3. Notify new location information 4. Response Location Configuration Changing 5. Update an individual subscription 6. Response Figure G.2.4-1: Subscribe to Notification for Periodic Location Updates 1) A Hosting CSE shall create a new periodic notification subscription for obtaining location information of a terminal periodically. In this step, the PeriodicNotificationSubscription resource type described in Table G.2.2-1 shall be used with CREATE operation. NOTE 1: POST operation shall be used for this CREATE operation. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 282 oneM2M TS-0004 version 2.7.1 Release 2 2) After the successful creation of subscription, the Hosting CSE shall receive the response. 3) When the set up timer is expires, the location server shall notify the application of current location information. In this step, the notification message shall be used as NOTIFY operation. NOTE 2: Alternatively, the Hosting CSE obtains the notifications using a Notification Channel [i.3]. This is repeated at specific frequency (periodic information) when the CSE is not reachable. NOTE 3: POST operation shall be used for this NOTIFY operation 4) After the successful receiver of notification, the Hosting CSE shall send a response to the location server. 5) Based upon the location configuration change by the Hosting CSE, it updates an individual subscription for periodic location notification. In this step, the PeriodicNotificationSubscription resource type described in Table G.2.2-1 shall be used with UPDATE operation. NOTE 4: PUT operation shall be used for this UPDATE operation. G.2.5 Subscribe to notifications for area updates This procedure shows how to subscribe to area update notification. CSE Location Server OMA REST NetAPI for Terminal Location Interface 1. Create new area notification subscription 2. Response the subscription Terminal Cross in the area 3. Notify new location information 4. Response Location Configuration Changing 5. Update a subscription 6. Response Figure G.2.5-1: Subscribe to Notification for Area Updates 1) A Hosting CSE shall create a new area notification subscription to track the terminal's movement in relation to the geographical area (circle), crossing in and out. In this step, the CircleNotificationSubscription resource type described in the table G.1-3 shall be used with CREATE operation. NOTE 1: POST operation shall be used for this CREATE operation. 2) After the successful creation of subscription, the Hosting CSE shall receive the response. 3) When the target terminal crosses in or out the specified area (circle), the location server shall notify the application of current location information. In this step, the notification message shall be used as NOTIFY operation. NOTE 2: Alternatively, the Hosting CSE obtains the notifications using a Notification Channel [i.3]. NOTE 3: POST operation shall be used for this NOTIFY operation 4) After the successful receiver of notification, the Hosting CSE shall send a response to the location server. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 283 oneM2M TS-0004 version 2.7.1 Release 2 5) Based upon the location configuration change by the Hosting CSE, it updates an individual subscription for area location notification. In this step, the CircleNotificationSubscription resource type described in the table-G.1-3 shall be used with UPDATE operation. NOTE 4: PUT operation shall be used for this UPDATE operation. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 284 oneM2M TS-0004 version 2.7.1 Release 2 Annex H (normative): CMDH message processing H.1 Pre-requisites The scope of CMDH processing is to decide at which time and via which communication path to forward request or response messages from a receiver CSE to another CSE. A number of message parameters impact the CMDH processing. CMDH-related request message parameters are: • Event Category ('ec') • Request Expiration Timestamp ('rqet') • Result Expiration Timestamp ('rset') • Operation Execution Time ('oet') • Result Persistence ('rp') • Originating Timestamp ('ot') • Delivery Aggregation ('da') CMDH-related response message parameters are: • Event Category ('ec') - 'ec' is needed for response messages as well since response messages can go over multiple hops and CMDH needs to know how to handle them. • Result Expiration Timestamp ('rset') • Delivery Aggregation ('da') - When a request message was carried inside a <delivery> resource type, also the corresponding response message shall be carried in a <delivery> resource, i.e. the CSE requested to carry out an operation indicated in a request message that reached that CSE via a <delivery> resource, shall also send the response within a <delivery> resource. The details on how those parameters impact the CMDH processing are described in the next clauses in clause H.2. This annex uses the short names as listed above to refer to request and response parameters. In the following description it is assumed that the CSE behaviour for CMDH processing is governed by CMDH policies that are represented by [cmdhPolicy] resources and their child resources which are effective for the respective CSE. If legacy device management technologies are used to provision these policies, the information represented by the effective [cmdhPolicy] resources and their child resources may not be available as oneM2M defined resources on the field nodes hosting the respective CSE. This CMDH related policy information may only be available in form of managed objects specific to the used device management technology. In that case the mapping from oneM2M specified [cmdhPolicy] resources and their child resources to equivalent objects of the deployed legacy device management technology shall be used to substitute the respective information contained in [cmdhPolicy] resources and their child resources in the description below. Therefore, whenever reference to [cmdhPolicy] resources, child resources thereof or any attributes of [cmdhPolicy] resources and their children are used in the description of CMDH processing below, they shall be read as a placeholder for the equivalent objects provided by legacy device management technologies on field nodes that are provisioned with such legacy device management technologies. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 285 oneM2M TS-0004 version 2.7.1 Release 2 For a CSE that is processing request or response messages in CMDH, exactly one set of policies represented by a [cmdhPolicy] resource shall be active, as defined by the [activeCmdhPolicy] child resource of the <node> resource that represents the node which hosts the respective CSE. In case of field nodes that are managed via legacy device management technologies, the active CMDH policy can be represented by management objects of that device management technology. For the sake of simplicity, the term 'active [cmdhPolicy]' is used in this and the following clauses to refer to the active CMDH policy information even if no oneM2M specified resources are used to represent CMDH policies. Before any provisioning of CMDH policies has occurred, the 'active [cmdhPolicy]' and its corresponding managed objects defined for legacy device management technologies shall contain the specified default values as described in the [cdmhPolicy] specific procedures and procedures specific for all its child resources. For that reason, it can be assumed that information for an 'active [cmdhPolicy]' is always present on a CMDH capable CSE. In addition, the active [cmdhPolicy] can have at least one or more [cmdhLimits] child resources and the active [cmdhPolicy] Hosting CSE shall lookup all [cmdhLimits] child resources. If the attribute requestContextNotification of any of found [cmdhLimits] resources is present and set to true, the CSE shall establish a subscription to the dynamic context information of the CSE defined in requestContext attribute of the found [cmdhLimits] as well as subscription to this [cmdhLimits] resource for all AEs corresponding to the AE-ID or an App-ID appearing in the requestOrigin attribute. The subscription(s) shall be established when the [cmdhPolicy] is provisioned or pre-provisioned and any of found [cmdhLimits] child resource has the attribute requestContextNotification that is set to true. Hence, both this policy establishment and changes of the context information and the [cmdhLimits] resource shall be notified to the respective AEs and the notification shall contain the limits for CMDH related parameter values defined in [cmdhLimits], context information and subscription reference ID. After this, the AEs which received the notification shall send only allowed 'ec' messages if 'ec' is specified by the AEs. H.2 CMDH processing: processing request or response messages requiring the receiver CSE to forward information to another CSE H.2.1 Applicability of CMDH processing If a request or response message that is targeting an entity or a resource in the 'to' parameter that is not among any of • the receiver CSE itself, • an AE registered with the receiver CSE, • a resource hosted on the receiver CSE, and if the message is not a response message with an acknowledgement response code, the receiver CSE of that message needs to forward the message to another CSE via CMDH processing, see also the description in Clause 7.2.2. Description of Generic Procedures of this TS. For forwarding a message to the target CSE indicated by the 'to' parameter of the message, the receiver CSE shall determine to which CSE the message needs to be forwarded next. In the following clauses this CSE is referred to as the 'next CSE'. CMDH processing shall be carried out as described in the following clauses. H.2.2 Partitioning of CMDH processing The CMDH processing consists of two parts: A. CMDH message validation: This includes message parameter pre-processing, deciding on acceptance for transporting the message, and buffering of messages. This procedure defines how incoming request or response messages that need to be forwarded to other CSE(s) shall be pre-processed, how a decision on acceptance of the message for forwarding to another CSE shall be derived and how the messages shall be queued up before the actual forwarding can happen. Details of CMDH validation are defined in clause H.2.3 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 286 oneM2M TS-0004 version 2.7.1 Release 2 B. CMDH message forwarding: This includes selecting buffered messages and communication path for forwarding the message to another CSE. This procedure defines how to select among the messages buffered for forwarding to other CSEs the ones that need to be transported at a certain time and how to select an appropriate communication path for transporting the message(s). Details of CMDH message forwarding are defined in clause H.2.4. CMDH message validation (Part A) will be carried out for each incoming new message for which CMDH processing is applicable. If CMDH message validation is successful, the received message shall be queued up for the CMDH message forwarding process (Part B) including the associated storagePriority attribute as defined in the applicable [cmdhBuffer] resource (see details in the CMDH message validation procedure). If the queued message was a request message and it was done in non-blocking mode then: • if the Receiver CSE supports the <request> resource type, it shall create a <request> resource representing the pending non-blocking request; • the Receiver CSE shall send an acknowledgement response message to the entity that sent the request message directly via Mca or Mcc to the receiver CSE indicating the acceptance of the request; • if the receiver CSE supports the <request> resource type it shall provide a reference to the created <request> resource in the 'cn' parameter of the response. After successful forwarding of such a request message, any incoming response message matching with the Request-ID and the Originator in the <request> resource shall be parsed to update the corresponding attributes of the <request> resource. In case a non-blocking synchronous request was forwarded successfully and a response with acknowledgement was received, it is the responsibility of the CSE that forwarded the message to periodically poll the status of the <request> resource created on the next CSE and update the locally created <request> resource accordingly. When the locally created <request> resource expires the Hosting CSE can remove it. Details on <request> resource specific procedures for polling results are defined in clause 7.3.1.4. If the queued message was a request message and it was done in blocking mode then memorize the open blocking request by storing its Request-ID and Originator and set a timer for a timeout until which a matching response message with the same Request-ID and Originator shall be received by the CSE processing this message. If no matching response is received when the timeout expires, the receiver CSE shall send a response message to the entity that sent the request to the Receiver CSE indicating unsuccessful processing of the request, unless the Receiver CSE and the Originator are the same. If Receiver CSE and Originator are the same, the Originator can decide internally whether to retry forwarding of the message. If CMDH message validation is not successful, then the received message shall either get ignored – in case the received message is a response message – or a new error response message shall be sent back to the entity that sent the message to the Receiver CSE – in case the received message is a request message and the Originator is not the Receiver CSE. If Receiver CSE and Originator are the same, the Originator can decide internally whether to create a new request message. The CMDH message forwarding process (Part B) will handle all queued up messages that shall be forwarded to another CSE. This process shall always be carried out when messages are pending for forwarding to another CSE. The flow of CMDH processing is depicted in Figure H.2.2-1. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 287 oneM2M TS-0004 version 2.7.1 Release 2 Figure H.2.2-1: CMDH Processing H.2.3 CMDH message validation procedure In CMDH message validation, pre-processing of CMDH related parameters of a message for which CMDH-processing applies, deriving the decision on acceptance of a message and the buffering of that messages shall be carried out in line with the following steps. A summary of this processing is depicted in the flow chart at the end of this clause. 1. Filling in missing CMDH-related parameters: 1.1. Determine the value that shall be used for the 'ec' parameter of the processed message 1.1.1. If the message contains an 'ec' parameter: Use the value of the 'ec' parameter provided in the message. 1.1.2. If the message does not contain an 'ec' parameter: 1.1.2.1. Lookup all [cmdhDefEcValue] child resources of the [cmdhDefaults] resource that is a child resource of the provisioned active [cmdhPolicy] resource. 1.1.2.2. If the message is a request message and any of the attributes requestContext, and requestCharacteristics are present in the found [cmdhDefEcValue] resources, discard all ETSI ETSI TS 118 104 V2.7.1 (2016-10) 288 oneM2M TS-0004 version 2.7.1 Release 2 [cmdhDefEcValue] resources from the list of found items for which the context conditions or the request characteristics at time of processing the request message are not met, respectively. 1.1.2.3. Among the remaining found [cmdhDefEcValue] resources do the following selection: 1.1.2.3.1. If present, select the [cmdhDefEcValue] resource containing the AE-ID in the list defined by the requestOrigin attribute which matches with the 'fr' parameter in case of a request message or with the 'to' parameter in case of a response message. If multiple [cmdhDefEcValue] resources match, select the one with the lowest value in the order attribute. Continue processing with step 1.1.2.4 1.1.2.3.2. If present, select the [cmdhDefEcValue] resource containing the App-ID in the list defined by the requestOrigin attribute which matches with the 'fr' parameter in case of a request message or with the 'to' parameter in case of a response message. If multiple [cmdhDefEcValue] resources match, select the one with the lowest value in the order attribute. Continue processing with step 1.1.2.4 1.1.2.3.3. If present, select the [cmdhDefEcValue] resource containing the string 'localAE' in the list defined by the requestOrigin attribute in case of processing a message where the 'fr' parameter is the AE-ID of an AE registered with the CSE processing this message. If multiple [cmdhDefEcValue] resources match, select the one with the lowest value in the order attribute. Continue processing with step 1.1.2.4 1.1.2.3.4. If present, select the [cmdhDefEcValue] resource containing the string 'thisCSE' in the list defined by the requestOrigin attribute in case of processing a message where the 'fr' parameter is the CSE-ID of the CSE processing this message. If multiple [cmdhDefEcValue] resources match, select the one with the lowest value in the order attribute. Continue processing with step 1.1.2.4 1.1.2.3.5. Select the [cmdhDefEcValue] resource containing the string 'default' in the list defined by the requestOrigin attribute in case of processing a message where no other matches were found. 1.1.2.4. If a [cmdhDefEcValue] resource has been selected in steps 1.1.2.3.1 through 1.1.2.3.4: Use the value of the defEcValue attribute of the selected [cmdhDefEcValue] resource as the value for the 'ec' parameter of the message. Else use the enumeration value of 'bestEffort' for the 'ec' parameter of the message. 1.2. Filling in values that shall be used for the remaining CMDH-related parameters of messages 1.2.1. If the message contains any of the CMDH-related parameters 'rqet', 'rset', 'oet', 'rp': The provided values of the respective parameters in the message shall be used. No filling in is needed for those parameters. If any of the parameters 'rqet', 'rset', 'oet', 'rp' present in the message is represented in relative time format (i.e. as a duration in units of milliseconds), the receiving CSE shall translate the values of those parameters into absolute time format by adding the duration to the originating timestamp in the 'ot' parameter of the message. This 'ot' parameter is an optional message parameter and in case it is not present in a message, it shall be filled in by the first receiving CSE of a message using the time when the message was received. 1.2.2. If the message parameter 'ec' has a value corresponding to 'bestEffort', use the following values for any missing CMDH-related parameters: For a request message use 'rqet' = -1('infinite'), 'rset' = -1 ('infinite'), 'oet' = 0 ('now'), 'rp' = 0 ('none'), 'da' = 'True'. For a response message use 'rset' = -1 ('infinite'), 'da' = 'True'. Continue with step 2. 1.2.3. If the message parameter 'ec' has a value corresponding to 'immediate', do not fill in any remaining missing CMDH-related parameters and continue with step 2. 1.2.4. For any of the missing CMDH-related parameters fill in values as follows: 1.2.4.1. Lookup all [cmdhEcDefParamValues] child resources of the [cmdhDefaults] resource that is a child resource of the provisioned active [cmdhPolicy] resource. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 289 oneM2M TS-0004 version 2.7.1 Release 2 1.2.4.2. Among the found [cmdhEcDefParamValues] resources do the following selection: 1.2.4.2.1. If present, select the [cmdhEcDefParamValues] resource containing the value of the 'ec' parameter of the message in the list defined by the applicableEventCategory attribute. If a match is found, continue processing with step 1.2.4.3 1.2.4.2.2. Select the [cmdhEcDefParamValues] resource that contains the string 'default' in the list defined by the applicableEventCategory attribute. 1.2.4.3. Use the following attributes of the selected [cmdhEcDefParamValues] resource to fill in any missing CMDH-related message parameters: Fill in the value of the attribute defaultRequestExpTime for the parameter 'rqet' if it is missing. Fill in the value of the attribute defaultResultExpTime for the parameter 'rset' if it is missing. Fill in the value of the attribute defaultOpExecTime for the parameter 'oet' if it is missing. Fill in the value of the attribute defaultRespPersistence for the parameter 'rp' if it is missing. Fill in the value of the attribute defaultDelAggregation for the parameter 'da' if it is missing. Convert the values of 'rqet', 'rset', 'oet' and 'rp' into absolute time representations if they were filled in during this step, by adding the respective durations to the 'ot' parameter value. In case where the time duration of the default parameter indicates 'infinity', the absolute time representation of the corresponding primitive parameter shall be set to the largest possible date "99993112T000000". 2. Compare CMDH parameters with allowed CMDH parameter limits: Check if CMDH-related parameters effective for the message are with allowed limits. 2.1. Lookup all [cmdhLimits] child resources of the provisioned active [cmdhPolicy] resource. 2.2. If the message is a request message and any of the attributes requestContext, and requestCharacteristics are present in the found [cmdhLimits] resources, discard all [cmdhLimits] resources from the list of found items for which the context conditions or the request characteristics at time of processing the request message are not met, respectively. 2.3. Among the remaining found [cmdhLimits] resources do the following selection: 2.3.1. If present, select the [cmdhLimits] resource(s) containing the AE-ID in the list defined by the requestOrigin attribute which matches with the 'fr' parameter in case of a request message or with the 'to' parameter in case of a response message. If multiple [cmdhLimits] resources match, select the one with the lowest value in the order attribute. Continue processing with step 2.4 2.3.2. If present, select the [cmdhLimits] resource(s) containing the App-ID in the list defined by the requestOrigin attribute which matches with the 'fr' parameter in case of a request message or with the 'to' parameter in case of a response message. If multiple [cmdhLimits] resources match, select the one with the lowest value in the order attribute. Continue processing with step 2.4 2.3.3. If present, select the [cmdhLimits] resource(s) containing the string 'localAE' in the list defined by the requestOrigin attribute in case of processing a message where the 'fr' parameter is the AE-ID of an AE registered with the CSE processing this message. If multiple [cmdhLimits] resources match, select the one with the lowest value in the order attribute. Continue processing with step 1.1.2.4 2.3.4. If present, select the [cmdhLimits] resource(s) containing the string 'thisCSE' in the list defined by the requestOrigin attribute in case of processing a message where the 'fr' parameter is the CSE-ID of the CSE processing this message. If multiple [cmdhLimits] resources match, select the one with the lowest value in the order attribute. Continue processing with step 2.4 2.3.5. Select the [cmdhLimits] resource containing the string 'default' in the list defined by the requestOrigin attribute in case of processing a message where no other matches were found. 2.4. Validate if 'ec' parameter is within allowed range: If the 'ec' parameter of the message is not within the list defined by the limitsEventCategory attribute of the selected [cmdhLimits] resource, mark CMDH message validation for this message as not successful and exit CMDH message validation. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 290 oneM2M TS-0004 version 2.7.1 Release 2 2.5. Validate if 'rqet' parameter is within allowed range: If the 'rqet' parameter is present in the message and if it is not within the range defined by the 'ot' parameter and limitsRequestExpTime attribute of the selected [cmdhLimits] resource, mark CMDH message validation for this message as not successful and exit CMDH message validation. 2.6. Validate if 'rset' parameter is within allowed range: If the 'rset' parameter is present in the message and if it is not within the range defined by the 'ot' parameter and limitsResultExpTime attribute of the selected [cmdhLimits] resource, mark CMDH message validation for this message as not successful and exit CMDH message validation. 2.7. Validate if 'oet' parameter is within allowed range: If the 'oet' parameter is present in the message and if it is not within the range defined by the 'ot' parameter and limitsOpExecTime attribute of the selected [cmdhLimits] resource, mark CMDH message validation for this message as not successful and exit CMDH message validation. 2.8. Validate if 'rp' parameter is within allowed range: If the 'rp' parameter is present in the message and if it is not within the range defined by the 'ot' parameter and limitsRespPersistence attribute of the selected [cmdhLimits] resource, mark CMDH message validation for this message as not successful and exit CMDH message validation. 2.9. Validate if 'da' parameter is within allowed range: If the 'da' parameter is present in the message and if it is not within the list of allowed values defined by the limitsDelAggregation attribute of the selected [cmdhLimits] resource, mark CMDH message validation for this message as not successful and exit CMDH message validation. 3. Check if message complies with network access rules and buffer limits: 3.1. Check if 'ec' parameter has enumeration value for 'immediate': If the 'ec' parameter of the message is 'immediate' bypass any checks on buffering or access network usage rules. Mark the CMDH message validation for this message as successful and end CMDH message validation. 3.2. Check if delivering the message is possible within the boundaries of access network usage rules in CMDH policies: 3.2.1. Lookup all [cmdhNetworkAccessRules] child resources of the provisioned active [cmdhPolicy] resource. 3.2.2. Among the all found [cmdhNetworkAccessRules] resources do the following selection: 3.2.2.1. If present, select the [cmdhNetworkAccessRules] resource containing the value of the 'ec' parameter of the message in the list defined by the applicableEventCategory attribute. If a match is found, continue processing with step 3.2.3 3.2.2.2. Select the [cmdhNetworkAccessRules] resource that contains the enumeration value for 'default' in the list defined by the applicableEventCategory attribute. 3.2.3. Lookup all [cmdhNwAccessRule] child resources of the selected [cmdhNetworkAccessRules] resource 3.2.4. Among all found [cmdhNwAccessRule] resources find at least one for which the <schedule> child resource 'allowedSchedule' is allowing usage of the corresponding target network consistent with the 'rqet' parameter in case of a request message being processed or in line with the 'rset' parameter in case of a response message being processed. If no matching [cmdhNwAccessRule] resource is found, mark CMDH validation for this message as not successful due to lack of scheduling opportunities and end CMDH message validation. Otherwise continue. 3.3. Check if delivering the message is possible within the boundaries of buffer usage rules in CMDH policies: 3.3.1. Lookup all [cmdhBuffer] child resources of the provisioned active [cmdhPolicy] resource. 3.3.2. Among the all found [cmdhBuffer] resources do the following selection: ETSI ETSI TS 118 104 V2.7.1 (2016-10) 291 oneM2M TS-0004 version 2.7.1 Release 2 3.3.2.1. If present, select the [cmdhBuffer] resource containing the value of the 'ec' parameter of the message in the list defined by the applicableEventCategory attribute. If a match is found, continue processing with step 3.3.3 3.3.2.2. Select the [cmdhBuffer] resource that contains the enumeration value for 'default' in the list defined by the applicableEventCategory attribute. 3.3.3. Check if the amount of memory needed to buffer the message being validated in addition to the already buffered messages matching with the same buffer usage policy in the selected [cmdhBuffer] resource would exhaust the limit defined by the maxBufferSize attribute of the selected [cmdhBuffer] resource or if the available memory for CMDH forwarding on the receiver CSE would get exhausted even when purging buffered messages with lower storage priority. 3.3.3.1. If the check is negative, mark the CMDH message validation for the message being validated as successful, assign the storage priority defined in the storagePriority attribute of the selected [cmdhBuffer] resource to the validated message, and end CMDH message validation 3.3.3.2. If the check is positive, mark the CMDH message validation for the message being validated as not successful and end CMDH message validation. Figure H.2.3-1: CMDH message validation procedure ETSI ETSI TS 118 104 V2.7.1 (2016-10) 292 oneM2M TS-0004 version 2.7.1 Release 2 H.2.4 CMDH message forwarding procedure The high-level sequence of processing steps for the CMDH message forwarding process is depicted in the flow chart below. Note that this flow chart only represents the reference flow for implementing a standard compliant behaviour. Other standard compliant implementations may be possible as long as the events defined below will result in the same normative message exchanges via reference points. Occurrence of the following events shall trigger processing in the CMDH message forwarding: • One or more new message(s) get(s) queued up for CMDH message forwarding. • Any of the underlying networks becomes usable for message forwarding due to transition(s) in allowed schedule(s) or due to establishing of availability of connectivity (e.g. cable plugged-in, coverage established). • Any of the underlying networks becomes unusable for message forwarding due to transition(s) in allowed schedule(s) or due to loss of availability of connectivity (e.g. cable unplugged, coverage lost). • Any message buffered for CMDH forwarding expires. Figure H.2.4-1: CMDH message forwarding procedure ETSI ETSI TS 118 104 V2.7.1 (2016-10) 293 oneM2M TS-0004 version 2.7.1 Release 2 When a new message is getting queued up for CMDH message forwarding, carry out the following: If the 'ec' parameter of the messages has the value 'immediate': Forward message as soon as possible to the next CSE. The processing in this situation is described by the flow chart in Figure H.2.4-2. 1.1. If a Mcc communication connection to the next CSE for forwarding the message is already established, continue with step 1.3. 1.2. If no Mcc communication connection to the next CSE for forwarding the message is established pick one underlying network among all underlying networks that can provide communication to the next CSE and establish a Mcc communication connection to the next CSE in line with the rules outlined in clause H.25. If establishment of a Mcc communication connection to the next CSE was not successful before the message expires, continue with step 1.4. 1.3. Determine whether delivery aggregation or forwarding of the message itself shall be used: 1.3.1. If the message contains a 'da' parameter set to the value 'True', the Receiver CSE shall forward this message by creation of a <delivery> resource on the next CSE as outlined in clause 7.4.11. The receiver CSE can combine the forwarded message in the same <delivery> resource with other messages for which the 'da' parameter set to 'True' and which need to be forwarded to the same target CSE. 1.3.2. If the message is not forwarded using a <delivery> resource, the receiver CSE shall forward the message as is to the next CSE via the established Mcc communication connection. 1.4. If the message could not be forwarded successfully to the next CSE before it expired (e.g. due to repeated unsuccessful attempts to establish a Mcc communication connection or due to the lack of usable underlying networks), the receiver CSE shall carry out the following: 1.4.1. If the message was a response message, ignore the message. End this cycle of CMDH message forwarding and wait for new triggering events. 1.4.2. If the message was a request message: 1.4.2.1. If the request was a blocking request: Send an error response to the pending blocking request with a matching Request-ID and Originator indicating the reason for failure and close the blocking request. End this cycle of CMDH message forwarding and wait for new triggering events. 1.4.2.2. If the request was a non-blocking request: Update the associated <request> resource with matching Request-ID and Originator using an error response code indicating the reason for failure. If the non-blocking request was made in asynchronous mode, send a notification with the error response to the notification target(s) of the request. End this cycle of CMDH message forwarding and wait for new triggering events. 1.5. Else, i.e. if the message was forwarded successfully to the next CSE: 1.5.1. If the message was a response and the Receiver CSE has an open blocking request context with a matching Request-ID and matching Originator, mark the open blocking request as closed, end this cycle of CMDH message forwarding and wait for new triggering events. 1.5.2. If the message was a request message: 1.5.2.1. If the request was a blocking request: Keep the context of the pending blocking request with matching Request-ID and matching Originator open and wait for an incoming response message with the same Request-ID and Originator. End this cycle of CMDH message forwarding and wait for new triggering events. 1.5.3. If the request was a non-blocking request: Wait for a response to the forwarded request (e.g. response with acknowledgement or error ETSI ETSI TS 118 104 V2.7.1 (2016-10) 294 oneM2M TS-0004 version 2.7.1 Release 2 response). Update the associated <request> resource with the matching Request-ID and Originator using a response code that reflects the status of the forwarded request (e.g. accepted by next CSE, unsuccessful). If the next CSE responded with an error response message and the request was in non-blocking asynchronous mode, send a notification request message to the Originator of the forwarded request containing the error response of the next CSE. End this cycle of CMDH message forwarding and wait for new triggering events. 2. Else, i.e. when the 'ec' parameter of the messages does not have the value corresponding to 'immediate': 2.1.1. Buffer the message to be forwarded in the CMDH forwarding buffer: The processing in this situation is described by the flow chart in Figure H.2.4.2. If the message is a request message and the 'ec' parameter of the messages has the value corresponding to 'latest': 2.1.1.1. If the request message is a notification triggered by a subscription: 2.1.1.1.1. Find any buffered request message that is a notification triggered by a subscription with the same subscription reference. 2.1.1.2. Else, i.e. if the request message is not a notification triggered by a subscription: 2.1.1.2.1. Find any buffered request message that has the same values in the ('fr', 'to', 'op' ) parameters as the message being processed 2.1.1.3. If any request message was found in steps 2.1.1.1.1 or 2.1.1.2.1, purge the found message from the CMDH forwarding buffer. 2.1.2. If there is not enough memory available to buffer the message being processed in the CMDH forwarding buffer: 2.1.2.1. Find any buffered messages with storage priority values lower than the one assigned to the message being processed. 2.1.2.2. If any messages are found: Purge enough messages among the found messages so that the message being processed can be buffered in the CMDH forwarding buffer. Messages which entered the buffer later shall be purged first. In case any request messages need to be purged, carry out the following: 2.1.2.2.1. In case of purging a non-blocking request messages: Update the associated <request> resource with the same Request-ID as the purged request message with a status indicating unsuccessful completion. If the purged message was made in asynchronous mode, send a response to the notification target(s) of the pending non-blocking request 2.1.2.2.2. In case of purging a blocking request message: Send an error response to the open blocking request with the same Request-ID as in the purged request message and close the blocking request. 2.1.2.3. Due to the checking of sufficient memory in CMDH message forwarding buffer during CMDH message validation, there should be enough memory available to accommodate the message to be buffered at this point. If that is still not the case, then do the following: 2.1.2.3.1. In case the message to be buffered is a response message: Ignore the message to be buffered. End this cycle of CMDH message forwarding and wait for new triggering events. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 295 oneM2M TS-0004 version 2.7.1 Release 2 2.1.2.3.2. In case the message to be buffered is a non-blocking request message: Update the associated <request> resource with the same Request-ID as the request message to be buffered with a status indicating unsuccessful completion. If the request message to be buffered was made in asynchronous mode, send a response to the notification target(s) of the pending non-blocking request. End this cycle of CMDH message forwarding and wait for new triggering events. 2.1.2.3.3. In case the message to be buffered is a blocking request message: Respond with an error response message to the open blocking request with the same Request-ID as in the request message to be buffered and close the blocking request. End this cycle of CMDH message forwarding and wait for new triggering events. 2.1.3. Store the message to be buffered with its assigned storage priority in the CMDH forwarding buffer. Include it in future evaluations for possible message forwarding. 2.2. Evaluate if any message forwarding is currently allowed: 2.2.1. For all buffered messages that are pending in CMDH message forwarding carry out the following evaluation steps: 2.2.1.1. Among all [cmdhNetworkAccessRules] child resources of the provisioned active [cmdhPolicy] resource do the following selection: 2.2.1.1.1. If present, select the [cmdhNetworkAccessRules] resource containing a value in the list defined by the applicableEventCategory attribute that is equal to the value of the 'ec' parameter of the buffered message to be evaluated for forwarding. If a match is found, continue processing with step 2.2.1.2. 2.2.1.1.2. Select the [cmdhNetworkAccessRules] resource that contains the string 'default' in the list defined by the applicableEventCategory attribute. 2.2.1.2. Lookup all [cmdhNwAccessRule] child resources of the selected [cmdhNetworkAccessRules] resource 2.2.1.3. If the attribute otherConditions is present in any of the found [cmdhNwAccessRule] resources, discard all [cmdhNwAccessRule] resources from the list of found items for which the conditions expressed by otherConditions at time of evaluation of the message for forwarding are not met, respectively. 2.2.1.4. Among the all remaining found [cmdhNwAccessRule] resources find those for which - the <schedule> child resource allowedSchedule is currently allowing usage of the corresponding target network, and - for which the corresponding target network could be used to reach the next CSE for forwarding the message under evaluation. If any allowed target network was found, memorize the message under evaluation as an allowed message and the allowed target network(s) for the message under evaluation and continue with the next evaluation of buffered messages 2.2.2. When all buffered messages have been evaluated, remove from the memorized list of allowed messages and their allowed target networks those target networks where the amount of data to be forwarded – accumulated over all allowed messages of the same event category – is less than the amount of data indicated in the minReqVolume attribute of the corresponding [cmdhNwAccessRule] resource. 2.2.3. Remove any messages from the list of allowed messages for forwarding if no allowed target network is left for that message after the previous step. 2.3. Process messages allowed for forwarding to the next CSE: If any messages can be forwarded, i.e. if any evaluation of step 2.2 was positive, apply the following steps: ETSI ETSI TS 118 104 V2.7.1 (2016-10) 296 oneM2M TS-0004 version 2.7.1 Release 2 2.3.1. Reuse already established Mcc communication connections or – if needed – establish new Mcc communication connection(s) so that all the messages that are allowed to be forwarded to their next CSE can be forwarded. Some messages may be allowed on the same target network. Follow the procedure outlined in clause H.2.5for setting up a Mcc communication connection to another CSE via a particular target network. If no usable Mcc communication connection could be established for forwarding a particular allowed message before the message expires, execute step 1.4 in this clause H.2.4 for that message. 2.3.2. For all messages allowed for forwarding and for which Mcc communication connections are established, apply steps 1.3 through 1.5 in this clause H.2.4. 2.4. Else, i.e. currently no message forwarding is allowed: End this cycle of CMDH message forwarding and wait for new triggering events. When any of the underlying networks becomes usable for message forwarding due to transition(s) in allowed schedule(s) or due to establishing of availability of connectivity (e.g. cable plugged-in, coverage established), carry out the processing above in this clause starting with step 2.2. When any of the underlying networks becomes unusable for message forwarding due to transition(s) in allowed schedule(s) or due to loss of availability of connectivity (e.g. cable unplugged, coverage lost), complete – if at all possible – any ongoing message forwarding procedures. End this cycle of CMDH message forwarding and wait for new triggering events. When any message buffered for CMDH forwarding expires, carry out step 1.4 in this clause above. End this cycle of CMDH message forwarding and wait for new triggering events. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 297 oneM2M TS-0004 version 2.7.1 Release 2 Figure H.2.4-2: Forwarding of messages with 'ec' = 'immediate' ETSI ETSI TS 118 104 V2.7.1 (2016-10) 298 oneM2M TS-0004 version 2.7.1 Release 2 Figure H.2.4-3: Buffering of messages for CMDH message forwarding H.2.5 Establishment of Mcc communication connection to another CSE When a Mcc communication connection shall be established via a specific target network for forwarding a message of a specific event category indicated by the 'ec' parameter of the message, the process of establishing the Mcc communication connection shall be governed by values contained in the backOffParameters attribute of the [cmdhNwAccessRule] resource that was used to evaluate whether the message was allowed to be forwarded, as defined in step 2.2 in the procedure outlined in clause H.2.4 When connectivity via the selected target network to reach the next CSE has not already been established for other reasons, then the CSE that is trying to forward a message buffered for CMDH message forwarding shall establish a new Mcc communication connection via the selected target network for transporting oneM2M messages to the next CSE via a new Mcc instance. This communication connection shall be established following the procedures for authentication and security association using TLS or DTLS as defined in the ETSI TS 118 103 [7] taking into account provisioned security settings. The protocol mapping for transporting oneM2M specified messages via this instance of Mcc shall be selected according to the capabilities of the two end-points of the Mcc instance. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 299 oneM2M TS-0004 version 2.7.1 Release 2 If establishing the Mcc communication connection via the selected target network fails, a new attempt to establish that communication connection shall only be made after waiting for a back-off time according to the value given in the 'back-off time' component of the backOffParameters attribute of the effective [cmdhNwAccessRule] resource. When establishing the Mcc communication connection via the selected target network still fails, for each subsequent new attempt to establish the Mcc communication connection without any successful attempts in-between, the back-off time shall be increased by the value given in the 'back-off time increment' component of the backOffParameters attribute of the effective [cmdhNwAccessRule] resource. The back-off time for waiting before making any new attempt to establish the Mcc communication connection via the selected target network shall not exceed the value given by the 'maximum back-off time' component of the backOffParameters attribute of the effective [cmdhNwAccessRule] resource. When the next CSE is hosted on a node for which a usable Mcc communication connection for forwarding a message to the next CSE can only be established by the next CSE itself, device triggering mechanisms as defined in the ETSI TS 118 101 [6] shall be used. In case the next CSE can only be reached via communication connections originating from the node that hosts the next CSE, while it is capable of processing incoming oneM2M messages, it is assumed that such a CSE establishes a polling channel as defined in the ETSI TS 118 101 [6] in order to effectively receive unsolicited oneM2M messages. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 300 oneM2M TS-0004 version 2.7.1 Release 2 Annex I (informative): Guidelines for using XSD files in AE and CSE code I.1 Usage of the oneM2M developed XSD files The primary purpose of the XSD files developed by oneM2M is described in clause 6.1. This informative Annex provides an example of potential usage of the XSD in practical implementations of oneM2M entities (AE and CSE). As has been specified in clause 8, to enable efficient communication, the short names introduced in clause 8.2 shall be applied in XML and JSON serializations of request and response primitives to identify primitive parameters, and to identify resource names, resource attribute names and their complex data type members when included in the Content primitive parameter. This implies that short names are applied in any communication over the Mca, Mcc and Mcc' reference points. Nevertheless, the XSD files included in the present release employ the long names for primitive parameters and any other XML elements and attributes. This annex provides a possible use case of the oneM2M developed XSD files for information. I.2 Example AE/CSE implementation featuring mapping between short and long names for XML serialization Figure I.2-1 shows an example where the oneM2M defined XSD files are used as input to a code generator. Such code generators are available for most object-oriented programming languages such as e.g. Java, C++ and Python. The following descriptions include some code examples given in Python syntax. However, corresponding expressions in C++ or Java look very similar. Code generators generate a library of XSD binding classes corresponding to each of the data types defined in the input XSD files. This library can then be imported into the source code of the respective programming language which implements an AE or CSE. For example, if this library is denoted schemaLib, instances of a request primitive and of a resource type <contentInstance>, denoted in the Python source code fragment below as reqPrimInstance (internal representation of m2m:requestPrimitive) and contentInstance1 (as internal representation of m2m:contentInstance), respectively, can simply be generated as follows: import schemaLib … reqPrimInstance = schemaLib.requestPrimitive() contentInstance1 = schemaLib.contentInstance() Each of the instances created in this way represents a data object reflecting the same tree structure as defined in the XSD files that served as input to the code generator. Any request primitive parameter in reqPrimInstance as defined above can be addressed and assigned values as follows: reqPrimInstance.operation = operation #e.g. operation = 1 for CREATE reqPrimInstance.to = path #path = address of target resource reqPrimInstance.from_ = originator #originator=identifier representing the originator reqPrimInstance.requestIdentifier = str(requestIDCounter) #counter in string format reqPrimInstance.resourceType = resourceType #e.g. resourceType = 4 for <contentInstance> Parameters defined as complex type in the XSD such as e.g. the Filter Criteria primitive parameter can be assigned values as follows: reqPrimInstance.filterCriteria.createdBefore = '20161201T000000' reqPrimInstance.filterCriteria.createdAfter = '20150501T123000' reqPrimInstance.filterCriteria.labels = 'label1 label2 label3' reqPrimInstance.filterCriteria.attribute.append(pyxb.BIND()) reqPrimInstance.filterCriteria.attribute[0] = schemaLib.attribute("name0","value0") ETSI ETSI TS 118 104 V2.7.1 (2016-10) 301 oneM2M TS-0004 version 2.7.1 Release 2 Note that the class attribute names in the source code are identical with the XML element or attribute names as used in the XSD files (sometimes minor exceptions can occur, for instance in case that a name used in the XSD represents a reserved name in the source code. In such case the code generator typically would append a special suffix to the name, e.g. "_"). Since the XSD uses the long parameter and resource attribute names, these also appear as class attributes in the source code. From an implementation perspective, this is preferable compared to using short names. Using short names in the XSD would result in short names in the source code. However, these short names have essentially lost their semantics and are therefore more difficult do memorize. Any misspelling in the code may easily result in another well-defined short name such that identifying errors in the source code becomes more difficult. A code generator as considered here, typically also provides a set of class methods and utility functions which allow to generate code objects from a given XML representation, and inversely, to generate XML representations from a code object. For example, consider that a string variable, denote reqPrimXML represents a serialized request primitive as follows (note that this representation corresponds to the example given in clause 8.3.2 but with long names used here): reqPrimXML = '<?xml version="1.0" encoding="UTF-8"?> <m2m:requestPrimitive xmlns:m2m="http://www.onem2m.org/xml/protocols" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.onem2m.org/xml/protocols CDT-requestPrimitive-v2_7_0.xsd"> <operation>1</operation> <to>//cse1.mym2msp.org/</to> <from>//cse1234/app567</from> <requestIdentifier>0002bf63</requestIdentifier > <resourceType>4</resourceType> <primitiveContent> <contentInstance resourceName="temp754"> <contentInfo>application/xml:1</contentInfo> <content>PHRpbWU+MTc4ODkzMDk8L3RpbWU+PHRlbXA+MjA8L3RlbXA+DQo=</content> </contentInstance> </ primitiveContent> </m2m:requestPrimitive>' Assuming that the auto-generated library schemaLib includes a utility function createFromDocument(), the following code statement creates an instance reqPrimInstance from the XML serialized request primitive in the string variable reqPrimXML: reqPrimInstance = schemaLib.createFromDocument(reqPrimXML) The root element of the XML string (i.e. m2m:requestPrimitive in this example) identifies the template (class) that need to be used to create the data object reqPrimInstance. All value settings of the parameters are taken from the XML string, e.g. reqPrimInstance.operation is set to 1. The reverse operation, i.e. generation of an XML string from the data object reqPrimInstance is typically possible with a class method toxml() as follows: reqPrimXML = reqPrimInstance.toxml() If any value settings of reqPrimInstance have not been changed in the given code, the above statement generates the same XML string as given above. Both operations, createFromDocument() and toxml(), also allow to verify the compliance of the XML representations with the XSD that was used as input when generating the schemaLib source code. The question arises, if there is a way to generate XML or JSON representations that include the short names as defined in clause 8.2 when employing XSD with the long names as described above. The following outlines two possible ways to resolve this issue. The first straightforward approach is to use a text parser which replaces the long names used in XML or JSON strings with their corresponding short names, or vice-versa. It is denoted such functions as map_L2S() and map_S2L(). This approach is illustrated in the box labelled "AE or CSE source code" in Figure I.2-1 for an XML serialized string. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 302 oneM2M TS-0004 version 2.7.1 Release 2 Given a string reqPrimXML representing an XML serialized request primitive with long names as described above, the statement reqPrimXML_sh = map_L2S(reqPrimXML) would produce an XML string that includes the short names as shown in the representation already given in clause 8.3.2. The reverse operation, generating an XML representation with long names from a representation with short names could be done with reqPrimXML = map_S2L(reqPrimXML_sh) Both mapping functions require a mapping table which includes all long names and their associated short names. The required mapping table can be derived from Tables 8.2.2-1, 8.2.2-2, 8.2.3-1 to 8.2.3-5, 8.2.4-1 and 8.2.5-1. In order to work in both mapping directions, the mapping table represents a one-to-one relationship between short and long names. The second approach is essentially a code-optimized variant of the above first approach. The source code of the described createFromDocument() and toxml() functions could be extended by the programmer by including the functionality of map_S2L() directly into createFromDocument() and including the functionality of map_L2S() directly into toxml(). An additional function argument could be included which allows to enable and disable the mapping function. Figure I.2-1: Example AE or CSE implementation: processing based on long names, XML representations using short names I.3 Example AE/CSE implementation featuring mapping between short and long names for JSON serialization Figure I.3-1 shows an example implementation which employs JSON serialization. The core of this example implementation is identical with the one described above for XML serialization. In the example it is assumed that for producing a JSON representation which is valid against its associated XSD, an XML file is generated first by means of the toxml() function described in clause I.2 above. In this case the mapping from long to short names can be accomplished also with the map_L2S() function used in the XML serialization example. This XML file can then be converted into a structured data representation that allows direct conversion into JSON. When using Python programming language, the most suitable representation is the dictionary format. In Figure I.3-1, the function denoted as xml2dict(), generates a Python dictionary object which in the final operation step is serialized into the XSD-valid JSON representation by means of the json.dumps() function. In order to comply with the requirements for the JSON representation as defined in clause 8.4, it is necessary to adjust the data type of numeric and list-type elements. Set of XSD files Code Generator AE or CSE source code library of XSD binding classes and functions map_S2L() map_L2S() createFromDocument() t toxml() processing objects with long names messages including serialized XML with short names messages including serialized XML with short names ETSI ETSI TS 118 104 V2.7.1 (2016-10) 303 oneM2M TS-0004 version 2.7.1 Release 2 At the receiving side of the described implementation example, received JSON data is converted into a Python dictionary object by means of the json.loads() function. This dictionary object is unparsed by means of a function denoted dict.unparse() in Figure I.3-1 which generates directly an instance of the class applicable to the received data which is defined in SchemaLib. During the unparse operation, the mapping is accomplished between the short names included in the received JSON data object and the long names employed in the class definition included in SchemaLib. The unparse operation also implements validation of the compliance of the received JSON data with the XSD. Figure I.3-1: Example AE or CSE implementation with processing based on long names Code Generator AE or CSE source code json.loads() map_L2S() dict.unparse() toxml() processing objects with long names xml2dict() json.dumps() JSON with short names Set of XSD files library of XSD binding classes and functions JSON with short names ETSI ETSI TS 118 104 V2.7.1 (2016-10) 304 oneM2M TS-0004 version 2.7.1 Release 2 Annex J (normative): Specializations of <flexContainer> resource J.1 Introduction This annex defines each specialization of <flexContainer> resource that are used for generic interworking [35] and AllJoyn interworking [36]. The <flexContainer> resource and procedures are defined in the clause 7.4.37. Since the specialization resources handling procedures are the same as <flexContainer> resource, this annex does not specify them. Also, since all the specialization inherits the universal/common attributes of <flexContainer> resource, this annex does not specify that information. J.2 Resource type [genericInterworkingService] This resource type is used for grouping Input and/or Output Datapoints and/or OperationInstances of a Service in the context of Ontology based Interworking. The detailed description of the [genericInterworkingService] resource can be found in clause 9.2 of ETSI TS 118 112 [35]. Table J.2-1: Data type definition of [genericInterworkingService] resource Data Type ID File Name Note genericInterworkingService CDT-genericInterworkingService-v2_7_0.xsd XSD schema for genericInterworkingService resource Table J.2-2: Resource Specific Attributes of [genericInterworkingService] resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update containerDefinition M NP xs:anyURI No default ontologyRef O O xs:anyURI No default serviceName M NP xs:string No default. inputDataPointLinks O O m2m:listOfDataLinks No default outputDataPointLinks O O m2m:listOfDataLinks No default J.3 Resource type [genericInterworkingOperationInstance] This resource type and is used for grouping (persistent) Input and/or Output Datapoints and/or (transient) OperationInput / Output of an Operation in the context of Ontology based Interworking. Resources of resource type genericInterworkingOperationInstance are created as child-resources of a genericInterworkingService. The detailed description of the [genericInterworkingService] resource can be found in clause 9.2 of ETSI TS 118 112 [35]. Table J.3-1: Data type definition of [genericInterworkingOperationInstance] resource Data Type ID File Name Note genericInterworkingOperationInstance CDT- genericInterworkingOperationInstance- v2_7_0.xsd XSD schema for genericInterworkingOperationInstance resource ETSI ETSI TS 118 104 V2.7.1 (2016-10) 305 oneM2M TS-0004 version 2.7.1 Release 2 Table J.3-2: Resource Specific Attributes of [genericInterworkingOperationInstance] resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update containerDefinition M NP xs:anyURI No default ontologyRef O O xs:anyURI No default operationName M NP xs:string No default inputDataPointLinks O O m2m:listOfDataLinks No default outputDataPointLinks O O m2m:listOfDataLinks No default inputLinks O O m2m:listOfDataLinks No default outputLinks O O m2m:listOfDataLinks No default operationState M O xs:string No default J.4 Resource type [svcObjWrapper] This specialization of <flexContainer> is intended to be used to wrap a group of child resources related to AllJoyn service objects with minimal overhead. No custom attributes are needed for this specialization. Table J.4-1: Data type definition of [svcObjWrapper] resource Data Type ID File Name Note svcObjWrapper CDT-svcObjWrapper-v2_7_0.xsd XSD schema for [svcObjWrapper] resource Table J.4-2: Resource Specific Attributes of [svcObjWrapper] resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update containerDefinition M NP xs:anyURI No default ontologyRef O O xs:anyURI No default Table J.4-3: Child Resources of [svcObjWrapper] resource Child Resource Type Child Resource Name Multiplicity <subscription> [variable] 0..n <semanticDescriptor> [variable] 0..n [allJoynApp] [variable] 0..n J.5 Resource type [svcFwWrapper] This specialization of <flexContainer> is intended to be used to wrap a group of child resources related to AllJoyn framework services with minimal overhead. No custom attributes are needed for this specialization. Table J.5-1: Data type definition of [svcFwWrapper] resource Data Type ID File Name Note svcObjWrapper CDT-svcFwWrapper-v2_7_0.xsd XSD schema for [svcObjWrapper] resource ETSI ETSI TS 118 104 V2.7.1 (2016-10) 306 oneM2M TS-0004 version 2.7.1 Release 2 Table J.5-2: Resource Specific Attributes of [svcFwWrapper] resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update containerDefinition M NP xs:anyURI No default ontologyRef O O xs:anyURI No default Table J.5-3: Child Resources of [svcFwWrapper] resource Child Resource Type Child Resource Name Multiplicity <subscription> [variable] 0..n <semanticDescriptor> [variable] 0..n J.6 Resource type [allJoynApp] This specialization of <flexContainer> is used to represent a specific instance of an AllJoyn application. This resource shall include the direction custom attribute. Table J.6-1: Data type definition of [allJoynApp] resource Data Type ID File Name Note allJoynApp CDT-allJoynApp-v2_7_0.xsd XSD schema for [allJoynApp] resource Table J.6-2: Resource Specific Attributes of [allJoynApp] resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update containerDefinition M NP xs:anyURI No default ontologyRef O O xs:anyURI No default direction M NP m2m:allJoynDirection No default Table J.6-3: Child Resources of [allJoynApp] resource Child Resource Type Child Resource Name Multiplicity <subscription> [variable] 0..n <semanticDescriptor> [variable] 0..n [allJoynSvcObject] [variable] 0..n J.7 Resource type [allJoynSvcObject] This specialization of <flexContainer> is used to represent a specific instance of an AllJoyn application. This resource shall include the objectPath and enable custom attributes. Table J.7-1: Data type definition of [allJoynSvcObject] resource Data Type ID File Name Note allJoynSvcObject CDT-allJoynSvcObject-v2_7_0.xsd XSD schema for [allJoynSvcObject] resource ETSI ETSI TS 118 104 V2.7.1 (2016-10) 307 oneM2M TS-0004 version 2.7.1 Release 2 Table J.7-2: Resource Specific Attributes of [allJoynSvcObject] resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update containerDefinition M NP xs:anyURI No default ontologyRef O O xs:anyURI No default objectPath M NP xs:string No default. enable M O xs:boolean False Table J.7-3: Child Resources of [allJoynSvcObject] resource Child Resource Type Child Resource Name Multiplicity <subscription> [variable] 0..n <semanticDescriptor> [variable] 0..n [allJoynInterface] [variable] 0..n J.8 Resource type [allJoynInterface] This specialization of <flexContainer> is used to represent a specific implementation of an AllJoyn interface residing in an AllJoyn service object. This resource shall include the interfaceIntrospectXmlRef custom attribute. Table J.8-1: Data type definition of [allJoynInterface] resource Data Type ID File Name Note allJoynInterface CDT-allJoynInterface-v2_7_0.xsd XSD schema for [allJoynInterface] resource Table J.8-2: Resource Specific Attributes of [allJoynInterface] resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update containerDefinition M NP xs:anyURI No default ontologyRef O O xs:anyURI No default interfaceIntrospectXml Ref M NP xs:anyURI No default. Table J.8-3: Child Resources of [allJoynInterface] resource Child Resource Type Child Resource Name Multiplicity <subscription> [variable] 0..n <semanticDescriptor> [variable] 0..n [allJoynInterface] [variable] 0..n <subscription> [variable] 0..n <semanticDescriptor> [variable] 0..n J.9 Resource type [allJoynMethod] This specialization of <flexContainer> is used to represent a specific method of an AllJoyn interface residing in an AllJoyn service object. No custom attributes are needed for this specialization. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 308 oneM2M TS-0004 version 2.7.1 Release 2 Table J.9-1: Data type definition of [allJoynMethod] resource Data Type ID File Name Note allJoynMethod CDT-allJoynMethod-v2_7_0.xsd XSD schema for [allJoynMethod] resource Table J.9-2: Resource Specific Attributes of [allJoynMethod] resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update containerDefinition M NP xs:anyURI No default ontologyRef O O xs:anyURI No default Table J.9-3: Child Resources of [allJoynMethod] resource Child Resource Type Child Resource Name Multiplicity <subscription> [variable] 0..n <semanticDescriptor> [variable] 0..n [allJoynMethodCall] [variable] 0..n J.10 Resource type [allJoynMethodCall] This specialization of <flexContainer> is used to represent a specific calling instance of a method of an AllJoyn interface residing in an AllJoyn service object. This resource shall include the input, output and callStatus custom attributes. Table J.10-1: Data type definition of [allJoynMethodCall] resource Data Type ID File Name Note allJoynMethodCall CDT-allJoynMethodCall-v2_7_0.xsd XSD schema for [allJoynMethodCall] resource Table J.10-2: Resource Specific Attributes of [allJoynMethodCall] resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update containerDefinition M NP xs:anyURI No default ontologyRef O O xs:anyURI No default input O NP xs:string No default. callStatus O O xs:string No default output O O xs:string No default Table J.10-3: Child Resources of [allJoynMethodCall] resource Child Resource Type Child Resource Name Multiplicity <subscription> [variable] 0..n <semanticDescriptor> [variable] 0..n ETSI ETSI TS 118 104 V2.7.1 (2016-10) 309 oneM2M TS-0004 version 2.7.1 Release 2 J.11 Resource type [allJoynProperty] This specialization of <flexContainer> is used to represent a specific property of an AllJoyn interface residing in an AllJoyn service object. This resource shall include the currentValue and requestedValue custom attributes. Table J.11-1: Data type definition of [allJoynProperty] resource Data Type ID File Name Note allJoynProperty CDT-allJoynProperty-v2_7_0.xsd XSD schema for [allJoynProperty] resource Table J.11-2: Resource Specific Attributes of [allJoynProperty] resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update containerDefinition M NP xs:anyURI No default ontologyRef O O xs:anyURI No default currentValue M O xs:string No default. requestedValue O O xs:string No default Table J.11-3: Child Resources of [allJoynProperty] resource Child Resource Type Child Resource Name Multiplicity <subscription> [variable] 0..n <semanticDescriptor> [variable] 0..n ETSI ETSI TS 118 104 V2.7.1 (2016-10) 310 oneM2M TS-0004 version 2.7.1 Release 2 List of figures Figure 5.4.1-1: Communication model using Request and Response primitives over an IP-based Underlying Network26 Figure 5.4.2-1: Primitives modelling .................................................................................................................................26 Figure 6.3.4.1-1: Example of XSD version of oneM2M Enumeration Type ....................................................................39 Figure 6.5.1-1: Resource Types ........................................................................................................................................75 Figure 7.2.2.1-1: Generic procedure of Originator ............................................................................................................85 Figure 7.2.2.2-1: Generic procedure of Receiver ..............................................................................................................87 Figure 7.2.2.2-2: Resource handling procedure ................................................................................................................89 Figure 7.6.2-1: Procedure for applying End-to-End Security of Primitives (ESPrim) to protect an exchange of inner primitives .................................................................................................................................................................215 Figure E.1-1: Blocking access to resource ......................................................................................................................270 Figure E.2.2.-1: Non-Blocking access to resource in synchronous mode (no hop) .........................................................272 Figure E.2.2-2: Non-Blocking access to resource in synchronous mode (one hop) ........................................................274 Figure G.2.2-1: Resource Structure defined by NetAPI for Terminal Location .............................................................279 Figure G.2.3.1-1: Single Query Toward Location Server ...............................................................................................281 Figure G.2.4-1: Subscribe to Notification for Periodic Location Updates ......................................................................281 Figure G.2.5-1: Subscribe to Notification for Area Updates ...........................................................................................282 Figure H.2.2-1: CMDH Processing .................................................................................................................................287 Figure H.2.3-1: CMDH message validation procedure ...................................................................................................291 Figure H.2.4-1: CMDH message forwarding procedure .................................................................................................292 Figure H.2.4-2: Forwarding of messages with 'ec' = 'immediate' ....................................................................................297 Figure H.2.4-3: Buffering of messages for CMDH message forwarding ........................................................................298 Figure I.2-1: Example AE or CSE implementation: processing based on long names, XML representations using short names.......................................................................................................................................................................302 Figure I.3-1: Example AE or CSE implementation with processing based on long names.............................................303 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 311 oneM2M TS-0004 version 2.7.1 Release 2 List of tables Table 6.2.2-1: M2M Identifiers .........................................................................................................................................30 Table 6.3.2-1: Data Types incorporated from XML Schema ............................................................................................32 Table 6.3.3-1: oneM2M Simple Data Types .....................................................................................................................34 Table 6.3.4.1-1: Example of oneM2M Enumeration Type Definition ..............................................................................39 Table 6.3.4.2.1-1: Interpretation of resourceType .............................................................................................................40 Table 6.3.4.2.2-1: Interpretation of cseTypeID .................................................................................................................41 Table 6.3.4.2.3-1: Interpretation of locationSource ...........................................................................................................41 Table 6.3.4.2.4-1: Interpretation of stdEventCats .............................................................................................................41 Table 6.3.4.2.5-1: Interpretation of operation ...................................................................................................................41 Table 6.3.4.2.6-1: Interpretation of responseType ............................................................................................................41 Table 6.3.4.2.7-1: Interpretation of resultContent .............................................................................................................42 Table 6.3.4.2.8-1: Interpretation of discResType ..............................................................................................................42 Table 6.3.4.2.9-1: Interpretation of responseStatusCode ..................................................................................................42 Table 6.3.4.2.10-1: Interpretation of requestStatus ...........................................................................................................42 Table 6.3.4.2.11-1: Interpretation of memberType ...........................................................................................................43 Table 6.3.4.2.12-1: Interpretation of consistencyStrategy .................................................................................................44 Table 6.3.4.2.13-1: Interpretation of cmdType .................................................................................................................44 Table 6.3.4.2.14-1: Interpretation of execModetType .......................................................................................................44 Table 6.3.4.2.15-1: Interpretation of execStatusType .......................................................................................................44 Table 6.3.4.2.16-1: Interpretation of execResultType .......................................................................................................45 Table 6.3.4.2.17-1: Interpretation of pendingNotification ................................................................................................45 Table 6.3.4.2.18-1: Interpretation of notificationContentType .........................................................................................45 Table 6.3.4.2.19-1: Interpretation of notificationEventType .............................................................................................46 Table 6.3.4.2.20-1: Interpretation of status .......................................................................................................................46 Table 6.3.4.2.21-1: Interpretation of batteryStatus ............................................................................................................46 Table 6.3.4.2.22-1: Interpretation of mgmtDefinition .......................................................................................................47 Table 6.3.4.2.23-1: Interpretation of logTypeId ................................................................................................................47 Table 6.3.4.2.24-1: Interpretation of logStatus ..................................................................................................................47 Table 6.3.4.2.25-1: Interpretation of eventType ................................................................................................................48 Table 6.3.4.2.26-1: Interpretation of statsRuleStatusType ................................................................................................48 Table 6.3.4.2.27-1: Interpretation of statModelType ........................................................................................................48 Table 6.3.4.2.28-1: Interpretation of encodingType ..........................................................................................................48 Table 6.3.4.2.29-1: Interpretation of accessControlOperations .........................................................................................48 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 312 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.3.4.2.31-1: Interpretation of filterUsage ...............................................................................................................49 Table 6.3.4.2.35-1: Interpretation of securityInfoType .....................................................................................................50 Table 6.3.4.2.36-1: Interpretation of allJoynDirection ......................................................................................................50 Table 6.3.4.2.37-1: Interpretation of contentFilterSyntax .................................................................................................50 Table 6.3.4.2.38-1: Interpretation of contentSecurity........................................................................................................50 Table 6.3.4.2.39-1: Interpretation of suid ..........................................................................................................................51 Table 6.3.4.2.40-1: Interpretation of esprimKeyGenAlgID ..............................................................................................51 Table 6.3.4.2.41-1: Interpretation of esprimProtocolAndAlgID .......................................................................................52 Table 6.3.4.2.42-1: Interpretation of periodicIndicator .....................................................................................................52 Table 6.3.4.2.43-1: Interpretation of stationaryIndication .................................................................................................52 Table 6.3.4.2.44-1: Interpretation of contentStatus ...........................................................................................................52 Table 6.3.4.2.45-1: Interpretation of m2m:networkAction ...............................................................................................53 Table 6.3.5.2-1: Type Definition of m2m:deliveryMetadata.............................................................................................53 Table 6.3.5.3-1: Type Definition of m2m:aggregatedRequest ..........................................................................................53 Table 6.3.5.4-1: Type Definition of m2m:metaInformation ..............................................................................................54 Table 6.3.5.6-1: Type Definition of m2m:batchNotify .....................................................................................................54 Table 6.3.5.7-1:Type Definition of m2m:eventNotificationCriteria .................................................................................54 Table 6.3.5.8-1: Type Definition of m2m:filterCriteria ....................................................................................................55 Table 6.3.5.9-1: Type Definition of m2m:attribute ...........................................................................................................55 Table 6.3.5.11-1: Type Definition of m2m:scheduleEntries .............................................................................................55 Table 6.3.5.12-1: Type Definition of m2m:aggregatedNotification ..................................................................................55 Table 6.3.5.13-1: Type Definition of m2m:notification ....................................................................................................56 Table 6.3.5.14-1: Type Definition of m2m:actionStatus ...................................................................................................56 Table 6.3.5.15-1: Type Definition of m2m:anyArgType ..................................................................................................57 Table 6.3.5.16-1: Type Definition of m2m:resetArgsType ...............................................................................................57 Table 6.3.5.17-1: Type Definition of m2m:rebootArgsType ............................................................................................57 Table 6.3.5.18-1: Type Definition of m2m:uploadArgsType ............................................................................................57 Table 6.3.5.19-1: Type Definition of m2m:downloadArgsType .......................................................................................57 Table 6.3.5.20-1: Type Definition of m2m:softwareInstallArgsType ...............................................................................58 Table 6.3.5.21-1: Type Definition of m2m:softwareUpdateArgsType .............................................................................58 Table 6.3.5.22-1: Type Definition of m2m:softwareUninstallArgsType ..........................................................................58 Table 6.3.5.23-1: Type Definition of m2m:execReqArgsListType ...................................................................................58 Table 6.3.5.24-1: Type Definition of m2m:mgmtLinkRef ................................................................................................59 Table 6.3.5.25-1: Type Definition of m2m:resourceWrapper ...........................................................................................59 Table 6.3.5.26-1: Type Definition of m2m:setOfAcrs ......................................................................................................59 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 313 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.3.5.27-1: Type Definition of m2m:accessControlRule.........................................................................................60 Table 6.3.5.28-1: Type Definition of m2m:locationRegion ..............................................................................................60 Table 6.3.5.29-1: Type Definition of m2m:childResourceRef ..........................................................................................61 Table 6.3.5.30-1: Type Definition of m2m:responseTypeInfo ..........................................................................................61 Table 6.3.5.31-1: Type Definition of m2m:rateLimit........................................................................................................61 Table 6.3.5.32-1: Type Definition of m2m:operationResult .............................................................................................62 Table 6.3.5.33-1: Type Definition of m2m:aggregatedResponse ......................................................................................62 Table 6.3.5.34-1: Type Definition of m2m:mgmtResource ..............................................................................................62 Table 6.3.5.35-1: Type Definition of m2m:announcedMgmtResource .............................................................................63 Table 6.3.5.36-1: Type Definition of m2m:contentRef .....................................................................................................63 Table 6.3.5.37-1: Type Definition of m2m:deletionContexts ...........................................................................................63 Table 6.3.5.38-1: Type Definition of m2m:flexContainerResource ..................................................................................64 Table 6.3.5.39-1: Type Definition of m2m:announcedFlexContainerResource ................................................................64 Table 6.3.5.40-1: Type Definition of m2m:missingData ..................................................................................................65 Table 6.3.5.41-1: Type Definition of m2m:tokenPermission ............................................................................................65 Table 6.3.5.42-1: Type Definition of m2m:tokenClaimSet ...............................................................................................65 Table 6.3.5.43-1: Type Definition of m2m:dynAuthLocalTokenIdAssignments .............................................................65 Table 6.3.5.44-1: Type Definition of m2m:dynAuthTokenSummary ...............................................................................66 Table 6.3.5.45-1: Type Definition of m2m:dynAuthTokenReqInfo .................................................................................66 Table 6.3.5.46-1: Type Definition of m2m:dynAuthDasRequest .....................................................................................66 Table 6.3.5.47-1: Type Definition of m2m:dynAuthDasResponse ...................................................................................66 Table 6.3.5.48-1: Type Definition of m2m:securityInfo ...................................................................................................67 Table 6.3.5.49-1: Type Definition of m2m:listOfChildResourceRef ................................................................................67 Table 6.3.5.50-1: Type Definition of m2m:originatorESPrimRandObject .......................................................................67 Table 6.3.5.51-1: Type Definition of m2m:receiverESPrimRandObject ..........................................................................67 Table 6.3.5.52-1: Type Definition of m2m:e2eSecInfo ....................................................................................................68 Table 6.3.5.56-1: Type Definition of m2m:dataLink ........................................................................................................69 Table 6.3.6-1: Universal and Common Attributes ............................................................................................................69 Table 6.3.6-2: Complex Data Types declaring groups of resource common attributes .....................................................71 Table 6.4.1-1: Data Types for Request primitive parameters ............................................................................................73 Table 6.4.2-1: Data Types for Response primitive parameters .........................................................................................74 Table 6.6.2-1: Definition of Response Status Code class ..................................................................................................78 Table 6.6.3.2-1: Informational response class ...................................................................................................................78 Table 6.6.3.4-1: RSCs for redirection response class ........................................................................................................78 Table 6.6.3.5-1: RSCs for Originator error response class ................................................................................................79 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 314 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.8-1: Virtual Resources ..........................................................................................................................................81 Table 7.2.1.1-1: Request Primitive Parameters .................................................................................................................83 Table7.2.1.2-1 : Response Primitive Parameters ...............................................................................................................84 Table 7.3.1.4-1: Request primitive parameter settings ......................................................................................................91 Table 7.3.2.2-1: Common attributes settings for <request> resource ................................................................................93 Table 7.3.2.2-2: Resource-specific attributes settings for <request> resource ..................................................................93 Table 7.3.2.3-1: Response primitive parameter settings ....................................................................................................94 Table 7.3.2.5-1: Common attributes settings for <request> resource ................................................................................94 Table 7.3.2.5-2: Resource-specific attributes settings for <request> resource ..................................................................94 Table 7.3.3.17.0-1: Summary on Filter conditions ..........................................................................................................106 Table 7.4.1.1-2: Data type definition of <resourceType> ...............................................................................................112 Table 7.4.1.1-4: Universal/Common Attributes of <resourceType> resource ................................................................113 Table 7.4.1.1-5: Resource Specific Attributes of <resourceType> resource ...................................................................113 Table 7.4.1.1-6: Child resources of <resourceType> resource ........................................................................................113 Table 7.4.2.1-1: Data type definition of <accessControlPolicy> resource ......................................................................114 Table 7.4.2.1-2: Universal/Common Attributes of <accessControlPolicy> resource .....................................................114 Table 7.4.2.1-3: Resource Specific Attributes of <accessControlPolicy> resource ........................................................114 Table 7.4.2.1-4: Child Resources of <accessControlPolicy> resource ............................................................................114 Table 7.4.3-1: Data type definition of <CSEBase> resource ..........................................................................................115 Table 7.4.3-2: Resource Specific Attributes of <CSEBase> resource ............................................................................115 Table 7.4.3-3: Child resources of <CSEBase> resource .................................................................................................116 Table 7.4.4.1-1: Data type definition of <remoteCSE> resource ....................................................................................117 Table 7.4.4.1-2: Universal/Common Attributes of <remoteCSE> resource ....................................................................118 Table 7.4.4.1-3: Resource Specific Attributes of <remoteCSE> resource ......................................................................118 Table 7.4.4.1-4: Child resources of <remoteCSE> resource ...........................................................................................118 Table 7.4.5.1-1: Data type definition of <AE> resource .................................................................................................120 Table 7.4.5.1-2: Universal/Common Attributes of <AE> resource .................................................................................120 Table 7.4.5.1-3: Resource Specific Attributes of <AE> resource ...................................................................................120 Table 7.4.5.1-4: Child resources of <AE> resource ........................................................................................................120 Table 7.4.6.1-2: Universal/Common Attributes of <container> resource .......................................................................123 Table 7.4.6.1-3: Resource Specific Attributes of <container> resource ..........................................................................123 Table 7.4.7.1-2: Universal/Common Attributes of <contentInstance> resource .............................................................125 Table 7.4.7.1-3: Resource Specific Attributes of <contentInstance> resource ................................................................125 Table 7.4.8.1-1: Data type definition of <subscription> resource ...................................................................................127 Table 7.4.8.1-2: Universal/Common Attributes of <subscription> resource ..................................................................127 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 315 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.8.1-3: Resource Specific Attributes of <subscription> resource .....................................................................128 Table 7.4.8.1-4: Reference of child resources .................................................................................................................128 Table 7.4.9.1-1: Data type definition of <schedule> resource ........................................................................................130 Table 7.4.9.1-2: Universal/Common Attributes of <schedule> resource ........................................................................130 Table 7.4.9.1-3: Resource Specific Attributes of <schedule> resource ...........................................................................130 Table 7.4.9.1-4: Definition of m2m:scheduleEntry string format ...................................................................................130 Table 7.4.9.1-5: The task to be executed .........................................................................................................................131 Table 7.4.9.1-6: Child resources of <schedule > resource ..............................................................................................131 Table 7.4.10.1-1: Data type definition of <locationPolicy> resource .............................................................................132 Table 7.4.10.1-2: Universal/Common Attributes of <locationPolicy> resource .............................................................133 Table 7.4.10.1-3: Resource Specific Attributes of <locationPolicy> resource................................................................133 Table 7.4.10.1-4: Child resources of <locationPolicy> resource ....................................................................................133 Table 7.4.11.1-1: Data type definition of <delivery> resource .......................................................................................135 Table 7.4.11.1-2: Universal/Common Attributes of <delivery> resource .......................................................................136 Table 7.4.11.1-3: Resource Specific Attributes of <delivery> resource .........................................................................136 Table 7.4.11.1-4: Child resources of <delivery> resource ..............................................................................................136 Table 7.4.12.1-1: Data type definition of <request> resource .........................................................................................138 Table 7.4.12.1-2: Universal/Common Attributes of <request> resource ........................................................................139 Table 7.4.12.1-3: Resource Specific Attributes of <request> resource ...........................................................................139 Table 7.4.12.1-4 : Reference of child resources ..............................................................................................................139 Table 7.4.13.1-1: Data type definition of <group> resource ...........................................................................................140 Table 7.4.13.2-2: Universal/Common Attributes of <group> resource ...........................................................................140 Table 7.4.13.2-3: Resource Specific Attributes of <group> resource .............................................................................141 Table 7.4.13.2-4: Child resources of <group> resource ..................................................................................................141 Table 7.4.15.1-1: Universal/Common Attributes of <mgmtObj> resource .....................................................................148 Table 7.4.15.1-2: Resource Specific Attributes of <mgmtObj> resource .......................................................................148 Table 7.4.15.1-3: Child resources of <mgmtObj> resource ............................................................................................149 Table 7.4.16.1-1: Data type definition of <mgmtCmd> resource ...................................................................................150 Table 7.4.16.1-2: Universal/Common Attributes of <mgmtCmd> resource ...................................................................151 Table 7.4.16.1-3: Resource Specific Attributes of <mgmtCmd> resource .....................................................................152 Table 7.4.16.1-4: Child resources of <mgmtCmd> resource ..........................................................................................153 Table 7.4.17.1-1: Data type definition of <execInstance> resource ................................................................................155 Table 7.4.17.1-2: Universal/Common Attributes of <execInstance> resource ...............................................................155 Table 7.4.17.1-3: Resource Specific Attributes of <execInstance> resource ..................................................................156 Table 7.4.17.1-4: Child Resources of <execInstance> resource .....................................................................................156 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 316 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.18.1-1: Data type definition of <node> resource .............................................................................................158 Table 7.4.18.1-2: Universal/Common Attributes of <node> resource ............................................................................158 Table 7.4.18.1-3: Resource Specific Attributes of <node> resource ...............................................................................158 Table 7.4.18.1-4: Child resources of <node> resource ....................................................................................................158 Table 7.4.19.1-1: Data type definition of <m2mServiceSubscriptionProfile> resource .................................................159 Table 7.4.19.1-2: Universal/Common Attributes of <m2mServiceSubscriptionProfile> ...............................................159 Table 7.4.19.1-3: Resource Specific Attributes of <m2mServiceSubscriptionProfile> ..................................................160 Table 7.4.19.1-4: Child resources of <m2mServiceSubscriptionProfile> .......................................................................160 Table 7.4.20.1-1: Data type definition of <serviceSubscribedNode> resource ...............................................................161 Table 7.4.20.1-2: Universal/Common Attributes of <serviceSubscribedNode> resource ..............................................161 Table 7.4.20.1-3: Resource Specific Attributes of <serviceSubscribedNode> resource .................................................161 Table 7.4.20.1-4: Child resources of <serviceSubscribedNode> resource ......................................................................161 Table 7.4.21.1-1: Data type definition of <pollingChannel> resource ............................................................................162 Table 7.4.21.1-2: Universal/Common Attributes of <pollingChannel> resource ...........................................................162 Table 7.4.21.1-3: Child resources of <pollingChannel> resource ...................................................................................163 Table 7.4.23.1-1: Data type definition of <statsConfig> .................................................................................................165 Table 7.4.23.1-2: Universal/Common Attributes of <stateConfig> resource .................................................................166 Table 7.4.23.1-3: Child resources of <statsConfig> resource .........................................................................................166 Table 7.4.24.1-1: Data type definition of <eventConfig> ...............................................................................................167 Table 7.4.24.1-2: Universal/Common Attributes of <eventConfig> resource ................................................................167 Table 7.4.24.1-3: Resource Specific Attributes of <eventConfig> resource ...................................................................168 Table 7.4.24.1-4: Child Resources of <eventConfig> resource ......................................................................................168 Table 7.4.25.1-1: Data type definition of <statsCollect> ................................................................................................169 Table 7.4.25.1-2: Universal/Common Attributes of <statsCollect> resource .................................................................169 Table 7.4.25.1-3: Resource Specific Attributes of <statsCollect> resource ....................................................................170 Table 7.4.25.1-4: Child Resources of <statsCollect> resource .......................................................................................170 Table 7.4.26.1-3: Data type definition of announced Resource types .............................................................................172 Table 7.4.26.1-4: Universal/Common Attributes of announcedResource .......................................................................172 Table 7.4.26.1-5: Resource Specific Attributes of announcedResource .........................................................................173 Table 7.4.29.1-1: Data type definition of <serviceSubscribedAppRule> resource .........................................................177 Table 7.4.29.1-2: Universal/Common Attributes of <serviceSubscribedAppRule> resource .........................................177 Table 7.4.29.1-3: Resource Specific Attributes of <serviceSubscribedAppRule> resource ...........................................177 Table 7.4.29.1-4: Child resources of <serviceSubscribedAppRule> resource ................................................................177 Table 7.4.30.1-1: Data type definition of <notificationTargetMgmtPolicyRef> resource ..............................................178 Table 7.4.30.1-2: Universal/Common Attributes of <notificationTargetMgmtPolicyRef> resource ..............................178 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 317 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.30.1-3: Resource Specific Attributes of <notificationTargetMgmtPolicyRef> resource ................................179 Table 7.4.30.1-4: Child resources of <notificationTargetMgmtPolicyRef> resource .....................................................179 Table 7.4.31.1-1: Data type definition of <notificationTargetPolicy> resource ..............................................................180 Table 7.4.31.1-2: Universal/Common Attributes of <notificationTargetPolicy> resource .............................................180 Table 7.4.31.1-3: Resource Specific Attributes of <notificationTargetPolicy> resource ................................................180 Table 7.4.31.1-4: Child resources of <notificationTargetPolicy> resource.....................................................................180 Table 7.4.32.1-1: Data type definition of <policyDeletionRules> resource ....................................................................181 Table 7.4.32.1-2: Universal/Common Attributes of <policyDeletionRules> resource ...................................................182 Table 7.4.32.1-3: Resource Specific Attributes of <policyDeletionRules> resource ......................................................182 Table 7.4.32.1-4: Child resources of <policyDeletionRules> resource ...........................................................................182 Table 7.4.34.1-1: Data type definition of <semanticDescriptor> resource .....................................................................185 Table 7.4.34.1-2: Universal/Common Attributes of <semanticDescriptor> resource .....................................................185 Table 7.4.34.1-3: Resource Specific Attributes of <semanticDescriptor> resource ........................................................185 Table 7.4.34.1-4: Child resources of <semanticDescriptor> resource ............................................................................185 Table 7.4.36.1-1: Data type definition of <dynamicAuthorizationConsultation> resource ............................................189 Table 7.4.36.1-2: Universal/Common Attributes of <dynamicAuthorizationConsultation > resource ...........................190 Table 7.4.36.1-3: Resource Specific Attributes of <dynamicAuthorizationConsultation> resource ..............................190 Table 7.4.37.1-1: Universal/Common Attributes of <flexContainer> resource ..............................................................191 Table 7.4.37.1-2: Resource Specific Attributes of <flexContainer> resource .................................................................192 Table 7.4.37.1-3: Child Resources of <flexContainer> resource ....................................................................................192 Table 7.4.38.1-1: Data type definition of <timeSeries> resource ....................................................................................193 Table 7.4.38.1-2: Universal/Common Attributes of <timeSeries> resource ...................................................................193 Table 7.4.38.1-3: Resource Specific Attributes of <timeSeries> resource ......................................................................194 Table 7.4.38.1-4: Child Resources of <timeSeries> resource .........................................................................................194 Table 7.4.39.1-1: Data type definition of <timeSeriesInstance> resource ......................................................................195 Table 7.4.39.1-2: Universal/Common Attributes of <timeSeriesInstance> resource ......................................................195 Table 7.4.39.1-3: Resource Specific Attributes of <timeSeriesInstance> resource ........................................................196 Table 7.4.40.1-1: Data type definition of <role> resource ..............................................................................................197 Table 7.4.40.1-2: Universal/Common Attributes of <role> resource ..............................................................................197 Table 7.4.40.1-3: Resource Specific Attributes of <role> resource ................................................................................197 Table 7.4.40.1-4: Child Resources of <role> resource ....................................................................................................197 Table 7.4.41.1-1: Data type definition of <token> resource............................................................................................198 Table 7.4.41.1-2: Universal/Common Attributes of <token> resource ...........................................................................199 Table 7.4.41.1-3: Resource Specific Attributes of <token> resource ..............................................................................199 Table 7.4.41.1-4: Child Resources of <token> resource .................................................................................................199 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 318 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.42.1-1: Data type definition of <trafficPattern> resource ...............................................................................200 Table 7.4.42.1-2: Universal/Common Attributes of <trafficPattern> resource ...............................................................200 Table 7.4.42.1-3: Resource Specific Attributes of <trafficPattern> resource..................................................................201 Table 7.4.42.1-4: Child Resources of <trafficPattern> resource .....................................................................................201 Table 7.5.1.1-1: Data Type Definition of notification data object ..................................................................................203 Table 7.5.1.1-2: Data Types for notification data objects ...............................................................................................203 Table 7.5.2-1: Elements used for request content ...........................................................................................................213 Table 7.5.2-2: Elements used for response content .........................................................................................................213 Table 7.6.2-1: End-to-End security of Primitives (ESPrim) processing error cases with corresponding error message 218 Table 8.2.2-1: Primitive parameter short names ..............................................................................................................219 Table 8.2.3-1: Resource attribute short names (1/6)........................................................................................................220 Table 8.2.3-2: Resource attribute short names (2/6)........................................................................................................221 Table 8.2.3-3: Resource attribute short names (3/6)........................................................................................................222 Table 8.2.3-4: Resource attribute short names (4/6)........................................................................................................223 Table 8.2.3-5: Resource attribute short names (5/6)........................................................................................................224 Table 8.2.3-6: Resource attribute short names (6/6)........................................................................................................225 Table 8.2.4-1: Resource and specialization type short names .........................................................................................225 Table 8.2.5-1: Complex data type member short names .................................................................................................227 Table A.3-1: Mapping of Recorded M2M Information Elements to Diameter AVPs ....................................................237 Table A.4-1: Use Of Diameter AVPs ..............................................................................................................................238 Table B.2.1.2-1: Mapping between oneM2M resource and 3GPP AVP .........................................................................245 Table B.2.1.3-1: Mapping between oneM2M resource and 3GPP AVP .........................................................................245 Table D.2.1-1: Data Type Definition of [firmware] ........................................................................................................249 Table D.2.1-2: Resource specific attributes of [firmware] ..............................................................................................249 Table D.3.1-1: Data Type Definition of [software] .........................................................................................................250 Table D.3.1-2: Resource specific attributes of [software] ...............................................................................................251 Table D.4.1-1: Data Type Definition of [memory] .........................................................................................................252 Table D.4.1-2: Resource specific attributes of [memory] ...............................................................................................252 Table D.5.1-1: Data Type Definition of [areaNwkInfo] ..................................................................................................253 Table D.5.1-2: Resource specific attributes of [areaNwkInfo] ........................................................................................254 Table D.6.1-1: Data Type Definition of [areaNwkDeviceInfo] ......................................................................................255 Table D.6.1-2: Resource specific attributes of [areaNwkDeviceInfo] ............................................................................255 Table D.7.1-1: Data Type Definition of [battery] ...........................................................................................................256 Table D.7.1-2: Resource specific attributes of [battery] ..................................................................................................256 Table D.8.1-1: Data Type Definition of [deviceInfo]......................................................................................................258 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 319 oneM2M TS-0004 version 2.7.1 Release 2 Table D.8.1-2: Resource specific attributes of [deviceInfo] ............................................................................................258 Table D.9.1-1: Data Type Definition of [deviceCapability] ............................................................................................259 Table D.9.1-2: Resource specific attributes of [deviceCapability] ..................................................................................259 Table D.10.1-1: Data Type Definition of [reboot] ..........................................................................................................261 Table D.10.1-2: Resource specific attributes of [reboot] ................................................................................................261 Table D.11.1-1: Data Type Definition of [eventLog]......................................................................................................262 Table D.11.1-2: Resource specific attributes of [eventLog] ............................................................................................262 Table D.12.1-1: Data Type Definition of [cmdhPolicy] ..................................................................................................264 Table D.12.1-2: Resource specific attributes of [cmdhPolicy] ........................................................................................264 Table D.12.2-1: Data Type Definition of [activeCmdhPolicy] .......................................................................................264 Table D.12.2-2: Resource specific attributes of [activeCmdhPolicy] .............................................................................265 Table D.12.3-1: Data Type Definition of [cmdhDefaults] ..............................................................................................265 Table D.12.3-2: Resource specific attributes of [cmdhDefaults] ....................................................................................265 Table D.12.4-1: Data Type Definition of [cmdhDefEcValue] ........................................................................................265 Table D.12.4-2: Resource specific attributes of [cmdhDefEcValue] ..............................................................................266 Table D.12.5-1: Data Type Definition of [cmdhEcDefParamValues] ............................................................................266 Table D.12.5-2: Resource specific attributes of [cmdhEcDefParamValues] ..................................................................266 Table D.12.6-1: Data Type Definition of [cmdhLimits] .................................................................................................266 Table D.12.6-2: Resource specific attributes of [cmdhLimits] .......................................................................................267 Table D.12.7-1: Type Definition of [cmdhNetworkAccessRules] ..................................................................................267 Table D.12.7-2: Resource specific attributes of [cmdhNetworkAccessRules] ................................................................267 Table D.12.8-1: Data Type Definition of [cmdhNwAccessRule] ...................................................................................268 Table D.12.8-2: Resource specific attributes of [cmdhNwAccessRule] .........................................................................268 Table D.12.9-1: Data Type Definition of [cmdhBuffer] .................................................................................................268 Table D.12.9-2: Resource specific attributes of [cmdhBuffer] .......................................................................................269 Table G.2.2-1: Applicable NetAPI for Terminal Location ..............................................................................................279 Table G.2.2-2: Resource Type Definition - TerminalLocation .......................................................................................279 Table G.2.2-3: Resource Type Definition - PeriodicNotificationSubscription ...............................................................280 Table G.2.2-4: Resource Type Definition – CircleNotificationSubscription ..................................................................280 Table J.2-1: Data type definition of [genericInterworkingService] resource ..................................................................304 Table J.2-2: Resource Specific Attributes of [genericInterworkingService] resource ....................................................304 Table J.3-1: Data type definition of [genericInterworkingOperationInstance] resource .................................................304 Table J.3-2: Resource Specific Attributes of [genericInterworkingOperationInstance] resource ...................................305 Table J.4-1: Data type definition of [svcObjWrapper] resource .....................................................................................305 Table J.4-2: Resource Specific Attributes of [svcObjWrapper] resource........................................................................305 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 320 oneM2M TS-0004 version 2.7.1 Release 2 Table J.4-3: Child Resources of [svcObjWrapper] resource ...........................................................................................305 Table J.5-1: Data type definition of [svcFwWrapper] resource ......................................................................................305 Table J.5-2: Resource Specific Attributes of [svcFwWrapper] resource ........................................................................306 Table J.5-3: Child Resources of [svcFwWrapper] resource ............................................................................................306 Table J.6-1: Data type definition of [allJoynApp] resource ............................................................................................306 Table J.6-2: Resource Specific Attributes of [allJoynApp] resource ..............................................................................306 Table J.6-3: Child Resources of [allJoynApp] resource ..................................................................................................306 Table J.7-1: Data type definition of [allJoynSvcObject] resource ...................................................................................306 Table J.7-2: Resource Specific Attributes of [allJoynSvcObject] resource .....................................................................307 Table J.7-3: Child Resources of [allJoynSvcObject] resource ........................................................................................307 Table J.8-1: Data type definition of [allJoynInterface] resource .....................................................................................307 Table J.8-2: Resource Specific Attributes of [allJoynInterface] resource .......................................................................307 Table J.8-3: Child Resources of [allJoynInterface] resource ...........................................................................................307 Table J.9-1: Data type definition of [allJoynMethod] resource .......................................................................................308 Table J.9-2: Resource Specific Attributes of [allJoynMethod] resource .........................................................................308 Table J.9-3: Child Resources of [allJoynMethod] resource ............................................................................................308 Table J.10-1: Data type definition of [allJoynMethodCall] resource ..............................................................................308 Table J.10-2: Resource Specific Attributes of [allJoynMethodCall] resource ................................................................308 Table J.10-3: Child Resources of [allJoynMethodCall] resource ....................................................................................308 Table J.11-1: Data type definition of [allJoynProperty] resource ...................................................................................309 Table J.11-2: Resource Specific Attributes of [allJoynProperty] resource ......................................................................309 Table J.11-3: Child Resources of [allJoynProperty] resource .........................................................................................309 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 321 oneM2M TS-0004 version 2.7.1 Release 2 History Document history V2.7.1 October 2016 Publication |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 1 Scope | The reporting of Global KPIs in accordance with ETSI EN 305 200-3-1 [2] requires the collection of data to enable the calculation of the following aspects: • objective KPI relating to the total energy consumption (KPIEC); • objective KPI relating to the use of energy performance (KPIEP) which combines KPIEC with other measurements of energy consumption to provide Objective KPIs related to task efficiency (KPITE), the reuse of energy (KPIREUSE) and the use of renewable energy (KPIREN). The present document supports the requirements of ETSI EN 305 200-3-1 [2] providing a framework for, and detailing, the implementation procedures including any necessary techniques for estimation of energy consumption together with constants to be employed for weighting and banding purposes. |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 2 References | |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 2.1 Normative references | References are either specific (identified by date of publication and/or edition number or version number) or non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the referenced document (including any amendments) applies. Referenced documents which are not found to be publicly available in the expected location might be found at https://docbox.etsi.org/Reference. NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee their long term validity. The following referenced documents are necessary for the application of the present document. [1] ETSI EN 305 200 series: "Access, Terminals, Transmission and Multiplexing (ATTM); Energy management; Operational infrastructures; Global KPIs". [2] ETSI EN 305 200-3-1: "Access, Terminals, Transmission and Multiplexing (ATTM); Energy management; Operational infrastructures; Global KPIs; Part 3: ICT sites; Sub-part 1: DCEM". |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 2.2 Informative references | References are either specific (identified by date of publication and/or edition number or version number) or non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the referenced document (including any amendments) applies. NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee their long term validity. The following referenced documents are not necessary for the application of the present document but they assist the user with regard to a particular subject area. [i.1] CENELEC EN 50600-4-2: "Information technology - Data centre facilities and infrastructures; Part 4-2: Power Usage Effectiveness". [i.2] CENELEC EN 50600-4-3: "Information technology - Data centre facilities and infrastructures; Part 4-3: Renewable Energy Factor". [i.3] CENELEC EN 50600-4-6: "Information technology - Data centre facilities and infrastructures; Part 4-6: Energy Reuse Factor". [i.4] ETSI EN 305 174-2: "Access, Terminals, Transmission and Multiplexing (ATTM); Broadband Deployment and Lifecycle Resource Management; Part 2: ICT sites". ETSI ETSI TS 105 200-3-1 V1.2.1 (2019-12) 9 [i.5] ETSI TS 105 174-2: "Access, Terminals, Transmission and Multiplexing (ATTM); Broadband Deployment and Energy Management; Part 2: ICT sites". [i.6] ETSI EN 305 200-2-1: "Access, Terminals, Transmission and Multiplexing (ATTM); Energy management; Operational infrastructures; Global KPIs; Part 2: Specific requirements; Sub-part 1: ICT Sites". |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 3 Definition of terms, symbols and abbreviations | |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 3.1 Terms | For the purposes of the present document, the terms given in ETSI EN 305 200-3-1 [2] apply. |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 3.2 Symbols | For the purposes of the present document, the symbols given in ETSI EN 305 200-3-1 [2] apply. |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 3.3 Abbreviations | For the purposes of the present document, the abbreviations given in ETSI EN 305 200-3-1 [2] and the following apply: NGO Non-Governmental Organization |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4 Global KPIs of ETSI EN 305 200-3-1 | |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.1 ICT sites | The ICT sites addressed by ETSI EN 305 200-3-1 [2] and the present document are Operator Sites (OSs) and Network Data Centres (NDCs). It should be noted that an OS that is only connected to the core network is considered to be an NDC. The schematic of an ICT site used in the present document is shown in Figure 1 (taken from of ETSI EN 305 200-3-1 [2]). Figure 1: Schematic of the functional elements of an ICT site With reference to the schematic in Figure 1: • an NDC accommodates a mixture of information technology equipment (ITE) and network telecommunication equipment (NTE); • an OS will also accommodate a mixture of ITE and NTE - where the NTE may provide connections to core, fixed access, terrestrial mobile access and satellite mobile access network infrastructures; Power distribution Environmental control Security Telecommunications cabling ICT EQUIPMENT ITE NTE Control facilities Support facilities ICT site INFRASTRUCTURES AND FACILITIES ETSI ETSI TS 105 200-3-1 V1.2.1 (2019-12) 10 • the present document does not differentiate between ITE and NTE and the generic term ICT equipment is used. |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.2 KPIs for energy management | |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.2.1 Global KPI (KPIDCEM) for ICT sites | From ETSI EN 305 200-3-1 [2], KPIDCEM is a combination of two separate KPIs, for a common assessment period k, as follows: 1) the Objective KPI for energy consumption expressed as KPIEC (see clause 4.2.2.1); 2) a combination of three Objective KPIs for energy performance expressed as KPIEP: KPIEP = KPITE x ((1 - WREUSE x KPIREUSE) x (1 - WREN x KPIREN)) subject to a minimum value of 0. where: KPITE = Objective KPI for task effectiveness (see clause 4.2.2.2); KPIREUSE = Objective KPI for energy re-use (see clause 4.2.2.3); KPIREN = Objective KPI for renewable energy (see clause 4.2.2.4); and: WREUSE = weighting factor for energy re-use (see clause 6); WREN = weighting factor for renewable energy (see clause 6). KPIEC is presented as a banded value DCG (see clause 6). KPIEP is presented as a banded value DCCLASS (see clause 6). |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.2.2 Objective KPIs | |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.2.2.1 Energy consumption (KPIEC) | From ETSI EN 305 200-3-1 [2], KPIEC for the assessment period k, KPIEC (k) is defined mathematically as: ( ) ( ) ( ) 1 S k k k EC s s KPI C C = = = or ( ) ( ) 1 N k k EC n n KPI C = = (when applied to groups of ICT sites) where, for the assessment period k: C(k) = total energy consumption by the ICT site Cn(k) = total energy consumption by ICT site n Cs(k) = total energy consumption by ICT site from energy source s n = ICT site number N = total number of ICT sites s = energy source number S = total number of separate energy sources of the ICT site including those provided only during fault conditions ETSI ETSI TS 105 200-3-1 V1.2.1 (2019-12) 11 |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.2.2.2 Task effectiveness (KPITE) | From ETSI EN 305 200-3-1 [2], KPITE for the assessment period k, KPITE (k) is defined mathematically as: ( ) ( ) ( ) k k TE k C KPI L = or ( ) ( ) 1 ( ) 1 N k n k n TE N k n n C KPI L = = = (when applied to groups of ICT sites) where, for the assessment period k: C(k) = total energy consumption of the ICT site Cn(k) = total energy consumption of ICT site n L(k) = total energy consumed by ICT load in the ICT site Ln(k) = total energy consumed by ICT load in ICT site n n = ICT site number N = total number of ICT sites |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.2.2.3 Energy reuse (KPIREUSE) | From ETSI EN 305 200-3-1 [2], KPIREUSE for the assessment period k, KPIREUSE(k) is defined mathematically as: ( ) ( ) ( ) k k REUSE REUSE k EC KPI C = or ( ) ( ) 1 ( ) 1 n N k REUSE k n REUSE N k n n EC KPI C = = = (when applied to groups of ICT sites) where, for the assessment period k: C(k) = total energy consumption of the ICT site Cn(k) = total energy consumption of ICT site n ECREUSE(k) = total energy re-used from the ICT site ECREUSEn(k) = total energy re-used from ICT site n |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.2.2.4 Renewable energy (KPIREN) | From ETSI EN 305 200-3-1 [2], KPIREN for the assessment period k, KPIREN (k) is defined mathematically as: ( ) ( ) ( ) k k REN REN k EC KPI C = or ( ) ( ) 1 ( ) 1 n N k REN k n REN N k n n EC KPI C = = = (when applied to groups of ICT sites) where, for the assessment period k: C(k) = total energy consumption of the ICT site Cn(k) = total energy consumption of the ICT site n ETSI ETSI TS 105 200-3-1 V1.2.1 (2019-12) 12 ECREN(k) = total energy consumption from renewable sources of the ICT site ECRENn(k) = total energy consumption from renewable sources of ICT site n |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.2.3 Underlying principles | |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.2.3.1 Energy consumption | ETSI EN 305 200-3-1 [2] and the present document support the reduction in the energy consumption required to provide a given level of service as a primary objective. The KPIEC may be improved by local actions within individual ICT sites and/or global actions applied to the group under common governance. |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.2.3.2 Task effectiveness | ETSI EN 305 200-3-1 [2] and the present document support the improvement in task effectiveness as a primary objective. KPITE is the ratio of the total energy consumption of the ICT site to the energy consumption of the ICT equipment in the ICT site. KPITE is dimensionless and has the following properties: • KPITE ≥ 1; • KPITE = 1 is an ideal value. It should be noted that the work done by the load is not a basis for the KPITE due to the wide variety of operations performed by the ICT equipment in ICT sites. A simple comparison between KPITE and Power Usage Effectiveness of CENELEC EN 50600-4-2 [i.1] is provided in Annex A. |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.2.3.3 Energy re-use | |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.2.3.3.1 Objective | ETSI EN 305 200-3-1 [2] and the present document support re-use of energy as a secondary objective. KPIREUSE is the ratio of re-used energy by facilities, external to the ICT site, to the total energy consumption of the ICT site. Thermal energy can be reused in different forms, liquid or gas (air). KPIREUSE shall be measurable and quantifiable. It is a dimensionless number. The KPIREUSE of ETSI EN 305 200-3-1 [2] reflects a preference for energy consumption reduction rather than re-use. NOTE 1: The KPIREUSE of ETSI EN 305 200-2-1 [i.6] reflects a preference for re-use of energy in the form of heat generated by the ICT equipment rather than from poorly designed facilities and infrastructures. This is not contained in ETSI EN 305 200-3-1 [2]. In all cases "non-use" is better than "re-use". The vast majority of energy input to an ICT site is converted into heat. Possible initiatives to re-use this heat include: • heating of water for facilities external to the ICT site; • heating of spaces within premises containing the ICT site but not associated with the ICT site (e.g. general offices); • heating of other premises (commercial or residential) either directly or indirectly (via combined heat and power systems); • heating of spaces supporting the operation of the ICT site (e.g. pre-heating of diesel generators or heating offices accommodating ICT site personnel) or converting heat to provide. ETSI ETSI TS 105 200-3-1 V1.2.1 (2019-12) 13 NOTE 2: Energy reused for these purposes (internal to the ICT site) contributes to a reduction in KPIEC and KPITE but is not counted in KPIREUSE. A simple comparison between KPIREUSE and Energy Reuse Factor of CENELEC EN 50600-4-6 [i.3] is provided in Annex A. |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.2.3.3.2 Measurement | KPIREUSE can only be assessed and included in subsequent calculation and presentation of KPIDCEM if the energy re-used is measurable at the intended point of delivery i.e. any losses in the delivery system shall not be included. In addition to the text of ETSI EN 305 200-3-1 [2] it should be noted that losses in the system delivering the energy to be re-used are not to be included in ECREUSE. |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.2.3.4 Renewable energy | |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.2.3.4.1 Objective | ETSI EN 305 200-3-1 [2] and the present document support the use of renewable energy as a secondary objective. KPIREN is the ratio of energy consumption from renewable sources to the total energy consumption of the ICT site. It is a dimensionless number. A simple comparison between KPIREN and Renewable Energy Factor of CENELEC EN 50600-4-3 [i.2] is provided in Annex A. |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.2.3.4.2 Measurement | Only the sources contributing to KPIEC will be taken into account, whether dedicated or shared. KPIREN takes account of renewable energy that is produced by: a) sources dedicated to and directly serving an ICT site; b) sources (an ICT site or generator) under common governance with the ICT site(s) they serve and from which it is conveyed by the utility (grid) serving an ICT site or ICT sites in the group defined for the application of the KPIEM. In the case of b): • the renewable energy shall not be included within KPIREN of the recipient site if it is already included in the proportion of "green" energy within the energy mix of the utility (grid) supplied to the ICT site as defined in European standards or other international schemes; NOTE: Any proportion in the mix of utility electricity supplies certified as "renewable" (e.g. based on the carbon footprint of the energy source) by electricity suppliers or in accordance with nationally recognized schemes is not recognized by the present document. • the portion of such energy allocated to the recipient ICT site added to other ICT site consumptions shall not exceed the overall energy consumption by the ICT site. |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.3 Energy management trends | The Global KPI, KPIDCEM, is primarily intended to indicate the success of a defined energy management policy, independent of the site or location under consideration. The use of bands as described in clause 6 does not generally allow the trend analysis but the reporting (see clause 7) of the Objective KPIs and the relevant weightings does allow the trend analysis to be applied to those parameters. ETSI ETSI TS 105 200-3-1 V1.2.1 (2019-12) 14 |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 4.4 Energy management practices | An increase in either KPITE or KPIREN represents an improvement in energy management of the ICT sites - although individual improvements of KPITE and KPIREN are not comparable. Requirements and recommendations in relation to the improvement of the energy management of ICT sites are contained within ETSI EN 305 174-2 [i.4] and ETSI TS 105 174-2 [i.5]. |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 5 Data collection | |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 5.1 General | Measurement points and procedures have been described in detail in ETSI EN 305 200-3-1 [2]. However, there are some cases where these are difficult to apply either because of scale or lack of instrumentation. This clause describes the methods and restrictions that apply in such cases. |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 5.2 Estimated measurements | |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 5.2.1 Large groups of ICT sites | While in large ICT sites, measurement of energy consumption is easy using a small number of meters as described in ETSI EN 305 200-3-1 [2], the measurement of consumption in large groups of smaller ICT sites would be costly with regard to the number of counters to be implemented. Objective KPIs for such a group of ICT sites shall be derived from measurements of a number of fully instrumented representative sites. For each existing ICT site configuration, a number of sites shall be selected so as to be statistically representative and then to derive the total estimate of consumptions. The estimated statistical accuracy shall be specified. |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 5.2.2 Power measurements | Power consumption measurements can only be accepted as a palliative solution as compared to energy consumption measurements. This is because such measurements are periodic samples, typically obtained technician visits, and are less dependable than continuous energy consumption measurements which integrate over time the actual behaviour of the ICT site. The resulting KPITE shall not be used as a valid measurement for public disclosure. However, they can be used for evaluation and trend analysis on a private basis. To be as accurate as possible, power consumption measurements should be made daily (as a minimum) and: • at the lowest and highest ambient temperatures; • at the lowest and highest load (at extremes of data traffic where the predominant ICT equipment load comprises NTE). ETSI ETSI TS 105 200-3-1 V1.2.1 (2019-12) 15 |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 6 Weighting and banding constants | |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 6.1 The use of weighting factors to reflect policy objectives | In general, the Global KPIs of the ETSI EN 305 200 series [1] are designed to measure or map the performance of a infrastructure of broadband deployment to a specific policy, normally created by its owner or a third party, with regard to energy management. The present document supports ETSI EN 305 200-3-1 [2] which specifies KPIDCEM as the presentation of two separate Objective KPIs (KPIEC and KPIEP) as described in clause 4.2.1. The establishment of policy objectives for energy management within KPIEM is enabled by means of defining the relative importance of its underlying Objective KPIs KPIREUSE and KPIREN by means of the weighting parameters (WREUSE , WREN) as shown in clause 4.2.1. A policy, i.e. the selection of WREUSE and WREN, may be applied to an ICT site or to a group of ICT sites and may be applied differently depending upon the type of ICT sites under consideration. For example, Table 1 indicates the application of different weighting values: • for smaller ICT sites where energy reuse is not a high priority while focussing on the provision of renewable energy; • for large ICT sites where the provision of renewable energy is a medium priority while focussing on energy reuse. Table 1: Example set of banded weighting parameters for telecommunications network operators KPIEC range WREUSE WREN ≤ 0,04 GWh 0,1 1,0 > 0,04 GWh 1 0,5 Some policies may not differentiate on the basis of KPIEC and apply a universal weighting to all ICT sites as shown in the example of Table 2. Table 2: Weighting example for policy not using KPIEC banding KPIEC range WREUSE WREN any 1,0 0,8 |
01cd6ebc349e0889678e3746d8ba2764 | 105 200-3-1 | 6.2 The use of bands for DCG and DCCLASS | ETSI EN 305 200-3-1 [2] specifies that KPIDCEM is presented as two Objective KPIs (KPIEC and KPIEM) which are classified within bands (DCG and DCCLASS respectively). This simplified description of energy management performance allows an ICT site or group of ICT sites to be easily positioned in comparison to its neighbours. There is no defined set or naming convention for the bands but example are provided in clause 6.3. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.