hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.7.17 Delete <localMulticastGroup> | This procedure shall be used for deleting an existing <localMulticastGroup> resource. Table 10.2.7.17-1: <localMulticastGroup> DELETE <localMulticastGroup> DELETE Information in Request message From: Identifier of the CSE that initiates the Request. To: The address of the <localMulticastGroup> resource. Processing at Originator before sending Request According to clause 10.1.5. Processing at Receiver Besides the basic procedures described in clause 10.1.5, the receiver shall also comply with the multicast management protocol such as MLD or IGMP to leave the multicast group. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response None. Exceptions According to clause 10.1.5. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 368 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8 Device management | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.1 Introduction | This clause describes the procedures for managing device capabilities on MNs (e.g. M2M Gateways), ASNs and ADNs (e.g. M2M Devices), as well as devices that reside within an M2M Area Network. Resources maintaining information and relationships that are specific to Device Management are termed Device Management Resources. This clause details the creation, retrieval, update and deletion of the information associated with the following Device Management Resources: <node>, <mgmtObj>, <mgmtCmd> and its child resource <execInstance>. These operations are used in both Device Management options available in oneM2M: one utilizing existing technology protocols (e.g. BBF TR-069 [i.2], OMA-DM [i.3], and LWM2M [i.4]) and another utilizing the native oneM2M protocols. Clause 6.2.4 details the Device Management (DMG) CSF supporting this functionality. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.2 Node management | This clause describes node management procedures over Mca and Mcc reference points, using the <node> resource which represents information about M2M Nodes that can be utilized in Device Management and other operations. M2M Nodes represented by the <node> resource are: MN-CSE, ASN-CSE, ADN and NoDN. Zero, one or more <node> resources may be used to represent each M2M Node, as follows: • A <node> resource representing a MN-CSE or an ASN-CSE is hosted by the represented CSE or the registrar CSE. The hostedCSELink attribute of the resource allows to find the <CSEBase> or <remoteCSE> resource representing the MN-CSE or ASN-CSE represented by the <node> resource. All <node> resources hosted on M2M Node's CSE may be announced to associated IN-CSEs. • A <node> resource representing an ADN is hosted by the registrar CSE. The hostedAELink attribute of the resource allows to find the <AE> resources representing the AEs residing on the node ADN. • A <node> resource representing a NoDN is hosted by a CSE with DMG capabilities used to perform Device Management operations on the NoDN. If the NoDN is an interworked device, the hostedServiceLink attribute of the resource allows to find the <flexContainer> resources representing the services hosted on the NoDN. An entity co-located with a CSE on an ASN or MN which is managed using oneM2M Device Management shall be represented by the same <node> resource |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.3 Create <node> | This procedure shall be used for creating a <node> resource. NOTE: The creation of the <node> resource is on discretion of the Originator. Table 10.2.8.3-1: <node> CREATE <node> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The representation of the <node> resource described in clause 9.6.18. The following attributes from clause 9.6.18 are mandatory for the request: • resourceType which shall be set to the appropriate tag that identify the <node> resource as defined in clause 9.6.1.3. Processing at Originator before sending Request According to clause 10.1.2. Processing at Receiver According to clause 10.1.2. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: • Content: Address of the created <node> resource, according to clause 10.1.2. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 369 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.4 Retrieve <node> | This procedure shall be used for retrieving the attributes of a <node> resource. Table 10.2.8.4-1: <node> RETRIEVE <node> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: Void. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: Attributes of the <node> resource as defined in clause 9.6.18. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.5 Update <node> | This procedure shall be used for updating the attributes and the actual data of a <node> resource and its child resources. Table 10.2.8.5-1: <node> UPDATE <node> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: attributes of the <node> resource as defined in clause 9.6.18 which need be updated, with the exception of the Read Only (RO) attributes cannot be modified. Processing at Originator before sending Request According to clause 10.1.4. Processing at Receiver According to clause 10.1.4 with the following: • The Receiver shall check whether the provided attributes of the <node> resource represent a valid request for updating <node> resource Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.6 Delete <node> | This procedure shall be used for deleting an existing <node> resource. Table 10.2.8.6-1: <node> DELETE <node> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply. Processing at Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions According to clause 10.1.5. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 370 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.7 Device management using <mgmtObj> | This clause describes the management procedures over Mca and Mcc reference points. If technology specific protocols are used for management, different operations addressing a <mgmtObj> resource (or its attributes or child resources) shall be translated by IN-CSE or MN-CSE into technology specific requests performed on the mapped technology specific data model object on the managed entity. In this case, the <mgmtObj> resources are hosted on the IN-CSE or MN-CSE. Although management requests by the AE are agnostic to the technology specific protocol, the <mgmtObj> resource exposes information about the technology specific protocol. AEs have the capability to retrieve this information within the objectIDs attribute of the <mgmtObj> resource. In the scenario where the <mgmtObj> resource does not utilize an external management technology but instead uses the M2M Service Layer to perform the management request, the <mgmtObj> resource is hosted on the CSE of the managed entity when the managed entity is an ASN, MN or IN. If the managed entity is an ADN node or the managed entity is co-located on an ASN, MN or IN, the <mgmtObj> resource is hosted on the registrar CSE of the managed entity. The <mgmtObj> resource and its parent <node> resource hosted on node's CSE may be announced to associated IN-CSEs. In the scenario where the managed entity is an NoDN, the managed entities' <mgmObj> resources are hosted by a CSE with DMG capabilities used to perform Device Management operations on the NoDN. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.8 Create <mgmtObj> | This procedure shall be used to create a specific <mgmtObj> resource in the Hosting CSE to expose the corresponding management function of a managed entity (i.e. M2M Device/Gateway) over the Mca reference point. Depending on the data model being used, the created <mgmtObj> resource may be a partial or complete mapping from the technology specific data model object on the managed entity. If such a technology specific data model object is missing from the managed entity, it shall be added to the managed entity. Further operations performed on the created <mgmtObj> resource shall be converted by the Hosting CSE into a corresponding technology specific request performed on the mapped technology specific data model object on the managed entity using technology specific protocol (e.g. OMA-DM [i.3] or BBF TR-069 [i.2]). Besides the generic create procedure defined in clause 10.1.2, the procedure in table 10.2.8.8-1 shall be used when management is performed using technology specific protocols. If the management is performed by service layer entities, the procedure is the same as generic create procedure defined in clause 10.1.2. In this case, local APIs (drivers) on the managed entity is required to monitor the change of the <mgmtObj> resource and reflect the change to the managed entity. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 371 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.8.8-1: <mgmtObj> CREATE <mgmtObj> CREATE Information in Request message From: Identifier of the AE or the CSE that initiates the Request. To: The address of the <node> where the <mgmtObj> resource is intended to be Created. Content: The representation of the <mgmtObj> resource for which the attributes are described in clause 9.6.15. Processing at Originator before sending Request The Originator shall be an AE, or a CSE: • The Originator is a CSE: In this case, the CSE first collects the original technology specific data model object (the management tree structure or also the value of the tree nodes if needed) of the local device and transforms the object into the <mgmtObj> resource representation, then requests the Hosting CSE to create the corresponding <mgmtObj> resource. • The Originator is an AE: In this case, the AE requests the Hosting CSE to add the corresponding technology specific data model object to the managed entity by creating an <mgmtObj> resource in the Hosting CSE. (See notes 1 and 2) Processing at Receiver For the CREATE operation, besides the common create operation defined in clause 10.1.2, the Receiver shall: • If the Originator is an AE: Check if there is existing management session between the management server and the managed entity. If not, request the management server to establish a management session towards the managed entity. Send the technology specific request to the managed entity or to the management server to add the corresponding technology specific data model object to the managed entity based on technology specific protocol. • Maintain the mapping relationship between the created <mgmtObj> resource and the technology specific data model object on the managed entity. • Respond to the Originator with the appropriate responses based on the technology specific response. It shall also provide in the response the address of the created new resource. Information in Response message Error code if the new technology specific data model object is not created Processing at Originator after receiving Response None Exceptions • The creation of the technology specific data model object is not allowed. • The created technology specific data model object already exists. • Corresponding technology specific data model object cannot be added to the managed entity for some reason (e.g. not reachable, memory shortage). NOTE 1: The CSE can create the <mgmtObj> resource locally by itself. The details are out of scope. In this case, the Hosting CSE first collects the original technology specific data model object on the managed entity via technology specific protocol (e.g. OMA DM [i.3], BBF TR-069 [i.2] or LWM2M [i.4]), then transforms the object into the <mgmtObj> resource representation and create the <mgmtObj> resource locally in the CSE. NOTE 2: The <mgmtObj> resource can be created in the Hosting CSE by other offline provisioning means which are out of scope. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.9 Retrieve <mgmtObj> | This procedure shall be used to retrieve information from an existing <mgmtObj> resource. Besides the generic retrieve procedure defined in clause 10.1.3, the procedure in table 10.2.8.9-1 shall be used when management is performed using technology specific protocols. If the management is performed by service layer entities, the procedure is the same as generic retrieve procedure defined in clause 10.1.3. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 372 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.8.9-1: <mgmtObj> RETRIEVE <mgmtObj> RETRIEVE Information in Request message From: Identifier of the AE or the CSE that initiates the Request. To: The address of the <mgmtObj> resource. Processing at Originator before sending Request None. Processing at Receiver For the RETRIEVE operation, besides the common retrieve operation defined in clause 10.1.3, the Receiver shall: • If the Originator is an AE and if the requested information of the <mgmtObj> resource is not available, identify the corresponding technology specific data object on the managed entity according to the mapping relationship that the CSE maintains. Check if there is an existing management session between the management server and the managed entity. If not, request the management server to establish a management session towards the managed entity. Send the technology specific request to get the corresponding technology specific data model object from the managed entity based on the external management technology, then return the result to the Originator based on the technology specific response. Information in Response message Error code if the new technology specific data model object cannot be retrieved. Processing at Originator after receiving Response None. Exceptions • Corresponding technology specific data model object data cannot be retrieved from the managed entity (e.g. technology specific data model object not found). |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.10 Update <mgmtObj> | This procedure shall be used to update information of an existing <mgmtObj> resource. Besides the generic update procedure defined in clause 10.1.4, the procedure in table 10.2.8.10-1 shall be used when management is performed using technology specific protocol. If the management is performed by service layer entities, the procedure is the same as generic update procedure defined in clause 10.1.4. In this case, local APIs (drivers) on the managed entity is required to monitor the change of the <mgmtObj> resource and reflect the change to the managed entity. Table 10.2.8.10-1: <mgmtObj> UPDATE <mgmtObj> UPDATE Information in Request message From: Identifier of the AE or the CSE that initiates the Request. To: The address of the <mgmtObj> resource. Content: The representation of the <mgmtObj> resource for which the attributes are described in clause 9.6.15. Processing at Originator before sending Request None. Processing at Receiver For the UPDATE operation, besides the common update operation defined in clause 10.1.4, the Receiver shall: • If the Originator is an AE, identify the corresponding technology specific data model object on the managed entity according to the mapping relationship it maintains. Check if there is an existing management session between the management server and the managed entity. If not, request the management server to establish a management session towards the managed entity. Send the technology specific request to update the corresponding technology specific data model object in the managed entity accordingly based on technology specific protocol. • Respond to the Originator with the appropriate response based on the technology specific response from the external management technology. Information in Response message Error code if the technology specific data model object cannot be updated. Processing at Originator after receiving Response None. Exceptions • Corresponding technology specific data model object cannot be updated to managed entity (e.g. not reachable, technology specific data model object not found). ETSI ETSI TS 118 101 V4.15.0 (2022-09) 373 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.11 Delete <mgmtObj> | This procedure shall be used to delete an existing <mgmtObj> resource. An Originator uses this procedure to remove the corresponding technology specific data model object (e.g. an obsolete software package) from the managed entity. Besides the generic delete procedure defined in clause 10.1.5, the procedure in table 10.2.8.11-1 shall be used when management is performed using external management technologies. If the management is performed by service layer entities, the procedure is the same as generic delete procedure defined in clause 10.1.5. In this case, local APIs (drivers) on the managed entity is required to monitor the change of the <mgmtObj> resource and reflect the change to the managed entity. Table 10.2.8.11-1: <mgmtObj> DELETE <mgmtObj> DELETE Information in Request message From: Identifier of the AE, or the CSE that initiates the Request. To: The address of the <mgmtObj> resource. Processing at Originator before sending Request The Originator shall be an AE or CSE: • The Originator is a CSE: In this case, the CSE issues the request to the Hosting CSE to hide the corresponding management function from being exposed by the <mgmtObj> resource. • The Originator is an AE: In this case, the AE requests the Hosting CSE to delete the <mgmtObj> resource from the Hosting CSE and to remove the corresponding technology specific data model object from the managed entity. (See notes 1 and 2) Processing at Receiver For the DELETE operation, besides the common create operation defined in clause 10.1.5, the Receiver shall: • If the Originator is an AE, identify the corresponding technology specific data model object on the managed entity according to the mapping relationship the CSE maintains. Check if there is an existing management session between the management server and the managed entity. If not, request the management server to establish a management session towards the managed entity. The CSE sends technology specific request to remove the corresponding technology specific data model object from the managed entity based on technology specific protocol. • Respond to the Originator with the appropriate generic responses based on the technology specific response. Information in Response message Error code if the technology specific data model object cannot be deleted. Processing at Originator after receiving Response None. Exceptions • Corresponding technology specific data model object cannot be deleted from managed entity (e.g. not reachable, technology specific data model object not found). NOTE 1: The Hosting IN-CSE can delete the <mgmtObj> resource locally by itself. This internal procedure is out of scope. NOTE 2: The <mgmtObj> resource can be deleted in the Hosting CSE by offline provisioning means which are out of scope. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.12 Execute <mgmtObj> | This procedure shall be used to execute a technology specific requests on a managed entity through an existing <mgmtObj> resource on the Hosting CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 374 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.8.12-1: <mgmtObj> EXECUTE <mgmtObj> EXECUTE Information in Request message From: Identifier of the AE, or the CSE that initiates the Request. To: The address of the <mgmtObj> resource. Processing at Originator before sending Request The Originator shall be an AE or a CSE. The Originator shall request to execute a management command which is represented by a <mgmtObj> resource or its attribute by using an UPDATE operation. The request shall address the executable <mgmtObj> resource. For an execute operation on an attribute(s), the Content parameter shall be included with the name of such attribute(s) with predefined value(s) to trigger the respective action. After the execution request, the Originator shall request to retrieve the execution result or status from the executable <mgmtObj> resource or its attribute/child resource by using a RETRIEVE operation as specified in clause 10.2.8.9. Processing at Receiver For the EXECUTE operation, the Receiver shall: • Check if the Originator has the WRITE privilege on the addressed <mgmtObj> resource or its attribute. • Check if there is an existing management session between the management server and the managed entity. If not, request the management server to establish a management session towards the managed entity. Send the technology specific request to execute the corresponding management command (e.g. "Exec" in OMA DM [i.3]) on the managed entity based on technology specific protocol. • Respond to the Originator with the appropriate response based on the technology specific response. If available, the technology specific response shall contain execution results. • Retrieve the execution result or status from the executable <mgmtObj> resource or its attribute, perform the procedures as described in clause 10.2.8.9. • Upon receiving a management notification (e.g. OMA-DM [i.3] "Generic Alert" message or BBF TR-069 [i.2] "Inform" message) from a managed entity regarding the execution result or status, the Receiver shall send the technology specific request to retrieve the execution result or status of the technology specific data model object information received from the managed entity and update the corresponding <mgmtObj> resource or its attribute. Information in Response message Error code if the technology specific request cannot be executed. Processing at Originator after receiving Response None. Exceptions • Corresponding technology specific request cannot be executed in managed entity (e.g. not reachable, technology specific data model object not found). |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.13 Device management using <mgmtCmd> and <execInstance> | This clause describes how RESTful management operations may be performed using <mgmtCmd> resources over the Mca and Mcc reference points. The <mgmtCmd> resource, together with its attributes or sub-resources, may be used in the process of translating between RESTful operations and management commands and procedures from existing management technologies (e.g. BBF TR-069 [i.2]). These procedures can then be performed on the managed entity, using the Management Adapter and the procedures described in the following clauses. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.14 Create <mgmtCmd> | A CREATE request shall be used by an Originator to create a specific <mgmtCmd> resource in a Hosting CSE. The created <mgmtCmd> resource will be mapping a RESTful method to management commands and/or procedures which may be translated from existing management protocols (e.g. BBF TR-069 [i.2]). At run-time the Hosting CSE can expose the translated commands, over the Mcc reference point, to the managed entities (i.e. ASN/MN-CSE). The Originator may be: • An AE registered to the IN-CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 375 (oneM2M TS-0001 version 4.15.0 Release 4) • The CSE on the managed entity: In this case, the CSE transforms supported management command into the <mgmtCmd> resource representation, then requests the Hosting CSE to create the corresponding <mgmtCmd> resource. NOTE 1: The Hosting IN-CSE in the network domain may also create the <mgmtCmd> resource locally by itself. The details are out of scope. Then an AE can discover the created <mgmtCmd> and manipulate it. NOTE 2: The <mgmtCmd> resource could also be created in the Hosting CSE by other offline provisioning means which are out of scope. The Receiver shall be an IN-CSE. Table 10.2.8.14-1: <mgmtCmd> CREATE <mgmtCmd> CREATE Information in Request message The attributes of the <mgmtCmd> resource. The mandatory and/or optional attributes defined in clause 9.6.16, as needed. Processing at Originator before sending Request According to clause 10.1.2 with the following: • The CSE on the originating node shall first collect local management command. Processing at the Receiver According to clause 10.1.2 with the following: • The Receiver CSE shall maintain the mapping between the created <mgmtCmd> resource and the corresponding nonRESTful commands represented by the cmdType attribute of <mgmtCmd> resource. Information in Response message According to clause 10.1.2 with the following specific information: • Content: Address of created <mgmtCmd> resource. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.15 Retrieve <mgmtCmd> | This procedure shall be used for retrieving all or part information from a previously created <mgmtCmd> resource on a target CSE. The Originator may be: • An AE. • A CSE. The Receiver shall be an IN-CSE. Table 10.2.8.15-1: <mgmtCmd> RETRIEVE <mgmtCmd> RETRIEVE Information in Request message According to clause 10.1.3, with the mandatory and/or optional attributes defined in clause 9.6.16, as needed. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message According to clause 10.1.3. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.16 Update <mgmtCmd> | This procedure shall be used for updating some of the attributes (other than execEnable) of an existing <mgmtCmd> resource with new attribute values. An UPDATE method applied to the execEnable attribute is used to trigger the execution of the management procedure represented by <mgmtCmd>, as described in clause 10.2.8.18. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 376 (oneM2M TS-0001 version 4.15.0 Release 4) The Originator may be: • An AE. • A CSE. The Receiver shall be an IN-CSE. Table 10.2.8.16-1: <mgmtCmd> UPDATE <mgmtCmd> UPDATE Information in Request message According to clause 10.1.4, including mandatory and/or optional attributes defined in clause 9.6.16, as needed. Processing at Originator before sending Request According to clause 10.1.4. Processing at Receiver According to clause 10.1.4. Information in Response message According to clause 10.1.4. Processing at the Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.17 Delete <mgmtCmd> | This procedure shall be used for deletion of an existing <mgmtCmd> resource on a Hosting CSE. An AE may also use this procedure to cancel any initiated <execInstance> of an <mgmtCmd> if applicable. The Originator may be: • The CSE on the manageable entity: In this case, the CSE issues the request to the Hosting CSE to hide the corresponding management command from being exposed by the <mgmtCmd> resource. • An AE: In this case, the AE requests the Hosting CSE to delete the <mgmtCmd> resource from the Hosting CSE and cancel all initiated <execInstance> of an <mgmtCmd> if applicable. NOTE 1: The Hosting CSE in the network domain could also delete an <mgmtCmd> resource locally by itself. This internal procedure is out of scope. NOTE 2: The <mgmtCmd> resource could also be deleted in the Hosting CSE by other offline provisioning means which are out of scope. If the Originator is an AE and there is any initiated <execInstance> under the <mgmtCmd> that can be cancelled by a corresponding management command. The Hosting CSE shall also issue the management command to the managed entity to cancel those initiated <execInstance> based on existing management protocol (i.e. BBF TR-069 [i.2]). Then the CSE shall respond to the Originator with the appropriate generic responses. The Receiver shall be an IN-CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 377 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.8.17-1: <mgmtCmd> DELETE by ASN-CSE or MN-CSE <mgmtCmd> DELETE by ASN-CSE or MN-CSE Information in Request message According to clause 10.1.5. Processing at Originator before sending Request According to clause 10.1.5 with the following: • Before issuing a DELETE request to the IN-CSE, the originating CSE may perform cancelling of the corresponding management command locally. Processing at Receiver According to clause 10.1.5 with the following: • The Receiver IN-CSE shall verify if there are any initiated <execInstance> commands under the <mgmtCmd> which are cancellable by using a corresponding management command. If there are, the Receiver IN-CSE shall issue the management command to the managed entity to cancel those initiated <execInstance> based on existing management protocol (i.e. BBF TR-069 [i.2]). • The <mgmtCmd> resource shall be deleted from the repository of the Receiver IN-CSE. • Then the Receiver IN-CSE shall respond to the Originator ASN-CSE or MN-CSE with the appropriate responses. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions According to clause 10.1.5 with the following: • If the deletion is not allowed or the specific <mgmtCmd> resource does not exist, there is no local processing in the Receiver IN-CSE and a proper error code shall be returned to the Originator ASN-CSE or MN-CSE. • If the corresponding initiated commands cannot be deleted from the managed entity due to some reason (e.g. not found) a response with the proper indication shall be returned to the Originator ASN-CSE or MN-CSE. Table 10.2.8.17-2: <mgmtCmd> DELETE by an AE <mgmtCmd> DELETE by an AE Information in Request message According to clause 10.1.5. Processing at the Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5 with the following: • If there is any initiated <execInstance> under <mgmtCmd> and it is cancellable, the Receiver IN-CSE shall cancel those initiated <execInstance> from the managed entity using corresponding management procedures in existing management protocol (i.e. CancelTransfer RPC in BBF TR-069 [i.2]). • The <mgmtCmd> resource shall be deleted from the repository of the Receiver IN-CSE. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions According to clause 10.1.5 with the following: • If the deletion is not allowed or the specific <mgmtCmd> resource does not exist, there is no local processing in the Receiver IN-CSE and a proper error code shall be returned to the Originator AE. • If the corresponding initiated commands cannot be deleted from managed entity due to some reason (e.g. not found) a response with the proper indication shall be returned to the Originator AE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 378 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.18 Execute <mgmtCmd> | The Execute procedure shall be used by an Originator in order to trigger execution of a specific management command on a managed entity, by employing an UPDATE method to the execEnable attribute of an existing <mgmtCmd> resource on the Hosting CSE. The Originator shall be an AE. The Receiver shall be an IN-CSE. Table 10.2.8.18-1: <mgmtCmd> EXECUTE <mgmtCmd> EXECUTE Information in Request message According to clause 10.1.4, with the following (see attributes defined in clause 9.6.16): • The UPDATE request shall address the execEnable attribute with a predefined value to trigger the EXECUTE action. Processing at the Originator before sending Request According to clause 10.1.4, with the following: After issuing the execution request, the Originator may request to retrieve the execution result or status from <execInstance> sub-resources of the <mgmtCmd>by using a RETRIEVE method as described in clause 10.2.8.20. Processing at the Receiver According to clause 10.1.4 with the following: • The Receiver shall check if the Originator has the UPDATE privilege on the addressed <mgmtCmd> resource. Upon successful validation, the Hosting CSE shall perform command conversion and mapping, and send the converted management command to execute with the provided arguments on the remote entity based on existing device management protocol (i.e. BBF TR-069 [i.2]). • Then the Hosting CSE shall create for each target a corresponding <execInstance> resource under <mgmtCmd> and shall respond to the Originator with the appropriate generic responses. It shall also provide in the response the URL of the created <execInstance> resource. • If the execTarget attribute of the addressed <mgmtCmd> addresses a group, the Hosting CSE shall create corresponding <execInstance> resources for each target in the group and provide the corresponding URLs in the response. • Upon receiving from any remote entity, a management notification (i.e. BBF TR-069 [i.2] "Inform" message) regarding the execution result or status, the Hosting CSE may update the corresponding <execInstance> sub- resource locally. Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response According to clause 10.1.4, with additional processing which is dependent on the type of the command and execution status. The following actions may occur in any order after the command execution is finished: • The managed entity may send responses including execution results to the Receiver CSE, who will store the execution results in corresponding <execInstance> resource. • The Originator AE may use normal RETRIEVE procedure to retrieve the execution results or status of an <execInstance>. After receiving a RETRIEVE request from the Originator AE, the Receiver CSE can retrieve the execution status or results on the managed entity using existing management protocol. • A response shall be returned to the Originator AE. Exceptions • If the execution is not allowed or the specified <mgmtCmd> resource does not exist, no further processing is required on the Receiver CSE, and a proper error code shall be returned to the Originator AE in the message response. • If the corresponding management command cannot be executed on the managed entity, an error code shall be returned with the response to Originator AE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 379 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.19 Cancel <execInstance> | The Cancel procedure shall be used by an originating AE to disable/stop/cancel an initiated management command execution on the remote entity, through an UPDATE method to the execDisable attribute of an existing <execInstance> resource on the Hosting CSE. The Originator shall be an AE. The Receiver shall be an IN-CSE. Table 10.2.8.19-1: <execInstance> CANCEL <execInstance> CANCEL Information in Request message According to clause 10.1.4, with the following (see attributes defined in clause 9.6.17): The UPDATE request shall address the execDisable attribute with a predefined value in order to trigger the CANCEL action. Processing at the Originator before sending Request Originator needs to disable/stop/cancel an initiated management command execution on the managed entity using an <execInstance> sub-resource at the Receiver, by using an UPDATE operation. See also clause 10.1.4. Processing at Receiver The Receiver shall check if the Originator has the UPDATE privilege on the addressed <execInstance> resource. Then, the Receiver shall check if the management operation is initiated and cancellable. Upon successful validation, the Receiver IN-CSE shall perform command conversion and mapping, then use existing management protocol (i.e. BBF TR-069 [i.2]) to cancel the corresponding management command execution initiated on the managed entity. The Receiver IN-CSE shall respond to the Originator with the appropriate responses. Information in Response message According to clause 10.1.4. Processing at Originator after receiving ResponsePost- According to clause 10.1.4. Exceptions • If the <execInstance> has not been initiated, is already complete or it is not cancellable, or the specified <execInstance> resource does not exist in the Receiver IN-CSE, the post processing on Receiver CSE shall be skipped and a proper error code shall be returned to Originator in the Response message. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.20 Retrieve <execInstance> | This procedure shall be used for retrieving all or part information from an <execInstance> resource on a target CSE. The Originator shall be an AE. The Receiver shall be an IN-CSE. Table 10.2.8.20-1: <execInstance> RETRIEVE <execInstance> RETRIEVE Information in Request message According to clause 10.1.3, with the mandatory and/or optional attributes defined in clause 9.6.17, as needed. Processing at the Originator before sending Request Originator needs to create a resource. Processing at Receiver According to clause 10.1.3, with the following: • If the retrieval is allowed, the Receiver IN-CSE can retrieve the execution status or results on the managed entity using existing management protocol (i.e. BBF TR-069 [i.2]). • If the retrieval is allowed, the addressed attributes of the <execInstance> resource shall be retrieved from the repository of the Receiver IN-CSE. Information in Response message According to clause 10.1.3. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 380 (oneM2M TS-0001 version 4.15.0 Release 4) <execInstance> RETRIEVE Processing at Originator after receiving Response According to clause 10.1.3. Exceptions If the retrieval is not allowed or the specific <execInstance> resource does not exist in the Receiver IN-CSE, there is no local processing on the Receiver CSE and a proper error code shall be returned to Originator AE in the Response Message. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.8.21 Delete <execInstance> | The DELETE request procedure shall be used by an originating AE to delete an existing <execInstance> resource on a Receiver IN-CSE. The Originator shall be an AE. NOTE 1: The Receiver IN-CSE in the network domain could also delete an <execInstance> resource locally by itself. This internal procedure is out of scope. NOTE 2: The <execInstance> resource could also be deleted in the Receiver IN-CSE by other offline provisioning means which are out of scope. Receiver: The Receiver shall check if the Originator has the DELETE permission on the addressed <execInstance> resource. Upon successful validation, the Hosting CSE shall remove the resource from its repository. If a corresponding management command has been initiated and is pending finished on the managed entity and the management command is cancellable, the Hosting CSE shall use existing management protocols (i.e. BBF TR-069 [i.2] CancelTransfer RPC) to cancel the corresponding management currently initiated at the managed entity. Then the CSE shall respond to the Originator with the appropriate generic responses. The Hosting CSE shall be an IN-CSE. Table 10.2.8.21-1: <execInstance> DELETE <execInstance> DELETE Information in Request message According to clause 10.1.5. Processing at the Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5 with the following: • If the <execInstance> has not been initiated, is already complete or it is not cancellable, the <execInstance> resource shall be deleted from the repository of the IN-CSE. • If the <execInstance> is pending and it is cancellable, the Receiver IN-CSE shall first cancel the <execInstance> from the managed entity using corresponding management procedures in existing management protocol (i.e. CancelTransfer RPC in BBF TR-069 [i.2]). Afterwards, the <execInstance> resource shall be deleted from the repository of the Receiver IN-CSE. • If the corresponding initiated commands cannot be successfully cancelled on the managed entity for some reason, the <execInstance> resource shall be still deleted. • Then the Receiver IN-CSE shall respond to the Originator with the appropriate generic responses. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions If the deletion is not allowed or the specific <execInstance> resource does not exist on the Receiver IN-CSE, there is no processing at the Receiver and a proper error code shall be returned to the Originator. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 381 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.9 Location management | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.9.1 Introduction | This clause introduces the procedures for obtaining and managing a target M2M Node's location information, which are associated with the <locationPolicy> resource that contains the method for obtaining and managing location information. Since the actual location information of a target M2M Node shall be stored in the <contentInstance> resource as per the configuration described in the associated <locationPolicy> resource, this clause introduces the procedures related to the <contentInstance> and <container> resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.9.2 Create <locationPolicy> | This procedure shall be used for creating a <locationPolicy> resource. Table 10.2.9.2-1: <locationPolicy> CREATE <locationPolicy> CREATE Information in Request message From: Identifier of the AE or the CSE that initiates the Request. To: the address of the <CSEBase> resource. Content: The representation of the <locationPolicy> resource described in clause 9.6.10. Processing at Originator before sending Request According to clause 10.1.2. Processing at Receiver • Check whether the Originator is authorized to request the procedure. • Check whether the provided attributes of the <locationPolicy> resource represent a valid Request. • Upon successful validation of the above procedures, the Hosting CSE creates a <container> resource and a <locationPolicy> resource. Both of these resources shall be hosted locally on the Hosting CSE. The Hosting CSE shall maintain cross- references between both resources: locationContainerID attribute for <locationPolicy> resource and locationID attribute for <container> resource. • Check the defined locationSource attribute to determine which method is used. The locationSource attribute shall be set based on the capabilities of a target M2M Node, the required location accuracy of the Originator and the Underlying Network in which a target M2M Node resides: - For the Network-based case, if the locationServer is absent in the Originator's request the Hosting CSE shall either derive the locationServer value from the locationTargetID or be pre-provisioned with the identity of a locationServer. The Hosting CSE shall transform the request, from the Originator into a Location Server request that includes the following attributes locationTargetID, locationServer, authID that are defined in the <locationPolicy> resource. Additionally, the Hosting CSE shall also provide default values for other parameters (e.g. required quality of position) in the Location Server request [i.5] according to local policies. If the request which requests the location information of the target device towards the Location Server crosses over the Mcn reference point, then the Location Server in the Underlying Network verifies whether the external entity is authorized to request the location information, and only if the AE is permitted, the Location server performs positioning procedures, and returns the successful results over the Mcn reference point. - The specific mechanism used to communicate with the network Location Server depends on the capabilities of the Underlying Network and other factors. For example, it could be either the OMA Mobile Location Protocol [i.5] or OMA RESTful NetAPI for Terminal Location [i.6]. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 382 (oneM2M TS-0001 version 4.15.0 Release 4) <locationPolicy> CREATE Check the assigned locationInformationType attribute and if the value of this attribute is Geo-fence event, following the steps below: The Hosting CSE shall check the target Node's capability (Positionable, Non-Positionable or both) by retrieving the stored <node> resource or <mgmtCmd> procedure(e.g. checking the Node's capability through RPC-based procedure) and the Hosting CSE shall create <mgmtCmd> resource type with appropriate configuration based on the node capability and attributes stored in the created <locationPolicy> resource (e.g. locationUpdatePeriod attribute of <locationPolicy> to execFrequency attribute of <mgmtCmd>) to obtain the Geo-fence relevant information (e.g. measurement or position fix) from the target Node. The node shall respond the information and the Hosting CSE shall create <execInstance> resource type as a placeholder for the information. The Hosting CSE shall forward this information to Geo-Fence Server (refer to locationServer attribute) and returns the results (e.g. event type) over the Mcn reference point. The result shall be stored in the created <container> resource as explained in clause 10.2.9.6. (See note) - For the Device-based case, this case is applicable if the Originator is ASN- AE and the ASN has location determination capabilities (e.g. GPS). The Hosting CSE is capable of performing positioning procedure using the module or technologies. For example, if the ASN has a GPS module itself, the ASN-CSE obtains the location information of Node from the GPS module through internal interfaces (e.g. System call or JNI [i.18]). The detail procedure is out-of-scope. - For the Sharing-based case, this case shall be applicable if the Originator is an ADN-AE and the Hosting CSE is MN CSE and the ADN is a resource constrained node, no location determination capabilities (e.g. GPS) and Network-based positioning capabilities. Also according to the required location accuracy of the AE, the Originator may choose this case. When the Hosting CSE receives the CREATE request and if the Hosting CSE can find the closest Node that is registered with the Hosting CSE and has location information from the Originator in the M2M Area Network, the location information of the closest Node shall be stored as the location information of the Originator, or if the Hosting CSE cannot find any closest Node or has no topology information, the location information of the Node of the Hosting CSE (MN) shall be stored as the location information of the Originator. The closest Node can be determined by the minimum hop based on the topology information stored in the <node> resource. Information in Response message The representation of the created <locationPolicy> resource. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions No change from the generic procedure. NOTE: The details of the mechanisms are addressed in the ETSI TS 118 104 [3]. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.9.3 Retrieve <locationPolicy> | This procedure shall be used for retrieving an existing <locationPolicy> resource. Originator: The Originator shall request to obtain <locationPolicy> resource information by using RETRIEVE operation. The Originator is either an AE or a CSE. Receiver: The Receiver shall check if the Originator has RETRIEVE permission on the <locationPolicy> resource. Upon successful validation, the Hosting CSE shall respond to the Originator with the appropriate responses. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 383 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.9.3-1: <locationPolicy> RETRIEVE <locationPolicy> RETRIEVE Information in Request message From: Identifier of the AE or the CSE that initiates the Request. To: The address of the target <locationPolicy> resource. Processing at Originator before sending Request None. Processing at Receiver According to clause 10.1.3. Information in Response message According to clause 10.1.3. Processing at Originator after receiving Response None. Exceptions According to clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.9.4 Update <locationPolicy> | This procedure shall be used for updating an existing <locationPolicy> resource. Originator: The Originator shall request to update attributes of an existing <locationPolicy> resource by using an UPDATE operation. The request shall address the specific <locationPolicy> resource of a CSE. The Originator may be either an AE or a CSE. Receiver: The Receiver of an UPDATE request shall check whether the Originator is authorized to request the operation. The receiver shall further check whether the provided attributes of the <locationPolicy> resource represent a valid request for updating <locationPolicy> resource. Table 10.2.9.4-1: <locationPolicy> UPDATE <locationPolicy> UPDATE Information in Request message From: Identifier of the AE or the CSE that initiates the Request. To: The address of the target <locationPolicy> resource. Content: The attributes which are to be updated. Processing at Originator before sending Request None. Processing at Receiver According to clause 10.1.4 with the following: • If the value of locationUpdatePeriod attribute is updated to 0 or NULL, the Hosting CSE shall stop periodical positioning procedure and perform the procedure when Originator retrieves the <latest> resource of the linked <container> resource. See clause 10.2.9.6 and clause 10.2.9.7 for more detail. • If the value of locationUpdatePeriod attribute is updated to bigger than 0 (e.g. 1 hour) from 0 or NULL, the Hosting CSE shall start periodical positioning procedure. Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response None. Exceptions According to clause 10.1.4. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.9.5 Delete <locationPolicy> | This procedure shall be used for deleting an existing <locationPolicy> resource. Originator: The Originator shall request to delete an existing <locationPolicy> resource by using the DELETE operation. The Originator may be either an AE or a CSE. This request can be occurred when the locationSource attribute of the created <locationPolicy> resource is "sharing-based" and the Originator is an AE that disconnects from the registered MN-CSE. Receiver: The Receiver shall check if the Originator has DELETE permission on the <locationPolicy> resource. Upon successful validation, the CSE shall remove the resource from its repository and shall respond to the Originator with appropriate responses. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 384 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.9.5-1: <locationPolicy> DELETE <locationPolicy> DELETE Information in Request message From: Identifier of the AE or the CSE that initiates the Request. To: the address of the target <locationPolicy> resource. Processing at Originator before Sending Request None. Processing at Receiver According to clause 10.1.5. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response Once the <locationPolicy> resource is deleted, the Receiver shall delete the associated resources (i.e. <container>, <contentInstance> resources). If the locationSource attribute and the locationUpdatePeriod attribute of the <locationPolicy> resource has been set with appropriate value, the Receiver shall tear down the session. The specific mechanism used to tear down the session depends on the support of the Underlying Network and other factors. Exceptions According to clause 10.1.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.9.6 Procedure for <container> resource that stores the location information | This procedure is mainly triggered by the creation of <locationPolicy> resource. Based on the defined attributes related to the <container> resource such as 'locationContainerID' and 'locationContainerName', the Hosting CSE shall create <container> resource to store the location information in its child resource, <contentInstance> resource after the CSE obtains the actual location information of a target M2M Node. If the Originator provides the 'locationContainerName' and the given 'locationContainerName' does not exist in the Hosting CSE, the Hosting CSE shall set the 'resourceName' of the created <container> resource to the 'locationContainerName' provided by the Originator. If the given 'locationContainerName' already exists in the Hosting CSE, the Hosting CSE shall respond with an error following the general exceptions written in clause 10.1.2. If the Originator does not provide the 'locationContainerName' the Hosting CSE shall provide 'resourceName' for the created <container> resource. After the creation of the <container> resource, the resourceID attribute of the resource shall be stored in the 'locationContainerID'. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.9.7 Procedure for <contentInstance> resource that stores location information | After the <container> resource that stores the location information is created, each instance of location information shall be stored in the different <contentInstance> resources. In order to store the location information in the <contentInstance> resource, the Hosting CSE firstly checks the defined locationUpdatePeriod attribute. If a valid period value is set for this attribute, the Hosting CSE shall perform the positioning procedures as defined by locationUpdatePeriod in the associated <locationPolicy> resource and stores the results (e.g. position fix and uncertainty) in the <contentInstance> resource under the created <container> resource. However, if no value (e.g. null or zero) is set and locationUpdateEventCriteria is absent, the positioning procedure shall be performed when an Originator requests to retrieve the <latest> resource of the <container> resource and the result shall be stored as a <contentInstance> resource under the <container> resource. 10.2.10 Subscription and notification |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.1 Introduction | An Originator may create a <subscription> resource as a child resource of a subscribed-to resource on a Hosting CSE in order to instruct the Hosting CSE to send notifications to the Subscriber(s) of the subscribed-to resource when the subscribed-to resource is modified. After successful <subscription> resource creation, the Hosting CSE shall notify the Subscriber(s) of a modification of the subscribed-to resource that meets conditions configured in the <subscription> resource. A subscription shall be represented by a <subscription> resource (see clause 9.6.8). This allows manipulation of the subscription in a resource oriented manner, e.g. the conditions of a subscription may be modified by modifying a <subscription> resource, or a resource subscriber may unsubscribe by deleting the <subscription> resource. The following clauses describe procedures for Creation, Retrieval, Update and Deletion of a <subscription> resource. The following clauses also describe procedures for Creation, Retrieval, Update, and Deletion of a <crossResourceSubscription> resource, and the procedure for generating cross-resource notification. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 385 (oneM2M TS-0001 version 4.15.0 Release 4) Also included is a clause that describes a procedure for a <subscription> and <crossResourceSubscription> resource Hosting CSE to record notification statistics. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.2 Create <subscription> | This procedure shall be used to request the creation of a new <subscription> resource to instruct the Hosting CSE to send notifications to configured Subscriber(s) for modifications of a subscribed-to resource. The generic create procedure is described in clause 10.1.2. Table 10.2.10.2-1: <subscription> CREATE <subscription> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.8. Processing at Originator before sending Request According to clause 10.1.2 with the following additions: The Request shall address a subscribable resource. The Request shall include a <subscription> resource representation with the attribute notificationURI. If the notificationURI attribute includes Notification Target(s) which is/are not targeting the Originator, the Originator should send the request as non-blocking request (see clauses 8.2.2 and 9.6.12). Processing at Receiver According to clause 10.1.2 with the following additions: The Hosting CSE shall validate the followings: • Check if the subscribed-to resource, addressed in the To parameter in the Request, is a subscribable resource. • Check if the Originator has privileges for retrieving the subscribed-to resource. • In case a <subscription> resource representation is provided with a notificationEventType tag equal to "Update to attributes of the subscribed-to resource with blocking of the triggering UPDATE operation" in the eventNotificationCriteria attribute, check that no other subscriptions with this setting exist for the resource in the To parameter, check that only one entity is targeted by the notificationURI attribute and check that this entity has privileges for updating the subscribed-to resource. • If the <subscription> resource representation is provided with notificationEventType tag equal to "Report on missing data points" then the missingData attribute shall be provided. • If missingData attribute is provided the subscribed-to resource shall be <timeSeries> resource. • If an entity listed in the notificationURI is not the Originator, the Hosting CSE may send a Notify request to that entity to verify this <subscription> creation request. If the Hosting CSE initiates the verification, it shall check if the verification result in the Notify response is successful or not. If any of the entities listed in the notificationURI attribute fails verification then the <subscription> create process fails. • If the <subscription> resource representation includes a primitiveProfileID attribute configured with a value and the Hosting CSE does not support primitive profile functionality, then the <subscription> resource create process fails. If any of the checks above fails, the Hosting CSE shall send an unsuccessful response to the Originator with corresponding error information. Otherwise, the Hosting CSE shall create the <subscription> resource and send a successful response to the Originator. Upon successful creation of a <subscription> resource, the Hosing CSE shall evaluate subsequent operations on the subscribed-to resource and trigger notifications in line with the notification policies provisioned in the created <subscription> resource. If the notificationStatsEnable attribute is set to TRUE, the Hosting CSE shall collect and record notification statistics as defined in clause 10.2.10.27. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: • Content: address of the created <subscription> resource, according to clause 10.1.2. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 386 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.3 Retrieve <subscription> | This procedure shall be used to retrieve attributes and child resource information of a <subscription> resource. The generic retrieve procedure is described in clause 10.1.3. Table 10.2.10.3-1: <subscription> RETRIEVE <subscription> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: void. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <subscription> resource as defined in clause 9.6.8. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.4 Update <subscription> | This procedure shall be used to update an existing subscription, e.g. extension of its lifetime or the modification of the list of Notification Targets provided in the notificationURI attribute. The generic update procedure is described in clause 10.1.4. Table 10.2.10.4-1: <subscription> UPDATE <subscription> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: attributes of the <subscription> resource as defined in clause 9.6.8 which need be updated. Processing at Originator before sending Request According to clause 10.1.4. Processing at Receiver According to clause 10.1.4 with the following additions: • If the notificationURI attribute contains Notification Target(s) that is/are not the Originator, see applicable processing in table 10.2.10.2-1 in clause 10.2.10.2. • If notificationEventType is provided as "Report on missing data points" then the missingData attribute shall be set in the targeted resource or provided in the request. • If missingData attribute is provided the subscribed-to resource shall be <timeSeries> resource. • If the latestNotify attribute is set during this UPDATE operation, the Hosting CSE shall assign Event Category parameter of value 'latest' of the notifications generated pertaining to the subscription created and remove all buffered pending notifications for this subscription except for the latest one. • If the <subscription> resource representation includes a primitiveProfileID attribute configured with a value and the Hosting CSE does not support primitive profile functionality, then the <subscription> resource update process fails. Upon successful updating of a <subscription> resource, the Hosing CSE shall evaluate subsequent operations on the subscribed-to resource and trigger notifications in line with the new notification policies provisioned in the created <subscription> resource. If the notificationStatsEnable attribute is set to TRUE, the Hosting CSE shall collect and record notification statistics as defined in clause 10.2.10.27. Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 387 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.5 Delete <subscription> | This procedure shall be used to unsubscribe an existing subscription. The generic delete procedure is described in clause 10.1.5. Table 10.2.10.5-1: <subscription> DELETE <subscription> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.6 Notification procedures | This procedure shall be used to notify Notification Targets of modifications of a resource for an associated <subscription> resource and notify about a <subscription> resource deletion. Also, this procedure shall be used to request resource subscription verification to Notification Target(s) which is/are not the Originator. When the notification is forwarded or aggregated by transit CSEs, the Hosting CSE or a transit CSE shall check whether there is a latestNotify notification policy to enforce between subscription resource Hosting CSE and the notification target. In that case, the transit CSE as well as the Hosting CSE shall process notification(s) by using the corresponding policy and send processed notification(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 Originator. The notification policies related to the enforcement at this time is verified by using the subscription reference in the Notify request message. If any transit CSE does not recognize the attribute, then it should ignore it. A notifier can request verification of a Notification Target by including the Originator ID of the subscription creator in the notify request that it generates towards the Notification Target for that purpose. In this case, the Notification Target shall check if both the Notify Originator and the corresponding <subscription> creation Originator have NOTIFY privilege. • If either of the two checks are not successful, the Receiver shall return an unsuccessful response to the Originator with subscription verification failure information. • Otherwise, the Receiver shall send successful response to the Originator. If the Notification Target wants to remove itself from the Notification Target list (i.e. notificationURI attribute of the corresponding <subscription> resource), it shall follow one of the procedures below: • The Notification Target shall set in a Notify response the 'targetRemoval' indicator to TRUE after receiving a Notify request. NOTE: In this case the Notification Target will not know the outcome of its removal request immediately. • The Notification Target shall send a Delete Request to the < notificationTargetSelfReference > virtual resource subordinated as a child resource to the corresponding <subscription> resource. For either of the above procedures, the Notifier shall handle that according to the action attribute defined in the corresponding < notificationTargetPolicy > resource for the Notification Target. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.7 Notification message handling procedure | When a Hosting CSE receives a <subscription> creation request which requires verification (see clause 10.2.10.2), the Hosting CSE may send a notification to perform subscription verification. In this case, the notification shall include the ID of the Originator of the <subscription> resource creation. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 388 (oneM2M TS-0001 version 4.15.0 Release 4) When there is an event for a <subscription> resource that triggers a notification, the <subscription> Hosting CSE shall i nclude in the notification the creator if the <subscription> resource has creator attribute. When a subscription shall be established that sends notifications upon update of attributes of the subscribed-to resource while blocking the triggering UPDATE operation until the result of the notification is received, the value of the notificationEventType tag in the notificationEventCriteria attribute shall be set to "Update to attributes of the subscribed-to resource with blocking of the triggering UPDATE operation", see clause 9.6.8. For this notificationEventType value setting, only one single Notification Target shall be present in the notificationURI attribute - see notificationURI attribute definition in clause 9.6.8. A subset of attributes of the subscribed-to resource that are triggering a notification when modified can be specified in the attribute tag of the notificationEventCriteria attribute. If the attribute tag is not present, all attributes of the subscribed-to resource will trigger a notification when modified. Upon occurrence of a triggering UPDATE operation that has been validated and results in an authorized UPDATE operation for any of the triggering attributes of the subscribed-to resource, the triggering UPDATE operation shall be blocked before modifying the targeted attributes by the Hosting CSE until a notification request was sent out and a corresponding response message was received or a timeout happens. While such an UPDATE request is pending, no other UPDATE or DELETE requests to the same resource instance shall be processed, i.e. if they occur while the UPDATE operation that triggered this type of subscription is blocked, they need to be delayed until the blocked UPDATE has been completed. When the response status code of the notification response message indicates a successful notification reception by the Notification Target in combination with a successful notification action taken by the Notification Target, the blocked UPDATE operation shall be completed with a successful update of the targeted attribute(s). If the notification response message indicates an unsuccessful notification request reception or a successful notification request reception with unsuccessful notification action by the Notification Target or when the reception of a response message times out, the blocked UPDATE operation shall be completed with no success and no change of the targeted attribute(s). There shall exist a maximum of only one subscription with this setting of notificationEventType for a given resource. All other notification policies shall not be allowed when this setting of notificationEventType is used. Further details of Hosting CSE related notification policies follow: The expirationCounter shall be decreased by one when the Hosting CSE successfully sends the notification request to Receiver(s). If the counter reaches zero, the corresponding subscription resource shall be deleted. In the case an Originator wants to create batches of notifications rather than have the Hosting CSE send notifications one by one, it may set the batchNotify attribute to express its notification policy. The batchNotify attribute (notification policy) is based on two values, the number of notifications to be batched for delivery, and/or a duration. When the Hosting CSE generates a notification event it checks the batchNotify policy, if a duration value is specified then a timer is started which expires after the duration value. If a number of notifications is specified then notification events are accumulated until the accumulated notification events reaches the specified number. If only the duration is specified, then the accumulated notifications are sent as a batch when the timer expires. If both values are set then accumulated notifications are sent as a batch when either the timer expires or the number is reached whichever happens first. If neither the number nor the duration is specified (i.e. the batchNotify attribute is present and empty), then the Hosting CSE shall batch notifications using the default duration value as given by the M2M Service Provider. Note that Hosting CSE shall not batch notifications when the batchNotify is not present in the <subscription> resource. When the first notification event is generated then a timer shall be started and keep batching notifications for the duration. After the duration, batched notification shall be sent and a timer shall be set again at the next notification event. For example, a batchNotify policy having a duration of 10 minutes and a number of 20 notifications will accumulate notifications which is sent when the first of these two conditions are satisfied. The sending order is First-In First-Out (FIFO). The batch timer shall be reset once the batched notifications are being sent. notificationEventCat is checked at the time of batch transmission and applied to each notification individually in the batch. Stored notification events may be dropped according to the notificationStoragePriority and the notificationCongestionPolicy (see clause 9.6.3). When the batchNotify and latestNotify attributes (notification policies) are used together, they enable two ways of sampling notification events for notification generation. If the number of notifications is set high then the duration value will drive the policy, and the latestNotify policy will cause a single event notification every duration period, e.g. send the latest event notification every hour. If the duration value is set high then the number of notifications will drive the policy, and the latestNotify policy will cause a single notification for every specified number of notifications, e.g. send the latest event notification for every 500 events notifications generated. The scope of the batchNotify policy is the Hosting CSE for the one subscription it is set in, and does not extend to transit CSEs. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 389 (oneM2M TS-0001 version 4.15.0 Release 4) In the case when an Originator wants to limit the rate at which notifications are sent, it may set the rateLimit attribute (notification policy) to express its notification policy. The rateLimit policy is based on two values, a maximum specified number of events (e.g. 10 000) that may be sent within some specified rateLimit window duration (e.g. 60 seconds), and the rateLimit window duration. When the Hosting CSE generates a notification event it checks the rateLimit policy and whether the current total number of events sent is less than the maximum number of events within the current rateLimit window duration. If the current total is less than the maximum number then the notification may be sent. If it is equal or more then the notification is temporarily stored until the end of the current window duration, when the sending of notification events restarts in the next window duration. The sending of notification events continues as long as the maximum number of notification events is not exceeded within the window duration. The rateLimit windows are sequential (not rolling). The rateLimit policy may be used simultaneously with batchNotify and notificationStoragePriority policies. The scope of the rateLimit policy is the Hosting CSE for the one subscription it is set in, and does not extend to transit CSEs. The pendingNotification attribute (notification policy) indicates the notification procedure to be followed following a connectionless period (due to lack of notification schedule or reachability schedule). When the Hosting CSE generates a notification with the pendingNotification, it shall check the notification schedule of the subscription and the reachability schedule associated with the Notification Target. If there is no restriction then the notification is immediately sent, otherwise the notification may be cached according to the pendingNotification. If caching of retained notifications is supported on the Hosting CSE and contains the subscribed events then pending notification (those that occurred during the connectionless period) will be sent to Notification Target per the pendingNotification policy. If it is set to the "sendLatest", most recent notification should be sent and it shall have the Event Category set to "latest". Figure 10.2.10.7-1 illustrates an example for this case. If it is set to "sendAllPending", all the missed cached notifications should be sent in the order they occurred. Figure 10.2.10.7-2 illustrates an example of this case. The Hosting CSE may use the pendingNotification policy to determine whether and how many interim notifications to retain in its cache. The pendingNotification policy may be used simultaneously with any other notification policy, which would impact what would be sent during the connection period. The scope of the pendingNotification is the Hosting CSE for the one subscription it is set in, and does not extend to transit CSEs. Figure 10.2.10.7-1: Notification Mechanism when pendingNotification (sendLatest) is used Figure 10.2.10.7-2: Notification Mechanism when pendingNotification (sendAllPending) is used ETSI ETSI TS 118 101 V4.15.0 (2022-09) 390 (oneM2M TS-0001 version 4.15.0 Release 4) In the case an Originator wants (for example in the case where notification events occur on an irregular basis) that notifications are be sent for events generated prior to the creation of this subscription, it may set the preSubscriptionNotify attribute (notification policy) to express its notification policy. The preSubscriptionNotify policy is based upon a number of prior notifications that the Originator wants to be sent. When creating a subscription the Hosting CSE checks the preSubscriptionNotify policy. If caching of retained notifications is supported on the Hosting CSE and contains the subscribed events then prior notification events shall be sent to Receiver(s) up to the number requested by the preSubscriptionNotify policy. If caching of retained notifications is supported for the subscribed events but the available number of prior notification events is less than the number requested then the Hosting CSE shall send those notifications. If caching of retained notifications is not supported, then the response to the subscription creation request shall include a warning. The preSubscriptionNotify policy may be used simultaneously with any other notification policy. The scope of the preSubscriptionNotify policy is the Hosting CSE for the one subscription it is set in, and does not extend to transit CSEs. The latestNotify attribute (notification policy) indicates if the Originator is only interested in the latest state of the subscribed-to resource. If the latestNotify attribute is set, the Hosting CSE shall assign Event Category parameter of value 'latest' to the latest notifications generated pertaining to the subscription created. In the case the Receiver is a transit CSE which forwards or aggregates the notifications before sending them to the Originator or the other transit CSEs, upon receiving the notification with the Event Category set to 'latest', the transit CSE shall identify the latest notification with the same subscription reference while storing the notifications locally. When the Receiver as a transit CSE needs to send the pending notifications, it shall send the latest notification only for that subscription. The scope of the latestNotify policy is the Hosting CSE as well as transit CSEs. The notificationContentType attribute (notification policy) indicates the notification content type that shall be contained in notifications. The notificationContentType values shall be "modified attributes " (i.e. send the modified attribute(s) only), or "all attributes" (i.e. send all attributes of the subscribed-to resource), or "ID" of the resource indicated in the notificationEventType condition tag or the value "Trigger Payload". If it is not given by the Originator at the creation procedure, the default is "all attributes". If the primitiveProfileID attribute is configured with a resource identifier of a <primitiveProfile> resource, the Hosting CSE shall apply <primitiveProfile> resource to the notifications. The scope of the notificationContentType policy is the Hosting CSE for all Originator's subscriptions, and does not extend to transit CSEs. The value "Trigger Payload" for this attribute is only valid when at least one "notificationEventType" tag in the eventNotificationCriteria attribute is set to "Trigger Received targeting the MN/ASN-AE associated with the <AE> parent resource". The notificationEventCat attribute (notification policy) indicates an event category of the subscription that shall be included in the notification request to be able for the Notification Target to correctly handle the notification. When the notificationEventCat policy is not configured by the Originator, it shall be determined as a default value by the CMDH policy. The scope of the notificationEventCat policy is the Hosting CSE for all Originator's subscriptions, and does not extend to transit CSEs. When the Hosting CSE receives unsuccessful Notify response with subscription verification failure information, the Hosting CSE shall send unsuccessful result to the Originator of the corresponding <subscription> creation procedure if it has not created the <subscription> resource, otherwise the Hosting CSE may delete the corresponding <subscription> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 391 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.10.7-1: Notification Procedure Description Information in Request message According to clause 10.1.6 with the following additions: Content: • notification data that represents the content of subscribed-to resource may be included. The content is decided by notificationContentType attribute; • subscription reference (i.e. address of the corresponding <subscription> resource) that generates this notification shall be included; • notification event type shall be included; • monitored operation and its Originator information shall be included when operationMonitor condition in the eventNotificationCriteria attribute is configured; • notificationForwardingURI in case the subscriber intends the group to aggregate the notifications. If the primitiveProfileID attribute of the <subscription> resource is configured with a resource identifier of a <primitiveProfile> resource, the Hosting CSE shall apply the <primitiveProfile> resource to the notification request to determine the content and request parameters that are added, modified or deleted before the notification is sent by the Hosting CSE. Processing at Originator before sending Request Notification is triggered regarding subscription information in a <subscription> resource. Processing at Receiver According to clause 10.1.6. Information in Response message According to clause 10.1.6. Processing at Originator after receiving Response If the response includes 'targetRemoval' indicator which is set to TRUE, then the Notifier(i.e. the Originator of the Notify request) shall perform the procedure in clause 10.2.10.8 (Notification target removal handling procedure). If the primitiveProfileID attribute of the <subscription> resource is configured with a resource identifier of a <primitiveProfile> resource, the Hosting CSE shall apply the <primitiveProfile> resource to the notification response to determine the content and request parameters that are added, modified or deleted before the Hosting CSE processes the notification response. Exceptions According to clause 10.1.6. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.8 Notification Target removal procedure | Notification Target removal involves <notificationTargetSelfReference>, <notificationTargetMgmtPolicyRef>, <notificationTargetPolicy> and <policyDeletionRules> resources. When a Notification Target sends a Delete request to a <notificationTargetSelfReference> virtual resource, the <subscription> Hosting CSE gets deletion policies to handle the removal request. Depending on the action of the <notificationTargetPolicy> resource which is associated to the Notification Target, the <subscription> Hosting CSE can accept or reject the request by itself and get the authorization from the <subscription> resource creator. When the Hosting CSE gets a successful response from the creator, it deletes the target in the notificationURI and sends back the successful response to the removal Originator. If the action is to inform the subscription Originator, then the Hosting CSE just sends a notification to inform of this removal request. The subscription Originator is supposed to determine and perform the target removal. Figure 10.2.10.8-1 briefly illustrates the procedure mentioned above depending on the different action settings. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 392 (oneM2M TS-0001 version 4.15.0 Release 4) Figure 10.2.10.8-1: Notification target removal procedure The Notifier(i.e. the Originator of the Notify request) shall handle the notification target removal based on a <notificationTargetPolicy> resource. Selecting the applicable<notificationTargetPolicy> resource shall be performed as follows: • Check if there is a <notificationTargetMgmtPolicyRef> resource as a child of the <subscription> resource which includes the Notification Target in the notificationTargetURI attribute. If one is located, the Notifier shall apply the <notificationTargetPolicy> resource specified in the notificationPolicyID attribute in the matching <notificationTargetMgmtPolicyRef> resource. • Otherwise, the Notifier shall check if there is a <notificationTargetMgmtPolicyRef> resource which has the creator attribute set in the corresponding <subscription> resource and there is a <notificationTargetPolicy> resource which has the policyLabel attribute set as "default" and the creator attribute is equal to the creator of the <subscription> resource. • Otherwise, the Notifier shall fetch the <notificationTargetPolicy> resource which has the policyLabel attribute set as "default". With the selected <notificationTargetPolicy> resource, the Notifier shall handle the target removal as specified in the action attribute of the <notificationTargetPolicy> resource. If there's <policyDeletionRules> resource(s) then the action shall be applied when the rule(s) is satisfied. The action shall be performed as follows: • If the action is "accept", then the Notifier shall remove the address which is corresponding to the Notification Target and returns a successful response if applicable. • If the action is "reject" and if the target removal was requested with Delete request (clause 10.2.10.9), then the Notifier shall return an unsuccessful response if applicable. Subscription Originator (creator) <subscription> Hosting CSE (Notification Target Deletion) Originator 1. Delete request to <notificationTargetSelfReference> 2. Get deletion policies for the target 4a. Accepted or rejected 3. Check action 4b. Inform the subscription Originator 4c. Seek authorization ETSI ETSI TS 118 101 V4.15.0 (2022-09) 393 (oneM2M TS-0001 version 4.15.0 Release 4) • If the action is "seek authorization from the subscription creator", then the Notifier shall return a successful response to the Notification Target if applicable and shall send a Notify request including the ID of the <subscription> resource, the Notification Target, and the 'removalAuthorization' indicator which is set as TRUE, to the subscription creator. When the Notifier gets successful response from the creator, then the Notifier shall remove the address which is corresponding to the Notification Target. • If the action is "inform the subscription creator", then the Notifier shall return a successful response to the Notification Target if applicable and shall send a Notify request including the ID of the <subscription> resource, the Notification Target, and the 'targetRemoval' indicator which is set as TRUE to the subscription creator. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.9 Delete <notificationTargetSelfReference> | Only Delete operations shall be allowed for the <notificationTargetRemove> resource. This procedure shall apply to the <subscription> resource. Whenever a Delete Request is received at the <notificationTargetSelfReference> virtual resource from a Notification Target, the Notifier shall handle the request according to the action attribute defined in the <notificationTargetPolicy> resource which is linked from the <notificationTargetDisposition> resource. Detailed handling procedure is specified in clause 10.2.10.8 (Notification Target removal handling procedure). |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.10 Create <notificationTargetMgmtPolicyRef> | This procedure shall be used for creating a <notificationTargetMgmtPolicyRef> resource. Table 10.2.10.10-1: <notificationTargetMgmtPolicyRef> CREATE <notificationTargetMgmtPolicyRef> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.6 Processing at Originator before sending Request According to clause 10.1.2 Processing at Receiver According to clause 10.1.2 Information in Response message According to clause 10.1.2 Processing at Originator after receiving Response According to clause 10.1.2 Exceptions According to clause 10.1.2 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.11 Retrieve <notificationTargetMgmtPolicyRef> | This procedure shall be used for retrieving the attributes of a <notificationTargetMgmtPolicyRef> resource. Table 10.2.10.11-1: <notificationTargetMgmtPolicyRef> RETRIEVE <notificationTargetMgmtPolicyRef> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message All parameters defined in table 8.1.3-1 apply. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.12 Update <notificationTargetMgmtPolicyRef> | This procedure shall be used for updating attributes of a <notificationTargetMgtPolicyRef> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 394 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.10.12-1: <notificationTargetMgmtPolicyRef> UPDATE <notificationTargetMgmtPolicyRef> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply. Processing at Originator before sending Request According to clause 10.1.4. Processing at Receiver According to clause 10.1.4. Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.13 Delete <notificationTargetMgmtPolicyRef> | This procedure shall be used for deleting a <notificationTargetMgmtPolicyRef> resource. Table 10.2.10.13-1: <notificationTargetMgmtPolicyRef> DELETE <notificationTargetMgmtPolicyRef> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply. Processing at Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions According to clause 10.1.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.14 Create <notificationTargetPolicy> | This procedure shall be used for creating a <notificationTargetPolicy> resource. Table 10.2.10.14-1: <notificationTargetPolicy> CREATE <notificationTargetPolicy> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.6 Processing at Originator before sending Request According to clause 10.1.2 Processing at Receiver According to clause 10.1.2 Information in Response message According to clause 10.1.2 Processing at Originator after receiving Response According to clause 10.1.2 Exceptions According to clause 10.1.2 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.15 Retrieve <notificationTargetPolicy> | This procedure shall be used for retrieving the attributes of a <notificationTargetPolicy> resource. Table 10.2.10.15-1: <notificationTargetPolicy> RETRIEVE <notificationTargetPolicy> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 Information in Response message All parameters defined in table 8.1.3-1 apply Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.16 Update <notificationTargetPolicy> | This procedure shall be used for updating attributes of a <notificationTargetPolicy> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 395 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.10.16-1: <notificationTargetPolicy> UPDATE <notificationTargetPolicy> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.4 Processing at Receiver According to clause 10.1.4 Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response According to clause 10.1.4 Exceptions According to clause 10.1.4 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.17 Delete <notificationTargetPolicy> | This procedure shall be used for deleting a <notificationTargetPolicy> resource. Table 10.2.10.17-1: <notificationTargetPolicy> DELETE <notificationTargetPolicy> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.18 Create <policyDeletionRules> | This procedure shall be used for creating a <policyDeletionRules> resource. Table 10.2.10.18-1: <policyDeletionRules> CREATE <policyDeletionRules> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.6 Processing at Originator before sending Request According to clause 10.1.2 Processing at Receiver According to clause 10.1.2 Information in Response message According to clause 10.1.2 Processing at Originator after receiving Response According to clause 10.1.2 Exceptions According to clause 10.1.2 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.19 Retrieve <policyDeletionRules> | This procedure shall be used for retrieving the attributes of a <policyDeletionRules> resource. Table 10.2.10.19-1: <policyDeletionRules> RETRIEVE <policyDeletionRules> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 Information in Response message All parameters defined in table 8.1.3-1 apply Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.20 Update <policyDeletionRules> | This procedure shall be used for updating attributes of a <policyDeletionRules> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 396 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.10.20-1: <policyDeletionRules> UPDATE <policyDeletionRules> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.4 Processing at Receiver According to clause 10.1.4 Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response According to clause 10.1.4 Exceptions According to clause 10.1.4 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.21 Delete <policyDeletionRules> | This procedure shall be used for deleting a <policyDeletionRules> resource. Table 10.2.10.21-1: <policyDeletionRules> DELETE <policyDeletionRules> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.22 Create <crossResourceSubscription> | This procedure shall be used to request the creation of a new <crossResourceSubscription> resource to be notified for the modifications of multiple subscribed-to target resources. The generic create procedure is described in clause 10.1.2. Table 10.2.10.22-1: <crossResourceSubscription> CREATE <crossResourceSubscription> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.58. Processing at Originator before sending Request According to clause 10.1.2 with the following additions: The Request shall include at least one of the following attributes: regularResourcesAsTarget, subscriptionResourcesAsTarget. The Request shall include timeWindowType and timeWindowSize. The Request shall include notificationURI(s). The Request shall include notificationContentType. The Request shall include eventNotificationCriteriaSet if regularResourcesAsTarget is included in the Request. If the request includes notificationURI(s) which is not the Originator, the Originator should send the request as non-blocking request (see clauses 8.2.2 and 9.6.12). Processing at Receiver According to clause 10.1.2 with the following additions: The Hosting CSE shall validate the followings: • Check if the Originator has privileges for creating a child resource in the To parameter in the Request. • Check if each target resource in regularResourcesAsTarget is a subscribable resource. • Check if the Originator has privileges for retrieving the subscribed-to resource. • If a notificationURI is not the Originator, the Hosting CSE may send a Notify request to the notificationURI to verify this <crossResourceSubscription> creation request. If the Hosting CSE initiates the verification, it shall check if the verification result in the Notify response is successful or not. If any notificationURI contained in a list fails verification then the <crossResourceSubscription> create process fails. If any of the checks above fails, the Hosting CSE shall send an unsuccessful response to the Originator with corresponding error information. Otherwise, the Hosting CSE shall use the following procedure to create the <crossResourceSubscription> resource and send a successful or an unsuccessful response to the Originator. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 397 (oneM2M TS-0001 version 4.15.0 Release 4) <crossResourceSubscription> CREATE • If regularResourcesAsTarget is included, the Hosting CSE shall send a CREATE request message to each target resource host to create a <subscription> child resource under each target resource indicated by regularResourcesAsTarget using corresponding event notification criteria as included in eventNotificationCriteriaSet The notificationURI attribute for each <subscription> resource shall be configured with the same value as the notificationURI attribute of this <crossResourceSubscription> resource. The associatedCrossResourceSub attribute of each <subscription> resource shall be configured with the resource identifier of this <crossResourceSubscription> resource. The Hosting CSE shall leave the notificationStatsEnable attribute of each <subscription> resource with a default value of FALSE regardless of the value of the notificationStatsEnable attribute of the <crossResourceSubscription> resource. In the To parameter of each <subscription> CREATE request, the Hosting CSE shall include the identifier of the Originator of the <crossResourceSubscription> resource CREATE request, which shall be leveraged by the <subscription> resource host to verify if the Originator has the privilege to create a <subscription> resource; if the Originator has no privilege to create this <subscription> resource, this step shall be regarded as a failure. If any <subscription> resource cannot be successfully created, the Hosting CSE shall send an unsuccessful response to the Originator and shall delete any <subscription> resources that were created during the processing of this <crossResourceSubscription> resource CREATE request. • If subscriptionResourcesAsTarget is included, the Hosting CSE shall add the resource identifier of this <crossResourceSubscription> resource to the associatedCrossResourceSub attribute of each <subscription> resource as indicated in subscriptionResourcesAsTarget by issuing an UPDATE request to each <subscription> resource. In each UPDATE request, the Hosting CSE shall include the identifier of the Originator of the <crossResourceSubscription> resource CREATE request, which shall be leveraged by the <subscription> resource host to verify if the Originator has the privilege to retrieve the <subscription> resource and update the associatedCrossResourceSub attribute; if the Originator has no privilege to retrieve the <subscription> resource and update the associatedCrossResourceSub attribute, this step shall be regarded as a failure. If this step is not successfully performed, the Hosting CSE shall send an unsuccessful response to the Originator and shall also delete the resource identifier of this <crossResourceSubscription> resource from the associatedCrossResourceSub attribute of each <subscription> resource that was updated during the processing of this <crossResourceSubscription> resource CREATE request. • Otherwise, the Hosting CSE shall send a successful response to the Originator. Once the <crossResourceSubscription> resource is created, the Hosting CSE shall start the time window. If the notificationStatsEnable attribute is set to TRUE, the Hosting CSE shall collect and record notification statistics for the <crossResourceSubscription> resource as defined in clause 10.2.10.27. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: • Content: address of the created <crossResourceSubscription> resource, according to clause 10.1.2. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.23 Retrieve <crossResourceSubscription> | This procedure shall be used to retrieve attributes and child resource information of a <crossResourceSubscription> resource. The generic retrieve procedure is described in clause 10.1.3. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 398 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.10.23-1: <crossResourceSubscription> RETRIEVE <crossResourceSubscription> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: void Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <crossResourceSubscription> resource as defined in clause 9.6.58 Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.24 Update <crossResourceSubscription> | This procedure shall be used to update an existing cross-resource subscription (i.e. represented as a <crossResourceSubscription> resource), e.g. the modification of the list of notificationURI(s). The generic update procedure is described in clause 10.1.4. Table 10.2.10.24-1: <crossResourceSubscription> UPDATE <crossResourceSubscription> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: attributes of the <crossResourceSubscription> resource as defined in clause 9.6.58 which need be updated. Processing at Originator before sending Request According to clause 10.1.4. Processing at Receiver According to clause 10.1.4: • If a notificationURI is not the Originator, see table 10.2.10.2-1 in clause 10.2.10.2. • If regularResourcesAsTarget is updated, the Hosting CSE shall: − First, delete the <subscription> child resource for each target resource that is deleted from the regularResourcesAsTarget attribute. − Second, issue a CREATE request to create a <subscription> child resource under each target resource that is added to the regularResourcesAsTarget attribute. Each <subscription> resource shall be configured with corresponding event notification criteria as defined by the eventNotificationCriteriaSet attribute; the notificationURI for each <subscription> resourceshall be configured with the same value as the notificationURI attribute of this <crossResourceSubscription> resource. The associatedCrossResourceSub attribute of each <subscription> resource shall be configured with the resource identifier of this <crossResourceSubscription> resource. The Hosting CSE shall leave the notificationStatsEnable attribute of the <subscription> resource with a default value of FALSE regardless of the value of the notificationStatsEnable attribute of the <crossResourceSubscription> resource. In the To parameter of each <subscription> CREATE request, the Hosting CSE shall include the identifier of the Originator of the <crossResourceSubscription> resource CREATE request, which shall be leveraged by the <subscription> resource host to verify if the Originator has the privilege to create a <subscription> resource. If the Originator has no privilege to create this <subscription> resource, this step shall be regarded as a failure. If any <subscription> resource cannot be successfully created, the Hosting CSE shall send an unsuccessful response to the Originator and shall delete any <subscription> resources that were created during the processing of this <crossResourceSubscription> resource CREATE request. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 399 (oneM2M TS-0001 version 4.15.0 Release 4) <crossResourceSubscription> UPDATE • If subscriptionResourcesAsTarget is updated, the Hosting CSE shall: − First, for each <subscription> resource identifier removed from the subscriptionResourcesAsTarget attribute, the Hosting CSE shall remove the resource identifier of this <crossResourceSubscription> resource from the associatedCrossResourceSub attribute of that <subscription> resource by issuing an UPDATE to the <subscription> resource. − Second, for each <subscription> resource identifier added to the subscriptionResourcesAsTarget attribute, the Hosting CSE shall issue an UPDATE request to the <subscription> resource to add the resource identifier of this <crossResourceSubscription> resource to the associatedCrossResourceSub attribute of the <subscription> resource. In the UPDATE request, the Hosting CSE shall include the identifier of the Originator, which shall be leveraged by the <subscription> resource host to verify if the Originator has the privilege to retrieve this <subscription> resource and update the associatedCrossResourceSub attribute; if the Originator has no privilege to retrieve and update this <subscription> resource, this step shall be regarded as a failure. If this step is not successfully performed, the Hosting CSE shall send an unsuccessful response to the Originator and shall update the associatedCrossResourceSub attribute of any <subscription> resources that were updated during the processing of this <crossResourceSubscription> resource UPDATE request to return them to their prior state. • If eventNotificationCriteriaSet is updated, the Hosting CSE shall use each new event notification criteria to update the eventNotificationCriteria of the corresponding <subscription> child resource which has been created previously using the clause 10.2.10.22 for each target resource as included in the regularResourcesAsTarget attribute. • If the notificationStatsEnable attribute is set to TRUE in the <crossResourceSubscription> resource, the Hosting CSE shall collect and record notification statistics for the <crossResourceSubscription> resource as defined in clause 10.2.10.27. Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.25 Delete <crossResourceSubscription> | This procedure shall be used to unsubscribe an existing cross-resource subscription (i.e. represented as a <crossResourceSubscription> resource). The generic delete procedure is described in clause 10.1.5. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 400 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.10.25-1: <crossResourceSubscription> DELETE <crossResourceSubscription> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply. Processing at Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5. The Hosting CSE shall check whether the Originator has the privilege to delete the <crossResourceSubscription> resource. If this check fails, the Hosting CSE shall send an unsuccessful response to the Originator with corresponding error information; otherwise, the Hosting CSE shall perform the following operations: • If regularResourcesAsTarget is included in the <crossResourceSubscription> to be deleted, the Hosting CSE shall issue a DELETE request to delete the <subscription> child resource of the corresponding target resource as contained in the regularResourcesAsTarget attribute which has been created previously using the clause 10.2.10.22. The identifier of the <crossResourceSubscription> resource creator (i.e. its creator attribute) shall be included in this DELETE request and shall be leveraged by the target resource host to check the privilege to delete the <subscription> resource. • If subscriptionResourcesAsTarget is included, the Hosting CSE shall remove the resource identifier of this <crossResourceSubscription> from the associatedCrossResourceSub of each <subscription> resource as indicated in the subscriptionResourcesAsTarget. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions According to clause 10.1.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.26 Cross-Resource Notification Procedure | For each <crossResourceSubscription> resource, the Hosting CSE shall use the following procedures to determine whether a cross-resource notification shall be generated and sent to notification targets as indicated in the notificationURI attribute. • The Hosting CSE shall wait for notifications from target resources as indicated by regularResourcesAsTarget and subscriptionResourcesAsTarget to a <crossResourceSubscription> resource. • The Hosting CSE shall use the designated time window mechanism as indicated by timeWindowType to determine if a cross-resource notification shall be issued each time when receiving a notification from a target resource as indicated by regularResourcesAsTarget and subscriptionResourcesAsTarget. Only when expected changes on all target resources occur within the required time window (as indicated by timeWindowSize), the Hosting CSE shall issue a notification (i.e. cross-resource notification); otherwise, the Hosting CSE shall discard the received notification from any target resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.10.27 Notification Recording Procedure | For each <subscription> and <crossResourceSubsription> resource, the Hosting CSE shall use the following procedure to record notification statistics. • If the notificationStatsEnable attribute of a <subscription> or <crossResourceSubsription> resource is set to TRUE, either upon the successful creation or update of the <subscription> or <crossResourceSubsription> resource, the Hosting CSE shall clear any statistics that were stored previously in the notificationStatsInfo attribute and begin collecting notification statistics for each notification the Hosting CSE generates and sends to each notification target defined by the notificationURI attribute. • While the notificationStatsEnable attribute is set to TRUE, the Hosting CSE shall collect and store the following types of statistics within the notificationStatsInfo attribute for each notification target defined by the notificationURI attribute: - Total number of notification requests sent to a notification target ETSI ETSI TS 118 101 V4.15.0 (2022-09) 401 (oneM2M TS-0001 version 4.15.0 Release 4) - Total number of notification responses received from a notification target • When the notificationStatsEnable attribute of a <subscription> or <crossResourceSubsription> resource is set to FALSE, the Hosting CSE shall stop collecting notification statistics for the <subscription> or <crossResourceSubsription> resource. The Hosting CSE shall maintain the current value of the notificationStatsInfo attribute until a subsequent update of the notificationStatsEnable attribute to a value of TRUE. 10.2.11 Service Charging and Accounting Procedures |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.11.1 Service event-based statistics collection for applications | This clause is informative and provides a use case example to explain how the Infrastructure Node provides statistics for AEs using the <statsConfig> and <statsCollect> resources as defined in clauses 9.6.23, 9.6.24.and 9.6.25. Figure 10.2.11.1-1 shows an example of service layer event-based charging based on the Infrastructure Node. Steps 1-2: A statistics collection resource called <statsConfigSCA1> was created at the IN-CSE by a billing application. Note that the <statsConfig> can also be provisioned. In this use case, the <statsConfigSCA1> has the <eventConfigSCA1> sub-resource. For this specific use case, the <eventConfigSCA1> can be set as following: The eventID attribute is set with a unique ID to differentiate from other chargeable events. The eventType attribute defines what event will trigger the generation of service statistics collection record and is set to "Data Operation" for this case. eventStart and eventEnd attributes apply to timer based event so they will not be included in this event. operationType attribute will be "RETRIEVE". dataSize attribute does not apply so it is not included. Steps 3-5: In this example, AE1 already registered to IN-CSE. IN-CSE can make the statistics collection configuration accessible by AE. Based on the <statsConfigSCA1>, AE1 creates a statistics collection trigger for itself, stored in <statsCollectAE1>. AE1 will fill in the information for the collection rule. For example, it fills the collectingEntityID attribute with the AE-ID of AE1, and the collectedEntityID attribute empty, which means to collect for any entities. status attribute is set to "Active". The statModel is event-based. The eventID is set with the same ID value as the eventID in the <eventConfigSCA1>. This event collection trigger can be stored in the <eventConfigSCA1> resource at the IN-CSE and IN-CSE will assign a unique ID in attribute statsCollectID. Steps 6-8: When the configured event happens, i.e. when AE2 performed a RETRIEVE operation to the data stored by AE1 at IN-CSE, the event is recorded by IN-CSE. IN-CSE generates a service statistics collection record and sends it to AE1. AE1 can choose to use such information for statistics or billing. Transfer of the statistics is out of scope of the present document. Step 9: The AE of billing application can update or retrieve the charging policies and collection scenarios that it has the access control privilege. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 402 (oneM2M TS-0001 version 4.15.0 Release 4) Figure 10.2.11.1-1: Event-based Statistics Collection for Applications |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.11.2 Create <statsConfig> | This procedure shall be used for the Originator to establish a set of configurations for statistics collection at the Receiver. The configurations shall be stored at the <statsConfig> resource and each instance of the <statsConfig> resource shall represent a specific configuration. The Originator shall be an AE that wants to set up the statistics collection configurations. The Receiver shall be an IN-CSE. SCA1 on Infrastructure Node (IN-CSE1) 2. stat collection is Event based stored at <eventConfigSCA1> IN-AE (AE1) 6. IN-CSE1 generates statistic collections for AE1 Billing Application (AE) 1. Billing Application creates configuration for statistics collection 3. AE1 already registered to IN-CSE1 4. AE1 discovers the stats collection service offered by IN-CSE1 5. AE1 creates stats collection based on the configuration provided by IN-CSE1 7. IN-CSE1 sends statistics collection to AE1 8. AE1 choses how to use the information 9. Billing Application may update or retrieve the configuration for statistics collection ETSI ETSI TS 118 101 V4.15.0 (2022-09) 403 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.11.2-1: <statsConfig> CREATE <statsConfig> CREATE Information in Request message From: Identifier of the AE that initiates the Request. To: The address of the <CSEBase> where the <statsConfig> resource is intended to be Created. Content: The representation of the <statsConfig> resource for which the attributes are described in clause 9.6.23. Other information in the Request message is defined according to clause 10.1.2. Processing at Originator before sending Request The Originator shall request to Create a new <statsConfig> resource by addressing to the <CSEBase> resource of a Hosting CSE. The Originator shall be an AE. Processing at Receiver According to clause 10.1.2. Information in Response message According to clause 10.1.2. Processing at Originator after receiving Response None. Exceptions According to clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.11.3 Retrieve <statsConfig> | The RETRIEVE procedure shall be used for the Originator to retrieve the existing <statsConfig> resource from the Receiver. The Originator shall be an AE that is allowed to retrieve configuration information available for AEs within an IN-CSE. The Receiver shall be the IN- CSE containing the <statsConfig> resource. Table 10.2.11.3-1: <statsConfig> RETRIEVE <statsConfig> RETRIEVE Information in Request message From: ID of the Originator To: Address of the <statsConfig> resource or its attribute to be retrieved Processing at Originator before sending Request The Originator shall request to obtain <statsConfig> resource information by using the RETRIEVE operation. The request shall address the specific <statsConfig> resource or its attributes of a Hosting CSE. The Originator shall be an AE Processing at Receiver According to clause 10.1.3 Information in Response message According to clause 10.1.3 Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.11.4 Update <statsConfig> | This procedure shall be used for updating <statsConfig> resource. An UPDATE procedure on the <statsConfig> resource is used for the Originator to update charging related policies at the Receiver. The Originator shall be the AE that created the <statsConfig> resource. The same AE shall be able to update the resource. The Receiver shall be a CSE containing the <statsConfig> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 404 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.11.4-1: <statsConfig> UPDATE <statsConfig> UPDATE Information in Request message From: ID of the Originator To: Address of the <statsConfig> resource to be updated Content: the Originator provides the attributes of <statsConfig> to be updated Processing at Originator before sending Request According to clause 10.1.4 Processing at Receiver According to clause 10.1.4 Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response None Exceptions According to clause 10.1.4 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.11.5 Delete <statsConfig> | This procedure shall be used for deleting <statsConfig> resource. The Originator shall be the AE that created the <statsConfig> resource. The Receiver shall be a CSE containing the <statsConfig> resource. Table 10.2.11.5-1: <statsConfig> DELETE <statsConfig> DELETE Information in Request message From: ID of the Originator To: Address of the <statsConfig> resource to be deleted Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response None Exceptions According to clause 10.1.5 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 405 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.11.6 Create <eventConfig> | This procedure shall be used to create <eventConfig> resource. Table 10.2.11.6-1: <eventConfig> CREATE <eventConfig> CREATE Information in Request message From: Identifier of the AE that initiates the Request. To: The address of the <statsConfig> resource where the <eventConfig> sub-resource is intended to be created. Content: The representation of the <eventConfig> resource for which the attributes are described in clause 9.6.24. Other information in the Request message is defined according to clause 10.1.2. Processing at Originator before sending Request The Originator shall be an AE. The Originator shall request to Create a new <eventConfig> resource by addressing to the <statsConfig> resource of a Hosting CSE. Processing at Receiver The Receiver shall be an IN-CSE: • The Receiver shall check if the eventID is unique, and if not, provides a new value. • The Receiver shall verify that the eventEnd time is greater than the eventStart time if these two attributes are present. • The Receiver shall verify that the dataSize attribute is present and contains a value greater than zero if the eventType is set to "Storage based". Information in Response message According to clause 10.1.2. Processing at Originator after receiving Response None. Exceptions According to clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.11.7 Retrieve <eventConfig> | The RETRIEVE procedure shall be used for the Originator to retrieve the existing <eventConfig> resource from the Receiver. The Originator shall be an AE that is allowed to retrieve configuration information available for AEs within an IN-CSE. The Receiver shall be the IN-CSE containing the <eventConfig> resource. Table 10.2.11.7-1: <eventConfig> RETRIEVE <eventConfig> RETRIEVE Information in Request message From: ID of the Originator. To: Address of the <eventConfig> resource or its attributes to be retrieved. Processing at Originator before sending Request The Originator shall request to obtain <eventConfig> resource information by using the RETRIEVE operation. The request shall address the specific <eventConfig> resource or its attributes of a Hosting CSE. The Originator shall be an AE. Processing at Receiver According to clause 10.1.3. Information in Response message According to clause 10.1.3. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.11.8 Update <eventConfig> | This procedure shall be used for updating an existing <eventConfig> resource. The Originator shall be the AE that created the <eventConfig> resource. The same AE shall be able to update the resource. The Receiver shall be the IN-CSE containing the <eventConfig> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 406 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.11.8-1: <eventConfig> UPDATE <eventConfig> UPDATE Information in Request message From: ID of the Originator. To: Address of the <eventConfig> resource to be updated. Content: The Originator provides the attributes of <eventConfig> to be updated. The Originator can update attributes under <eventConfig> to update event-based configuration for statistics collection. Processing at Originator before sending Request According to clause 10.1.4. Processing at Receiver According to clause 10.1.4. Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response None. Exceptions According to clause 10.1.4. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.11.9 Delete <eventConfig> | This procedure shall be used for deleting <eventConfig> resource. The Originator shall be the AE that created the <eventConfig> resource. The Receiver shall be the IN-CSE containing the <eventConfig> resource. Table 10.2.11.9-1: <eventConfig> DELETE <eventConfig> DELETE Information in Request message From: ID of the Originator To: Address of the <eventConfig> resource to be deleted Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response None Exceptions According to clause 10.1.5 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.11.10 Create <statsCollect> | This procedure shall be used for the Originator to establish collection scenarios at the Receiver. The collection scenarios are stored at the <statsCollect> resource. Multiple collection scenarios can be created based on one instance of <statsConfig>. The Receiver shall be an IN-CSE. The Receiver shall validate whether the Originator has proper permissions for creating a <statsCollect> resource. Upon successful validation, create a new <statsCollect> resource with the provided attributes. The IN-CSE shall also create a unique statsCollectID. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 407 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.11.10-1: <statsCollect> CREATE <statsCollect> CREATE Information in Request message From: Identifier of the AE that initiates the Request. To: The Address of the <CSEBase> where the <statsCollect> resource is intended to be Created. Content: Contain the resource representation of <statsCollect>. Other information in the Request message is defined according to clause 10.1.2. Processing at Originator before sending Request The Originator shall be an AE that wants to set up the collection scenarios to an IN-CSE. The Originator shall request to Create a new <statsCollect> resource by addressing to the <CSEBase> resource of a Hosting CSE. The Originator shall populate the attributes for the <statsCollect> resource as defined in clause 9.6.25, except for statsCollectID. Processing at Receiver In addition to procedures defined in clause 10.1.2, the Receiver shall perform the following specific operations: • Create statsCollectID which shall be unique in the same service provider domain. • Once a <statsCollect> resource instance is created and the status is "ACTIVE", the IN-CSE shall generate service statistics collection records when the conditions defined by the <statsCollect> are met. Information in Response message According to clause 10.1.2. Processing at Originator after receiving Response None. Exceptions According to clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.11.11 Retrieve <statsCollect> | The RETRIEVE procedure shall be used for the Originator to retrieve the existing <statsCollect> resource from the Receiver. The Originator shall be an AE that is allowed to retrieve the collection scenario information from the IN-CSE. The Receiver shall be the IN- CSE containing the <statsCollect> resource. Table 10.2.11.11-1: <statsCollect> RETRIEVE <statsCollect> RETRIEVE Information in Request message From: ID of the Originator To: Address of the <statsCollect> resource or its attribute to be retrieved Processing at Originator before sending Request The Originator shall request to obtain <statsCollect> resource information by using the RETRIEVE operation. The request shall address the specific <statsCollect> resource or its attributes of a Hosting CSE. The Originator shall be an AE Processing at Receiver According to clause 10.1.3 Information in Response message According to clause 10.1.3 Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.11.12 Update <statsCollect> | An UPDATE procedure on the <statsCollect> resource shall be used for the Originator to update chargeable scenarios at the Receiver. The Originator shall be the AE that created the <statsCollect> resource. The same AE shall be able to update the resource. The Receiver shall be the IN-CSE containing the <statsCollect> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 408 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.11.12-1: <statsCollect> UPDATE <statsCollect> UPDATE Information in Request message From: ID of the Originator To: Address of the <statsCollect> resource to be updated Content: the Originator provides the attributes of <statsCollect> to be updated Processing at Originator before sending Request According to clause 10.1.4 Processing at Receiver According to clause 10.1.4 Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response None Exceptions According to clause 10.1.4 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.11.13 Delete <statsCollect> | This procedure shall be used for deleting <statsCollect> resource. The Originator shall be the AE that created the <statsCollect> resource. The Receiver shall be a CSE containing the <statsCollect> resource. Table 10.2.11.13-1: <statsCollect> DELETE <statsCollect> DELETE Information in Request message From: ID of the Originator To: Address of the <statsCollect> resource to be deleted Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response None Exceptions According to clause 10.1.5 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.11.14 Service Statistics Collection Record | When the Service Statistics Collection is supported, the Information Elements shall be generated according to table 10.2.11.14-1. The contents of each Service statistics collection record are decided by the specific collection scenario that triggered the information recording. Transfer of the Statistics Collection Records over the Mch reference point is not defined in the present document. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 409 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.11.14-1: Information Elements for Service Statistics Collection Record Information Element Mandatory/ optional Description statsCollectID M It is the unique ID that identifies a specific statistics collection scenario, which triggers information recording for a specific event. collectingEntityID M This is the unique ID of the entity that collects the statistics. It can be an AE-ID, M2M-User-ID or CSE-ID. collectedEntityID M This is the unique ID of the entity whose service layer operation statistics are being collected. It can be an AE-ID, M2M-User-ID or CSE-ID. event O This indicates a specific event type in each record, such as timer based, data operation, storage triggering. It is only present if the statModel is "event based". eventStart O The start time for the recording the M2M event record. eventEnd O The end time for the recording the M2M event record. transactionType O Specifies the detailed type of a transaction, such as CREATE, RETRIEVE, etc. dataSize O Storage Memory in Kbytes, where applicable, to store data associated events with container related operations. Vendor Specific Information O Defines Vendor specific information. 10.2.12 M2M service subscription management |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.12.1 Introduction | This clause describes the procedures for creation, retrieval, update and deletion of the M2M Service Subscription related resources (i.e. <m2mServiceSubscriptionProfile>, <serviceSubscribedNode> and <serviceSubscribedAppRule>). These resources are used to store M2M Service Subscription related information regarding an established contract between a M2M Service Provider and M2M Application Service Providers. The relationship between these three resource types is specified in clause 9.6.19. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.12.2 Create <m2mServiceSubscriptionProfile> | This procedure shall be used for creating a <m2mServiceSubscriptionProfile> resource. Table 10.2.12.2-1: <m2mServiceSubscriptionProfile> CREATE <m2mServiceSubscriptionProfile> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: The Receiver or Hosting CSE shall be an IN-CSE. Content: The resource content shall provide the information as defined in clause 9.6.19. Processing at Originator before sending Request According to clause 10.1.2. Processing at Receiver According to clause 10.1.2. The Receiver shall configure the value of the status attribute of this <m2mServiceSubscriptionProfile> resource based on the values of the activate attribute of this <m2mServiceSubscriptionProfile> resource as described in table 9.6.19-2. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: • Address of the created <m2mServiceSubscriptionProfile> resource, according to clause 10.1.2. • If the Receiver overrides and configures any attributes with values different than the values specified in the request by the Originator, the Receiver shall return the values back to the Originator in the response depending on the Result Content value specified by the Originator. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 410 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.12.3 Retrieve <m2mServiceSubscriptionProfile> | This procedure shall be used for retrieving the attributes of a <m2mServiceSubscriptionProfile> resource. Table 10.2.12.3-1: <m2mServiceSubscriptionProfile> RETRIEVE <m2mServiceSubscriptionProfile> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: The Receiver or Hosting CSE shall be an IN-CSE. Content: Void. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: Attributes of the <m2mServiceSubscriptionProfile> resource as defined in clause 9.6.19. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.12.4 Update <m2mServiceSubscriptionProfile> | This procedure shall be used for updating the attributes of a <m2mServiceSubscriptionProfile> resource. Table 10.2.12.4-1: <m2mServiceSubscriptionProfile> UPDATE <m2mServiceSubscriptionProfile> UPDATE Information in Request message All parameters defined in table 8.1.2-3 are applicable as indicate in the table with the specific details for: To: The Receiver or Hosting CSE shall be an IN-CSE. Content: Attributes of the <m2mServiceSubscriptionProfile> resource as defined in clause 9.6.19 which need be updated, with the exception of the following that cannot be modified: • "lastModifiedTime". Processing at Originator before sending Request According to clause 10.1.4. Processing at Receiver According to clause 10.1.4. If the request is to update an attribute specifying a limit (e.g. maxNumNodes, maxNumContainers, etc.) to a reduced value, the Receiver shall update the attribute with the reduced value if the limit corresponding to the reduced value has not yet been exceeded. For example, if maxNumNodes has a value of 10 and the request is to update it to a value of 5 and only 4 <node> resources associated with this service subscription have been created thus far, then the Receiver shall update maxNumNodes attribute to a value of 5. However, if the limit corresponding to the reduced value in the request has already been exceeded, the Receiver shall reject the request or override the value specified in the request. For example, if the maxNumNodes attribute has a value of 10 and the request is to update it to a value of 5 but 6 <node> resources associated with this service subscription have already been created, then the Receiver shall either reject the request or update the value of the maxNumNodes attribute to 6. Information in Response message According to clause 10.1.4. If the Receiver overrides and configures any attributes with values different than the values specified in the request by the Originator, the Receiver shall return the values back to the Originator in the response depending on the Result Content value specified by the Originator. Processing at Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 411 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.12.5 Delete <m2mServiceSubscriptionProfile> | This procedure shall be used for deleting a <m2mServiceSubscriptionProfile> resource residing under a <m2mServiceSubscriptionProfile> resource. Table 10.2.12.5-1: <m2mServiceSubscriptionProfile> DELETE <m2mServiceSubscriptionProfile> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply with specific details for: To: The Receiver or Hosting CSE shall be an IN-CSE Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.12.6 Create <serviceSubscribedNode> | This procedure shall be used for creating a <serviceSubscribedNode> resource which is sub-resource of <m2mServiceSubscriptionProfile> resource. Table 10.2.12.6-1: <serviceSubscribedNode> CREATE <serviceSubscribedNode> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: • To: The Receiver or Hosting CSE shall be an IN-CSE. • Content: The resource content shall provide the information as defined in clause 9.6.20. Processing at Originator before sending Request According to clause 10.1.2. Processing at Receiver According to clause 10.1.2. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: Address of the created <serviceSubscribedNode> resource, according to clause 10.1.2. Processing at Originator after receiving Response According to clause 10.1.2: • After a successful creation of the <serviceSubscribedNode> resource, the Originator shall use a CREATE operation request to create a <node> resource. The request shall address a <CSEBase> of a Hosting CSE. The Originator shall set nodeID attribute of this <node> resource to a value equal to nodeID attribute of the <serviceSubscribedNode> resource. • The Originator shall use a CREATE operation request to create a [registration] resource. The request shall address the above-mentioned <node> resource. The Originator shall set M2M-Sub-ID attribute of [registration] resource to a value equal to M2M-Sub-ID attribute of the <m2mServiceSubscriptionProfile> resource which is the parent of this <serviceSubscribedNode> resource. • If the node which is represented by this <node> resource intends to use Security Association then the Originator shall use a CREATE operation request to create an [authenticationProfile] resource. The request shall address the above-mentioned <node> resource. The Originator shall set M2M-Sub-ID attribute of the [authenticationProfile] resource to a value equal to the M2M-Sub-ID attribute of the <m2mServiceSubscriptionProfile> resource which is the parent of this <serviceSubscribedNode> resource. Exceptions According to clause 10.1.2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 412 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.12.7 Retrieve <serviceSubscribedNode> | This procedure shall be used for retrieving the attributes of a <serviceSubscribedNode> resource which is sub-resource of <m2mServiceSubscriptionProfile> resource. Table 10.2.12.7-1: <serviceSubscribedNode> RETRIEVE <serviceSubscribedNode> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: The Receiver or Hosting CSE shall be an IN-CSE Content: Void Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 Information in Response message All parameters defined in table 8.1.3-1 apply Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.12.8 Update <serviceSubscribedNode> | This procedure shall be used for updating the attributes of a <serviceSubscribedNode> resource which is sub-resource of <m2mServiceSubscriptionProfile> resource. Table 10.2.12.8-1: <serviceSubscribedNode> UPDATE <serviceSubscribedNode> UPDATE Information in Request message All parameters defined in table 8.1.2-3 are applicable as indicate in the table with the specific details for: To: The Receiver or Hosting CSE shall be an IN-CSE Content: Attributes of the <serviceSubscribedNode> resource as defined in clause 9.6.16 which need be updated, with the exception of the following that cannot be modified: "lastModifiedTime" Processing at Originator before sending Request According to clause 10.1.4 Processing at Receiver According to clause 10.1.4 Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response According to clause 10.1.4 Exceptions According to clause 10.1.4 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.12.9 Delete <serviceSubscribedNode> | This procedure shall be used for deleting a <serviceSubscribedNode> resource residing under a <m2mServiceSubscriptionProfile> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 413 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.12.9-1: <serviceSubscribedNode> DELETE <serviceSubscribedNode> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: The Receiver or Hosting CSE shall be an IN-CSE. Processing at Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5: • The Originator shall use a DELETE operation request to delete a <node> resource. The request shall address the <node> resource having nodeID attribute same as that of deleted <serviceSubscribedNode> resource. The Originator can use a discovery request to find the resourceID of this <node> resource. Exceptions According to clause 10.1.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.12.10 Create <serviceSubscribedAppRule> | This procedure shall be used for creating an <serviceSubscribedAppRule> resource. The information represented in the attributes of a <serviceSubscribedAppRule> resource impacts the Application Entity Registration procedure as outlined in clause 10.2.2.2. Instances of <serviceSubscribedAppRule> resources are associated with specific CSEs by linking to them via the ruleLinks attribute of a <serviceSubscribedNode> resource that contains the respective CSE-ID in its CSE- ID attribute. Table 10.2.12.10-1: <serviceSubscribedAppRule> CREATE <serviceSubscribedAppRule> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: The Hosting CSE shall be an IN-CSE. Content: The resource content shall provide the information as defined in clause 9.6.29. Processing at Originator before sending Request According to clause 10.1.2. Processing at Receiver According to clause 10.1.2. Information in Response message All parameters defined in table 8.1.3-1 apply. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.12.11 Retrieve <serviceSubscribedAppRule> | This procedure shall be used for retrieving the representation of the <serviceSubscribedAppRule> resource. Table 10.2.12.11-1: <serviceSubscribedAppRule> RETRIEVE <serviceSubscribedAppRule> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: The Hosting CSE shall be an IN-CSE. Content: void. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message All parameters defined in table 8.1.3-1 apply. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 414 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.12.12 Update <serviceSubscribedAppRule> | This procedure shall be used for updating the attributes of the <serviceSubscribedAppRule> resource. Table 10.2.12.12-1: <serviceSubscribedAppRule> UPDATE <serviceSubscribedAppRule> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: The Hosting CSE shall be an IN-CSE. Content: Attributes of the <serviceSubscribedAppRule> resource as defined in clause 9.6.29. Processing at Originator before sending Request According to clause 10.1.4. Processing at Receiver According to clause 10.1.4. Information in Response message All parameters defined in table 8.1.3-1 apply. Processing at Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.12.13 Delete <serviceSubscribedAppRule> | This procedure shall be used for deleting the <serviceSubscribedAppRule> resource with all related information. Table 10.2.12.13-1: <serviceSubscribedAppRule> DELETE <serviceSubscribedAppRule> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: The Hosting CSE shall be an IN-CSE. Processing at Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5. Information in Response message All parameters defined in table 8.1.3-1 apply. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions According to clause 10.1.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.12.14 Create <serviceSubscribedUserProfile> | This procedure shall be used for creating a <serviceSubscribedUserProfile> resource. The information represented in the attributes of a <serviceSubscribedUserProfile> resource shall be used by a Hosting CSE to restrict the usage of services by a M2M Service User. For example, a Hosting CSE can use this information to enforce limits on the maximum number of <container> resources or the maximum number of <contentInstance> resources per parent <container> resource that a M2M Service User is permitted. Instances of <serviceSubscribedUserProfile> resources may be associated with specific AEs by linking them via the allowedUsers attribute of <serviceSubscribedAppRule> resources. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 415 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.12.14-1: <serviceSubscribedUserProfile> CREATE <serviceSubscribedUserProfile> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: The Hosting CSE shall be an IN-CSE. Content: The resource content shall provide the information as defined in clause 9.6.68. Processing at Originator before sending Request According to clause 10.1.2. Processing at Receiver According to clause 10.1.2. Information in Response message All parameters defined in table 8.1.3-1 apply. If the Receiver overrides and configures any attributes with values different than the values specified in the request by the Originator, the Receiver shall return the values back to the Originator in the response depending on the Result Content value specified by the Originator. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. The Receiver shall check that any values specified for the attributes of this <serviceSubscribedUserProfile> do not violate the limits (if specified) in the parent <m2mServiceSubscriptionProfile> resource (e.g. maxNumContainers). When performing this check, the Receiver shall check that the aggregated values of all attributes across all the <serviceSubscribedUserProfile> child resources do not violate the limits specified in the parent <m2mServiceSubscriptionProfile> resource. If the limts are exceeded, the Receiver shall reject the request or modify the values specified in the request. If limits are not specified in the parent <m2mServiceSubscriptionProfile> resource, the Receiver may use a limit based on local policy. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.12.15 Retrieve <serviceSubscribedUserProfile> | This procedure shall be used for retrieving the representation of the <serviceSubscribedUserProfile> resource. Table 10.2.12.15-1: <serviceSubscribedUserProfile> RETRIEVE <serviceSubscribedUserProfile> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: The Hosting CSE shall be an IN-CSE. Content: void. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message All parameters defined in table 8.1.3-1 apply. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.12.16 Update <serviceSubscribedUserProfile> | This procedure shall be used for updating the attributes of the <serviceSubscribedUserProfile> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 416 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.12.16-1: <serviceSubscribedUserProfile> UPDATE <serviceSubscribedUserProfile> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: The Hosting CSE shall be an IN-CSE. Content: Attributes of the <serviceSubscribedUserProfile> resource as defined in clause 9.6.68. Processing at Originator before sending Request According to clause 10.1.4. Processing at Receiver According to clause 10.1.4. If the request is to update an attribute specifying a limit (e.g. maxNumNodes, maxNumContainers, etc.) to a reduced value, the Receiver shall update the attribute with the reduced value if the limit corresponding to the reduced value has not yet been exceeded. For example, if maxNumNodes has a value of 10 and the request is to update it to a value of 5 and only 4 <node> resources associated with this user have been created thus far, then the Receiver shall update maxNumNodes attribute to a value of 5. However, if the limit corresponding to the reduced value in the request has already been exceeded, the Receiver shall reject the request or override the value specified in the request. For example, if the maxNumNodes attribute has a value of 10 and the request is to update it to a value of 5 but 6 <node> resources associated with this user have already been created, then the Receiver shall either reject the request or update the value of the maxNumNodes attribute to 6. Information in Response message All parameters defined in table 8.1.3-1 apply. If the Receiver overrides and configures any attributes with values different than the values specified in the request by the Originator, the Receiver shall return the values back to the Originator in the response depending on the Result Content value specified by the Originator. Processing at Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4. The Receiver shall check that any values specified for the attributes of this <serviceSubscribedUserProfile> do not violate the limits (if specified) in the parent <m2mServiceSubscriptionProfile> resource (e.g. maxNumContainers). When performing this check, the Receiver shall check that the aggregated values of all attributes across all the <serviceSubscribedUserProfile> child resources do not violate the limits specified in the parent <m2mServiceSubscriptionProfile> resource. If the limts are exceeded, the Receiver shall reject the request or modify the values specified in the request. If limits are not specified in the parent <m2mServiceSubscriptionProfile> resource, the Receiver may use a limit based on local policy. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.12.17 Delete <serviceSubscribedUserProfile> | This procedure shall be used for deleting the <serviceSubscribedUserProfile> resource with all related information. Table 10.2.12.17-1: <serviceSubscribedUserProfile> DELETE <serviceSubscribedUserProfile> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: To: The Hosting CSE shall be an IN-CSE. Processing at Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5. Information in Response message All parameters defined in table 8.1.3-1 apply. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions According to clause 10.1.5. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 417 (oneM2M TS-0001 version 4.15.0 Release 4) 10.2.13 Resource announcement |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.13.1 Introduction | This clause describes the procedures for announcing the original resource and de-announcing the announced resource. A resource may be announced from its Hosting CSE to one or more announcement target CSEs to inform the announcement target CSE(s) of the existence of the original resource. The announced resource also may be de- announced from the announcement target CSE(s). A limited set of attributes of original resource may be announced or de-announced in the resource announcement or de-announcement procedure. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.13.2 Procedure for AE and CSE to initiate Creation of an Announced Resource | This clause describes the procedure for an AE or a CSE to initiate the creation of an announced resource. Figure 10.2.13.2-1 depicts how creation of an announced resource is initiated (clause 10.2.13.2) and the announced resource is created on an announcement target CSE (clause 10.2.13.5). Figure 10.2.13.2-1: Announced resource CREATE procedures The Originator of a Request for initiating resource announcement can be either an AE or a CSE. Two methods are supported for initiating the creation of an announced resource: • CREATE: The Originator can initiate the creation of an announced resource during the creation of the original resource by providing announceTo attribute in the CREATE Request. • UPDATE: The Originator can initiate the creation of an announced resource by using the UPDATE Request to update the announceTo attribute at the original resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 418 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.13.2-1: Initiate Resource Announcement: UPDATE or CREATE Initiate Resource Announcement: CREATE or UPDATE Information in Request message All parameters defined in table 8.1.2-3 are applicable as indicated in that table. In addition, for the case of the CREATE procedure for a specific resource is described in clause 10.2. The Originator suggests the address(es) or the CSE-ID(s) to which the resource will be announced in the Content parameter. Processing at the Originator before sending Request Content: contains address where the resource needs to be announced (within announceTo attribute): • The Originator provides either the address(es) for the announced resource or the list of CSE-IDs of the remote CSEs where the original resource needs to be announced by including such information within the announceTo attribute of the UPDATE or CREATE Request. Processing at the Receiver Once the Originator has been successfully authorized, the Receiver (which shall be the original resource Hosting CSE) shall grant the Request after successful validation of the Request: • If the Request provides address(es) for the announced resource that are not already stored in the announceTo attribute or for a newly created announceTo attribute, the Receiver shall announce the resource to the provided address(es). • If the Request provides a list of CSE-IDs of the remote CSEs that are not already stored in the announceTo attribute or for the newly created announceTo attribute, the announced resource target location shall be the announced parent resource or the <CSEBaseAnnc> resource representing the Receiver at the announcement target CSE. In order to determine the target location, the Receiver shall: 1) Check if the parent resource is announced by checking the announceTo attribute of the parent resource and if so, create the announced resource as a child of the announced parent resource. 2) If the parent resource is not announced, the Receiver shall check if <CSEBaseAnnc> existsinto the announcement target CSE. If it does not exist, the Receiver shall create a <CSEBaseAnnc> resource as a child of the <CSEBase> resource of the announcement target CSE. The Receiver shall then create the announced resource as a child of the <CSEBaseAnnc> resource. Information in Response message On successful completion of resource announcement as in clause 10.2.3.5, the Receiver shall provide all parameters defined in table 8.1.3-1 that are applicable as indicated in that table in the Response message: • The Receiver shall provide the address(es) of the announced resource to the Originator which replace the given CSE-ID or URI in the content of the announceTo attribute in the original resource and by providing it in the UPDATE or CREATE Response message depending on the type of the Request. Processing at Originator after receiving Response According to clause 10.1.2 in case of CREATE Request. According to clause 10.1.4 in case of UPDATE Request. Exceptions All exceptions described in the basic procedures (clause 10.1.2) are applicable. If the parent resource of a contentInstance, or a timeSeriesInstance or a flexContainerInstance is not announced then the announcement shall fail. 10.2.13.3 Procedure at AE or CSE to Retrieve information from an Announced Resource This clause describes the procedures that shall be use for an AE or a CSE to retrieve information about an announced resource or the corresponding original resource. Figure 10.2.13.3-1 depicts how the announced resource is retrieved from an announcement target CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 419 (oneM2M TS-0001 version 4.15.0 Release 4) Original Resource Hosting CSE Local or Remote CSE Announcement Target CSE RemoteCSE Originator for RETRIEVE AE or RemoteCSE 001: Retrieve request for the announced resource 003: Response 002: Local Processing (After authorization, it performs the requested operation applying to the announced resource and the original resource, if needed, using link attribute) 10.2.13.3 Figure 10.2.13.3-1: Announced resource RETRIEVE procedures The Originator of a Request for initiating retrieval of information about a resource can be either an AE or a CSE. The Originator initiates this procedure by using RETRIEVE Request. Table 10.2.13.3-1: Announced Resource Information Retrieval: RETRIEVE Resource Retrieval: RETRIEVE Information in Request message Clause 8.1.2 specifies the information to be included in the Request message. Table 8.1.2-3 also describes the parameters that are applicable in the Request message: • Specifically, the To parameter is set to the address of the announced resource to be retrieved. • If a specific attribute is to be retrieved, the address of such attribute is included in the To parameter. • The Originator can specify one of the values for the optional Result Content parameter. • The Originator can request retrieval of the original resource by targeting the announced resource at the Hosting CSE by setting the Result Content parameter to the "original-resource". Processing at the Originator before sending Request The Originator can request retrieval of information from an announced resource at the Hosting CSE. Optionally, the Originator can request retrieval of the original resource by targeting the announced resource at the Hosting CSE by setting the Result Content parameter to the "original-resource. Processing at the Receiver Once the Originator has been successfully authorized, the Receiver (Hosting CSE) shall grant the Request after successful validation of the Request: • Information from the identified announced resource (at Hosting CSE) shall be returned to Originator via RETRIEVE Response, as described in clause 8.1.2. • If Result Content request message parameter set to "original-resource" is included in the Request message, the Receiver shall provide the representation of the original resource indicated by the link attribute in the announced resource. The Receiver shall retrieve the original resource to return the representation of the original resource to the Originator. Information in Response message Information from the identified announced resource (at Hosting CSE), or the original resource shall be returned to Originator via RETRIEVE Response, as described in clause 8.1.3. Exceptions All exceptions described in the basic procedure (clause 10.1.3) are applicable. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 420 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.13.4 Procedure for AE and CSE to initiate Deletion of an Announced Resource | This clause describes the procedure that shall be used for an AE or a CSE (not the original resource Hosting CSE) to initiate the deletion of an announced resource. Figure 10.2.13.4-1 depicts how deletion of an announced resource is initiated (clause 10.2.13.4) and the announced resource is deleted on an announcement target CSE (clause 10.2.13.6). Figure 10.2.13.4-1: Announced resource DELETE procedures The Originator of a Request for initiating resource de-announcement can be either an AE or a CSE. Two methods are supported for initiating resource de-announcement: • UPDATE: The Originator can request to initiate the deletion of an announced resource by using UPDATE Request to the announceTo attribute at the original resource Hosting CSE. • DELETE: Resource de-announcement (deletion) shall also be performed when the Originator deletes the original resource at the original resource Hosting CSE by using DELETE Request. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 421 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.13.4-1: Initiate Resource De-Announcement: UPDATE and DELETE Initiate Resource De-Announcement: UPDATE or DELETE Information in Request message All parameters defined in table 8.1.2-3 are applicable as indicated in that table. Processing at the Originator before sending Request The Originator shall perform one of the following for the deletion of an announced resource: • The Originator shall request to update the announceTo attribute at the original resource Hosting CSE by providing new content of the announceTo attribute which does not include the CSE-IDs of the announcement target CSEs where the announced resource needs to be de-announced (deleted) by the UPDATE operation. • The Originator shall request to delete the announceTo attribute at the original resource Hosting CSE by sending UPDATE Request that sets the value of the announceTo attribute to NULL for the deletion of all announced resources. • For DELETE operation, the Originator shall include the resource address of the original resource Hosting CSE that needs to be deleted, in the DELETE Request. • Content: Void. Processing at the Receiver Once the Originator has been successfully authorized, the Receiver (which shall be the original resource Hosting CSE) shall grant the Request after successful validation of the Request. The Receiver shall be the resource Hosting CSE. On receiving the UPDATE or DELETE Request, the Receiver shall perform as follows: • For UPDATE Request, the Receiver shall request to delete the announced resource(s) whose address(es) is/are not included in the announceTo attribute of the request as per procedures in clause 10.2.13.6. • For DELETE Request, the Receiver shall request to delete all announced resources in the announceTo attribute as per procedures in clause 10.2.13.6. Information in Response message On successful completion of resource de-announcement procedure in clause 10.2.13.6, the Receiver knows that the announced resource has been deleted: • The Receiver shall provide confirmation of resource de-announcement to the Originator. • The content of the updated announceTo attribute shall be provided to the Originator to indicate the successfully deleted announced resource, if the announceTo attribute is not deleted by the Originator in the Request message. Exceptions All exceptions described in the basic procedure (clause 10.1.4) are applicable for UPDATE operation. All exceptions described in the basic procedure (clause 10.1.5) are applicable for DELETE operation. 10.2.13.5 Procedure for original resource Hosting CSE to Create an Announced Resource This clause explains the resource announcement procedure that shall be used by the original resource Hosting CSE to announce the original resource to the remote CSE(s). See figure 10.2.13.2-1 for the graphical explanation. The Originator of this Request shall be the original resource Hosting CSE. The Originator shall request to create the announced resource by using CREATE Request. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 422 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.13.5-1: Resource Hosting CSE to Announce Resource: CREATE Resource Announcement: CREATE Information in Request message All parameters defined in table 8.1.2-3 are applicable as indicated in that table. Content: contains MA attributes and OA attributes that are included in announcedAttribute attribute. Processing at the Originator before sending Request Other details for the information in the Request message shall be as follows: • Attributes marked with MA and attributes marked with OA that are included in the announcedAttribute attribute at the original resource shall be provided in the CREATE Request. Such attributes shall have the same value as for the original resource. • resourceType which shall be set to the appropriate tag that identifies the <Annc> resource. • expirationTime provided by the Originator equal to the one for the original resource. • The link attribute of the announced resource shall have the address of the original resource in SP-relative Resource-ID format or Absolute Resource-ID format. • The labels attribute of the announced resource shall have the same value as for the original resource. • The accessControlPolicyIDs attribute shall always be provided in the CREATE Request even if it is not present in the original resource. In this case the original resource shall include accessControlPolicyIDs from its parent resource or from the local policy at the original resource, as needed. • accessControlPolicyIDs and labels attributes, if present at the original resource, shall be provided by the original resource Hosting CSE in the CREATE Request. Such attributes shall have the same value at the original resource and at the announced resource(s). • If an attribute that is to be announced has an identifier type (i.e. CSE-ID, AE- ID, resource identifier), the Originator shall convert the value of the original resource attribute to an identifier format (see table 7.2-1) required by the Receiver. Processing at the Receiver Once the Originator has been successfully authorized, the Receiver shall grant the Request after successful validation of the Request. The Receiver shall perform as follows: • The basic procedure (clause 10.1.2) for the Receiver of the CREATE Request apply. • The created announced resource shall include the common attributes specified in clause 9.6.26.1. The created announced resource shall contain the additional attributes that are provided by the Originator; i.e. attributes marked with MA and the attributes marked with OA that are included in the announcedAttribute attribute. • The created announced resource shall set the accessControlPolicyIDs attribute to the value received in the Request message, and shall set the labels attribute (if present) and the link attribute to the value received in the Request message. • Respond to the Originator with the CREATE Response. In this Response, the address of the successfully announced resource shall be provided. Information in Response message All parameters defined in table 8.1.3-1 are applicable as indicated in that table with the specific details for: Content: address where the announced resource is created according to clause 10.1.2. Processing at Originator after receiving Response The Originator after receiving the Response from the Receiver shall perform the following steps: • If the announced resource has been successfully created, the announceTo attribute of the original resource shall be updated to include the address for the successfully announced resource at the Receiver. The announcedAttribute attribute shall be updated as well to represent the successfully announced attributes as received in the Response. • For the attributes marked as MA and for the attributes marked as OA that are included in the announcedAttribute attribute, the Originator shall further take the responsibility to keep their values synchronized at the announced resource by using UPDATE operation (clause 10.1.4). Exceptions All exceptions described in the basic procedures (clause 10.1.2) are applicable. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 423 (oneM2M TS-0001 version 4.15.0 Release 4) 10.2.13.6 Procedure for original resource Hosting CSE to Delete an Announced Resource This clause explains the procedure that shall be used for deleting an announced resource (i.e. the resource de- announcement). This procedure shall be used by the original resource Hosting CSE for deleting the announced resource that resides at the remote CSE. The Originator of this Request shall be the original resource Hosting CSE. Table 10.2.13.6-1: Resource Hosting CSE to De-Announce Resource: DELETE Resource De-Announcement: DELETE Information in Request message All parameters defined in table 8.1.2-3 are applicable as indicate in that table. From: Identifier of the CSE that initiates the Request. To: The address where announced resource needs to be deleted. Processing at the Originator before sending Request The Originator shall request to delete an announced resource by using the DELETE Request. To: Parameter provides an address that identifies the announced resource to be deleted. Processing at the Receiver If the value of the From parameter in Request message is identical with the CSE-ID included in the link attribute in the announced resource, the Receiver shall grant the Request after successful validation of the Request: • Delete the announced resource identified by the To parameter in the Request, as per basic procedure in clause 10.1.5. • Respond to the Originator with the appropriate DELETE Response, as per basic procedure in clause 10.1.5. Information in Response message No change from the basic procedure (clause 10.1.5). Processing at Originator after receiving Response The Originator after receiving the Response from the Receiver shall: • If the announced resource is successfully deleted, the announceTo attribute in the original resource shall be updated to delete the address for the deleted announced resource. Exceptions All exceptions described in the basic procedures (clause 10.1.5) are applicable. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.13.7 Procedure for AE and CSE to initiate the Creation of an Announced Attribute | This clause describes the procedure that shall be used for an AE and CSE (not the original resource Hosting CSE) to initiate the creation of an announced attribute (attribute announcement). The Originator of a Request, for initiating attribute announcement, can be either AE or CSE (not the original resource Hosting CSE). Table 10.2.13.7-1: Initiate Creation of Announced Attributes Initiate Attribute Announcement: UPDATE Information in Request message Parameters defined in table 8.1.2-3 that are applicable for UPDATE. Content parameter includes the names of the attributes to be announced. Processing at the Originator before sending Request The Originator shall request attribute announcement by updating the announcedAttribute attribute at the original resource: • The Originator shall update the announcedAttribute attribute at the original resource by adding the attribute name for the attribute that needs to be announced by using the UPDATE Request. Only the attributes marked with OA can be announced to remote announced resources. Processing at the Receiver Once the Originator has been successfully authorized, the Receiver, which shall be the original resource Hosting CSE, shall grant the Request after successful validation of the Request. • The attributes received in the Request, which are not marked as OA, are invalid. • The attributes received in the Request, which are not present in the original resource structure, are invalid. • If some attributes received in the Request do not already exist in the announcedAttribute attribute, the Receiver shall announce such attributes to all announced resources listed in the announceTo attribute as per procedures in clause 10.2.13.9. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 424 (oneM2M TS-0001 version 4.15.0 Release 4) Initiate Attribute Announcement: UPDATE On successful announcement of attributes as per procedures in clause 10.2.13.9, the Receiver shall perform the following: • The Receiver shall respond to the Originator (requesting AE/CSE) with UPDATE Response as specified in clause 10.1.4. The content of the announced attributes can be provided in such Response. Information in Response message Parameters defined in table 8.1.3-1 that are applicable. Exceptions All exceptions described in the basic procedures (clause 10.1.4) are applicable. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.13.8 Procedure for AE and CSE to initiate the Deletion of an Announced Attribute | This clause describes the procedure that shall be used for an AE and CSE (not the original resource Hosting CSE) to initiate the deletion of announced attributes (attribute de-announcement). The Originator of a Request, for initiating attribute de-announcement, can be either AE or CSE (not the original resource Hosting CSE). Table 10.2.13.8-1: Initiate Deletion of Announced Attributes Initiate Attribute De-Announcement: UPDATE Information in Request message Parameters defined in table 8.1.2-3 that are applicable for UPDATE. Content parameter does not include the names of the attributes to be de-announced. Processing at the Originator before sending Request The Originator shall request attribute de-announcement by updating the announcedAttribute attribute at the original resource as follows: • The Originator shall update the announcedAttribute attribute at the original resource by deleting the attribute name for the attribute that needs to be de- announced by using the UPDATE Request. Only the attributes marked with OA can be de-announced to remote announced resources. Processing at the Receiver Once the Originator has been successfully authorized, the Receiver, which shall be the original resource Hosting CSE, shall grant the Request after successful validation of the Request: • The attributes received in the Request, which are not marked as OA, are invalid. • If some attributes that exist in the announcedAttribute attribute are not received in the Request (i.e. attributes that need to be deleted by the UPDATE Request), the Receiver shall de-announce such attributes to all announced resources listed in the announceTo attributes as per procedure in clause 10.2.3.10. On successful de-announcement of all attributes as per procedures in clause 10.2.3.10, the Receiver shall perform the following: • The Receiver shall respond to the Originator (requesting AE/CSE) with UPDATE Response as specified in clause 10.1.4. The names of the de- announced attributes can be provided in such Response. Information in Response message Parameters defined in table 8.1.3-1 that are applicable. Exceptions All exceptions described in the basic procedures (clause 10.1.4) are applicable. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.13.9 Procedure for original resource Hosting CSE for Announcing Attributes | This clause describes procedure that shall be used by the original resource Hosting CSE to create announced attributes at the remote announced resources (i.e. the attribute announcement). The Originator of this Request shall be the original resource Hosting CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 425 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.13.9-1: Original Resource Hosting CSE to Announce Attribute: UPDATE Attribute Announcement: UPDATE Information in Request message Information described for the Originator of the UPDATE Request as in clause 10.1.4. Content: Parameter includes the names of the attributes to be announced and their values. Processing at the Originator before sending Request The Originator shall request to create attributes at the announced resources by using the UPDATE Request as specified in clause 10.1.4. Only parameters marked with OA can be announced. If an attribute that is to be announced has an identifier type (i.e. CSE-ID, AE-ID, resource identifier), the Originator shall convert the value of the original resource attribute to an identifier format (see table 7.2-1) required by the Receiver. Processing at the Receiver Once the Originator has been successfully authorized, the Receiver (CSE hosting announced resource) shall grant the Request after successful validation of the Request. The Receiver shall perform as follows: • Create announced attributes at the announced resource as per procedures in clause 10.1.4. The initial value for the announced attributes shall use the same value as with the original resource. • Respond to the Originator with UPDATE Response as in clause 10.1.4. Information in Response message Parameters defined in table 8.1.3-1 that are applicable. Processing at Originator after receiving Response Originator after receiving the Response from the Receiver shall perform the following steps: • If the announced attributes have been successfully created, the announcedAttribute attribute shall be updated to include the attribute names for the successfully announced attributes. • For the newly announced attributes in the announcedAttribute attribute, the Originator shall take the responsibility to keep their values synchronized at the announced resources by using UPDATE operation as in clause 10.1.4. Exceptions All exceptions described in the basic procedures (clause 10.1.4) are applicable. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.13.10 Procedure for original resource Hosting CSE for De-Announcing Attributes | This clause describes procedure that shall be used by the original resource Hosting CSE to remove announced attributes at remote announced resources (i.e. the attribute de-announcement). The Originator of this Request shall be the original resource Hosting CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 426 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.13.10-1: Original Resource Hosting CSE to De-Announce Attribute: UPDATE Attribute De-Announcement: UPDATE Information in Request message Information described for the Originator of the UPDATE Request as in clause 10.1.4. Content: Parameter includes the names of the attributes to be deleted (de-announced) with their values set to NULL. Processing at the Originator before sending Request The Originator shall request to delete the announced attributes by using the UPDATE Request as specified in clause 10.1.4. Only attributes marked as OA can be de- announced: Content: Parameter in the UPDATE Request shall provide the names of the attributes to be de-announced by setting their values set to NULL. Processing at the Receiver If the value of the From parameter in Request message is identical with the CSE-ID included in the link attribute in the announced resource, the Receiver (CSE hosting announced resource) shall grant the Request after successful validation of the Request. The Receiver shall perform as follows: • Delete the de-announced attributes identified by the Content parameter in the UPDATE Request as per procedures in clause 10.1.4. • Respond to the Originator with the appropriate UPDATE Response as in clause 10.1.4. Information in Response message Parameters defined in table 8.1.3-1 that are applicable. Processing at Originator after receiving Response The Originator after receiving the Response from the Receiver shall perform the following steps: • If the attributes have been successfully removed, the announcedAttribute attribute shall be updated so as to remove the attribute names for the successfully de-announced attributes. Exceptions All exceptions described in the basic procedures (clause 10.1.4) are applicable. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.13.11 Procedure for original resource Hosting CSE for Updating Attributes | This clause describes procedure that shall be used by the original resource Hosting CSE to update announced attributes at the remote announced resources. The Originator of this Request shall be the original resource Hosting CSE. Table 10.2.13.11-1: Original Resource Hosting CSE to Update Attribute: UPDATE Attribute Update: UPDATE Information in Request message Information described for the Originator of the UPDATE Request as in clause 10.1.4. Content: Parameter includes the names of the attributes to be updated with their target values. Processing at the Originator before sending Request The Originator shall request to update the announced attributes by using the UPDATE Request as specified in clause 10.1.4. Attributes marked as MA or OA can be updated: Content: Parameter in the UPDATE Request shall provide the names of the attributes to be updated by setting their target values. If an attribute has an identifier type (i.e. CSE-ID, AE-ID, resource identifier), the Originator shall convert the target value of this attribute to an identifier format (see table 7.2-1) required by the Receiver. Processing at the Receiver If the value of the From parameter in Request message is identical with the CSE-ID included in the link attribute in the announced resource, the Receiver (CSE hosting announced resource) shall grant the Request after successful validation of the Request. The Receiver shall perform as follows: • Update the target attributes identified by the Content parameter in the UPDATE Request as per procedures in clause 10.1.4. • Respond to the Originator with the appropriate UPDATE Response as in clause 10.1.4. Information in Response message Parameters defined in table 8.1.3-1 that are applicable. Exceptions All exceptions described in the basic procedures (clause 10.1.4) are applicable. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 427 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.13.12 Notification Procedure targeting an AE Announced Resource | This clause describes handling of notifications received at an <AEAnnc> resource Hosting CSE. Table 10.2.13.12-1: Notification Procedure for AE Announced Resource Notification Procedure for AE Announced Resource Information in Request message Notification message made according to clause 10.2.10 Processing at the Originator before sending Request According to clause 10.1.6 Processing at the Receiver <AEAnnc> hosting CSE shall forward received notification message to original resource Hosting CSE targeting original <AE> resource when <AE> resource is available Information in Response message According to clause 10.1.6 Processing at Originator after receiving Response According to clause 10.1.6 Exceptions According to clause 10.1.6 10.2.14 Semantics management Semantics management is performed for the purpose of leveraging CRUD operations on semantic-related resources to enable semantic functionalities in service layer (e.g. enhancing the meaning of resources and data in the system). Table 10.2.14-1 summarizes the specialized resource types defined for the purpose of providing semantic enablement, providing references to the resource type definition clause. The table also provides references to the corresponding CRUD procedures. Table 10.2.14-1: Specialized resource types for semantic management Resource type Description Resource Type Reference CRUD procedures <semanticDescriptor> Resource type used for annotating resources with semantic descriptions, providing the means for resource discovery in a semantically- aware fashion and for semantic queries. 9.6.30 [14] clause 6.1 <semanticFanOutPoint> Virtual resource type used to form an overall graph based on the content of the semantic descriptors associated with the members of the group, for the purpose of performing semantic resource discovery and semantic query. 9.6.14a [14] clause 6.2 <semanticMashupJobProfile > Resource type describing the profile and necessary information (e.g. input parameters, member resources, mashup function, output parameters) required for a specific mashup service. 9.6.53 [14] clause 6.3 <semanticMashupInstance> Resource type describing a mashup instance based on mashup request and implementing the semantic mashup function. Each instance corresponds to a semantic mashup job profile. 9.6.54 [14] clause 6.4 <mashup> Virtual resource type used for triggering a calculation and generation of the mashup result based on its parent resource. 9.6.55 [14] clause 6.5 <semanticMashupResult> Resource type storing the result generated when it executes a semantic mashup operation. 9.6.56 [14] clause 6.6 <ontology> Resource type storing the representation of an ontology. 9.6.51 [14] clause 6.8 <ontologyRepository> Resource type for storage of all ontology representations. 9.6.50 [14] clause 6.7 <semanticValidation> Virtua resource type used to trigger validation of semantic content. 9.6.52 [14] clause 6.9 <semanticRuleRepository> Resource type for storage of different reasoning rule sets. 9.6.65 [14] clause 6.10 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 428 (oneM2M TS-0001 version 4.15.0 Release 4) Resource type Description Resource Type Reference CRUD procedures <reasoningRules> Resource type for storage of a particular set of reasoning rules. 9.6.66 [14] clause 6.11 <reasoningJobInstance> Resource type for describing a reasoning job instance. 9.6.67 [14] clause 6.12 <ontologyMapping> Resource type for the mapping between two different ontologies. 9.6.70 [14] clause 6.13 <ontologyMappingAlgorithm Repository> Resource type for storing a collection of ontology mapping algorithms. 9.6.71 [14] clause 6.14 <ontologyMappingAlgorithm> Resource type for a single ontology mapping algorithm. 9.6.72 [14] clause 6.15 Table 10.2.14-2 summarizes the specialized procedures defined for the purpose of providing semantic enablement, providing references to the oneM2M TS-0034 [14] clauses where the detail procedural descriptions are provided. Table 10.2.14-2: Specialized procedures and functions for semantic management Procedure Description Reference Access Control for Semantic Content Functionality enabling the use of access control information applicable to resources for accessing RDF triple content when executing semantic operations. [14] clause 7.2 Semantics Annotation Functionality for providing semantic description for resources and content. [14] clause 7.3 Semantic Filtering and Discovery Procedures for the discovery of resources and semantic information, respectively, based on the semantic annotation. [14] clause 7.4 Semantics Mash-up Procedures enabling the creation, execution and result retrieval of functions based on semantic mashup. [14] clause 7.7 Semantic Query Procedures for directly retrieving both explicitly and implicitly derived information based on syntactic, semantic and structural information contained in semantic content data (such as RDF triples). The result of a semantic query is the semantic information/knowledge for answering/matching the query. [14] clause 7.5 Semantic Validation Procedures enabling the validation of semantic content. [14] clause 7.10 Ontology Management Procedures enabling the use and management of ontologies. [14] clause 7.9 Semantic Reasoning Procedures enabling semantic reasoning-related functionalities. [14] clause 7.11 Ontology Mapping Procedures enabling the ontology mapping and the semantic discovery/discovery based on the ontology mapping result. [14] clause 7.12 10.2.15 3GPP network interworking |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.15.1 Introduction | This clause introduces the functionality supporting 3GPP interworking and 3GPP CIoT features. The oneM2M system leverages the IoT related features and services that 3GPP added in releases 10 through 14. At the field Node level, features and services may be accessed by an ADN-AE, MN-CSE, or an ASN-CSE that is hosted on a UE. IN-CSEs are also able to access services that are exposed by a mobile network operator. Detailed analysis of interworking features and specification for the related functionality are provided in ETSI TS 118 126 [15]. Table 10.2.15.1-1 summarizes the specialized procedures defined for the purpose of providing 3GPP Interworking, providing references to other clauses where the detail procedural descriptions are provided. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 429 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.15.1-1: Specialized procedures and functions for 3GPP Interworking Procedure Description References Device Triggering Functionality enabling nodes in the infrastructure domain to initiate sending of information to a node in the field domain. See [15] clause 7.5 Group Message Delivery Functionality enabling communication to a group of nodes in the field domain. See [15] clause 7.7 Configuration of Traffic Patterns Procedures enabling the oneM2M System to provide service layer information about the communication patterns of oneM2M devices to the Underlying Network. See [15] clause 7.6 Background Data Transfer Procedures enabling nodes in the infrastructure domain to negotiate with the Underlying Network a background data transfer for a set of field nodes. See [15] clause 7.10 Monitoring events Procedures enabling nodes in the infrastructure domain to request monitoring of Underlying Network evenest. See [15] clause 7.4 Change the chargeable party Procedures enabling the infrastructure nodes to request a change of chargeable party for the traffic flows. See [15] clause 7.11 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.15.2 Create <triggerRequest> | This procedure shall be used for creating a <triggerRequest> resource. Table 10.2.15.2-1: <triggerRequest> CREATE <triggerRequest> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.49. Processing at Originator before sending Request According to clause 10.1.2. Processing at Receiver According to clause 10.1.2 with the following modifications: • The trigger payload sent in the Trigger request shall be serialized based on the contentSerialization attribute of the <AE> or <remoteCSE> resource of the targeted entity. • The CSE shall determine which NSE to send the trigger request to. The CSE may determine which NSE based on locally provisioned information or based on a DNS lookup of the M2M-Ext-ID. If an NSE cannot be determined, the IN- CSE sets the triggerStatus attribute to ERROR-NSE-NOT-FOUND. Otherwise, the CSE sets the triggerStatus attribute to PROCESSING. • The CSE shall submit a trigger request to the appropriate NSE using the appropriate Mcn protocol. The message shall contain information needed by the NSE to generate a trigger request for the corresponding underlying network. For example, for a 3GPP trigger request the required information needed within the trigger request message is captured in ETSI TS 118 126 [15]. • Upon receipt of trigger response(s) from the NSE, the CSE shall set the triggerStatus attribute of the <triggerRequest> resource. If the CSE receives a confirmation from the NSE that the trigger was accepted, the CSE shall set the triggerStatus attribute to TRIGGER-SUBMITTED. If the CSE receives an indication that the trigger request was successfully delivered, the CSE shall set the triggerStatus attribute to TRIGGER-DELIVERED. If the CSE receives an indication that the trigger request was not accepted or the delivery was not successful, the CSE shall set the triggerStatus attribute to TRIGGER- FAILED. Information in Response message According to clause 10.1.2. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 430 (oneM2M TS-0001 version 4.15.0 Release 4) |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.