hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.1.4.5 Update primitive mapping for factory reset operation | The Update Request and Response primitives that results in a factory reset operation (e.g. factoryReset attribute of Resource [ reboot]) shall use the FactoryReset RPC defined in BBF TR-069 [4]. The FactoryReset RPC is an asynchronous command. The FactoryReset RPC returns a successful response or one of the following fault codes in table 8.1.4.5-1. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 29 oneM2M TS-0006 version 3.6.2 Release 3 Table 8.1.4.5-1: FactoryReset Fault Code Mapping Fault code Description Response Status Code 9000 Method not supported 4000 (BAD_REQUEST) 9001 Request denied (no reason specified) 4000 (BAD_REQUEST) 9002 Internal error 4000 (BAD_REQUEST) 9003 Invalid arguments 4000 (BAD_REQUEST) |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.1.4.6 Update primitive mapping for software install operation | The Update Request and Response primitives that results in a software installation operation (e.g. install attribute of Resource [software]) shall use the ChangeDUState mechanism defined in BBF TR-069 [4]. The ChangeDUState mechanism is an asynchronous command that consists of the synchronous ChangeDUState RPC for the download and the asynchronous ChangeDUStateComplete RPC. The ChangeDUState RPC returns a successful response or one of the following fault codes in table 8.1.4.6-1. A successful response means that the CPE has accepted the ChangeDUState RPC. Table 8.1.4.6-1: ChangeDUState Fault Code Mapping Fault code Description Response Status Code 9000 Method not supported 4000 (BAD_REQUEST) 9001 Request denied (no reason specified) 4000 (BAD_REQUEST) 9002 Internal error 4000 (BAD_REQUEST) 9004 Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) 4000 (BAD_REQUEST) Once the CPE has attempted to change the state of the deployment unit, the CPE reports the result of the state change operation using the ChangeDUStateComplete RPC. The ChangeDUStateComplete RPC indicates a successful operation or one of the following fault codes in table 8.1.4.6-2. Table 8.1.4.6-2: ChangeDUStateComplete Fault Code Mapping Fault code Description Response Status Code 9001 Request denied (no reason specified) 4000 (BAD_REQUEST) 9003 Invalid arguments 4000 (BAD_REQUEST) 9012 File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9013 Unsupported protocol for file transfer (associated with Upload, Download, ScheduleDownload, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9015 File transfer failure: unable to contact file server (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9016 File transfer failure: unable to access file (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9017 File transfer failure: unable to complete download (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9018 File transfer failure: file corrupted or otherwise unusable (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9022 Invalid UUID Format (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install, Update, and Uninstall) 4000 (BAD_REQUEST) 9023 Unknown Execution Environment (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install only) 4000 (BAD_REQUEST) 9024 Disabled Execution Environment (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install, Update, and Uninstall) 4000 (BAD_REQUEST) 9025 Deployment Unit to Execution Environment Mismatch (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install and Update) 4000 (BAD_REQUEST) ETSI ETSI TS 118 106 V3.6.2 (2021-02) 30 oneM2M TS-0006 version 3.6.2 Release 3 Fault code Description Response Status Code 9026 Duplicate Deployment Unit (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install only) 4000 (BAD_REQUEST) 9027 System Resources Exceeded (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install and Update) 4000 (BAD_REQUEST) 9028 Unknown Deployment Unit (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update and Uninstall) 4000 (BAD_REQUEST) 9029 Invalid Deployment Unit State (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install, Update and Uninstall) 4000 (BAD_REQUEST) 9030 Invalid Deployment Unit Update - Downgrade not permitted (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update only) 4000 (BAD_REQUEST) 9031 Invalid Deployment Unit Update - Version not specified (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update only) 4000 (BAD_REQUEST) 9032 Invalid Deployment Unit Update - Version already exists (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update only) 4000 (BAD_REQUEST) |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.1.5 Retrieve primitive mapping | The Retrieve Request and Response primitives shall map to the GetParameterValues RPC. The GetParametersValue RPC is defined in BBF TR-069 [4] as a synchronous RPC and returns a successful response or one of the following fault codes in table 8.1.5-1. Table 8.1.5-1: GetParameterValues Fault Code Mapping Fault code Description Response Status Code 9001 Request denied (no reason specified) 4000 (BAD_REQUEST) 9002 Internal error 4000 (BAD_REQUEST) 9003 Invalid arguments 4000 (BAD_REQUEST) 9004 Resources exceeded (when used in association with SetParameterValues, this cannot used to indicate Parameters in error) 4000 (BAD_REQUEST) 9005 Invalid Parameter name (associated with Set/GetParameterValues, GetParameterNames, Set/GetParameterAttributes, AddObject, and DeleteObject) 4000 (BAD_REQUEST) |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.1.6 Notify primitive mapping | |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.1.6.0 Introduction | The NotifyRequest and Response primitives permit notifications to AE or CSEs that have subscribed to a Resource. While BBF TR-069 [4] has the capability to notify the subscribed ACS when an object's parameter has been modified, BBF TR-069 [4] does not have the capability for an ACS to be notified if any parameter within the object has been modified unless the ACS individually subscribes to all the parameters of the object. As such the procedure for mapping the Notify Request and Response primitives for BBF TR-069 [4] is not possible unless the CSE subscribes to receive notification to all the parameters of an Object that are mapped to the Resource's attributes. NOTE: In many implementations, subscribing to all the parameters of an Object that are mapped to the Resource can cause performance issues in the CPE as well as the CSE. As such using the attribute based subscription capabilities of BBF TR-069 [4] for subscription of Resources should be avoided when possible. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 31 oneM2M TS-0006 version 3.6.2 Release 3 |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.1.6.1 Procedure for subscribed Resource attributes. | When a <subscription> Resource for a <mgmtObj> Resource is Created, Deleted or Updated the CSE shall map to the SetParameterAttributes RPC in the following manner: • BBF TR-069 [4] provides the capability to subscribe to changes of a specific attribute through the use of the SetParameterAttributes RPC using the "Active" value for the Notification parameter. • BBF TR-069 [4] provides the capability to un-subscribe to changes of a specific attribute through the use of the SetParameterAttributes RPC using the "None" value for the Notification parameter. The SetParametersAttributes RPC is defined in BBF TR-069 [4] as a synchronous RPC and returns a successful response or one of the following fault codes in table 8.1.6.1-1. Table 8.1.6.1-1: SetParameterAttributes Fault Code Mapping Fault code Description Response Status Code 9000 Method not supported 4000 (BAD_REQUEST) 9001 Request denied (no reason specified) 4000 (BAD_REQUEST) 9002 Internal error 4000 (BAD_REQUEST) 9003 Invalid arguments 4000 (BAD_REQUEST) 9004 Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) 4000 (BAD_REQUEST) 9010 File transfer failure (associated with Download, ScheduleDownload, TransferComplete or AutonomousTransferComplete methods) 4000 (BAD_REQUEST) |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.1.6.2 Notification primitive mapping | Notify Request and Response primitives shall map to the BBF TR-069 [4] notification mechanism. CPEs produce notifications for subscribed attributes using the BBF TR-069 [4] Inform method, the Inform method has an argument Event that has as one of the EventCodes with the value "4 VALUE CHANGE" indicating that a subscribed parameter's value has changed. The parameter(s) that have changed are included ParameterList argument of the Inform method. The ParameterList argument is list of name-value pairs; the name is parameter name and shall be mapped to the objectPath attribute of the Resource while the value is the most recent value of the parameter. NOTE: BBF TR-069 [4] CPEs do not report value changes of parameters that were modified by the ACS. 8.2 <mgmtCmd> and <execInstance> resource primitive mappings |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.2.1 Update (Execute) primitive for the <mgmtCmd> resource | |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.2.1.0 Introduction | When the Update Request primitive for <mgmtCmd> resource addresses the execEnable attribute of the <mgmtCmd> resource, it effectively triggers an Execute <mgmtCmd> procedure. The Hosting CSE performs command conversion of its <execInstance> sub-resources. The mapping between the <execInstance> attributes and the BBF TR-069 [4] RPC procedures triggered is based on the value of the cmdType attribute of the <mgmtCmd> resource defined in table 8.2.1.0-1. The CPE acceptance of the corresponding RPC procedures is indicated by returning a successful Response primitive to the initial Update Request. The Fault Codes which may be returned by the CPE to the Hosting CSE are mapped onto execResult codes and stored in the corresponding <execInstance> attributes, and are detailed in the following clauses. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 32 oneM2M TS-0006 version 3.6.2 Release 3 Table 8.2.1.0-1: Mapping of Execute <mgmtCmd> primitives to BBF TR-069 [4] RPC cmdType value BBF TR-069 [4] RPCs "DOWNLOAD" Download RPC (see clause 8.2.1.1) and TransferComplete RPC (clause 8.2.1.3) "UPLOAD" Upload RPC (clause 8.2.1.2) and TransferComplete RPC (clause 8.2.1.3) "SOFTWAREINSTALL" ChangeDUState RPC (clause 8.2.1.4) and ChangeDUStateComplete RPC (clause 8.2.1.5) "SOFTWAREUNINSTALL" ChangeDUState RPC (clause 8.2.1.4) and ChangeDUStateComplete RPC (clause 8.2.1.5) "REBOOT" Reboot RPC (clause 8.2.1.6) "RESET" Factory reset RPC (clause 8.2.1.7) |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.2.1.1 Execute File Download | The download file transfer operation may use the Download mechanism defined in BBF TR-069 [4]. The Download mechanism is an asynchronous command which returns a successful response or one of the following fault codes mapped onto execResult values as detailed in table 8.2.1.1-1. A successful response to the Update primitive triggering the Execute procedure means that the CPE has accepted the Download RPC. Table 8.2.1.1-1: Download Fault Code Mapping Fault code Description execResult Code 9000 Method not supported STATUS_REQUEST_UNSUPPORTED 9001 Request denied (no reason specified) STATUS_REQUEST_DENIED 9002 Internal error STATUS_INTERNAL_ERROR 9003 Invalid arguments STATUS_INVALID_ARGUMENTS 9004 Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) STATUS_RESOURCES_EXCEEDED 9010 File transfer failure (associated with Download, ScheduleDownload, TransferComplete or AutonomousTransferComplete methods) STATUS_FILE_TRANSFER_FAILED 9012 File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods, not associated with Scheduled Download method) STATUS_FILE_TRANSFER_SERVER_AUTH ENTICATION_FAILURE 9013 Unsupported protocol for file transfer (associated with Upload, Download, ScheduleDownload, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) STATUS_UNSUPPORTED_PROTOCOL |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.2.1.2 Execute File Upload Operations | The upload file transfer operation shall use the Upload mechanism defined in BBF TR-069 [4]. The Upload mechanism is an asynchronous command that consists of the synchronous Upload RPC for the Upload and the asynchronous TransferComplete RPC. The Upload RPC returns a successful response or one of the following fault codes mapped onto execResult values as detailed in table 8.2.1.2-1. A successful response to the Update primitive triggering the execute procedure means that the CPE has accepted the Upload RPC in table 8.2.1.2-1. Table 8.2.1.2-1: Upload Fault Code Mapping Fault code Description execResult Code 9000 Method not supported STATUS_REQUEST_UNSUPPORTED 9001 Request denied (no reason specified) STATUS_REQUEST DENIED 9002 Internal error STATUS_INTERNAL_ERROR 9003 Invalid arguments STATUS_INVALID_ARGUMENTS 9004 Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) STATUS_RESOURCES_EXCEEDED ETSI ETSI TS 118 106 V3.6.2 (2021-02) 33 oneM2M TS-0006 version 3.6.2 Release 3 Fault code Description execResult Code 9011 Upload failure (associated with Upload, TransferComplete or AutonomousTransferComplete methods) STATUS_UPLOAD_FAILED 9012 File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) STATUS_FILE_TRANSFER_SERVER_AUTHENTI CATION_FAILURE 9013 Unsupported protocol for file transfer (associated with Upload, Download, ScheduleDownload, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) STATUS_UNSUPPORTED_PROTOCOL |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.2.1.3 Report Results using TransferComplete RPC | After a File Download or Upload has been attempted, the result of the operation is reported using the TransferComplete RPC. The TransferComplete RPC indicates a successful operation or one of the following fault codes mapped onto execResult values in table 8.2.1.3-1. Table 8.2.1.3-1: TransferComplete Fault Code Mapping Fault code Description execResult Code 9001 Request denied (no reason specified) STATUS_REQUEST DENIED 9002 Internal error STATUS_INTERNAL_ERROR 9010 File transfer failure (associated with Download, ScheduleDownload, TransferComplete or AutonomousTransferComplete methods) STATUS_FILE_TRANSFER_FAILED 9011 Upload failure (associated with Upload, TransferComplete or AutonomousTransferComplete methods) STATUS_UPLOAD_FAILED 9012 File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) STATUS_FILE_TRANSFER_SERVER_A UTHENTICATION_FAILURE 9014 File transfer failure: unable to join multicast group (associated with Download, TransferComplete or AutonomousTransferComplete methods) STATUS_FILE_TRANSFER_FAILED_MU LTICAST_GROUP_UNABLE_JOIN 9015 File transfer failure: unable to contact file server (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) STATUS_FILE_TRANSFER_FAILED_SE RVER_CONTACT_FAILED 9016 File transfer failure: unable to access file (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) STATUS_FILE_TRANSFER_FAILED_FIL E_ACCESS_FAILED 9017 File transfer failure: unable to complete download (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) STATUS_FILE_TRANSFER_FAILED_DO WNLOAD_INCOMPLETE 9018 File transfer failure: file corrupted or otherwise unusable (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) STATUS_FILE_TRANSFER_FAILED_FIL E_CORRUPTED 9019 File transfer failure: file authentication failure (associated with Download, TransferComplete or AutonomousTransferComplete methods) STATUS_FILE_TRANSFER_FILE_AUTH ENTICATION_FAILURE 9020 File transfer failure: unable to complete download within specified time windows (associated with TransferComplete method) STATUS_FILE_TRANSFER_WINDOW_E XCEEDED ETSI ETSI TS 118 106 V3.6.2 (2021-02) 34 oneM2M TS-0006 version 3.6.2 Release 3 |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.2.1.4 Execute Software Operations with ChangeDUState RPC | The software installation and uninstall operations shall use the ChangeDUState mechanism defined in BBF TR-069 [4]. The ChangeDUState mechanism is an asynchronous command that consists of the synchronous ChangeDUState RPC and returns a successful response or one of the fault codes mapped onto execResult values as detailed in table 8.2.1.4.-1. A successful response to the Update primitive triggering the Execute procedure means that the CPE has accepted the ChangeDUState RPC. Table 8.2.1.4-1: ChangeDUState Fault Code Mapping Fault code Description execResult Code 9000 Method not supported STATUS_REQUEST_UNSUPPORTED 9001 Request denied (no reason specified) STATUS_REQUEST DENIED 9002 Internal error STATUS_INTERNAL_ERROR 9004 Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) STATUS_RESOURCES_EXCEEDED |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.2.1.5 Report Results with ChangeDUStateComplete RPC | After software installation and uninstall operations using a ChangeDUState mechanism as defined in BBF TR-069 [4], the result of the state change operation is retrieved using the ChangeDUStateComplete RPC. The ChangeDUStateComplete RPC indicates a successful operation or one of the fault codes mapped onto execResult values as detailed in table 8.2.1.5.-1. Table 8.2.1.5-1: ChangeDUStateComplete Fault Code Mapping Fault code Description execResult Code 9001 Request denied (no reason specified) STATUS_REQUEST_DENIED 9003 Invalid arguments STATUS_INVALID_ARGUMENTS 9012 File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) STATUS_FILE_TRANSFER_SERVER_A UTHENTICATION_FAILURE 9013 Unsupported protocol for file transfer (associated with Upload, Download, ScheduleDownload, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) STATUS_UNSUPPORTED_PROTOCOL 9015 File transfer failure: unable to contact file server (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) STATUS_FILE_TRANSFER_FAILED_SE RVER_CONTACT_FAILED 9016 File transfer failure: unable to access file (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) STATUS_FILE_TRANSFER_FAILED_FIL E_ACCESS_FAILED 9017 File transfer failure: unable to complete download (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) STATUS_FILE_TRANSFER_FAILED_DO WNLOAD_INCOMPLETE 9018 File transfer failure: file corrupted or otherwise unusable (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) STATUS_FILE_TRANSFER_FAILED_FIL E_CORRUPTED 9022 Invalid UUID Format (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install, Update, and Uninstall) STATUS_INVALID_UUID_FORMAT 9023 Unknown Execution Environment (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install only) STATUS_UNKNOWN_EXECUTION_ENVI RONMENT ETSI ETSI TS 118 106 V3.6.2 (2021-02) 35 oneM2M TS-0006 version 3.6.2 Release 3 Fault code Description execResult Code 9024 Disabled Execution Environment (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install, Update, and Uninstall) STATUS_DISABLED_EXECUTION_ENVI RONMENT 9025 Deployment Unit to Execution Environment Mismatch (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install and Update) STATUS_EXECUTION_ENVIRONMENT_ MISMATCH 9026 Duplicate Deployment Unit (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install only) STATUS_DUPLICATE_DEPLOYMENT_U NIT 9027 System Resources Exceeded (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install and Update) STATUS_SYSTEM_RESOURCES_EXCE EDED 9028 Unknown Deployment Unit (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update and Uninstall) STATUS_UNKNOWN_DEPLOYMENT_U NIT 9029 Invalid Deployment Unit State (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install, Update and Uninstall) STATUS_INVALID_DEPLOYMENT_UNIT _STATE 9030 Invalid Deployment Unit Update - Downgrade not permitted (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update only) STATUS_INVALID_DEPLOYMENT_UNIT _UPDATE_DOWNGRADE_DISALLOWED 9031 Invalid Deployment Unit Update - Version not specified (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update only) STATUS_INVALID_DEPLOYMENT_UNIT _UPDATE_UPGRADE_DISALLOWED 9032 Invalid Deployment Unit Update - Version already exists (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update only) STATUS_INVALID_DEPLOYMENT_UNIT _UPDATE_VERSION_EXISTS |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.2.1.6 Execute Reboot operation | The reboot operation shall use the Reboot RPC defined in BBF TR-069 [4]. The Reboot RPC is a synchronous command. A successful response to the Update primitive triggering the Execute procedure means that the CPE has accepted the Reboot RPC. The Reboot RPC returns a successful response or one of the fault codes mapped onto execResult values as detailed in table 8.2.1.6-1. Table 8.2.1.6-1: Reboot Fault Code Mapping Fault code Description execResult Code 9001 Request denied (no reason specified) STATUS_REQUEST_DENIED 9002 Internal error STATUS_INTERNAL_ERROR 9003 Invalid arguments STATUS_INVALID_ARGUMENTS |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.2.1.7 Execute Factory Reset operation | The factory reset operation shall use the FactoryReset RPC defined in BBF TR-069 [4]. The FactoryReset RPC is a synchronous command. A successful response to the Update primitive triggering the Execute procedure means that the CPE has accepted the FactoryReset RPC. The FactoryReset RPC returns a successful response or one of the fault codes mapped onto execResult values as detailed in table 8.2.1.7-1. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 36 oneM2M TS-0006 version 3.6.2 Release 3 Table 8.2.1.7-1: FactoryReset Fault Code Mapping Fault code Description execResult Code 9000 Method not supported STATUS_REQUEST_UNSUPPORTED 9001 Request denied (no reason specified) STATUS_REQUEST_DENIED 9002 Internal error STATUS_INTERNAL_ERROR 9003 Invalid arguments STATUS_INVALID_ARGUMENTS |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.2.2 Delete <mgmtCmd> resource primitive mapping | The Delete Request primitive for the <mgmtCmd> resource may initiate BBF TR-069 [4] RPC commands for the corresponding <execInstance> sub-resources as follows: • If there are no <execInstance> sub-resources with RUNNING execStatus, a successful response to the Delete primitive is returned and the <mgmtCmd> resource is deleted without triggering any BBF TR-069 [4] RPCs. • If there are <execInstance> sub-resources with RUNNING execStatus that resulted in cancellable BBF TR-069 [4] RPCs (e.g. File Upload and File Download RPCs), a BBF TR-069 [4] CancelTransfer RPC shall be initiated for each cancellable operation. Upon completion of all the cancellation operations, if any fault codes are returned by the CPE, an unsuccessful Response to the Delete primitive with status code "Delete mgmtCmd- execInstance cancellation error" is returned, and the <mgmtCmd> resource is not deleted. The execStatus attribute of each specific <execInstance> is set to CANCELLED and the execResult attribute is set to "STATUS_SUCCESS" for successful RPCs. For the unsuccessful case, execResult is determined from the RPC fault codes as detailed in table 8.2.2-1. If all cancellation operations are successful on the managed entity, a successful Response to the Delete primitive is returned and the <mgmtCmd> resource is deleted. • If there is at least one <execInstance> sub-resource with RUNNING execStatus that resulted in non- cancellableBBF TR-069 [4] RPCs (e.g. RPCs other than File Upload and File Download RPCs), the execStatus attribute of the specific <execInstance> is changed to STATUS_NON_CANCELLABLE. An unsuccessful Response to the Delete primitive with status code "Delete mgmtCmd- execInstance cancellation error" is returned and the <mgmtCmd> resource is not deleted. Table 8.2.2-1: CancelTransfer Fault Code Mapping for Delete <mgmtCmd> Fault code Description execResult Code 9000 Method not supported STATUS_REQUEST_UNSUPPORTED 9001 Request denied (no reason specified) STATUS_REQUEST DENIED 9021 Cancellation of file transfer not permitted in current transfer state STATUS_CANCELLATION_DENIED |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.2.3 Update (Cancel) <execInstance> primitive mapping | When the Update Request primitive for an <execInstance> sub-resource addresses the execDisable attribute of the <execInstance > sub-resource, it effectively triggers a Cancel <execInstance> resource procedure. The hosting CSE determines whether the <execInstance> resource has a RUNNING execStatus and weather the resulting BBF TR-069 [4] RPCs are cancellable. Currently, only the BBF TR-069 [4] File Upload and File Download RPCs are cancellable using the BBF TR-069 [4] CancelTransfer RPC: • If the addressed <execInstance> sub-resource has an execStatus other than RUNNING, an un-successful Response to the Update primitive is returned with status code "Cancel execInstance - already complete". ETSI ETSI TS 118 106 V3.6.2 (2021-02) 37 oneM2M TS-0006 version 3.6.2 Release 3 • If the addressed <execInstance> sub-resources has RUNNING execStatus and resulted in cancellable BBF TR-069 [4] RPCs (e.g. File Upload and File Download RPCs), a BBF TR-069 [4] CancelTransfer RPC shall be initiated. For a successful CancelTransfer RPC the execStatus attribute of the specific <execInstance> is set to CANCELLED and a successful Response is sent to the Update primitive. For a successful CancelTransfer RPC the execStatus attribute of the specific <execInstance> is set to CANCELLED, the execResult attribute is set to "STATUS_SUCCESS" and a successful Response is sent to the Update primitive. For an unsuccessful CancelTransfer RPC the execResult attribute is determined from the RPC fault codes as detailed in table 8.2.3-1 and an unsuccessful Response is sent to the Update primitive with status code "Cancel execInstance - cancellation error". • If the addressed <execInstance> sub-resources has RUNNING execStatus and resulted non-cancellable BBF TR-069 [4] RPCs (e.g. RPCs other than File Upload and File Download RPCs), the execStatus attribute of the specific <execInstance> is changed to STATUS_NON_CANCELLABLE. An unsuccessful Response is sent to the Update primitive with status code "Cancel execInstance - not cancellable". Table 8.2.3-1: CancelTransfer Fault Code Mapping for Update (Cancel) <execInstance> Fault code Description execResult Code 9000 Method not supported STATUS_REQUEST_UNSUPPORTED 9001 Request denied (no reason specified) STATUS_REQUEST DENIED 9021 Cancellation of file transfer not permitted in current transfer state STATUS_CANCELLATION_DENIED |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.2.4 Delete <execInstance> primitive mapping | The Delete Request primitive for an <execInstance> sub-resource may initiate BBF TR-069 [4] RPC commands for the corresponding <execInstance> sub-resources as follows: • If the addressed <execInstance> sub-resource has an execStatus other than RUNNING, an successful Response to the Delete primitive is returned and the <execInstance> sub-resource is deleted without triggering any BBF TR-069 [4] RPCs. • If the addressed <execInstance> sub-resource has RUNNING execStatus and resulted in cancellable BBF TR-069 [4] RPCs (e.g. File Upload and File Download RPCs), a BBF TR-069 [4] CancelTransfer RPC shall be initiated. For a successful CancelTransfer RPC a successful response is sent to the Delete primitive and the <execInstance> sub-resource is deleted. For an unsuccessful CancelTransfer RPC the execStatus attribute is determined from the RPC fault codes as detailed in table 8.2.4-1 and an unsuccessful Response is sent to the Delete primitive with status code "Delete execInstance - cancellation failed". • If the addressed <execInstance> sub-resource has RUNNING execStatus and resulted non-cancellable BBF TR-069 [4] RPCs (e.g. RPCs other than File Upload and File Download RPCs), the execResult attribute is set to STATUS_NON_CANCELLABLE and an unsuccessful Response is sent to the Update primitive with status code "Delete execInstance - not cancellable". Table 8.2.4-1: CancelTransfer Fault Code Mapping for Delete <execInstance> Fault code Description execResult Code 9000 Method not supported STATUS_REQUEST_UNSUPPORTED 9001 Request denied (no reason specified) STATUS_REQUEST DENIED 9021 Cancellation of file transfer not permitted in current transfer state STATUS_CANCELLATION_DENIED |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.3 Resource [myCertFileCred] primitive mappings | |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.3.1 Introduction | This clause contains information regarding the procedures for establishing a certificates presented by the managed entity in order for the peer to authenticate the managed entity. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 38 oneM2M TS-0006 version 3.6.2 Release 3 |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.3.2 Creation of Resource [myCertFileCred] | |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.3.2.1 Introduction | The creation of a [myCertFileCred] resource requires the use of the BBF TR-069 Download RPC to establish the credential on the managed entity. Once the managed entity has obtained the credential, the Device.Security.Certificate.{i} instance's SUIDs parameter is set from the [myCertFileCred] attribute using the BBF TR-069 [4] Set RPC. |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 8.3.2.2 Procedure for creation of Resource [myCertFileCred] | The Create Request and Response primitives for Resource [myCertFileCred] that results in a download file transfer shall use the Download mechanism defined in BBF TR-069 [4]. The Download mechanism is an asynchronous command that consists of the synchronous Download RPC for the Download and the asynchronous TransferComplete RPC. The Download RPC returns a successful response or one of the following fault codes in table 8.3.2.2-1. A successful response means that the CPE has accepted the Download RPC. Table 8.3.2.2-1: Download Fault Code Mapping Fault code Description Response Status Code 9000 Method not supported 4000 (BAD_REQUEST) 9001 Request denied (no reason specified) 4000 (BAD_REQUEST) 9002 Internal error 4000 (BAD_REQUEST) 9003 Invalid arguments 4000 (BAD_REQUEST) 9004 Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) 4000 (BAD_REQUEST) 9010 File transfer failure (associated with Download, ScheduleDownload, TransferComplete or AutonomousTransferComplete methods) 4000 (BAD_REQUEST) 9012 File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9013 Unsupported protocol for file transfer (associated with Upload, Download, ScheduleDownload, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) Once the CPE has attempted to download the file, the CPE reports the result of the download operation using the TransferComplete RPC. The TransferComplete RPC indicates a successful operation or one of the following fault codes in table 8.3.2.2-2. Table 8.3.2.2-2: TransferComplete Fault Code Mapping Fault code Description Response Status Code 9001 Request denied (no reason specified) 4000 (BAD_REQUEST) 9002 Internal error 4000 (BAD_REQUEST) 9010 File transfer failure (associated with Download, ScheduleDownload, TransferComplete or AutonomousTransferComplete methods) 4000 (BAD_REQUEST) 9011 Upload failure (associated with Upload, TransferComplete or Autonomous- TransferComplete methods) 4000 (BAD_REQUEST) 9012 File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9014 File transfer failure: unable to join multicast group (associated with Download, TransferComplete or AutonomousTransferComplete methods) 4000 (BAD_REQUEST) 9015 File transfer failure: unable to contact file server (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9016 File transfer failure: unable to access file (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9017 File transfer failure: unable to complete download (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) ETSI ETSI TS 118 106 V3.6.2 (2021-02) 39 oneM2M TS-0006 version 3.6.2 Release 3 Fault code Description Response Status Code 9018 File transfer failure: file corrupted or otherwise unusable (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9019 File transfer failure: file authentication failure (associated with Download, TransferComplete or AutonomousTransferComplete methods) 4000 (BAD_REQUEST) 9020 File transfer failure: unable to complete download within specified time windows (associated with TransferComplete method) 4000 (BAD_REQUEST) Upon successful TransferComplete notification from the CPE, the newly created Device.Security.Certificate.{i} object instance shall be assigned the values of the SUIDs attribute using the procedure for updating parameters in clause 8.1.4. |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 9 Server Interactions | |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 9.0 Introduction | This clause specifies how the IN-CSE interacts with an ACS in order to manage the Resources described in the present document. The IN-CSE interaction with an ACS includes: • Establishment of the communication session between the IN-CSE and ACS. • Processing of requests and notifications between the IN-CSE and the ACS. • Discovery. NOTE: The Broadband Forum has not defined a protocol specification for the Northbound Interface of an ACS. As such, the present document only describes the expectations of this interface in the form of requirements on the ACS. |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 9.1 Communication Session Establishment | |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 9.1.1 IN-CSE to ACS Communication Session Establishment | When the IN-CSE detects that it has to delegate an interaction with a device resource to an ACS, the IN-CSE establishes a communication session with the ACS. The establishment of a communication session between the IN-CSE and ACS provides security dimensions for Access control, Authentication, Non-repudiation, Data confidentiality, Communication security, Data integrity and Privacy adhering to the following BBF TR-131 [7] Architectural requirement A7. The IN-CSE may establish multiple sessions with an ACS based on the security model utilized between the IN-CSE and the ACS. |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 9.1.2 ACS to IN-CSE Communication Session Establishment | When the ACS detects a change to resources it manages that the IN-CSE has expressed interest, the ACS requests the IN-CSE to establish a session if a session does not exist for the resource being managed. The establishment of a communication session between the IN-CSE and ACS provides security dimensions for Access control, Authentication, Non-repudiation, Data confidentiality, Communication security, Data integrity and Privacy adhering to the following BBF TR-131 [7] Architectural requirement A7. The ACS may establish multiple sessions with an IN-CSE based on the security model utilized between the IN-CSE and the ACS. While a session between the ACS and IN-CSE is not established, the ACS retains any notifications or changes in the resources based on an Event retention policy (i.e. time, number of events). ETSI ETSI TS 118 106 V3.6.2 (2021-02) 40 oneM2M TS-0006 version 3.6.2 Release 3 When an ACS to IN-CSE interaction is required and a session does not exist, the ACS requests to initiate a session based on a Session Initiation Policy (i.e. Periodic contact establishment (schedule), upon event detection with timeframe window). |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 9.1.3 ACS and IN-CSE Communication Session Requirements | When establishing a session from the ACS to the IN-CSE: • If a session does not exist between the IN-CSE and ACS, the ACS shall retain any notifications or changes in the resources based on an Event retention policy (i.e. time, number of events). • When an ACS to IN-CSE interaction is required and a session does not exist, the ACS shall be capable to initiate a session based on a Session Initiation Policy (i.e. Periodic contact establishment (schedule), upon event detection with timeframe window). |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 9.2 Processing of Requests and Responses | |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 9.2.1 Request and Notification Formatting | Requests and Notifications mechanisms between the IN-CSE and the DM Server format the XML schema of the CPE methods defined in BBF TR-069 [4] as an ACS would format the CPE methods that it would pass to the CPE. The IN-CSE would then also process the CPE methods as defined in BBF TR-069 [4]. Likewise the ACS would send notifications in the format of the XML schema of the CPE for sending events using the Inform RPC. |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 9.2.2 ACS Request Processing Requirements | When receiving requests from the IN-CSE the ACS shall be capable of defining mechanisms to support triggering of immediate operations to device. If the device is not available the ACS returns an appropriate error code. The ACS shall provide capability for the IN-CSE to indicate request policies to include: Retry policy, Request Time out. |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 9.2.3 ACS Notification Processing Requirements | When sending notifications to the IN-CSE: • The ACS shall be capable of providing a mechanism for the IN-CSE to subscribe to events. • The ACS shall be capable of providing a list of events for which the IN-CSE can subscribe. • The ACS shall be capable of providing a mechanism for the IN-CSE to unsubscribe from events. • The ACS shall be capable of providing an event delivery mechanism. • The ACS shall be capable of providing the capability for the IN-CSE to request event filters including: Event Code; Specific parameters changing value; Device; Any combination of the previous criteria. • The IN-CSE shall be capable of subscribing to be notified of changes to resources it manages. • The ACS shall be capable of notifying the IN-CSE of changes to resources to which the client has subscribed. |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 9.3 Discovery and Synchronization of Resources | For devices under management, the IN-CSE may discover resources of interest (metadata and values) within a device using the ACS. For resources of interest, the IN-CSE may also express an interest to be notified of a resource if a resource is changed (added, deleted, updated). ETSI ETSI TS 118 106 V3.6.2 (2021-02) 41 oneM2M TS-0006 version 3.6.2 Release 3 The IN-CSE shall be capable to discover and subscribe to changes of resources in order to synchronize the IN-CSE with resources of interest of the ACS. |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 9.4 Access Management | |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 9.4.0 Introduction | Once a request has performed an Access Decision by the IN-CSE to allow the request, the IN-CSE shall select the appropriate ACS along with elements the ACS would need to implement access management within the ACS. These would include the Identity of the subject (oneM2M Originator) of the request which is needed in scenarios where the original issuer of the request is needed to be known - this could be done by correlating principals (e.g. Roles, Accounts) used by the IN-CSE and ACS. |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 9.4.1 Access Management Requirements | • The ACS shall be capable of providing a mechanism for the IN-CSE to discover the Access Management elements used to authorize and authenticate access to resources controlled by the ACS. • The IN-CSE shall be capable of correlating Access Management elements provided by the ACS to Access Management elements used by the IN-CSE. • The IN-CSE shall be capable of providing secured storage of Access Management elements within the IN-CSE. |
9ab246a740b04002bf9bf7eacc512119 | 118 106 | 10 New Management Technology Specific Resources | BBF TR-181 [6] provides a list of management objects that have been standardized by the Broadband Forum and where possible, clause 7 provides a mapping of the Resources to standardized management objects. This clause provides the oneM2M vendor specific extensions to the BBF TR-181 [6] data model. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 42 oneM2M TS-0006 version 3.6.2 Release 3 History Document history V3.6.2 February 2021 Publication |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 1 Scope | The present document specifies the communication protocol(s) for oneM2M compliant Systems, M2M Applications, and/or other M2M systems. The present document also specifies the common data formats, interfaces and message sequences to support reference points(s) defined by oneM2M. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 2 References | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 2.1 Normative references | References are either specific (identified by date of publication and/or edition number or version number) or non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the referenced document (including any amendments) applies. Referenced documents which are not found to be publicly available in the expected location might be found at https://docbox.etsi.org/Reference/. NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee their long term validity. The following referenced documents are necessary for the application of the present document. [1] W3C Recommendation: "Extensible Markup Language (XML) 1.0 (Fifth Edition)", 26 November 2008. [2] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". [3] W3C XMLSchemaP2: "W3C Recommendation (2004), XML Schema Part 2:Datatypes Second Edition". [4] Void. [5] Void. [6] ETSI TS 118 101: "oneM2M; Functional Architecture (oneM2M TS-0001)". [7] ETSI TS 118 103: "oneM2M; Security solutions (oneM2M TS-0003)". [8] IEEE 754-2008: "IEEE Standard for Floating-Point Arithmetic", 29 August 2008. NOTE: http://ieeexplore.ieee.org/servlet/opac?punumber=4610933. [9] IETF RFC 4648: "The Base16, Base32, and Base64 Data Encodings". [10] IETF RFC 2045: "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies". [11] IETF RFC 3987: "Internationalized Resource Identifiers (IRIs)". [12] IETF BCP 47: "Best Current Practices 47". Concatenation of IETF RFC 4646: "Tags for Identifying Languages" (2006) and IETF RFC 4647: "Matching of Language Tags" (2006). [13] IETF RFC 3588: "Diameter Base Protocol". [14] IETF RFC 6733: "Diameter Base Protocol". [15] ETSI TS 123 682: "Digital cellular telecommunications system (Phase 2+) (GSM); Universal Mobile Telecommunications System (UMTS); LTE; Architecture enhancements to facilitate communications with packet data networks and applications (3GPP TS 23.682)". ETSI ETSI TS 118 104 V2.7.1 (2016-10) 20 oneM2M TS-0004 version 2.7.1 Release 2 [16] ETSI TS 129 368: "Universal Mobile Telecommunications System (UMTS); LTE; Tsp interface protocol between the MTC Interworking Function (MTC-IWF) and Service Capability Server (SCS) (3GPP TS 29.368)". [17] ETSI TS 123 003: "Digital cellular telecommunications system (Phase 2+) (GSM); Universal Mobile Telecommunications System (UMTS); Numbering, addressing and identification (3GPP TS 23.003)". [18] Void. [19] IETF RFC 7159: "The JavaScript Object Notation (JSON) Data Interchange Format". [20] IETF RFC 4234: "Augmented BNF for Syntax Specifications: ABNF" [21] IETF RFC 3629: "UTF-8, a transformation format of ISO 10646". [22] ETSI TS 118 108: "oneM2M; CoAP Protocol Binding (oneM2M TS-0008)". [23] ETSI TS 118 109: "oneM2M; HTTP Protocol Binding (oneM2M TS-0009)". [24] ETSI TS 118 110: "oneM2M; MQTT Protocol Binding (oneM2M TS-0010)". [25] ETSI TS 118 111: "oneM2M; Common Terminology (oneM2M TS-0011)". [26] IETF RFC 6837: "Media Type Specifications and Registration Procedures". [27] ISO 8601:2004: "Data elements and interchange formats -- Information interchange -- Representation of dates and times". [28] OMA-TS-REST-NetAPI_TerminalLocation: "Open Mobile Alliance; RESTful Network API for Terminal Location", Version 1.0. [29] IETF RFC 4632: "Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan". [30] IETF RFC 5952: "A Recommendation for IPv6 Address Text Representation". [31] ETSI TS 132 299: "Digital cellular telecommunications system (Phase 2+) (GSM); Universal Mobile Telecommunications System (UMTS); LTE; Telecommunication management; Charging management; Diameter charging applications (3GPP TS 32.299)". [32] IETF RFC 4006: "Diameter Credit-Control Application". [33] W3C SPARQL 1.1: "Query Language". [34] W3C RDF 1.1 XML Syntax. [35] IETF RFC 4122: "A Universally Unique IDentifier (UUID) URN Namespace". [35] ETSI TS 118 112: "oneM2M; Base Ontology (oneM2M TS-0012)". [36] ETSI TS 118 121: "oneM2M; oneM2M and AllJoyn® Interworking (oneM2M TS-0021)". [37] ETSI TS 129 336: "Universal Mobile Telecommunications System (UMTS); LTE; Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications (3GPP TS 29.336)". [38] IETF RFC 7049: "Concise Binary Object Representation (CBOR)", October 2013. [39] ETSI TS 118 123: "oneM2M; Home Appliances Information Model and Mapping (oneM2M TS-0023)". [40] ISO 3166-1:2013: "Codes for the representation of names of countries and their subdivisions -- Part 1: Country codes". ETSI ETSI TS 118 104 V2.7.1 (2016-10) 21 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 2.2 Informative references | References are either specific (identified by date of publication and/or edition number or version number) or non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the referenced document (including any amendments) applies. NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee their long term validity. The following referenced documents are not necessary for the application of the present document but they assist the user with regard to a particular subject area. [i.1] oneM2M Drafting Rules. NOTE: Available at http://www.onem2m.org/images/files/oneM2M-Drafting-Rules.pdf. [i.2] Fielding, Roy Thomas (2000): "Architectural Styles and the Design of Network-based Software Architectures", Doctoral dissertation, University of California, Irvine. [i.3] OMA-TS-REST_NetAPI_NotificationChannel: "Open Mobile Alliance; RESTful Network API for Notification Channel", OMA-TS-REST_NetAPI_NotificationChannel-V1_0. [i.4] OMA-TS-MLP: "Open Mobile Alliance; Mobile Location Protocol", OMA-TS-MLP-V3_4- 20130226-C Version 3.4. [i.5] W3C Resource Description Framework. NOTE: Available at https://www.w3.org/RDF/. [i.6] W3C SPARQL Query Language for RDF. NOTE: Available at https://www.w3.org/TR/rdf-sparql-query/. [i.7] IETF RFC 7515: "JSON Web Signature (JWS)", 2015. [i.8] IETF RFC 7516: "JSON Web Encryption (JWE)", 2015. [i.9] IETF RFC 7518: "JSON Web Algorithms (JWA)", 2015. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 3 Definitions and abbreviations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 3.1 Definitions | For the purposes of the present document, the terms and definitions given in ETSI TS 118 111 [25] and the following apply: Complex Data Types: data type that has a child element Enumeration Type: data type that enables for a variable to be a set of predefined constants Group Hosting CSE: CSE where the addressed group resource resides Hosting CSE: CSE where the addressed resource is hosted Location Server: server offering location capabilities M2M Area Network: network providing connectivity between Application Service Nodes or Application Dedicated Nodes and Middle Nodes in the field domain Mca: reference Point for M2M Communication with AE Mcc: reference Point for M2M Communication with CSE ETSI ETSI TS 118 104 V2.7.1 (2016-10) 22 oneM2M TS-0004 version 2.7.1 Release 2 Mcc': reference Point for M2M Communication with CSE of different M2M Service Provider Originator: in case of a request traversing a single reference point, the Originator is the AE/CSE that sends the request NOTE: In case of a request that traverses multiple reference points, the Originator is the AE/CSE that sends the first request in the sequence. Receiver: entity that receives the Request Receiver CSE: any CSE that receives a request Registrar CSE: CSE where an Application or another CSE has registered Registree/Registrar CSE: CSE that registers with another CSE Request: message sent from the Originator to the Receiver Response: message replied to the Request from the Receiver to the Originator |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 3.2 Abbreviations | For the purposes of the present document, the abbreviations given in ETSI TS 118 111 [25] and the following apply: 3GPP2 3rd Generation Partnership Project 2 ACP AccessControlPolicy AD Anno Domini AE-ID Application Entity Identifier ARC Architecture ASN-CSE Application Entity that is registered with the CSE at Application Service Node BCP Best Current Practices CDT Common Data Type CIDR Classless Inter-Domain Routing CMDH Communication Management and Delivery Handling CoAP Constrained Application Protocol CRUD Create Retrieve Update Delete CRUD+N Create Retrieve Update Delete Notification CSE-ID Common Service Entity Identifier CUDN Create Update Delete Notify DAA Device Action Answer DAR Device-Action-request DNA Device Notification Answer DNR Device Notification Request DTLS Datagram Transport Layer Security FFS For Further Study FQDN Fully Qualified Domain Name GPS Global Positioning System HTTP HyperText Transfer Protocol IANA Internet Assigned Numbers Authority ID IDentifier IEEE Institute of Electrical and Electronics Engineers IETF Internet Engineering Task Force IN-AE Application Entity that is registered with the CSE in the Infrastructure Node IN-CSE CSE which resides in the Infrastructure Node IRI Internationalized Resource Identifier ISO International Organization for Standardization JSON JavaScript Object Notation MA Mandatory Announced MIME Multipurpose Internet Mail Extension MN-CSE Reference Point for M2M Communication with CSE of different M2M Service Provider MQTT Message Queue Telemetry Transport MTC-IWF MachinetType Communications - InterWorking Function NP Not Present OA Optional Announced ETSI ETSI TS 118 104 V2.7.1 (2016-10) 23 oneM2M TS-0004 version 2.7.1 Release 2 OMA-DM Open Mobile Alliance Device Management RD Retrieve Delete RFC Request For Comment RPC Remote Procedure Call RSC Response Status Codes RUD Retrieve Update Delete SCS Services Capability Server SP Service Provider SP-ID Service Provider Identifier TBD To Be Determined TCP Transmission Control Protocol TLS Transport Layer Security UDP User Datagram Protocol URI Uniform Resource Identifier URL Uniform Resource Locator UTC Coordinated Universal Time UTF UCS Transformation Format UUID Universally Unique Identifier WLAN Wireless Local Area Network XML eXtensible Markup Language XSD XML Schema Definition |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 4 Conventions | The key words "Shall", "Shall not", "May", "Need not", "Should", "Should not" in the present document are to be interpreted as described in the oneM2M Drafting Rules [i.1]. To improve readability: • The information elements of oneM2M Request/Response messages will be referred to as parameters. Parameter names will be written in bold italic. • The information elements of resources will be referred to as attributes and child resources. Attributes will be written in italics. • Abbreviated short names for information elements (see clause 8) will be written in bold italic. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5 Protocol design principles and requirements | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.1 General introduction | Clause 5 contains the design principles and requirements for the oneM2M protocol. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.2 Introduction | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.2.0 Overview | The oneM2M architecture is resource-based (ETSI TS 118 101 [6]). The functionality of the system is exposed by means of APIs over all reference points specified in ETSI TS 118 101 [6]. Operations upon resources hosted by a CSE are carried over an established channel that constitutes the communication on the reference points Mca and Mcc. All resource operations could be fulfilled with the considerations in terms of scalability, extensibility, fault tolerance and robustness, energy efficiency, and self-operation. Offline Charging using the Mch reference point is described in [6] and specified in Annex A ETSI ETSI TS 118 104 V2.7.1 (2016-10) 24 oneM2M TS-0004 version 2.7.1 Release 2 Each resource operation comprises a pair of primitives: Request and Response. The Request and Response primitives can be represented as XML documents or JSON texts. This process of representing a primitive as XML documents or JSON texts is denoted serialization in the present document. Serialization translates primitives into a format that can be stored or exchanged between network entities. This is exploited when transmitting primitives over communication protocols such as HTTP, CoAP or MQTT. In order to provide a well-defined interface for the reference points in ETSI TS 118 101 [6], the following aspects need to be provided: • the collection of primitives carried over a specific reference point; and • the definitions and procedures of resource types in relation to the underlying protocols and reference points involved. The present document provides: • protocol design principles and requirements • data type definitions and representations; • primitive format and generic procedures; • common operations of originators and receivers; • resource type-specific procedures; and • XML definitions and schema. NOTE: The actual binding of the interface to a specific protocol is not part of the present document, but is specified in a separate Technical Specifications [22], [23], [24]. In accordance with the oneM2M architecture, each reference point is applicable to a wide range of underlying network technologies and transport protocols. oneM2M defines a set of bindings for specific underlying network technologies and transport protocols, these bindings are not limiting the applicability of the interfaces when used in other underlying networks and transport protocols. However, the behaviour of the interface needs to be respected in accordance to the present document and ETSI TS 118 101 [6]. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.2.1 Interfaces to the underlying networks | The CSEs access the network service functions provided by the underlying networks such as 3GPP, 3GPP2 and WLAN via Mcn reference point. The following services are provided by the underlying networks: • Device triggering (see clause B.1) • Location request (see annex G) • Device Management (see clause 7.3.4) |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.3 API design guidelines | The following are the guidelines for designing APIs: 1) APIs shall follow the principle of RESTful architecture, as described in [i.2]. 2) APIs shall indicate which features are supported and not supported over the reference points specified in ETSI TS 118 101 [6]. 3) APIs shall define how to address resources and how to manipulate resources, in accordance with ETSI TS 118 101 [6]; the resource is identified by a Universal Resource Identifier (URI), [2]. 4) APIs shall provide the format and syntax of the operation primitives for all resources defined in ETSI TS 118 101 [6]. In case that for a particular protocol binding an operation cannot be supported it has to be clearly stated in the specific protocol binding technical specification. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 25 oneM2M TS-0004 version 2.7.1 Release 2 5) Resource has a representation (see [i.2]) that shall be transferred and manipulated with the verbs. These verbs are identified as operations in ETSI TS 118 101 [6]: CREATE. RETRIEVE, UPDATE, DELETE and NOTIFY. 6) All primitives as well as the way that those primitives are sent shall be defined. The functionality of the primitives shall be compliant to the resource type specific procedure as specified in ETSI TS 118 101 [6], clause 10.2. 7) Primitives shall include attributes in accordance with ETSI TS 118 101 [6] for a specific resource. 8) Primitive shall be self-descriptive and contain all the information needed for the receiver of the primitives to handle the primitives. 9) Primitive should be idempotent operations which mean no matter how many times the primitive is sent, the result does not change, in accordance to [i.2]. 10) Primitives shall be mapped on the transport layer protocols. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.4 Primitives | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.4.1 Introduction | Primitives are common service layer messages exchanged over the Mca, Mcc and Mcc' reference points. There are two use cases: • communication between an Originator and a Receiver which are collocated on the same M2M Node (e.g. ASN or MN) in the Common Service layer, • communication between an Originator and a remote Receiver via an Underlying Network. In the first use case the primitives may be exchanged directly between the Originator and Receiver processes. In case of using an IP-based Underlying Network as illustrated in Figure 5.4.1-1, the primitives are mapped to application layer communication protocols such as HTTP, CoAP or MQTT which use TCP or UDP on the transport layer. The specification of primitives, however, is independent of underlying communication protocols and allows introduction of bindings to other communication protocols. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 26 oneM2M TS-0004 version 2.7.1 Release 2 Binding Function Receiver IP- based Underlying Network Response Originator Request Application/Common Service Layer Application Layer Communication Protocol (e.g. HTTP, CoAP, MQTT) Primitives Request Response Primitives Binding Function Application Layer Communication Protocol (e.g. HTTP, CoAP, MQTT) Transport Layer Protocol (UDP/TCP) Transport Layer Protocol (UDP/TCP) Figure 5.4.1-1: Communication model using Request and Response primitives over an IP-based Underlying Network A single primitive in the common service layer may be mapped to zero or more transport messages by the communication protocol. The Originators shall send requests to Receivers through primitives. The Originator and Receiver may be represented by either an AE or a CSE. The CRUD request primitive addresses a resource residing in a CSE. The Notify request primitive may address an AE or CSE. Each CRUD+N operation consists of request and response primitives. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.4.2 Primitives modelling | Primitives are modelled as follows. A primitive is represented in form of a data structure which defines with appropriate parameters specific procedures to be executed by both originator and receiver entities. The data structure of a primitive consists of two parts: • a control part, which contains parameters specifying the processing of the primitive; and • an optional content part, which represents resource data, either the complete resource or only part of the resource (i.e. values of one or more resource attributes) in the partial addressing case. Control part Content part Figure 5.4.2-1: Primitives modelling ETSI ETSI TS 118 104 V2.7.1 (2016-10) 27 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.4.3 Primitive principles | Execution of one primitive shall finish completely before execution of a subsequent primitives starts that affects the same resource. When creating or updating the resource, its representation (full or partial) shall be contained in the content part of the primitive. Based on the representation of the resource, the Hosting CSE can create or update the entire resource without need for further information. The operations on resources triggered by primitives shall be idempotent. This means no matter how many times the same primitive is targeted to the same resource, the resource does not change after the first execution of this primitive, with the exception of the creation of child resources. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.4.4 Serialization of primitives | When transferred over a oneM2M reference point while using a communication protocol such as HTTP, CoAP or MQTT, the way oneM2M Request and Response primitives are represented shall be defined by a specific oneM2M protocol binding that is being used for the message transfer. The originator and receiver of each primitive use the same binding, and thus they will be using compatible serialization and deserialization techniques. Clause 8 of the present document defines canonical approaches for serializing primitives as JSON objects or XML documents used by oneM2M protocol bindings. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.5 Design principles | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.5.1 Introduction | The following clauses (5.5.2 to 5.5.7) present the design principles which could wrap up the perspectives and ways in terms of definitions and procedures of APIs and resources for the oneM2M core protocol specified in the present document. These design principles shall cover all characteristics and advantages of oneM2M protocols including specifications of bindings to transport protocols such as HTTP, CoAP, and MQTT. The design of oneM2M protocols consider and mitigate the risk of unintended consequences, such as extensibility and interoperability issues, operational problems, or efficiency. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.5.2 Extensibility | The oneM2M protocols are designed to allow continued development and to facilitate changes by means of standardized extensions. The impact of the extensibility on the existing oneM2M protocol functions shall be minimized. Extensibility can be related to one or more of the following aspects: • handling a wide range of transport protocols as well as a different number of devices, • adding, removing or modifying oneM2M protocol functionality, • new oneM2M protocol routines, • new primitives and data types. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.5.3 Scalability | For provisioning scalability as a requirement in the design of oneM2M protocols, one or several of the following mechanisms are used: • Ensuring direct addressability to the CSEs hosting target resources, to minimize network hops. • Asynchrony in terms of data processing, with the objective of minimizing the number of discarded packets. • Caching mechanisms that allow all the received packets to be processed. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 28 oneM2M TS-0004 version 2.7.1 Release 2 • Efficient load distribution to avoid bottlenecks and data loss. • Data compression and/or aggregation, in order to reduce the amount of data sent through the network. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.5.4 Fault tolerance and robustness | One or more of the following mechanisms in terms of link availability can be exploited in the design of oneM2M protocols to account for a variety of exception conditions. • To provide reliable transmission of data packets, packet recovery will be dealt with by using mechanisms appropriate for the operating environment (e.g. constrained devices, unreliable networks). • When oneM2M protocols are employed over unreliable links, multiple data dissemination paths can be provided and maintained. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.5.5 Efficiency | oneM2M protocols are designed with consideration of efficiency for networking involved resource-constrained devices. • As energy consumption directly affects the overall system performance, oneM2M protocols should consider energy efficiency, especially in resource constrained environments with battery-powered oneM2M devices. • Energy efficient oneM2M protocols aims at reducing the overall energy consumption while maintaining the performance required by the oneM2M Applications. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.5.6 Inter-operability | API inter-operability between different protocol stacks is expected. For example, oneM2M API over HTTP/TCP/IP needs to inter-operate with CoAP/UDP in a local network using oneM2M API. oneM2M protocols are specified to provision the API inter-operability. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 5.5.7 Self-operation and self-management | Devices employing the oneM2M API inter-work with established management protocols (e.g. security, discovery, bootstrapping, etc.). The inter-working with legacy management protocols via the oneM2M API shall be carried out in self-operation methods. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6 oneM2M protocols/API overview | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.1 Introduction | The present document describes message formats and procedures to communicate with oneM2M compliant M2M Platform System. The present document describes: • Data representation for communication protocol messages. • Normal and exceptional procedure. • Status codes. • Guidelines for drafting APIs. For wide acceptance by industrial markets, the present document describes structured and non-structured data for oneM2M Protocol using XML Schema Definition (XSD) language [3]. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 29 oneM2M TS-0004 version 2.7.1 Release 2 The actual format of data in request and response messages partially depends on the applied protocol binding. Mapping rules between the data formats defined in the present document types and protocol-specific native data formats are specified in the protocol binding specifications ETSI TS 118 108 [22], ETSI TS 118 109 [23] and ETSI TS 118 110 [24]. The core data types of XML elements defined in the present document for use in oneM2M protocols shall use the namespace: • http://www.onem2m.org/xml/protocols. Specializations of the <flexContainer> resource type (see clause 7.4.37) may employ a different target namespace. The present document, and any XML or XML Schema Documents produced by oneM2M shall use the prefix m2m: to refer to that namespace. The XSD files referenced in the present document shall serve following purposes: 1) Provide an unambiguous definition of XML element names and data types used for a) resource representations, b) resource attributes, c) Request and Response primitives (including Notification primitive), d) parameters used in Request and Response primitives. 2) Help to identify and avoid that equivalent data types are defined multiple times with different names. 3) Provide a testable definition of the value range of data elements (e.g. allowed number range, allowed characters or character patterns, allowed enumeration values). NOTE 1: The XML schemas do not fully check the value ranges of all data elements. This particularly applies to XML elements which represent string patterns (see Table 6.3.2-1). For full compliance with this specification, an implementation shall respect both the schema definition and any additional constraints given in the tables of data types defined in the present document. 4) Provide a testable definition of the presence of mandatory elements (minOccurs="1") and of cardinality of data elements (e.g. maxOccurs="2") in XML representations of data objects (i.e. resource instantiations and primitive parameters). NOTE 2: The XSD files referenced in the present document are intended to validate instantiations of complete resources at the Hosting CSE. When requesting a CRUD operation and receiving the response, the Content primitive parameter however typically includes partial representations of a resource. Implementations compliant with this specification may employ modified versions of the XSD for schema-validation of partial resource representations. 5) Provide a testable definition of the correct sequence of occurrence of each element of a data object (where correct sequence is required). 6) Enable the use of development tools that generate executable code for data object processing from the XSD. 7) Enable the use of XML development tools which allow automatic generation of valid templates for XML and JSON objects, and validation of the compliance of any XML or JSON objects with the XSD. Parameters and resource representations exchanged in primitives between oneM2M entities shall comply with data formats defined in the present document based on the referred XSD documents. The present document defines procedures for validation of received messages and the error handling in case of reception of non-compliant message content. NOTE 3: M2M implementations are required to validate the data received in incoming primitives in accordance with the present document, but the present document does not intend to impose restrictions on implementation of the validation procedures. In particular the validation procedure is not required to use the XSD documents directly. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 30 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.2 Addressing | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.2.1 Introduction | This clause describes the method of addressing oneM2M entities (e.g. AE or CSE) and oneM2M resources using identifiers described in the ETSI TS 118 101 [6]. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.2.2 Summary of oneM2M Identifiers | Table 6.2.2-1 shows the summary of M2M Identifiers defined in ETSI TS 118 101 [6]. Table 6.2.2-1: M2M Identifiers Identifier Data Type Description M2M-SP-ID m2m:ID (see clause 6.3.3) A globally unique ID as specified in [6] App-ID m2m:ID (see clause 6.3.3) The identifier is specified in[6] AE-ID m2m:ID (see clause 6.3.3) A globally unique ID as specified in [6] CSE-ID m2m:ID (see clause 6.3.3) A globally unique ID as specified in [6] M2M-Node-ID m2m:nodeID (see clause 6.3.3) A globally unique ID as specified in[6] M2M-Sub-ID m2m:ID (see clause 6.3.3) A globally unique ID as specified in [6] M2M-Request-ID m2m:requestID (see clause 6.3.3) A unique ID as specified in [6] M2M-Ext-ID m2m:externalID (see clause 6.3.5) The identifier is specified in [6] UNetwork-ID m2m:ID (see clause 6.3.3) A unique ID as specified in [6] Trigger-Recipient-ID m2m:triggerRecipientID The identifier is specified in [6] Role-ID m2m:roleID (see clause 6.3.3) A globally unique ID as specified in [6] Token-ID m2m:tokenID (see clause 6.3.3) A globally unique ID as specified in [6] |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.2.3 oneM2M Entity Addressing | The oneM2M entities (e.g. AE or CSE) are identified and addressable using M2M Identifiers. Since an M2M Identifier is protocol independent, an IN-CSE shall accommodate address resolution functionality to get actual PoA addresses for communicating with other M2M entities using a specific protocol binding. The present document assumes each oneM2M entity has the CSE-PoA address of its Registrar CSE in advance. When the oneM2M entity is communicating to another oneM2M entity , the address appearing in the oneM2M primitive (e.g. From or To parameter) shall be the absolute form of AE-ID or CSE-ID defined in ETSI TS 118 101 [6]. The CSE-ID shall be assigned by M2M Service Provider. The syntax of CSE-ID is defined by following ABNF notation [20]. CSE-ID = absolute-CSE-ID / SP-relative-CSE-ID absolute-CSE-ID = M2M-SP-ID SP-relative-CSE-ID M2M-SP-ID = "//" 1*unreserved SP-relative-CSE-ID = "/" 1*unreserved unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~" ETSI ETSI TS 118 104 V2.7.1 (2016-10) 31 oneM2M TS-0004 version 2.7.1 Release 2 EXAMPLE 1 Starts: EXAMPLE: //myoperator.com/cse1 This is an example of an absolute-CSE-ID, "//myoperator.com" is the M2M-SP-ID and "/cse1" is the SP-relative CSE-ID. EXAMPLE 1 Ends: The AE-ID is either assigned by the M2M Service Provider (S-type AE-ID Stem), or by the AE's Registrar CSE (C-Type Stem). The syntax of AE-ID in ABNF notation [20] is as follows: AE-ID = absolute-AE-ID / SP-relative-AE-ID absolute-AE-ID = M2M-SP-ID SP-relative-AE-ID SP-relative-AE-ID = (SP-relative-CSE-ID "/" C-AE-ID-Stem ) / ("/" S-AE-ID-Stem ) S-AE-ID-Stem = "S" SP-assigned-AE-ID-Stem C-AE-ID-Stem = "C" CSE-assigned-AE-ID-Stem SP-assigned-AE-ID-Stem = 1*unreserved CSE-assigned-AE-ID-Stem = 1*unreserved unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~" EXAMPLE 2 Starts: EXAMPLE: //myoperator.com/S563423 This is an example of an absolute-AE-ID that was assigned by the M2M-SP (//myoperator.com). EXAMPLE: //myoperator.com/cse2/C3532ea3 This is an example of an absolute AE-ID, which registered on the Registrar CSE //myoperator.com/cse2. 'C3532ea3' is the AE-ID-Stem which is assigned by //myoperator.com/cse2. EXAMPLE: /cse2/C3532ea3 This is the SP-relative version of the absolute AE-ID that is shown above. EXAMPLE 2 Ends: |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.2.4 oneM2M Resource Addressing | Authorized oneM2M entities can operate on a oneM2M resource by addressing the resource identifier as the target address (i.e. To parameter) in a request primitive. There are two resource addressing methods: 1) Structured resource identifier (used in Hierarchical Addressing): the identifier is constructed as a relative path from the CSEBase resource via parent resources. 2) Unstructured resource identifier (used in Non-hierarchical Addressing): the identifier uniquely identifies the resource in the domain of its Hosting CSE. Virtual resource addressing is specified in clause 6.8. Furthermore each resource identifier can be expressed in either a. CSE-relative format, or b. SP-relative format, or c. Absolute format ETSI ETSI TS 118 104 V2.7.1 (2016-10) 32 oneM2M TS-0004 version 2.7.1 Release 2 A single attribute of the targeted oneM2M resource shall be addressable adding the sub-address,(targeted-attribute- name) following a "#" character after the resource address. This sub-address representing an attribute name shall be the short name (clause 8.2). The syntax of the resource identifier in ABNF notion [20] is as follows: resource-identifier = (structured-resource-identifier / unstructured-resource-identifier) [ "#" targeted- attribute-name ] structured-resource-identifier = [CSE-ID "/"] first-segment *("/" resource-name) first-segment = resource-name / "." / unstructured-CSE-relative-resource-identifier unstructured-resource-identifier = [CSE-ID "/"] unstructured-CSE-relative-resource-identifier unstructured-CSE-relative-resource-identifier = 1*unreserved resource-name = 1*unreserved When including resource identifiers into the Content parameter of response primitives (clause 7.5.2), the resource Hosting CSE shall use the CSE-relative format since the Originator knows the Hosting CSE ID. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3 Common data types | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.1 Introduction | The following clauses (6.3.2 to 6.3.6) define the data format of resource attributes and parameters used in primitives. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.2 Simple data types incorporated from XML schema | The following 'built-in data types' defined in Table 6.3.2-1 are incorporated from XML Schema definition [3]. Note that name space identifier for 'http://www.w3.org/2001/XMLSchema' shall be referred to using the prefix xs: in the present document. Table 6.3.2-1: Data Types incorporated from XML Schema Data Type Description Notes xs:anyType A special complex type definition whose name is anyType in the XSD namespace, is present in each XSD schema. The definition of anyType serves as default type definition for element declarations whose XML representation does not specify one. xs:anySimpleType The anySimpleType is considered to have an unconstrained lexical space for all built-in simple datatypes. xs:string The string data type represents character strings in XML xs:boolean boolean represents the values of two-valued logic. xs:decimal decimal represents a subset of the real numbers, which can be represented by decimal numerals. The value space of decimal is the set of numbers that can be obtained by dividing an integer by a non-negative power of ten, i.e. expressible as i / 10 n where i and n are integers and n ≥ 0. Precision is not reflected in this value space; the number 2.0 is not distinct from the number 2.00. The order relation on decimal is the order relation on real numbers, restricted to this subset. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 33 oneM2M TS-0004 version 2.7.1 Release 2 Data Type Description Notes xs:float The float data type is patterned after the IEEE single- precision 32-bit floating point data type IEEE 754-2008 [8]. Its value space is a subset of the rational numbers. Floating point numbers are often used to approximate arbitrary real numbers. xs:double The double data type is patterned after the IEEE double-precision 64-bit floating point data type IEEE 754-2008 [8]. Each floating point data type has a value space that is a subset of the rational numbers. Floating point numbers are often used to approximate arbitrary real numbers. xs:duration duration is a data type that represents durations of time. xs:hexBinary hexBinary represents arbitrary hex-encoded binary data. xs:base64Binary base64Binary represents arbitrary Base64-encoded binary data. For base64Binary data the entire binary stream is encoded using the Base64 Encoding defined in IETF RFC 4648 [9], which is derived from the encoding described in IETF RFC 2045 [10]. xs:anyURI anyURI represents an Internationalized Resource Identifier Reference (IRI). An anyURI value can be absolute or relative, and may have an optional fragment identifier (i.e. it may be an IRI Reference). This type should be used when the value fulfils the role of an IRI, as defined in IETF RFC 3987 [11] or its successor(s) in the IETF Standards Track. xs:normalizedString normalizedString represents white space normalized strings. The ·value space· of normalizedString is the set of strings that do not contain the carriage return (#xD), line feed (#xA) nor tab (#x9) characters. The lexical space· of normalizedString is the set of strings that do not contain the carriage return (#xD), line feed (#xA) nor tab (#x9) characters. The base type of normalizedString is string. xs:token token represents tokenized strings. The ·value space· of token is the set of strings that do not contain the carriage return (#xD), line feed (#xA) nor tab (#x9) characters, that have no leading or trailing spaces (#x20) and that have no internal sequences of two or more spaces. The lexical space· of token is the set of strings that do not contain the carriage return (#xD), line feed (#xA) nor tab (#x9) characters, that have no leading or trailing spaces (#x20) and that have no internal sequences of two or more spaces. The base type·of token is normalizedString. xs:NCName The·value space of NCName is the set of all strings which can be used as XML element names, omitting strings that contain : characters. xs:language language represents formal natural language identifiers, as defined by BCP 47 [12]. xs:integer integer is derived from decimal by fixing the value of fractionDigits·to be 0 and disallowing the trailing decimal point. This results in the standard mathematical concept of the integer numbers. The ·value space· of integer is the infinite set {...,-2,-1,0,1,2,...}. The ·base type of integer is decimal. xs:nonNegativeInteger nonNegativeInteger has a lexical representation consisting of an optional sign followed by a non-empty finite-length sequence of decimal digits (#x30-#x39). If the sign is omitted, the positive sign ('+') is assumed. If the sign is present, it shall be "+" except for lexical forms denoting zero, which may be preceded by a positive ('+') or a negative ('-') sign. For example: 1, 0, 12678967543233, +100000. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 34 oneM2M TS-0004 version 2.7.1 Release 2 Data Type Description Notes xs:positiveInteger positiveInteger is ·derived· from nonNegativeInteger by setting the value of minInclusive·to be 1. This results in the standard mathematical concept of the positive integer numbers. The ·value space· of positiveInteger is the infinite set {1,2,...}. The base type·of positiveInteger is nonNegativeInteger. xs:unsignedLong unsignedLong is derived· from nonNegativeInteger by setting the value of ·maxInclusive· to be 18446744073709551615. The base type·of unsignedLong is nonNegativeInteger. xs:unsignedInt unsignedInt is ·derived·from unsignedLong by setting the value of·maxInclusive·to be 4294967295. The base type·of unsignedInt is unsignedLong. xs:unsignedShort unsignedShort is ·derived· from unsignedInt by setting the value of maxInclusive· to be 65535. The ·base type·of unsignedShort is unsignedInt. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.3 oneM2M simple data types | Table 6.3.3-1 describes oneM2M-specific simple data type definitions. XML Schema data type definitions for these data types can be found in the XSD file called CDT-commonTypes-v2_7_0.xsd. The types in table 6.3.3-1 are either: • Atomic data types derived from XML Schema data types by restrictions other than enumeration. • List data types constructed from other XML Schema or oneM2M-defined atomic data types. The oneM2M-defined enumeration data types are defined in clause 6.3.4. Table 6.3.3-1: oneM2M Simple Data Types XSD type name Type Name Examples Description m2m:ID Generic ID //globalm2m.org Used to represent generic IDs generated and used within oneM2M (M2M-SP-ID) //globalm2m.org/C190XX7T (CSE-ID) //globalm2m.org/CSE1/123A38ZZY (AE-ID) m2m:nodeID Node ID urn:gsma:imei:90420156-025763- 0;svn=42 Used for Node IDs. The constraints on this type are different from those on Generic IDs (IMEI as node ID) m2m:deviceID Device ID urn:dev:ops:012345- Set%2DTop%2DBox-0123456789 A Device ID uniquely identifies a device using a URN. The format of the URN is one of IETF RFC 4122([35]) UUID, OPS URN, OS URN, IMEI URN, ESN URN, or MEID URN.A m2m:externalID M2M-EXT-ID urn:gsma:imei:90420156-025763- 0;vers=0 The External Identifier allows the Underlying Network to identify the M2M Device (e.g. ASN, MN) associated with the CSE-ID.In 3GPP case, the accessID is mapped to External Identifier as specified in ETSI TS 123 003 [17]. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 35 oneM2M TS-0004 version 2.7.1 Release 2 XSD type name Type Name Examples Description m2m:requestID Request ID ab3f124a, CSE1/98821 Used for Request IDs. This type may include the ID of the target CSE as well as a part that varies for each ID m2m:nhURI Non Hierarchical Identifier /CSE090112/ C190XX7T Used where a resourceID is required to be non-hierarchical m2m:acpType List of ACP Resource IDs //IN- CSEID.m2m.myoperator.org/93405 Used to represent a list of AccessControlPolicy identifiers. m2m:labels list of xs:token printers networkwifi1 home_energy A list of tokens used as keys for discovering resources (searching wifi connected printer from vendor 1) m2m:triggerRecipientID Trigger Recipient Identifier 3010 Used when device triggering services are requested from the Underlying Network, to identify an instance of an ASN/MN-CSE on an execution environment, to which the trigger is routed. Defined as port number in the range 0 to 65535. m2m:listOfM2MID List of M2M identifiers xs:list of elements of data type m2m:ID m2m:listOfMinMax List of Time Limits 10 2560 xs:list of two xs:long values defining min and max limits of time intervals in units of milliseconds (value -1 representing infinite time) m2m:ipv4 IPv4 address string with optional CIDR suffix 10.125.0.0/16,122.77.12.1 Used in m2m:accessControlRule s specified in clause 6.3.5.27 m2m:ipv6 IPv6 address string with optional CIDR suffix ::/0, Fadf:ddd0::/32, abcd:ffff:abb0:aaaa::/64 Used in m2m:accessControlRule s specified in clause 6.3.5.27 m2m:countryCode Country Code KR 2-character country code as defined by ISO 3166- 1 [40] m2m:poaList List of PointOfAccess strings http://172.25.0.10:8080, coap://m2m.sp.com:5683, mqtt://172.25.0.10:1883 list of xs:string. Each pointOfAccess entry in list is represented as a string containing the underlying transport protocol as well as the IP address and port (or an FQDN). m2m:timestamp Time stamp string 20141003T112032 DateTime string using 'Basic Format' specified in ISO8601 [27]. Time zone shall be interpreted as UTC timezone. See below for more details. m2m:absRelTimestamp absolute or relative time stamp string 20141003T112032 (absolute time),or 3600000 (relative time) defined as xs:union of m2m:timestamp and xs:duration data types ETSI ETSI TS 118 104 V2.7.1 (2016-10) 36 oneM2M TS-0004 version 2.7.1 Release 2 XSD type name Type Name Examples Description m2m:typeOfContent Type of Content application/xml The media type shall be an IANA registered Media Types name, or an experimental Media Type (See [26]) ':' m2m:serializations Serialization types application/xml application/json application/cbor A list of IANA registered media types that can be used for serialization of primitives. The permitted values are • application/xml • application/json • application/cbor m2m:contentInfo Content Information application/xml:1 application/xml:1:0 application/xml:1:5 A string consisting of a media type followed by a m2m:encodingType and optional m2m:contentSecurity, each separated by ':' character. If the m2m:contentSecurity value is not present, then the preceding ':' shall also be not present. If the m2m:contentSecurity value is not present then this has the same interpretation as a value of 0 for m2m:contentSecurity. See note. m2m:eventCat Event Category 2 Either 1. One of the values from m2m:stdEventC ats or 2. A user-defined category in the range 100-999 m2m:eventCatWithDef Event Category with default 0 Either 1. A value from m2m:eventCat , or 2. The value 0 which has the special meaning "default" m2m:listOfEventCat List of (applicable) Event Categories 1 101 xs:list of elements of data type m2m:eventCat m2m:listOfEventCatWithDef List of m2m:eventCatWith Def 0 1 101 m2m:scheduleEntry Schedule Entry * 0-5 2,6,10 * * * * * The string is used to describe a duration of enablement. The string format is described in clause 7.4.9.1. m2m:attributeList List of xs:NCName poa rr Used for the Content parameter of Retrieve request primitives. Attributes represented with their short names. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 37 oneM2M TS-0004 version 2.7.1 Release 2 XSD type name Type Name Examples Description m2m:roleID Role-ID 1234abcd@role-issuer.com A string pattern consisting of a name (the issuerRelativeID) and an FQDN (the issuerID) separated by the ‘@' character, not including any whitespace characters. The issuerRelativeID shall be comprised of any combination of the Roman alphabet, numerals, '.', '_' and '-' characters. m2m:descriptorRepresentation Semantic content representation application/rdf+xml:1 A string consisting of a media type followed by a m2m:encoding separated by ':' character. The only permitted value is application/rdf+xml:1 m2m:sparql SPARQL content SELECT ?functionality WHERE { ?functionality rdf:type base:Measuring. ?functionality base:refersTo ?aspect. ?aspect rdf:type instance:Temperature } The string is used for SPARQL content, e.g. in semanticsFilter m2m:missingDataList List of absolute timestamp or list of relative timestamp absolute time: 20141103T111832 , 20141103T112435 , 20141103T113633 or relative time: 10000 , 10005 , 10020 Used for storing the time information of missing data points in Time Series. defined as xs:union of list of m2m:timestamp and list of xs:duration data types m2m:tokenID Token-ID 1234abcd@token-issuer.com A string pattern consisting of a name (the issuerRelativeID) and an FQDN (the issuerID) separated by the ‘@' character, not including any whitespace characters. See constraints above for the issuerRelativeID. m2m:dynAuthJWT JSON Web Token (JWT), which uses either JSON Web Encryption (JWE) Compact Serialization JSON Web Signature (JWS) Compact Serialization See m2m:e2eCompactJWE and m2m:e2eCompactJWS Defined as xs:union of m2m:e2eCompactJWE and m2m:e2eCompactJWS ETSI ETSI TS 118 104 V2.7.1 (2016-10) 38 oneM2M TS-0004 version 2.7.1 Release 2 XSD type name Type Name Examples Description m2m:e2eCompactJWS JSON Web Signature (JWS) Compact Serialization, used in End-to-End Security Features ETSI TS 118 103 [7] eyJ0eXAiOiJK. eyJpc3MiOiJqb2UiLA0KIC. dBjftJeZ4CVP (line breaks for display purposes only) Of the form [a].[b].[c], where components [a] and [c] are non-empty, while component [b] can be either empty or not empty. When not empty, each component is base64url encoded (IETF RFC 4648 [9]). See [i.7] m2m:e2eCompactJWE JSON Web Encryption (JWE) Compact Serialization, used in End-to-End Security Features ETSI TS 118 103 [7] eyJ0eXAiOiJK. eyJpc3MiOiJqb2UiLA0KIC. dBjftJeZ4CVP. 5eym8TW_c8SuK. SdiwkIr3a. XFBoMYUZo (line breaks for display purposes only) Of the form [a].[b].[c].[d].[e], where components [a] and [d] are non-empty, while components [b],[c] and [e] can be empty or not empty. When not empty, each component is base64url encoded (IETF RFC 4648 [9]). See [i.8] NOTE: The media type and m2m:encodingType in m2m:contentInfo describe the content data to which the End-to- End Security of Data (ESData) processing, if any, was applied as indicated by m2m:contentSecurity. The m2m:contentInfo indicates a sequence of processes to be applied to the content after being obtained from the CSE. First, the ESData processing (if any) as indicated by m2m:contentSecurity is applied. The result of this processing then has transfer decoding (if any) applied as indicated by m2m:encodingType. The result of this processing is then processed according to the media type. The m2m:timestamp datatype uses ISO8601 [27] Complete Representation using the Basic Format as described here: • The timestamp shall be a string containing Year, Month, Day, Hours, Minutes and Seconds components using the format YYYYMMDDThhmmss as defined in [27]. In this representation the character "T" is to indicate the start of the time of day portion. • All these components shall appear in the string; reduced representations are not permitted. • The Seconds component may optionally contain a decimal fraction. In this case the string shall contain two integer digits, followed by a comma and then one or more fractional digits, up to a maximum of six. For example YYYYMMDDThhmmss,ssssss. • The timestamp string shall not contain Timezone information. All timestamps shall be interpreted as being in UTC. A receiving or Hosting CSE shall accept a timestamp that contains fractional seconds, but it need not act on a timestamp with the level of precision that is implied by its fractional part. For example it is acceptable for a Hosting CSE to round up an expiration time when interpreting it. NOTE 1: Care should be taken when developing an application that compares timestamps. This is because AE's and CSE's are not required to have their clocks synchronized. NOTE 2: As the m2m:timestamp is expressed in UTC, an AE has to be aware of the Timezone in which it is operating if it is to be able to relate the timestamp to its local time. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.4 oneM2M enumerated data types | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.4.1 Introduction | The oneM2M Enumeration Types are defined as extension from 'enumeration type' which is defined in XML Schema definition [3]. The oneM2M Enumeration Types are based on <xs:integer>, and the numeric values are interpreted as specified in clause 6.3.4.2. Table 6.3.4.1-1 shows the example of Enumeration Type definition for m2m:enumFooType. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 39 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.3.4.1-1: Example of oneM2M Enumeration Type Definition Value Interpretation Note 1 Interpretation-1 2 Interpretation-2 3 Interpretation-3 NOTE: See clause x.x.x "title of clause". The oneM2M Enumeration Type definition shall be implemented as part of CDT-enumeration-v2_7_0 .xsd. Figure 6.3.4.1-1 shows the example of XSD representation of 'm2m:enumFooType'. Figure 6.3.4.1-1: Example of XSD version of oneM2M Enumeration Type <xs:simpleType name="enumFooType"> <xs:restriction base="xs:integer"> <xs:enumeration value="1"/> <xs:enumeration value="2"/> <xs:enumeration value="3"/> </xs:restriction> </xs:simpleType> ETSI ETSI TS 118 104 V2.7.1 (2016-10) 40 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.4.2 Enumeration type definitions | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.4.2.1 m2m:resourceType | Table 6.3.4.2.1-1: Interpretation of resourceType Value Interpretation Note 1 accessControlPolicy 2 AE 3 container 4 contentInstance 5 CSEBase 6 delivery 7 eventConfig 8 execInstance 9 group 10 locationPolicy 11 m2mServiceSubscriptionProfile 12 mgmtCmd 13 mgmtObj 14 node 15 pollingChannel 16 remoteCSE 17 request 18 schedule 19 serviceSubscribedAppRule 20 serviceSubscribedNode 21 statsCollect 22 statsConfig 23 subscription 24 semanticDescriptor 25 notificationTargetMgmtPolicyRef 26 notificationTargetPolicy 27 policyDeletionRules 28 flexContainer 29 timeSeries 30 timeSeriesInstance 31 role 32 token 33 trafficPattern 34 dynamicAuthorizationConsultation 10001 accessControlPolicyAnnc 10002 AEAnnc 10003 containerAnnc 10004 contentInstanceAnnc 10009 groupAnnc 10010 locationPolicyAnnc 10013 mgmtObjAnnc 10014 nodeAnnc 10016 remoteCSEAnnc 10018 scheduleAnnc 10024 semanticDescriptorAnnc 10028 flexContainerAnnc 10029 timeSeriesAnnc 10030 timeSeriesInstanceAnnc 10033 trafficPatternAnnc 10034 dynamicAuthorizationConsultationAnnc NOTE: See clause 6.4.1 "Request message parameter data types". |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.4.2.2 m2m:cseTypeID | Used for cseType attribute of <CSEBase> resource. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 41 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.3.4.2.2-1: Interpretation of cseTypeID Value Interpretation Note 1 IN_CSE 2 MN_CSE 3 ASN_CSE NOTE: See clause 7.4.4 "Resource Type remoteCSE". |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.4.2.3 m2m:locationSource | Used for locationSource attribute of <locationPolicy> resource. Table 6.3.4.2.3-1: Interpretation of locationSource Value Interpretation Note 1 Network_based 2 Device_based 3 Sharing_based NOTE: See clause 7.4.10 "Resource Type locationPolicy". |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.4.2.4 m2m:stdEventCats | Used for ec parameter in request and eventCat attribute of <delivery> resource and cmdh policy resource types. Table 6.3.4.2.4-1: Interpretation of stdEventCats Value Interpretation Note 2 Immediate 3 BestEffort 4 Latest NOTE: See clause 7.4.11 "Resource Type delivery" and clause D.12 "Resource cmdhPolicy". |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.4.2.5 m2m:operation | Used for Operation parameter in request and operation attribute in <request> resource as well as operationMonitor. Table 6.3.4.2.5-1: Interpretation of operation Value Interpretation Note 1 Create 2 Retrieve 3 Update 4 Delete 5 Notify NOTE: See clause 6.4.1 "Request message parameter data types". |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.4.2.6 m2m:responseType | Used for Response Type parameter (as a part of responseTypeInfo, see clause 6.3.5.30) in request. Table 6.3.4.2.6-1: Interpretation of responseType Value Interpretation Note 1 nonBlockingRequestSynch 2 nonBlockingRequestAsynch 3 blockingRequest 4 flexBlocking NOTE: See clause 6.4.1 "Request message parameter data types". ETSI ETSI TS 118 104 V2.7.1 (2016-10) 42 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.4.2.7 m2m:resultContent | Used for Result Content parameter in request. Table 6.3.4.2.7-1: Interpretation of resultContent Value Interpretation Note 0 nothing 1 attributes 2 hierarchical address 3 hierarchical address and attributes 4 attributes and child resources 5 attributes and child resource references 6 child resource references 7 original resource 8 child resources NOTE: See clause 6.4.1 "Request message parameter data types". |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.4.2.8 m2m:discResType | Used in metaInformation attribute in <request> resource. Table 6.3.4.2.8-1: Interpretation of discResType Value Interpretation Note 1 structured 2 unstructured NOTE: See clause 6.4.1 "Request message parameter data types". |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.4.2.9 m2m:responseStatusCode | See clause 6.6.3 "Current Response Status Codes". Table 6.3.4.2.9-1: Interpretation of responseStatusCode Value Interpretation Note ('Numeric Code' in Clause 6.6.3) ('Description' in clause 6.6.3) 6.3.4.2.10 m2m:requestStatus Used for requestStatus attribute in <request> resource. Table 6.3.4.2.10-1: Interpretation of requestStatus Value Interpretation Note 1 COMPLETED 2 FAILED 3 PENDING 4 FORWARDED 5 PARTIALLY_COMPLETED NOTE: See clause 7.4.12 "Resource Type request". 6.3.4.2.11 m2m:memberType Used for memberType attribute in <group> resource. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 43 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.3.4.2.11-1: Interpretation of memberType Value Interpretation Note 0 mixed A mixture of all the resource types (except mixed itself). 1 accessControlPolicy 2 AE 3 container 4 contentInstance 5 CSEBase 6 delivery 7 eventConfig 8 execInstance 9 group 10 locationPolicy 11 m2mServiceSubscription 12 mgmtCmd 13 mgmtObj 14 node 15 pollingChannel 16 remoteCSE 17 request 18 schedule 19 serviceSubscribedAppRule 20 serviceSubscribedNode 21 statsCollect 22 statsConfig 23 subscription 24 semanticDescriptor 25 notificationTargetMgmtPolicyRef 26 notificationTargetPolicy 27 policyDeletionRules 28 flexContainer 29 timeSeries 30 timeSeriesInstance 31 role 32 token 33 trafficPattern 34 dynamicAuthorizationConsultation 10001 accessControlPolicyAnnc 10002 AEAnnc 10003 containerAnnc 10004 contentInstanceAnnc 10009 groupAnnc 10010 locationPolicyAnnc 10013 mgmtObjAnnc 10014 nodeAnnc 10016 remoteCSEAnnc 10018 scheduleAnnc 10024 semanticDescriptorAnnc 10028 flexContainerAnnc 10029 timeSeriesAnnc 10030 timeSeriesInstanceAnnc 10033 trafficPatternAnnc 10034 dynamicAuthorizationConsultationAnnc 20001 oldest 20002 latest NOTE: See clause 7.4.13 "Resource Type group". 6.3.4.2.12 m2m:consistencyStrategy Used for consistencyStrategy attribute in <group> resource. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 44 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.3.4.2.12-1: Interpretation of consistencyStrategy Value Interpretation Note 1 ABANDON_MEMBER 2 ABANDON_GROUP 3 SET_MIXED NOTE: See clause 7.4.13 "Resource Type group". 6.3.4.2.13 m2m:cmdType Used for cmdType attribute in <mgmtCmd> resource. Table 6.3.4.2.13-1: Interpretation of cmdType Value Interpretation Note 1 RESET 2 REBOOT 3 UPLOAD 4 DOWNLOAD 5 SOFTWAREINSTALL 6 SOFTWAREUNINSTALL 7 SOFTWAREUPDATE NOTE: See clause 7.4.16 "Resource Type mgmtCmd". 6.3.4.2.14 m2m:execModeType Used for execModeType attribute in <mgmtCmd> and <execInstance> resource. Table 6.3.4.2.14-1: Interpretation of execModetType Value Interpretation Note 1 IMMEDIATEONCE 2 IMMEDIATEREPEAT 3 RANDOMONCE 4 RANDOMREPEAT NOTE: See clause 7.4.16 "Resource Type mgmtCmd" and Clause 7.4.17 "Resource Type execInstance". 6.3.4.2.15 m2m:execStatusType Used for execStatusType attribute in <execInstance> resource. Table 6.3.4.2.15-1: Interpretation of execStatusType Value Interpretation Note 1 INITIATED 2 PENDING 3 FINISHED 4 CANCELLING 5 CANCELLED 6 STATUS_NON_CANCELLABLE NOTE: See clause 7.4.17 "Resource Type execInstance". 6.3.4.2.16 m2m:execResultType Used for execStatusType attribute in <execInstance> resource. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 45 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.3.4.2.16-1: Interpretation of execResultType Value Interpretation Note 1 STATUS_REQUEST_UNSUPPORTED 2 STATUS_REQUEST DENIED 3 STATUS_CANCELLATION_DENIED 4 STATUS_INTERNAL_ERROR 5 STATUS_INVALID_ARGUMENTS 6 STATUS_RESOURCES_EXCEEDED 7 STATUS_FILE_TRANSFER_FAILED 8 STATUS_FILE_TRANSFER_SERVER_AUTHENTICATION_FAILURE 9 STATUS_UNSUPPORTED_PROTOCOL 10 STATUS_UPLOAD_FAILED 11 STATUS_FILE_TRANSFER_FAILED_MULTICAST_GROUP_UNABLE_JOIN 12 STATUS_FILE_TRANSFER_FAILED_SERVER_CONTACT_FAILED 13 STATUS_FILE_TRANSFER_FAILED_FILE_ACCESS_FAILED 14 STATUS_FILE_TRANSFER_FAILED_DOWNLOAD_INCOMPLETE 15 STATUS_FILE_TRANSFER_FAILED_FILE_CORRUPTED 16 STATUS_FILE_TRANSFER_FILE_AUTHENTICATION_FAILURE 19 STATUS_FILE_TRANSFER_WINDOW_EXCEEDED 20 STATUS_INVALID_UUID_FORMAT 21 STATUS_UNKNOWN_EXECUTION_ENVIRONMENT 22 STATUS_DISABLED_EXECUTION_ENVIRONMENT 23 STATUS_EXECUTION_ENVIRONMENT_MISMATCH 24 STATUS_DUPLICATE_DEPLOYMENT_UNIT 25 STATUS_SYSTEM_RESOURCES_EXCEEDED 26 STATUS_UNKNOWN_DEPLOYMENT_UNIT 27 STATUS_INVALID_DEPLOYMENT_UNIT_STATE 28 STATUS_INVALID_DEPLOYMENT_UNIT_UPDATE_DOWNGRADE_DISALLOWED 29 STATUS_INVALID_DEPLOYMENT_UNIT_UPDATE_UPGRADE_DISALLOWED 30 STATUS_INVALID_DEPLOYMENT_UNIT_UPDATE_VERSION_EXISTS NOTE: See clause 7.4.16 "Resource Type mgmtCmd". 6.3.4.2.17 m2m:pendingNotification This is used for pendingNotification attribute in <subscription> resource. Table 6.3.4.2.17-1: Interpretation of pendingNotification Value Interpretation Note 1 sendLatest 2 sendAllPending NOTE: See clause 7.4.8 "Resource Type subscription". 6.3.4.2.18 m2m:notificationContentType Table 6.3.4.2.18-1: Interpretation of notificationContentType Value Interpretation Note 1 All Attributes 2 Modefied Attributes 3 ResourceID NOTE: See clause 7.4.8 "Resource Type subscription". 6.3.4.2.19 m2m:notificationEventType Used for eventNotificationCriteria conditions. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 46 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.3.4.2.19-1: Interpretation of notificationEventType Value Interpretation Note 1 Update_of_Resource Default 2 Delete_of_Resource 3 Create_of_Direct_Child_Resource 4 Delete_of_Direct_Child_Resource 5 Retrieve_of_Container_Resource_With_No_Child_Resource Context: a RETRIEVE request targets a subscribed-to <container> resource with the Result Content parameter set to either "child-resources" or "attributes+child-resources". A notification is initiated if the <contentInstance> child resource is obsolete or not present in the targeted parent resource. 6.3.4.2.20 m2m:status This is used for [software], [firmware] resources. Table 6.3.4.2.20-1: Interpretation of status Value Interpretation Note 1 Successful 2 Failure 3 In_Process NOTE: See clauses D.12, D.3 firmware and software management. 6.3.4.2.21 m2m:batteryStatus This is used for [battery] resource. Table 6.3.4.2.21-1: Interpretation of batteryStatus Value Interpretation Note 1 NORMAL The battery is operating normally and not on power. 2 CHARGING The battery is currently charging. 3 CHARGING_COMPLETE The battery is fully charged and still on power. 4 DAMAGED The battery has some problem. 5 LOW_BATTERY The battery is low on charge. 6 NOT_INSTALLED The battery is not installed. 7 UNKNOWN The battery information is not available. NOTE: See clause D.7 battery management. 6.3.4.2.22 m2m:mgmtDefinition This is used for <mgmtObj> resource. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 47 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.3.4.2.22-1: Interpretation of mgmtDefinition Value Interpretation Note 1001 [firmware] 1002 software 1003 memory 1004 areaNwkInfo 1005 areaNwkDeviceInfo 1006 battery 1007 deviceInfo 1008 deviceCapability 1009 reboot 1010 eventLog 1011 cmdhPolicy 1012 activeCmdhPolicy 1013 cmdhDefaults 1014 cmdhDefEcValue 1015 cmdhEcDefParamValues 1016 cmdhLimits 1017 cmdhNetworkAccessRules 1018 cmdhNwAccessRule 1019 cmdhBuffer 0 Unspecified Permits vendor-specific extensions NOTE: See clause 7.4.15 mgmtObj. 6.3.4.2.23 m2m:logTypeId Used for the logTypeId attribute of [eventLog] Management Resource. Table 6.3.4.2.23-1: Interpretation of logTypeId Value Interpretation Note 1 System 2 Security 3 Event 4 Trace 5 Panic 6.3.4.2.24 m2m:logStatus Used for the logStatus attribute of [eventLog] Management Resource. Table 6.3.4.2.24-1: Interpretation of logStatus Value Interpretation Note 1 Started The logging activity is started 2 Stopped The logging activity is stopped 3 Unknown The current status of the logging activity is unknown. 4 NotPresent The log data is not present and the logData attribute shall be ignored. 5 Error Error conditions for the logging activities, and the logging is stopped. 6.3.4.2.25 m2m:eventType Used for eventType attribute in <eventConfig> resource. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 48 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.3.4.2.25-1: Interpretation of eventType Value Interpretation Note 1 DATAOPERATION 2 STORAGEBASED 3 TIMERBASED NOTE: See clause 7.4.24 "Resource Type eventConfig". 6.3.4.2.26 m2m:statsRuleStatusType Used for statsRuleStatusType attribute in <statsCollect> resource. Table 6.3.4.2.26-1: Interpretation of statsRuleStatusType Value Interpretation Note 1 ACTIVE 2 INACTIVE NOTE: See clause 7.4.25 "Resource Type statsCollect". 6.3.4.2.27 m2m:statModelType Used for statModelType attribute in <statsCollect> resource. Table 6.3.4.2.27-1: Interpretation of statModelType Value Interpretation Note 1 EVENTBASED NOTE: See clause 7.4.25 "Resource Type statsCollect". 6.3.4.2.28 m2m:encodingType Used for describing encoding type which is applied on the content attribute of the contentInstance resource. Table 6.3.4.2.28-1: Interpretation of encodingType Value Interpretation Note 0 Plain - no transfer encoding is applied 1 base64 encoding (see [9]) is applied on string data 2 base64 encoding (see [9]) is applied on binary data 6.3.4.2.29 m2m:accessControlOperations Used for accessControlPolicys. Table 6.3.4.2.29-1: Interpretation of accessControlOperations Value Interpretation Note 1 CREATE 2 RETRIEVE 4 UPDATE 8 DELETE 16 NOTIFY 32 DISCOVERY NOTE: Combinations of these values are specified by adding them together. For example the value 5 is interpreted as "CREATE and UPDATE". ETSI ETSI TS 118 104 V2.7.1 (2016-10) 49 oneM2M TS-0004 version 2.7.1 Release 2 6.3.4.2.30 Void 6.3.4.2.31 m2m:filterUsage Used in m2m:filterCriteria. Table 6.3.4.2.31-1: Interpretation of filterUsage Value Interpretation Note 1 Discovery Criteria 2 Conditional Retrieval This is the default value when the filterUsage condition is not present in a Retrieve request. 3 IPE On-demand Discovery 6.3.4.2.32 m2m:notificationTargetPolicyAction Table 6.3.4.2.32-1: Interpretation of notificationTargetPolicyAction Value Interpretation Note 1 accept request 2 reject request 3 seek authorization from subscription originator before responding 4 inform the subscription originator without taking any action 6.3.4.2.33 m2m:logicalOperator Table 6.3.4.2.33-1: Interpretation of logicalOperator Value Interpretation Note 1 AND operation 2 OR operation 6.3.4.2.34 m2m:filterOperation Used in m2m:filterCriteria. Table 6.3.4.2.34-1: Interpretation of filterOperation Value Interpretation Note 1 Logical AND This is the default value when the filterOperation condition is not present in filterCriteria. 2 Logical OR 6.3.4.2.35 m2m:securityInfoType Used in m2m:securityInfo. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 50 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.3.4.2.35-1: Interpretation of securityInfoType Value Interpretation Note 1 Dynamic Authorization Request 2 Dynamic Authorization Response 3 Receiver E2E Rand Object Request 4 Receiver E2E Rand Object Response 5 ESPrim Object 6 ESCertKE Message 6.3.4.2.36 m2m:allJoynDirection Used for direction attribute of [allJoynApp] resource. Table 6.3.4.2.36-1: Interpretation of allJoynDirection Value Interpretation Note 1 AllJoyn_to_oneM2M 2 oneM2M_to_AllJoyn NOTE: See clause J.6 "Resource type [allJoynApp]". 6.3.4.2.37 m2m:contentFilterSyntax Used for contentFilterSyntax element in Filter Criteria primitive parameter. Table 6.3.4.2.37-1: Interpretation of contentFilterSyntax Value Interpretation Note 1 JSON_PATH_SYNTAX 'jsonpath' query syntax. See Annex K.2 of ETSI TS 118 101 [6] for information about the jsonpath syntax. 6.3.4.2.38 m2m:contentSecurity Used in m2m:contentInfo. Table 6.3.4.2.38-1: Interpretation of contentSecurity Value Interpretation Note 0 ESData has not been applied to the content data. 1 ESData using JWE and/or JWS with Compact Serialization has been applied to the content data with no subsequent transfer encoding. See note 2. See Note 3 2 ESData using JWE and/or JWS with JSON Serialization has been applied to the content data with no subsequent transfer encoding. See Note 4 3 ESData using JWE and/or JWS with JSON Serialization has been applied to the content data and subsequent base64 encoding (see [9]) has been applied. See Note 4 4 ESData using XML encryption and/or XML-Signature has been applied to the content data has been applied with no subsequent transfer encoding. See Note 5 5 ESData using XML encryption and/or XML-Signature has been applied to the content data and subsequent base64 encoding (see [9]) has been applied. See Note 5 NOTE 1: See ETSI TS 118 103 [7] for details on these security protocols NOTE 2: JWE and/or JWS with Compact Serialization is almost entirely base64URL encoded by default - see m2m:e2eCompactJWS and m2m:e2eCompactJWE in Table 6.3.3. Consequently, there is no option for additional base64 encoding of JWE and/or JWS with Compact Serialization. NOTE 3: The ESData envelope (see ETSI TS 118 103 [7]) in this case has media type application/jose. NOTE 4: The ESData envelope in this case has media type application/jose+json. NOTE 5: The ESData envelope in this case has media type application/xenc+xml or application/xml (the latter is the media type for XML Signature). ETSI ETSI TS 118 104 V2.7.1 (2016-10) 51 oneM2M TS-0004 version 2.7.1 Release 2 6.3.4.2.39 m2m:suid Used in m2m:e2eSecInfo and other security features in ETSI TS 118 103 [7]. NOTE: This enumeration is the concatenation of two identifiers. The first identifier identifies the type of credential (such as pre-provisioned symmetric key, symmetric key provisioned via a RSPF, or symmetric key distributed via MAF and certificate) and the intended scope within which the credential is to be used (such as shared with an MEF, shared with an MAF, use in SAEF, use in ESPrim, use in authentication encryption in ESData, or use in signature only in ESData). Table 6.3.4.2.39-1: Interpretation of suid Value Interpretation Note 10 A pre-provisioned symmetric key intended to be shared with a MEF 11 A pre-provisioned symmetric key intended to be shared with a MAF 12 A pre-provisioned symmetric key intended for use in a Security Associated Establishment Framework (SAEF) 13 A pre-provisioned symmetric key intended for use in End-to-End Security of Primitives (ESPrim) 14 A pre-provisioned symmetric key intended for use with authenticated encryption in the Encryption-only or Nested Sign-then-Encrypt End-to-End Security of Data (ESData) Data classes 15 A pre-provisioned symmetric key intended for use in Signature-only ESData Security Class 21 A symmetric key, provisioned via a Remote Security Provisioning Framework (RSPF), and intended to be shared with a MAF 22 A symmetric key, provisioned via a RSPF, and intended for use in a SAEF 23 A symmetric key, provisioned via a RSPF, and intended for use in ESPrim 24 A symmetric key, provisioned via a RSPF, and intended for use with authenticated encryption in the Encryption-only or Nested Sign-then-Encrypt ESData) Data classes 25 A symmetric key, provisioned via a RSPF, and intended for use in Signature- only ESData Security Class 32 A MAF-distributed symmetric key intended for use in a SAEF 33 A MAF-distributed symmetric key intended for use in ESPrim 34 A MAF-distributed symmetric key intended for use with authenticated encryption in the Encryption-only or Nested Sign-then-Encrypt ESData Data classes 35 A MAF-distributed symmetric key intended for use in Signature-only ESData Security Class 40 A certificate intended to be shared with a MEF 41 A certificate intended to be shared with a MAF 42 A certificate intended for use in a Security Associated Establishment Framework (SAEF) 43 A certificate intended for use in End-to-End Security of Primitives (ESPrim) 44 A certificate intended for use with authenticated encryption in the Encryption- only or Nested Sign-then-Encrypt End-to-End Security of Data (ESData) Data classes 45 A certificate intended for use in Signature-only ESData Security Class NOTE: See ETSI TS 118 103 [7] for further detail. 6.3.4.2.40 m2m:esprimKeyGenAlgID Used in m2m:receiverESPrimRandObject and m2m:originatorESPrimRandObject. Table 6.3.4.2.40-1: Interpretation of esprimKeyGenAlgID Value Interpretation Note 1 HMAC-SHA256 See ETSI TS 118 103 [7] NOTE: Further sessionESPrimKey Key Generation Algorithms are anticipated to be added in the future. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 52 oneM2M TS-0004 version 2.7.1 Release 2 6.3.4.2.41 m2m:esprimProtocolAndAlgID Used in m2m:receiveESPrimRandObject and m2m:originatorESPrimRandObject. NOTE: This enumeration is the concatenation of two identifiers. The most significant numeral identifies an object security technology (that is, a protocol) such as JSON Web Encryption (JWE) Compact Representation [i.8]. Further protocols can be supported in the future. The least significant numeral identifies an Authenticated Encryption option for that object security technology. Table 6.3.4.2.41-1: Interpretation of esprimProtocolAndAlgID Value Interpretation Notes 10 JWE Compact Serialization with "enc" = "A128GCM" AES GCM using 128-bit key 11 JWE Compact Serialization with "enc" = "A192GCM" AES GCM using 192-bit key 12 JWE Compact Serialization with "enc" = "A256GCM" AES GCM using 256-bit key NOTE 1: JWE Compact Serialization for ESPrim is specified in clause 8.4.3.2 of ETSI TS 118 103 [7]. NOTE 2: JWE authentication encryption using AES GCM is specified in [i.8], [i.9]. 6.3.4.2.42 m2m:periodicIndicator Used for periodicIndicator attribute of <trafficPattern> resource. Table 6.3.4.2.42-1: Interpretation of periodicIndicator Value Interpretation Note 1 Periodic 2 On demand NOTE: See clause 7.4.42 "Resource Type trafficPattern". 6.3.4.2.43 m2m:stationaryIndication Used for stationaryIndication attribute of <trafficPattern> resource. Table 6.3.4.2.43-1: Interpretation of stationaryIndication Value Interpretation Note 1 Stationary 2 Mobile (Moving) NOTE: See clause 7.4.42 "Resource Type trafficPattern". 6.3.4.2.44 m2m:contentStatus Used for Content Status response parameter. Table 6.3.4.2.44-1: Interpretation of contentStatus Value Interpretation Note 1 PARTIAL_CONTENT 2 FULL_CONTENT NOTE: See clause 6.4.2 "Response primitive parameter data type". 6.3.4.2.45 m2m:networkAction Used in the networkAction element in the m2m:backOffParameters. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 53 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.3.4.2.45-1: Interpretation of m2m:networkAction Value Interpretation Note 1 cellular-registration 2 cellular-attach 3 cellular-pdpctxact 4 cellular-sms 5 default |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5 Complex data types | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.1 Introduction | The present clause defines structured information for specific use in oneM2M protocol. These types are defined to be xs:sequence complex types, unless specified otherwise. XML Schema data type definitions for these data types can be found in the XSD file called CDT-commonTypes-v2_7_0.xsd.In addition, each oneM2M resource has a corresponding complex data type. These are described in Clause 6.5. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.2 m2m:deliveryMetaData | Used for deliveryMetaData attribute in <delivery> resource. Table 6.3.5.2-1: Type Definition of m2m:deliveryMetadata Element Path Element Data Type Multiplicity Note tracingOption xs:boolean 1 tracingInfo m2m:listOfM2MID 0..1 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.3 m2m:aggregatedRequest | Used for aggregatedRequest attribute in <delivery> resource. Table 6.3.5.3-1: Type Definition of m2m:aggregatedRequest Element Path Element Data Type Multiplicity Note request (anonymous) 1..n request/operation m2m:operation 1 See clause 6.3.4.2.5 request/to xs:anyURI 1 request/from m2m:ID 1 See clause 6.3.3 request/requestIdentifier m2m:requestID 1 See clause 6.3.3 request/primitiveContent m2m:primitiveContent 0..1 See clause 6.3.5.5 request/metaInformation m2m:metaInformation 0..1 See clause 6.3.5.4 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.4 m2m:metaInformation | Used for metaInformation attribute in <request> resource, and m2m:aggregatedRequest data type. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 54 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.3.5.4-1: Type Definition of m2m:metaInformation Element Path Element Data Type Multiplicity Note resourceType m2m:resourceType 0..1 See clause 6.3.4.2.1 originatingTimestamp m2m:timestamp 0..1 requestExpirationTimestamp m2m:absRelTimestamp 0..1 resultExpirationTimestamp m2m:absRelTimestamp 0..1 operationExecutionTime m2m:absRelTimestamp 0..1 responseType m2m:responseTypeInfo 0..1 See clause 6.3.4.2.6 resultPersistence m2m:absRelTimestamp 0..1 resultContent m2m:resultContent 0..1 See clause 6.3.4.2.7 eventCategory m2m:eventCat 0..1 See clause 6.3.3 deiveryAggregation xs:boolean 0..1 groupRequestIdentifier xs:string 0..1 filterCriteria m2m:filterCriteria 0..1 See clause 6.3.5.8 discoveryResultType m2m:discResType 0..1 See clause 6.3.4.2.8 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.5 m2m:primitiveContent | Used for Content parameter in request/response primitive and the content attribute in <request> resource. See clauses 7.2.1.1 and 7.2.1.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.6 m2m:batchNotify | Used for batchNotify attribute in <subscription> resource. Table 6.3.5.6-1: Type Definition of m2m:batchNotify Element Path Element Data Type Multiplicity Note number xs:nonNegativeInteger 1 duration xs:duration 1 If the duration is not given by the Originator, the Hosting CSE shall set this with the default duration value as given by the M2M Service Provider. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.7 m2m:eventNotificationCriteria | Used for eventNotificationCriteria of a <subscription> resource. Table 6.3.5.7-1:Type Definition of m2m:eventNotificationCriteria Element Path Element Data Type Multiplicity Note createdBefore m2m:timestamp 0..1 createdAfter m2m:timestamp 0..1 modifiedSince m2m:timestamp 0..1 unmodifiedSince m2m:timestamp 0..1 stateTagSmaller xs:positiveInteger 0..1 stateTagBigger xs:nonNegativeInteger 0..1 expireBefore m2m:timestamp 0..1 expireAfter m2m:timestamp 0..1 sizeAbove xs:nonNegativeInteger 0..1 sizeBelow xs:positiveInteger 0..1 operationMonitor m2m:operation 0..5 attribute m2m:attribute 0..n notificationEventType m2m:notificationEventType 0..5 missingData m2m:missingData 0..1 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 55 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.8 m2m:filterCriteria | Used indirectly in the <request> resource and for the Filter Criteria parameter in a request. Table 6.3.5.8-1: Type Definition of m2m:filterCriteria Element Path Element Data Type Multiplicity Note createdBefore m2m:timestamp 0..1 createdAfter m2m:timestamp 0..1 modifiedSince m2m:timestamp 0..1 unmodifiedSince m2m:timestamp 0..1 stateTagSmaller xs:positiveInteger 0..1 stateTagBigger xs:nonNegativeInteger 0..1 expireBefore m2m:timestamp 0..1 expireAfter m2m:timestamp 0..1 labels m2m:labels 0..1 resourceType list of m2m:resourceType 0..1 sizeAbove xs:nonNegativeInteger 0..1 sizeBelow xs:positiveInteger 0..1 contentType m2m:typeOfContent 0..n attribute m2m:attribute 0..n filterUsage m2m:filterUsage 0..1 limit xs:nonNegativeInteger 0..1 semanticsFilter m2m:sparql 0..n filterOperation m2m:filterOperation 0..1 contentFilterSyntax m2m:contentFilterSyntax 0..1 contentFilterQuery xs:string 0..1 level xs:positiveInteger 0..1 offset xs:positiveInteger 0..1 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.9 m2m:attribute | Used in m2m:eventNotificationCriteria and m2m:filterCriteria. Table 6.3.5.9-1: Type Definition of m2m:attribute Element Path Element Data Type Multiplicity Note name xs:NCName 1 value xs:anyType 1 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.10 Void |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.