hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.7 Resource Type <contentInstance> | 7.4.7.1 Introduction The <contentInstance> resource represents a data instance in the container. The detailed description can be found in clause 9.6.7 in ETSI TS 118 101 [6]. Table 7.4.7.1-1: Data type definition of <contentInstance> resource Data Type ID File Name Note contentInstance CDT-contentInstance-v2_7_0.xsd Table 7.4.7.1-2: Universal/Common Attributes of <contentInstance> resource Attribute Name Request Optionality Create @resourceName O resourceType NP resourceID NP parentID NP expirationTime O creationTime NP lastModifiedTime NP stateTag NP labels O announceTo O announcedAttribute O dynamicAuthorization ConsultationIDs O creator O Table 7.4.7.1-3: Resource Specific Attributes of <contentInstance> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create contentInfo O m2m:contentInfo No default contentSize NP xs:nonNegativeInteger No default contentRef O m2m:contentRef No default ontologyRef O xs:anyURI No default content M xs:anySimpleType No default (Transfer encoding may be applied, and indicated applied encoding as part of the contentInfo attribute) Table 7.4.7.1-4: Child resources of <contentInstance> resource Child Resource Type Child Resource Name Multiplicity Ref. to in Resource Type Definition <semanticDescriptor> [variable] 0..n Clause 7.4.28 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 126 oneM2M TS-0004 version 2.7.1 Release 2 The contentInfo attribute shall provide meta information about the stored data in content. m2m:encodingType (0:plain, 1:base64 encoded string, 2:base64 encoded binary) and is optional. 7.4.7.2 <contentInstance> resource specific procedure on CRUD operations |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.7.2.1 Create | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Primitive specific operation on Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed": 1) The Hosting CSE shall set the contentSize to the size in bytes of the content attribute. 2) currentNrOfInstances and currentByteSize of direct parent <container> resource shall be updated. If currentNrOfInstances and/or currentByteSize exceeds maxNrOfInstances and/or maxByteSize of direct parent <container> resource respectively, the Hosting CSE shall return the response primitive with a Response Status Code indicating " NOT_ACCEPTABLE" error. 3) stateTag attribute of direct parent <container> resource shall be incremented and copied into the stateTag of this <contentInstance> resource. No other changes from the generic procedures in clause 7.2.2.2. The Originator may omit the name of the <contentInstance> resource unless the Originator need to refer specific content later. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.7.2.2 Retrieve | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Same as the generic procedures in clause 7.2.2.2 except following conditions: • If the value of disableRetrieval attribute of the parent <container> resource is ‘true', then the Hosting CSE shall return response primitive with a Response Status Code indicating "OPERATION_NOT_ALLOWED" error. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.7.2.3 Update | Originator: The <contentInstance> resource shall not be Updated via API. Receiver: Primitive specific operation on Recv-1.0 "Check the syntax of received message": If the request is received, the Receiver CSE shall execute the following steps in order. a) "Create an unsuccessful Response primitive" with the Response Status Code indicating "OPERATION_NOT_ALLOWED" error. 2) "Send the Response primitive". ETSI ETSI TS 118 104 V2.7.1 (2016-10) 127 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.7.2.4 Delete | Originator: Primitive specific operation on Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed": 1) currentNrOfInstances and currentByteSize of direct parent <container> resource shall be updated. Receiver: No change from the generic procedures in clause 7.2.2.2 except following conditions: • If the value of disableRetrieval attribute of the parent <container> resource is ‘true', then the Hosting CSE shall return response primitive with a Response Status Code indicating "OPERATION_NOT_ALLOWED" error. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.8 Resource Type <subscription> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.8.1 Introduction | 7.4. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 8.1 Introduction | The <subscription> resource contains subscription information for its subscribed-to resource. The subscription resource is a child of the subscribed to resource. The detailed description can be found in clause 9.6.8 in ETSI TS 118 101 [6]. Table 7.4.8.1-1: Data type definition of <subscription> resource Data Type ID File Name Note subscription CDT-subscription-v2_7_0.xsd Table 7.4.8.1-2: Universal/Common Attributes of <subscription> resource Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP parentID NP NP accessControlPolicyIDs O O creationTime NP NP expirationTime O O lastModifiedTime NP NP labels O O creator O NP dynamicAuthorizationConsultationIDs O O ETSI ETSI TS 118 104 V2.7.1 (2016-10) 128 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.8.1-3: Resource Specific Attributes of <subscription> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update eventNotificationCrite ria O O m2m:eventNotificationCr iteria Default behaviour is notification on Update_of_Resource expirationCounter O O xs:positiveInteger No default notificationURI M O list of xs:anyURI No default groupID O O xs:anyURI No default notificationForwardin gURI O O xs:anyURI No default batchNotify O O m2m:batchNotify No default rateLimit O O m2m:rateLimit No default preSubscriptionNotify O NP xs:positiveInteger No default pendingNotification O O m2m:pendingNotification No default notificationStoragePri ority O O xs:positiveInteger No default latestNotify O O xs:boolean No default notificationContentTy pe O O m2m:notificationContent Type Default value is set to ‘all attributes' notificationEventCat O O m2m:eventCat No default subscriberURI O NP xs:anyURI No default Table 7.4.8.1-4: Reference of child resources Child Resource Type Child Resource Name Multiplicity Ref. to in Resource Type Definition <schedule> notificationSchedule 0..1 Clause 7.4.9 <notificationTargetMgmtPolicyRef> [variable] 0..n Clause 7.4.30 <notificationTargetSelfReference> notificationTargetSelfReference 1 Clause 7.4.33 7.4.8.2 <subscription> resource specific procedure on CRUD operations |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.8.2.1 Create | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: The following are additional Hosting CSE procedures to the generic resource handling procedures (Figure 7.2.2.2-1 in clause 7.2.2.2). The additional procedures shall be inserted from Recv-6.2 to Recv-6.8 as below. The resource handling procedure for the Hosting CSE which receives <subscription> CREATE request shall perform the following procedures in order: 1. Recv-6.2 2. Recv-6.3 3. Check if the subscribed-to resource, addressed in To parameter in the Request, is subscribable. Subscribable resource types are defined in ETSI TS 118 101 [6], they have <subscription> resource types as their child resources. If it is not subscribable, the Hosting CSE shall return the Notify response primitive with a Response Status Code indicating "TARGET_NOT_SUBSCRIBABLE" error. 4. Check if the Originator has privileges for retrieving the subscribed-to resource. If the Originator does not have the privilege, the Hosting CSE shall return the response primitive with Response Status Code indicating "ORIGINATOR_HAS_NO_PRIVILEGE" error. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 129 oneM2M TS-0004 version 2.7.1 Release 2 5. If the notificationURI is not the Originator, the Hosting CSE should send a Notify request primitive to the notificationURI with verificationRequest parameter set as TRUE (See clause 7.5.1.2.2). a. If the Hosting CSE cannot send the Notify request primitive, the Hosting CSE shall return the Notify response primitive with a Response Status Code indicating "SUBSCRIPTION_VERIFICATION_INITIATION_FAILED" error. b. If the Hosting CSE sent the primitive, the Hosting CSE shall check if the Notify response primitive contains a Response Status Code indicating "SUBSCRIPTION_CREATOR_HAS_NO_PRIVILEGE" or "SUBSCRIPTION_HOST_HAS_NO_PRIVILEGE error. If so, the Hosting CSE shall return the Create response primitive with a Response Status Code indicating the same error from the Notify response primitive to the Originator. 6. Recv-6.4 7. If the Originator does not provide notificationContentType, the Hosting CSE shall set it as ‘all attributes'. 8. Recv-6.5 If the notificationURI is not the Originator, the Hosting CSE shall store Originator ID to creator attribute. 9. Recv-6.6 10. Recv-6.7 11. Recv-6.8 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.8.2.2 Retrieve | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.8.2.3 Update | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.8.2.4 Delete | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.9 Resource Type <schedule> | 7.4.9.1 Introduction The <schedule> resource shall represent scheduling information in the context of its parent resource. If a <schedule> resource is not present as a child resource then there are no time-constraints on the context of its parent resource. An Originator shall have the same access control privileges to the <schedule> resource as it has to its parent resource. The detailed <schedule> resource description can be found in clause 9.6.9 of the ETSI TS 118 101 [6]. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 130 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.9.1-1: Data type definition of <schedule> resource Data Type ID File Name Note schedule CDT-schedule-v2_7_0.xsd Table 7.4.9.1-2: Universal/Common Attributes of <schedule> resource Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP parentID NP NP creationTime NP NP expirationTime O O lastModifiedTime NP NP labels O O announceTo O O announcedAttribute O O dynamicAuthorization ConsultationIDs O O Table 7.4.9.1-3: Resource Specific Attributes of <schedule> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update scheduleElement M O m2m:scheduleEntries No Default and shall not be blank. The scheduleElement attribute represents the list of scheduled execution times. The each entry of the scheduleElelement attribute shall consist of a line with 7 field values (See Table 7.3.8.1-4). The time to be matched with the schedule pattern shall be interpreted in UTC timezone. Table 7.4.9.1-4: Definition of m2m:scheduleEntry string format Field Name Range of values Note Second 0 to 59 Minute 0 to 59 Hour 0 to 23 Day of the month 1 to 31 Month of the year 1 to 12 Day of the week 0 to 6 0 means Sunday Year 20000 to 9999 Each field value can be either an asterisk ('*': matching all valid values), an element, or a list of elements separated by commas(','). An element shall be either a number, a range (two numbers separated by a hyphen '-') or a range followed by a step value. A step value (a slash '/' followed by an interval number) specifies that values are repeated over and over with the interval between them. For example, note "0-23/2" in the Hour field is equivalent to "0,2,4,6,8,10,12,14,16,18,20,22". A step value can also be used after an asterisk (e.g. "*/2"). The task which shall be executed is depending on the parent resource of the <schedule> resource (see Table 7.4.9.1-5). ETSI ETSI TS 118 104 V2.7.1 (2016-10) 131 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.9.1-5: The task to be executed Parent resource Task to be executed Note <remoteCSE> Establish connection to the remoteCSE Timing of disconnection is up to implementation in present release. <subscription> Flash spooled notifications EXAMPLE 1: EXAMPLE: * 0-5 2,6,10 * * * * In case of parent resource was <remoteCSE>, the CSE will establish connection on 2:00-2:05, 6:00-6:05, and 10:00- 10:05 every day. End of EXAMPLE 1: EXAMPLE 2: EXAMPLE: * * 8-20 * * * * In case of the parent resource was <subscription>, the notification for the subscribed event will be suspended between from 20:00 to 8:00 on weekend. End of EXAMPLE 2: EXAMPLE 3: EXAMPLE: * * 0-23/2 * * * * In case of parent resource was <remoteCSE>, the CSE will establish connection every two hours every day. End of EXAMPLE 3: EXAMPLE 4: EXAMPLE: * * * * * */2 * In case of parent resource was <remoteCSE>, the CSE will establish connection on Sunday, Tuesday, Thursday and Saturday (*/2 in the day of the week field is equivalent to 0,2,4,6). End of EXAMPLE 4: Table 7.4.9.1-6: Child resources of <schedule > resource Child Resource Type Child Resource Name Multiplicity Ref. to in Resource Type Definition Subscription [variable] 0..n Clause 7.4.8 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.9.2 <schedule> resource specific procedure on CRUD operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.9.2.0 Introduction | This sub-clause describes <schedule> resource specific behaviour for CRUD operations. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 132 oneM2M TS-0004 version 2.7.1 Release 2 7.4.9.2.1 Create Originator: No change from the generic procedures in clause 7.2.2.1. If <schedule> is created then scheduleElement (L) shall be created. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.9.2.2 Retrieve | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.9.2.3 Update | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.9.2.4 Delete | Originator: No change from the generic procedures in clause 7.2.2.1. If <schedule> is deleted then scheduleElement (L) shall be deleted. Receiver: No change from the generic procedures in clause 7.2.2.2. 7.4.10 Resource Type <locationPolicy> |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.10.1 Introduction | The <locationPolicy> resource represents the method for obtaining and managing geographical location information of an M2M Node. The detailed description can be found in the clause 9.6.10 in ETSI TS 118 101 [6]. Table 7.4.10.1-1: Data type definition of <locationPolicy> resource Data Type ID File Name Note locationPolicy CDT-locationPolicy-v2_7_0.xsd ETSI ETSI TS 118 104 V2.7.1 (2016-10) 133 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.10.1-2: Universal/Common Attributes of <locationPolicy> resource Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP parentID NP NP expirationTime O O accessControlPolicyI Ds O O creationTime NP NP lastModifiedTime NP NP labels O O announceTo O O announcedAttribute O O dynamicAuthorization ConsultationIDs O O Table 7.4.10.1-3: Resource Specific Attributes of <locationPolicy> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update locationSource M NP m2m:locationSource No default locationUpdatePerio d O O List of xs:duration No default locationTargetID O NP m2m:nodeID No default locationServer O NP xs:anyURI No default locationContainerID NP NP xs:anyURI No default locationContainerNa me O O xs:string No default locationStatus NP NP xs:string No default Table 7.4.10.1-4: Child resources of <locationPolicy> resource Child Resource Type Child Resource Name Multiplicity Ref. to Resource Type Definition <subscription> [variable] 0..n Clause 7.4.8 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.10.2 <locationPolicy> resource specific procedure on CRUD Operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.10.2.0 Introduction | This clause describes <locationPolicy> resource specific primitive behaviour for CRUD operations. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.10.2.1 Create | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: The following <locationPolicy> resource type specific procedures shall be performed after Recv-6.5 and before Recv- 6.6 generic procedures. 1) After the successful creation of <locationPolicy> resource, the Hosting CSE shall create <container> resource where the actual location information will be stored and the resource shall contain cross-references for the both resources, locationContainerID attribute for the <locationPolicy> resource and locationID attribute for the <container> resource. The name of the created <container> resource shall be determined by the locationContainerID attribute if it is applicable. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 134 oneM2M TS-0004 version 2.7.1 Release 2 2) Check the locationSource and locationUpdatePeriod attributes: a) If the locationSource attribute is set by 'Network Based' and locationUpdatePeriod attribute is set by any duration value (higher than 0 second), then continue with the step 3. b) If the locationSource attribute is set by 'Device Based' and locationUpdatePeriod attribute is set by any duration value (higher than 0 second), then continue with the step 4. c) If the locationSource attribute is set by 'Sharing Based' and locationUpdatePeriod attribute is set by any duration value (higher than 0 second), then continue with the step 5. d) If the locationUpdatePeriod has more than one values, the first value in the list shall be used as the current location update period in step 3,4 and 5. In this case, based on the local context information of the Hosting CSE such as velocity, available memory, the Hosting CSE may choose one of the value out of the list to be the active location update period. If the device is moving at the high speed, it is expected that the location of the device would be update more frequently. The Hosting CSE would acquire the current velocity of the device and compare the value with some predefined value, depend on the result of the comparison, the Hosting CSE would choose a smaller value from the list if the current velocity is higher than the predefined value. Otherwise, the Hosting CSE would choose a larger value. 3) The Hosting CSE shall retrieve the locationTargetID and locationServer attributes from the stored <location Policy> resource. In case either the locationTargetID or locationServer attribute cannot be obtained, the Hosting CSE shall reject the request with the Response Status Code indicating "BAD_REQUEST" error. Then, the Hosting CSE shall transform the location-acquisition request into Location Server request [28], using the attributes stored in <locationPolicy> resource. The Hosting CSE shall also provide default values for other required parameters (e.g. quality of position) in the Location Server request according to local policies. The Hosting CSE shall send this Location Server request to the location server using, for example, OMA Mobile Location Protocol [i.4] and OMA RESTful NetAPI for Terminal Location [28]. The location server performs positioning procedure based upon the Location Server request. Then continue with step 6. Based on the period information, locationUpdatePeriod attribute, this step can be periodically repeated or the location server can only notify the Hosting CSE of location information that performs periodically. NOTE 1: The location server performs the privacy control and only responds successfully if the positioning procedure is permitted. NOTE 2: The detail information on how the Location Server request message is converted into OMA RESTful NetAPI for Terminal Location message is described in annex G. 4) The Hosting CSE shall perform positioning procedure using location determination modules and technologies (e.g. GPS). Then continue with step 6. Based on the period information, locationUpdatePeriod attribute, this step can be periodically repeated. NOTE 3: The Hosting CSE can utilize the internal interface (e.g. System Call) to communicate with the modules and technologies. The detailed procedure is out of scope. 5) The Hosting CSE shall collect information of topology of M2M Area Network using <node> resource and find the closest Node from the Originator that has registered with the Hosting CSE and has location information. The closest Node is determined by the minimum hop based on the collected topology information. a) If the Hosting CSE can find the closest Node from the Originator, the location information of the closest Node shall be stored as the location information of the Originator into a <contentInstance> resource under the created <container> resource. b) If the Hosting CSE cannot find the closest Node from the Originator, the location information of the Hosting CSE shall be stored as the location information of the Originator into a <contentInstance> resource under the created <container> resource. 6) The Hosting CSE shall receive the corresponding response and transform it into a Response primitive. a) If the positioning procedure is failed, the Hosting CSE shall store a statusCode based on the error code in the locationStatus attribute in the created <locationPolicy> resource. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 135 oneM2M TS-0004 version 2.7.1 Release 2 b) If the positioning procedure is successfully complete which means that the Hosting CSE acquires the location information, The Hosting CSE shall store the acquired location information into a <contentInstance> resource under the created <container> resource. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.10.2.2 Retrieve | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.10.2.3 Update | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.10.2.4 Delete | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: The procedure of the Receiver written in the clause 7.2.2.2 (from Rcv-D-1.0 to Rcv-D-10.0) shall be the same as initial steps. A following step is the <locationPolicy> resource type specific procedure for DELETE operation. 1) Once the <locationPolicy> resource is deleted, the Receiver shall delete the associated resources (e.g. <container>, <contentInstance> resources). If the locationSource attribute and the locationUpdatePeriod attribute of the <locationPolicy> resource has been set with appropriate value, the Receiver shall tear down the session. The specific mechanism used to tear down the session depends on the support of the Underlying Network and other factors. 7.4.11 Resource Type <delivery> |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.11.1 Introduction | In order to be able to initiate and manage the execution of data delivery in a resource-based manner, resource type delivery is defined. This resource type shall be used for forwarding requests from one CSE to another CSE when the Delivery Aggregation parameter in the request is set to ON. The detailed description can be found in clause 9.6.11 in ETSI TS 118 101 [6]. Table 7.4.11.1-1: Data type definition of <delivery> resource Data Type ID File Name Note delivery CDT-delivery-v2_7_0.xsd ETSI ETSI TS 118 104 V2.7.1 (2016-10) 136 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.11.1-2: Universal/Common Attributes of <delivery> resource Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP expirationTime O O parentID NP NP creationTime NP NP lastModifiedTime NP NP accessControlPolicyI Ds O O labels O O stateTag NP NP dynamicAuthorization ConsultationIDs O O Table 7.4.11.1-3: Resource Specific Attributes of <delivery> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update source M NP m2m:ID No default target M NP m2m:ID No default lifespan M O m2m:timestamp No default eventCat M O m2m:eventCat No default deliveryMetaData M O m2m:deliveryMetaDat a No default aggregatedRequest O O m2m:aggregatedRequ est No default Table 7.4.11.1-4: Child resources of <delivery> resource Child Resource Type Child Resource Name Multiplicity Ref. to Resource Type Definition <subscription> variable 0..n Clause 7.4.8 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.11.2 <delivery> resource specific procedure on CRUD operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.11.2.0 Introduction | This clause describes <delivery> resource specific behaviour for CRUD operations. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.11.2.1 Create | Originator: An AE shall not originate a Create <delivery> resource request. Primitive specific operation on Orig-1.0 "Compose Request primitive": 1) The Originator shall use a blocking request (i.e. Response Type=blockingRequest). 2) The Originator shall provide the content of the <delivery> resource. No change for the remaining steps from the generic procedures in clause 7.2.2.1. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 137 oneM2M TS-0004 version 2.7.1 Release 2 Receiver: Primitive specific operation on Recv-1.0 "Check the syntax of received message": 1) If the request is received over Mca reference point, the Receiver CSE shall execute the following steps in order. a. "Create an unsuccessful Response primitive" with a Response Status Code indicating 'OPERATION_NOT_ALLOWED' error. b. "Send the Response primitive". 2) Otherwise, a. No change from the generic procedures in clause 7.2.2.2. NOTE: Determination of the reference point is to the discretion of the Receiver CSE implementation. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.11.2.2 Retrieve | Originator: Primitive specific operation on Orig-1.0 "Compose Request primitive": 1) The Originator shall use a blocking request (i.e. Response Type=blockingRequest). No change for the remaining steps from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. 7.4.11.2.3 Update Originator: An AE shall not originate a Create <delivery> resource request. Primitive specific operation on Orig-1.0 "Compose Request primitive": 1) The Originator shall use a blocking request (i.e. Response Type=blockingRequest). 2) The Originator shall provide the content of the <delivery> resource. No change for the remaining steps from the generic procedures in clause 7.2.2.1. Receiver: Primitive specific operation on Recv-1.0 "Check the syntax of received message": 1) If the request is received over Mca reference point, the Receiver CSE shall execute the following steps in order. a. "Create an unsuccessful Response primitive" with a Response Status Code indicating 'OPERATION_NOT_ALLOWED' error. b. "Send the Response primitive". 2) Otherwise, a. No change from the generic procedures in clause 7.1.2.2. NOTE: Determination of the reference point is to the discretion of the Receiver CSE implementation. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 138 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.11.2.4 Delete | Originator: An AE shall not originate a Create <delivery> resource request. Primitive specific operation on Org-1.0 "Compose Request primitive": 1) The Originator shall use a blocking request (i.e. Response Type=blockingRequest). No change for the remaining steps from the generic procedures in clause 7.2.2.1. Receiver: Primitive specific operation on Recv-1.0 "Check the syntax of received message": 1) If the request is received over Mca reference point, the Receiver CSE shall execute the following steps in order. a. "Create an unsuccessful Response primitive" with a Response Status Code indicating 'OPERATION_NOT_ALLOWED' error. b. "Send the Response primitive". 2) Otherwise, a. No change from the generic procedures in clause 7.2.2.2 NOTE: Determination of the reference point is to the discretion of the Receiver CSE implementation. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.12 Resource Type <request> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.12.1 Introduction | The <request> resource is used to represent information on locally issued requests (i.e. issued by an AE or CSE internal). This allows for robust synchronous and asynchronous request processing coping with various constraints on maximum blocking time. When an AE or CSE issues a request for targeting any other resource type or requesting a notification in non-blocking mode , i.e. the Response Type parameter of the request is set to either 'nonBlockingRequestSynch' or 'nonBlockingRequestAsynch', and if the Registrar CSE of the Originator supports the <request> resource type as indicated by the supportedResourceType attribute of the <CSEBase> resource representing the Registrar CSE of the Originator, the Registrar CSE of the Originator shall create an instance of <request> to capture and expose the context of the associated non-blocking request. The detailed description can be found in clause 9.6.12 in ETSI TS 118 101 [6]. Table 7.4.12.1-1: Data type definition of <request> resource Data Type ID File Name Note request CDT-request-v2_7_0.xsd ETSI ETSI TS 118 104 V2.7.1 (2016-10) 139 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.12.1-2: Universal/Common Attributes of <request> resource Attribute Name Request Optionality Create Update @resourceName NP NP resourceType NP NP resourceID NP NP expirationTime NP NP parentID NP NP creationTime NP NP lastModifiedTime NP NP accessControlPolicyI Ds NP NP labels NP NP stateTag NP NP dynamicAuthorization ConsultationIDs O O Table 7.4.12.1-3: Resource Specific Attributes of <request> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update operation NP NP m2m:operation No default target NP NP xs:anyURI No default originator NP NP m2m:ID No default requestID NP NP m2m:requestID No default metaInformation NP NP m2m:metaInformation No default primitiveContent NP NP m2m:primitiveContent No default requestStatus NP NP m2m:requestStatus No default operationResult NP NP m2m:operationResult No default Table 7.4.12.1-4 : Reference of child resources Child Resource Type Name Child Resource Name Multiplicity Ref. to in Resource Type Definition <subscription> [variable] 0..n Clause 7.4.8 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.12.2 <request> resource specific procedure on CRUD operations | 7.4.12.2.0 Introduction This clause describes request resource specific procedure on Resource Hosting CSE for CRUD operations. 7.4.12.2.1 Create Originator: The <request> resource shall not be created via API. See clause 7.3.2.2 Create <request> resource locally. Receiver: Primitive specific operation on Recv-1.0 "Check the syntax of received message": 1) "Create an unsuccessful Response primitive" with a Response Status Code indicating 'OPERATION_NOT_ALLOWED' error. 2) "Send the Response primitive". 7.4.12.2.2 Retrieve Originator: the procedure of the Originator is the same as the clause 7.2.2.1. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 140 oneM2M TS-0004 version 2.7.1 Release 2 Receiver: the procedure of the Receiver is the same as the clause 7.2.2.2. 7.4.12.2.3 Update Originator: The <request> resource shall not be updated via API. See clause 7.3.2.5 Update <request> resource. Receiver: Primitive specific operation on Recv-1.0 "Check the syntax of received message": 1) "Create an unsuccessful Response primitive" with a Response Status Code indicating 'OPERATION_NOT_ALLOWED' error. 2) "Send the Response primitive". 7.4.12.2.4 Delete Originator: the procedure of the Originator is the same as the clause 7.2.2.1 Receiver: the procedure of the Receiver is the same as the clause 7.2.2.2. 7.4.13 Resource Type <group> |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.13.1 Introduction | The <group> resource represents a group of resources of the same or mixed types. The <group> resource can be used to do bulk manipulations on the resources represented by the memberIDs attribute. The <group> resource contains an attribute that represents the members of the group and a virtual resource (the <fanOutPoint>) that allows operations to be applied to the resources represented by those members. The detailed description can be found in clause 9.6.13 in ETSI TS 118 101 [6]. Table 7.4.13.1-1: Data type definition of <group> resource Data Type ID File Name Note group CDT-group-v2_7_0.xsd Table 7.4.13.2-2: Universal/Common Attributes of <group> resource Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP parentID NP NP accessControlPolicyI Ds O O creationTime NP NP expirationTime O O lastModifiedTime NP NP labels O O announceTo O O announcedAttribute O O creator O NP dynamicAuthorization ConsultationIDs O O ETSI ETSI TS 118 104 V2.7.1 (2016-10) 141 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.13.2-3: Resource Specific Attributes of <group> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update memberType O NP m2m:memberType Default value is set to 'MIXED' currentNrOfMembers NP NP xs:nonNegativeInteger No default (This is generated by the Hosting CSE and limited by the maxNrOfMembers attribute of the <group> resource) maxNrOfMembers M O xs:positiveInteger No default memberIDs M O list of xs:anyURI No default This list may contain no members membersAccessCont rolPolicyIDs O O m2m:listOfURIs No default memberTypeValidate d NP NP xs:boolean No default (This is generated by the Hosting CSE) consistencyStrategy O NP m2m:consistencyStrateg y Default value is set to 'ABANDON_MEMBER' groupName O O xs:string No default Table 7.4.13.2-4: Child resources of <group> resource Child Resource Type Child Resource Name Multiplicity Ref. to in Resource Type Definition <subscription> [variable] 0..n Clause 7.4.8 <semanticDescriptor> [variable] 0..n Clause 7.4.34 <fanOutPoint> fanOutPoint 1 Clause 7.4.14 <semanticFanOutPoint> semanticFanOutPoint 0..1 Clause 7.4.35 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 142 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.13.2 <group> resource specific procedure on CRUD operations | 7.4.13.2.0 Introduction This clause describes <group> resource specific procedure on Resource Hosting CSE for CRUD operations. 7.4.13.2.1 Create Primitive specific operation after Recv-C-6.4 "Check validity of resource representation for the given resource type" and before Recv-C-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed". See clause 7.2.2.2. 1) Primitive specific operation: Validate the provided attributes. It shall also check whether the number of URIs present in the memberIDs attribute of the group resource representation does not exceed the maximum as specified by the maxNrOfMembers attribute. If the maximum is exceeded, the request shall be rejected with a Response Status Code indicating "MAX_NUMBER_OF_MEMBER_EXCEEDED" error. If there are duplicate members in the memberIDs attribute then the duplicate members are removed before creation of the <group> resource. If the memberType attribute of the <group> resource is not "MIXED", the Hosting CSE shall also verify that all the member IDs including sub-groups in the attribute memberIDs of the <group> resource representation provided in the request shall conform to the memberType of the group resource. To validate a resource type of a member, the Hosting CSE shall check the resourceType attribute of the resource which is indicated by the member ID. To check the resourceType attribute, the Hosting CSE may retrieve the member resource. When a member ID is virtual resource, the Hosting CSE shall check the resourceType attribute of the parent resource. If the resource type of the parent allows this child virtual resource type, the Hosting CSE checks whether the virtual resource type matches with the memberType attribute of the group. If they match, then the Hosting CSE considers that the virtual member resource is validated. 2) In the case that the <group> resource contains sub-group member resources, the receiver shall retrieve the memberType of the sub-group member resources to validate the memberType. If the memberType cannot be retrieved due to lack of privilege, the request shall be rejected with a Response Status Code indicating "RECEIVER_HAS_NO_PRIVILEGE" error. If the sub-group member resources are temporarily unreachable, the receiver shall set the memberTypeValidated attribute of the <group> resource to FALSE and return the result to the originator in the response of the request. As soon as any unreachable sub-group resource becomes reachable, the receiver shall perform the memberType validation procedure. The originator may get to know the validation result by subscribing to the created resource if the memberTypeValidated attribute is FALSE. Upon unsuccessful validation, the receiver shall delete the <group> resource if the consistencyStrategy of the <group> resource is ABANDON_GROUP, or remove the inconsistent members from the <group> resource if the consistencyStrategy attribute is ABANDON_MEMBER, or set the memberType attribute of the <group> resource to "MIXED" if the consistencyStrategy attribute is SET_MIXED. 3) The memberTypeValidated attribute shall be set to TRUE if all the members have been validated successfully. If a member validation for the memberType of the <group> resource is unsuccessful, then the Hosting CSE shall perform the following: a) If the consistencyStrategy of the <group> resource is ABANDON_GROUP then the request shall be rejected with a Response Status Code indicating "GROUP_MEMBER_TYPE_INCONSISTENT" error. 4) If the consistencyStrategy of the <group> resource is ABANDON_ MEMBER then remove the inconsistent members and create the <group> resource and the memberTypeValidated attribute shall be set to TRUE. 5) If the consistencyStrategy of the <group> resource is SET_ MIXED then set the memberType attribute of the <group> resource to "MIXED" and create the <group> resource and the memberTypeValidated attribute shall be set to TRUE. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.13.2.2 Retrieve | No primitive specific operations. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 143 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.13.2.3 Update | 1) Primitive specific operation after Recv-6.4 "Check validity of resource representation for the given resource type" and before Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed". See clause 7.2.2.2.Primitive specific operation: If the memberType attribute of the <group> resource is not "MIXED", the Hosting CSE shall verify that all the member IDs including sub-groups in the attribute memberIDs of the <group> resource representation provided in the request shall conform to the memberType of the <group> resource. Virtual member resource validation shall be done as specified in the group creation procedure (clause 7.4.13.2.1 step 1). 2) In the case that the <group> resource contains sub-group member resources, the receiver shall retrieve the memberType of the sub-group member resource to validate the memberType. If the memberType cannot be retrieved due to lack of privilege, the request shall be rejected with a Response Status Code indicating "RECEIVER_HAS_NO_PRIVILEGE" error. If the sub-group member resources are temporarily unreachable, the receiver shall set the memberTypeValidated attribute of the <group> resource to FALSE and return the result to the originator in the response of the request. As soon as any unreachable sub-group resource becomes reachable, the receiver shall perform the memberType validation procedure. The Originator may get to know the validation result by subscribing to the created resource if the memberTypeValidated attribute is FALSE. Upon unsuccessful validation, the receiver shall delete the <group> resource if the consistencyStrategy of the <group> resource is ABANDON_GROUP, or remove the inconsistent members from the <group> resource if the consistencyStrategy attribute is ABANDON_MEMBER, or set the memberType attribute of the <group> resource to "MIXED" if the consistencyStrategy attribute is SET_MIXED. 3) The memberTypeValidated attribute shall be set to TRUE if all the members have been validated successfully. If a member validation for the memberType of the <group> resource is unsuccessful, then the Hosting CSE shall perform the following: a) If the consistencyStrategy of the <group> resource is ABANDON_GROUP then the request shall be rejected with a Response Status Code indicating "GROUP_MEMBER_TYPE_INCONSISTENT" error. 4) If the consistencyStrategy of the <group> resource is ABANDON_ MEMBER then remove the inconsistent members and update the <group> resource and the memberTypeValidated attribute shall be set to TRUE. 5) If the consistencyStrategy of the <group> resource is SET_ MIXED then set the memberType attribute of the <group> resource to "MIXED" and update the <group> resource and the memberTypeValidated attribute shall be set to TRUE. 6) Primitive specific operation: The Hosting CSE shall check whether the number of provided memberIDs in the attribute members exceeds the limitation of maxNrOfMembers. The Hosting CSE shall also check whether the value provided in the maxNrOfMembers attribute is smaller than the currentNrOfMembers attribute value. If any of the condition is true, the Hosting CSE shall reject the request with Response Status Code indicating "MAX_NUMBER_OF_MEMBER_EXCEEDED". error. 7.4.13.2.4 Delete No primitive specific operations. 7.4.14 Resource Type <fanOutPoint> 7.4.14.1 Introduction The <fanOutPoint> resource is a virtual resource because it does not have a representation. It is the child resource of a <group> resource. Whenever the request is sent to the <fanOutPoint> resource, the request is fanned out to each of the members of the <group> resource indicated by the memberIDs attribute of the <group> resource. The responses (to the request) from each member are then aggregated and returned to the Originator. The detailed description can be found in clause 9.6.14 in ETSI TS 118 101 [6]. There are no common attributes, resource specific attributes or xsd file to <fanOutPoint> resource because it is a virtual resource. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 144 oneM2M TS-0004 version 2.7.1 Release 2 A <fanOutPoint> can be addressed in one of two ways: • Using the URI retrieved from its parent <group> resource; or • Using a hierarchical URI formed by taking the hierarchical URI of the parent <group> and appending the string /fanOutPoint to that URI. This hierarchical URI can be extended by appending further path elements beyond the place where /fanOutPoint/ occurs. A request sent to such a URI is not fanned out to the group members, but instead it is fanned out to the resources located by taking the hierarchical URI of each group member in turn and then appending the additional path elements to that URI. For example, if /IN-CSE-0001/myGroup were a group with members • /IN-CSE-0001/m1 and • /IN-CSE-0001/m2 then a request sent to /IN-CSE-0001/myGroup/fanOutPoint/x/y would be fanned out to • /IN-CSE-0001/m1/x/y and • /IN-CSE-0001/m2/x/y The additional path elements can reference virtual resources, for example if m1 and m2 were both <container> resources then a request sent to /IN-CSE-0001/myGroup/fanOutPoint/latest would be fanned out to the most recent <contentInstance> child resource of both m1 and m2. If the members m1 and m2 are themselves also <group> resources, a request sent to /IN-CSE- 0001/myGroup/fanOutPoint will be fanned out to all the members of m1 and all members of m2. 7.4.14.2 <fanOutPoint> operations 7.4.14.2.1 Validate the type of resource to be created If this is a CREATE request and the memberType attribute of the addressed parent group resource is not "MIXED", the group Hosting CSE may check whether the type of resource to be created is a valid and compatible child resource type of the group members. If they are not consistent, the request shall be rejected with a Response Status Code indicating "INVALID_CHILD_RESOURCE_TYPE" error. 7.4.14.2.2 Sub-group creation for members residing on the same CSE The group hosting CSE shall obtain URIs of addressed resources from the attribute memberIDs of the parent <group> resource. The group hosting CSE may determine that multiple member resources belong to the same remote member hosting CSE, and may perform as an Originator to request to create a sub-group containing the specific multiple member resources in that member hosting CSE. This sub-group is created in the member hosting CSE as described in clause 7.4.13.2.1. The To parameter of this group Create request shall be <memberHosting cseBase>/<groupHosting remoteCse>/ or <memberHosting cseBase>/. The group hosting CSE shall also provide From parameter (i.e. group hosting CSE) and sub-group resource representation that contains a memberIDs attribute with all the members residing on the addressed member Hosting CSE. The sub-group representation may include the attribute accessControlPolicyIDs, so that both the group hosting CSE and all permissions of the original group apply to this sub- group. The ID of the sub-group may be proposed by the group hosting CSE and accepted by the member hosting CSE or it may be given by the member hosting CSE. If there is already a sub-group resource defined in the remote member hosting CSE, then the group hosting CSE may utilize the existing sub-group resource. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 145 oneM2M TS-0004 version 2.7.1 Release 2 7.4.14.2.3 Assign URI for aggregation of notification If the request is to create a <subscription> resource, the group hosting CSE shall validate the request to check whether it contains a notificationForwardingURI attribute or not. If it does not, the group hosting CSE shall forward it to the group members. If it does, the group hosting CSE shall assign a new URI to the notificationURI attribute of the <subscription> in the requests before forwarding it to the group members. This new URI shall address the group hosting CSE so that it can receive and aggregate Notifications from those subscriptions. 7.4.14.2.4 Fanout Request to each member If the parent group has no members, the group hosting CSE shall reject the request with the Response Status Code indicating "NO_MEMBERS". Otherwise it shall perform the following steps for each member: a) The primitive parameters From and To shall be mapped to the primitive parameters of the corresponding Request to be sent out to each member of the group. The primitive parameter From shall be directly used. The prefix of primitive parameter To i.e. <URI of group resource>/fanOutPoint shall be replaced by hierarchical URIs derived from the attribute memberIDs of the group resource, but excluding the member resources which are sub-groups. For member resources that are sub-groups, the To parameter of the primitives shall be the resourceID of the fanOutPoint virtual resource of the sub-group resources. In addition, any additional relative address that was appended to .../fanOutPoint in the original Request shall be appended to each To URI. For those members resource contained in a sub-group, the primitive To of the composed Request shall be <URI of sub-group resource>/fanOutPoint plus any additional appended relative address including in the original Request. The group hosting CSE shall execute "Compose Request primitives". In addition, the group hosting CSE shall generate a unique group request identifier, add it as a primitive parameter to the Request and locally store the group request identifier as per the local policy. b) "Send the Request to the receiver CSE". c) "Wait for Response primitives". The procedures between group hosting CSE and member hosting CSEs shall comply with the corresponding creation procedures as described in clause 7. The detailed procedures are according to the type of Resource provided in the Request primitive. During fanOutPoint manipulation, the member hosting CSE receiving a Request send from the group hosting CSE shall check if the Request contains a Group Request Identifier parameter. If the Request contains a Group Request Identifier parameter, the member hosting CSE shall compare the Group Request Identifier parameter to the Group Request Identifier locally stored. If a match is found, the member hosting CSE shall reject the request with the Response Status Code indicating "GROUP_REQUEST_IDENTIFIER_EXISTS" error in the Response primitive. Otherwise, the member hosting CSE shall continue with the operations according to the Request and locally store the Group Request Identifier parameter. 7.4.14.2.5 Aggregation of member responses After receiving the member responses from the member hosting CSEs, the group hosting CSE shall respond to the Originator with an aggregated response. To indicate which response is generated by which member resource, the Hosting CSE shall add member resource ID, which is corresponding to the response, into From response parameter in each member response. If the group Hosting CSE gets no response before the Result Expiration Timestamp expiry, then the Hosting CSE shall return error with the Response Status Code parameter set as "GROUP_MEMBERS_NOT_RESPONDED". If Response Type, Result Expiration Time or Result Persistence were set in the request, these affect the behaviour of the group hosting CSE as follows: If Response Type is set to blockingRequest, the group hosting CSE shall respond only once with the aggregated response. It shall do this before the time indicated by the Result Expiration Time is reached. The group hosting CSE shall discard any member responses received after this time. If Response Type is set to nonBlockingRequestSynch, the group hosting CSE shall create a <request> resource locally and respond the Originator with the address of this <request> resource. Until the Result Expirtation Time is reached, the group hosting CSE shall aggregate the member responses and include this aggregated response in the operationResult of the <request> resource. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 146 oneM2M TS-0004 version 2.7.1 Release 2 If Response Type is set to nonBlockingRequestAsynch, the group hosting CSE shall notify the Originator or the notification targets with aggregated responses before the Result Expiration Time expires. The group hosting CSE may notify the Originator more than once during the period until the Result Expiration Time expires. Each notification shall contain different member responses. If Response Type is set to flexBlocking, the group hosting CSE shall keep aggregating the member responses until the group hosting CSE determines that it is time to send a response – this depends on the properties of the group hosting CSE related to the <group> resource (the number of aggregated responses or the time period of the aggregation). By that time, if the aggregated response contains all the member responses, the group hosting CSE shall respond with the aggregated response. However if only some of the member responses have been received , the group hosting CSE shall create a <request> resource from the received request, and respond to the Originator with the reference to the created <request> resource as well as the currently aggregated responses. Until the time specified in Result Expiration Time is reached, the group hosting CSE shall keep aggregating the remaining member responses and updating the aggregated response in the operationResult of the <request> resource. If notificationTarget is provided in the request, the group hosting CSE shall notify the Originator with the aggregated response. Each notification shall contain different member responses. If the group hosting CSE supports <request> resource, in the nonBlockingRequestAsynch, nonBlockingSynch and flexBlocking case, it shall set the requestStatus of the <request> resource to PARTIALLY_COMPLETED if some of the member responses are received. If the group hosting CSE has aggregated all the member responses, it shall set the operationResult to COMPLETED. In any of the cases above, member responses received after the Result Expiration Time shall be discarded. After the time specified in Result Persistence, the aggregated response shall not be retrievable. If any of the parameter mentioned above are missing from the request, the group hosting CSE shall determine the time to respond using its local Policy. 7.4.14.3 <fanOutPoint> resource specific procedure on CRUD operations 7.4.14.3.1 Introduction This sub-clause describes <fanOutPoint> resource specific behaviour for CRUD operations. 7.4.14.3.2 Create A Create operation sent to a <fanOutPoint> is fanned out to the members (if any) of the parent <group>. It is equivalent to sending a Create to each member and therefore results in new resources being created as children of these existing members. If the Create is sent to a hierarchical URI containing a fanOutPoint and an additional path relative to that fanOutPoint then the new resources are not created as immediate children of the members, rather they are created as children of descendents of those members (as determined by the relative path). Originator: Primitive specific operation after Orig-1.0 "Compose Request primitive" and before Orig-2.0 "Send the Request to the receiver CSE": In the case the Originator wants to subscribe to all the member resources of the group and the originator wants the group hosting CSE to aggregate all the notifications come from its member hosting CSEs, the Originator shall include notificationForwardingURI attribute in the <subscription> resource. Receiver: Primitive specific operation after Recv-6.2 "Check existence of the addressed resource" and before Recv-6.3 "Check authorization of the Originator". Primitive specific operation additional to Recv-6.3 "Check authorization of the Originator": The Group Hosting CSE shall check the authorization of the Originator based on the membersAccessControlPolicyIDs of the parent <group> resource. In the case the membersAccessControlPolicyIDs is not provided, the accessControlPolicyIDs of the parent <group> resource shall be used. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 147 oneM2M TS-0004 version 2.7.1 Release 2 Primitive specific operation to replace Recv-6.5"Create/Update/Retrieve/Delete/Notify operation is performed" and Recv-6.6"Announce/De-announce the resource" in the generic procedure: 1) Validate the type of resource to be created, refer to clause 7.4.14.2.1. 2) Sub-group creation for members residing on the same CSE, refer to clause 7.4.14.2.2. 3) Assign URI for aggregation of notification, refer to clause 7.4.14.2.3. 4) Fanout Request to each member, refer to clause 7.4.14.2.4. 5) Aggregation of member responses, refer to clause 7.4.14.2.5. 7.4.14.3.3 Retrieve Originator: No primitive specific operations. Receiver: Primitive specific operation after Recv-6.2 "Check existence of the addressed resource" and before Recv-6.3 "Check authorization of the Originator". Primitive specific operation additional to Recv-6.3 "Check authorization of the Originator": The Group Hosting CSE shall check the authorization of the Originator based on the membersAccessControlPolicyIDs of the parent group resource. In the case the membersAccessControlPolicyIDs is not provided, the accessControlPolicyIDs of the parent group resource shall be used. Primitive specific operation to replace Recv-6.5"Create/Update/Retrieve/Delete/Notify operation is performed" and Recv-6.6 "Announce/De-announce the resource" in the generic procedure: 1) Sub-group creation for members residing on the same CSE, refer to 7.4.14.2.2. 2) Fanout Request to each member, refer to 7.4.14.2.4. 3) Aggregation of member responses, refer to clause 7.4.14.2.5. 7.4.14.3.4 Update Originator: No primitive specific operations. Receiver: Primitive specific operation after Recv-6.2 "Check existence of the addressed resource" and before Recv-6.3 "Check authorization of the Originator". Primitive specific operation additional to Recv-6.3 "Check authorization of the Originator": The Group Hosting CSE shall check the authorization of the Originator based on the membersAccessControlPolicyIDs of the parent group resource. In the case the membersAccessControlPolicyIDs is not provided, the accessControlPolicyIDs of the parent group resource shall be used. Primitive specific operation to replace Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed" and Recv-6.6"Announce/De-announce the resource" in the generic procedure: 1) Sub-group creation for members residing on the same CSE , refer to 7.4.14.2.2. 2) Fanout Request to each member. See Clause 7.4.14.2.4. 3) Aggregation of member responses, refer to clause 7.4.14.2.5. 7.4.14.3.5 Delete The primitive deletes the member resources and their child resources belonging to an existing <group> resource. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 148 oneM2M TS-0004 version 2.7.1 Release 2 Originator: No primitive specific operations. Receiver: Primitive specific operation after Recv-6.2 "Check existence of the addressed resource" and Recv-6.3 "Check authorization of the Originator": The To parameter consists of the URI of the group resource plus a suffix consisting of /fanOutPoint or /fanOutPoint/plus any additional appended relative address. Primitive specific operation additional to Recv-6.3 "Check authorization of the Originator": The Group Hosting CSE shall check the authorization of the Originator based on the membersAccessControlPolicyIDs of the parent group resource. In the case the membersAccessControlPolicyIDs is not provided, the accessControlPolicyIDs of the parent group resource shall be used. Primitive specific operation to replace Recv-6.5"Create/Update/Retrieve/Delete/Notify operation is performed" and Recv-6.6"Announce/De-announce the resource" in the generic procedure: 1) Sub-group creation for members residing on the same CSE , refer to 7.4.14.2.2 2) Fanout Request to each member. See Clause 7.4.14.2.4 3) Aggregation of member responses, refer to clause 7.4.14.2.5. 4) A Delete operation targeting a <fanOutPoint> does not remove members from the parent <group>. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.15 Resource Type <mgmtObj> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.15.1 Introduction | The <mgmtObj> resource contains management data which represents individual M2M management functions. It represents a general structure to map to technology specific data models. There are multiple specializations of <mgmtObj>; these are defined in annex D. Each of these specializations has its own schema file. There is no separate schema file just for <mgmtObj>, however the XML schema types for the specializations all conform to the pattern described in this clause. Table 7.4.15.1-1: Universal/Common Attributes of <mgmtObj> resource Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP parentID NP NP accessControlPolicyI Ds O O creationTime NP NP expirationTime O O lastModifiedTime NP NP labels O O dynamicAuthorization ConsultationIDs O O Table 7.4.15.1-2: Resource Specific Attributes of <mgmtObj> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition O NP m2m:mgmtDefinition No default objectIDs O NP list of xs:anyURI No default objectPaths O NP list of xs:anyURI No default description O O xs:string No default mgmtLink O O m2m:mgmtLinkRef No default ETSI ETSI TS 118 104 V2.7.1 (2016-10) 149 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.15.1-3: Child resources of <mgmtObj> resource Child Resource Type Child Resource Name Multiplicity Ref. to Resource Type Definition <subscription> [variable] 0..n Clause 7.4.8 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.15.2 <mgmtObj> resource specific procedure on CRUD operations | 7.4.15.2.1 Introduction This clause describes <mgmtObj> resource specific procedure on resource Hosting CSE for CRUD operations. The procedures are defined for management when technology specific protocols are used. When service layer management is performed, generic procedures defined in clause 7.2.2 shall comply for resource creation, update, retrieval and deletion. Procedures additional to resource manipulations to perform the management are further defined in annex D. 7.4.15.2.2 Create Primitive specific operation before Orig-C-1.0 "Compose Request primitive": 1) Primitive specific operation: If the originator is the managed entity, it shall generate the <mgmtObj> resource representation based on the technology specific data model object of the managed entity to be exposed. The objectIDs and objectPaths attributes may be set with the Request. Primitive specific operation after Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed" and before Recv-6.6 "Announce/De-announce the resource" if the originator is an IN-AE: 2) "Identify the managed entity and the technology specific protocol". Primitive specific operation: the receiver shall generate the technology specific data model object to be added to the managed entity based on the <mgmtObj> resource representation provided in the Request primitive. The receiver may determine the target location on the managed entity where the generated technology specific data model object shall be added based on the objectIDs and objectPaths provided in the request primitive and the technology specific data model being used. The receiver may also choose to let the managed entity decide the target location where the generated technology specific data model object shall be added using technology specific mechanism. 3) "Establish a management session with the managed entity". 4) "Send the management request(s) to the managed entity corresponding to the received Request primitive". If the receiver receives an error response from the managed entity because the technology specific data model object to be added already exists on the managed entity, the receiver shall check (by using e.g. OMA-DM Get command or TR069 GetParameterValues/GetParameterAttributes command) if the existing technology specific data model object is the same as the one to be added, then it shall consider the requested primitive as successfully performed instead of sending an error response primitive; otherwise, it shall reject the request with the Response Status Code indicating "ALREADY_EXISTS" error in the Response primitive. The receiver shall also record the location where the technology specific data model object is added to the managed entity in the successful case. The objectIDs and objectPaths attributes may be set with the Request. 5) The receiver may repeat Step 4 in order to add to the managed entity the technology specific data model objects that are mapped from the mandatory sub-resources (including any descendants) that are required to be created automatically with the default attribute values. 7.4.15.2.3 Retrieve Primitive specific operation after Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed" and before Recv-6.6 "Announce/De-announce the resource" if the originator is an IN-AE: 1) "Identify the managed entity and the technology specific protocol". 2) "Locate the technology specific data model objects to be managed on the managed entity". ETSI ETSI TS 118 104 V2.7.1 (2016-10) 150 oneM2M TS-0004 version 2.7.1 Release 2 3) "Establish a management session with the managed entity". 4) "Send the management request(s) to the managed entity corresponding to the received Request primitive". The receiver may also update the <mgmtObj> resource representation with the retrieved technology specific data model object if required according to the local policy. 7.4.15.2.4 Update The Update primitive is used for the update of the resource as well as the execution of a management procedure. The execution is performed using an Update primitive which without any content as the payload part of the primitive by addressing specific attribute to start the management procedure. Primitive specific operation after Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed" and before Recv-6.6 "Announce/De-announce the resource" if the originator is IN-AE. 1) "Identify the managed entity and the technology specific protocol". 2) "Locate the technology specific data model objects to be managed on the managed entity". 3) "Establish a management session with the managed entity". 4) "Send the management request(s) to the managed entity corresponding to the received Request primitive". The receiver may also update the <mgmtObj> resource representation with the retrieved technology specific data model object information if required according to the local policy. 7.4.15.2.5 Delete Primitive specific operation after Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed" and before Recv-6.6 "Announce/De-announce the resource" if the originator is IN-AE. 1) "Identify the managed entity and the technology specific protocol". 2) "Locate the technology specific data model objects to be managed on the managed entity". 3) "Establish a management session with the managed entity". 4) "Send the management request(s) to the managed entity corresponding to the received Request primitive". The receiver may also update the <mgmtObj> resource representation with the retrieved technology specific data model object if required according to the local policy. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.16 Resource Type <mgmtCmd> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.16.1 Introduction | The <mgmtCmd> resource represents a method to execute management procedures or to model commands and remote procedure calls (RPC) required by existing management protocols and enables AEs to request management procedures to be executed on a remote entity. The detailed description can be found in clause 9.6.16 in ETSI TS 118 101 Architecture TS [6]. Table 7.4.16.1-1: Data type definition of <mgmtCmd> resource Data Type ID File Name Note mgmtCmd CDT-mgmtCmd-v2_7_0.xsd ETSI ETSI TS 118 104 V2.7.1 (2016-10) 151 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.16.1-2: Universal/Common Attributes of <mgmtCmd> resource Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP parentID NP NP accessControlPolicyI Ds O O creationTime NP NP expirationTime O O lastModifiedTime NP NP labels O O dynamicAuthorization ConsultationIDs O O ETSI ETSI TS 118 104 V2.7.1 (2016-10) 152 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.16.1-3: Resource Specific Attributes of <mgmtCmd> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update description O O xs:string size: 256 No default cmdType M O m2m:cmdType RESET, REBOOT, UPLOAD, DOWNLOAD, SOFTWAREINSTALL, SOFTWAREUPDATE, SOFTWAREUNINSTA LL No default execReqArgs O O m2m:execReqArgsListT ype A list of entries which are dependent on cmdType: If cmdType=RESET, execReqArgsList=rese tArgsType. If cmdType=REBOOT, execReqArgsList=rebo otArgsType. If cmdType=UPLOAD, execReqArgsList=uplo adArgsType. If cmdType=DOWNLOA D, execReqArgsList=dow nloadArgsType. If cmdType=SOFTWAR EINSTALL, execReqArgsList=soft wareInstallArgsType. If cmdType=SOFTWAR EUPDATE, execReqArgsList=soft wareUpdateArgsType. If cmdType= SOFTWAREUNINSTAL L, execReqArgsList=softw areUninstallArgsType. No default execEnable O O xs:boolean No default execTarget M O m2m:nodeID No default execMode M O m2m:execModeType IMMEDIATEONCE, IMMEDIATEREPEAT, RANDOMONCE, RANDOMREPEAT Default=IMMEDIATEO NCE execFrequency O O xs:duration No default execDelay O O xs:duration Default=0 execNumber O O xs:nonNegativeInteger Default=1 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 153 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.16.1-4: Child resources of <mgmtCmd> resource Child Resource Type Child Resource Name Multiplicity Ref. to Resource Type Definition <subscription> [variable] 0..n clause 7.4.8 <execInstance> [variable] 0..n clause 7.4.17 The <mgmtCmd> shall be executed for the following modes: • If execMode is IMMEDIATEONCE, <mgmtCmd> shall be executed immediately and only once. In this mode, execFrequency, execDelay, and execNumber shall not be used. • If execMode is IMMEDIATEREPEAT, <mgmtCmd> shall be executed immediately and repeated multiple times as determined by execNumber and the time interval between each execution is specified by execFrequency. In this mode, execDelay shall not be used. • If execMode is RANDOMONCE, <mgmtCmd> shall be executed only once at a delayed time which is specified by execDelay. In this mode, execFrequency and execNumber shall not be used. • If execMode is RANDOMREPEAT, <mgmtCmd> shall be executed multiple times as specified by execNumber but the first execution shall be executed at a delayed time. execDelay specifies the delayed time. The time interval between each execution is specified by execFrequency. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.16.2 <mgmtCmd> resource specific procedure on CRUD oerations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.16.2.0 Introduction | This clause describes <mgmtCmd> resource specific procedures for CRUD operations. 7.4.16.2.1 Create This procedure shall use the Create common operations detailed in clause 7.2.2.1 without primitive specific actions. The Originator shall use the steps Orig-C-1.0, Orig-C-2.0, and Orig-C-3.0 as described in clause 7.2.2.1. The Receiver shall use the steps Rcv-C-1.0 to Rcv-C-11.0 as described in clause 7.2.2.1. The Originator shall provide the <mgmtCmd> resource representation to the Receiver (e.g. IN-CSE). The Receiver may generate one of the following status codes and send it to the Originator. If the Originator provides an invalid cmdType value in the Create primitive, the Receiver shall generate a Response Status Code indicating "INVALID_CMDTYPE" error. If the name/value entry in execReqArgs does not match the value of cmdType in the Create primitive, the Receiver shall generate a Response Status Code indicating "INVALID_ARGUMENTS" error. If the name/value entries in execReqArgs do not contain mandatory arguments as required by cmdType, the Receiver shall generate a Response Status Code indicating "INSUFFICIENT_ARGUMENTS" error. 7.4.16.2.2 Retrieve This procedure shall use the Retrieve common operations detailed in clause 7.3 without primitive specific actions. The Originator shall use the steps Orig-R-1.0, Orig-R-2.0, and Orig-R-3.0 as described in clause 7.3. The Receiver shall use the steps Rcv-R-1.0 to Rcv-R-9.0 as described in clause 7.3. 7.4.16.2.3 Update 7.4.16.2.3.1 Update (Normal) If the Update primitive does not address the execEnable attribute of the <mgmtCmd>, it results in update of all or part of the information of an existing <mgmtCmd> resource with the new attribute values. The procedure uses the common Update operations detailed in clause 7.3, without primitive specific actions. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 154 oneM2M TS-0004 version 2.7.1 Release 2 The Originator shall use the steps Orig-U-1.0, Orig-U-2.0, and Orig-U-3.0 as described in clause 7.3. The Receiver shall use the steps Rcv-U-1.0 to Rcv-U-11.0 as described in clause 7.3. If the Originator attempts to update attributes resourceType, resourceID or cmdType, the Receiver shall generate a Response Status Code indicating "BAD_REQUEST" error. If the Originator attempts to update attributes execTarget, execMode, but the <mgmtCmd> has child resource <execInstance> already created, the Receiver shall generate a Response Status Code indicating "CONTENTS_UNACCEPTABLE" error. If the Originator attempts to update attributes any attribute with a value which is not allowed, the Receiver shall generate a Response Status Code indicating "CONTENTS_UNACCEPTABLE" error. If the Update primitive for <mgmtCmd> does address the execEnable attribute of the <mgmtCmd>, it effectively triggers an Execute <mgmtCmd> procedure, see clause 7.4.16.2.3.2. 7.4.16.2.3.2 Update (Execute) The execute operation is triggered by an Update primitive, if the primitive addresses the execEnable attribute of the <mgmtCmd>. The procedure uses the Update common operations detailed in clause 7.3 with the following primitive specific operation after Rcv-U-4.0 and before Rcv-U-5.0: 1) The Receiver shall identify the managed entity and the management protocol. The execTarget attribute of <mgmtCmd> indicates the managed entity. The Receiver shall automatically create an <execInstance> based on the <mgmtCmd> resource. If the execTarget attribute addresses a <group> resource, the Receiver shall create multiple <execInstance> sub-resources based on the value of currentNrOfMembers attribute. The Receiver shall copy the following attributes from <mgmtCmd> to each <execInstance> created: execMode, execFrequency, execDelay, execNumber, and execReqArgs. The execStatus of <execInstance> is set as INITIATED. The Receiver shall set the execTarget attribute of each <execInstance> sub-resource to the URI of each target <node> resource. The Receiver shall determine if the <mgmtCmd> shall be executed immediately or postponed according to the combination of execMode, execFrequency, execDelay, and execNumber. If the <mgmtCmd> shall be executed immediately (e.g. execMode is IMMEDIATEONCE), the following steps shall be performed; otherwise the following steps shall be postponed and skipped until the delay is expired (e.g. as indicated by execDelay). The Receiver shall establish a management session with the identified managed entity. The Receiver shall perform management command conversion and execution and set the execStatus attribute of <execInstance> to PENDING. If the Receiver cannot perform the command conversion successfully (e.g. execReqArgs does not have sufficient name/value pairs), the Receiver shall generate a Response Status Code indicating "MGMT_CONVERSION_ERROR" error. After receiving completion response from the managed entity, the Receiver shall set execStatus attribute of corresponding <execInstance> to FINISHED. If the Update primitive for <mgmtCmd> does not address the execEnable attribute of the <mgmtCmd>, it effectively triggers an Update <mgmtCmd> procedure, see clause 7.4.16.2.3. 7.4.16.2.4 Delete This procedure is based on the Delete common operations detailed in clause 7.3. The Receiver shall determine: • If there are related management operations pending on the managed entity by checking if the execStatus attribute of all <execInstance> sub-resources are PENDING. • If the related management operations are cancellable by checking the cmdType attribute of <mgmtCmd>. If there are no management commands pending on the remote entity the Receiver shall delete the addressed <mgmtCmd> resource and send a success response to the Originator. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 155 oneM2M TS-0004 version 2.7.1 Release 2 If there are cancellable management commands still pending on any remote entity, the Receiver shall perform the following steps: 1) The Receiver shall identify the managed entity and the management protocol. The execTarget attribute of each <execInstance> sub-resource which has execStatus of PENDING indicates the managed entity. 2) The Receiver shall establish a management session with each managed entity. 3) The Receiver shall perform management command conversion and execution resulting in cancellation of the commands which are pending on the managed entity. 4) For each successful cancellation RPC the execStatus attribute of the corresponding <execInstance> is set to CANCELLED. For each un-successful cancellation RPCs the execStatus attribute of the corresponding <execInstance> is determined from the reported fault codes for the unsuccessful RPCs. 5) Upon completion of all the cancellation operations, if any fault codes are returned by the managed entity, an error response to the Delete primitive with a Response Status Code indicating "CANCELLATION_FAILED" error is returned, and the <mgmtCmd> resource is not deleted. If all cancellation operations are successful on the managed entity, a success response to the Delete primitive is returned and the <mgmtCmd> resource is deleted. If there are non-cancellable management commands still pending on the remote entity, the Receiver shall send an error response to the Delete request to the Originator, with a Response Status Code indicating "MGMT_COMMAND_NOT_CANCELLABLE" error. The execStatus attribute of the specific <execInstance> sub- resource is changed to STATUS_NON_CANCELLABLE. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.17 Resource Type <execInstance> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.17.1 Introduction | The <execInstance> resource shall contain the following child resource and attributes. Table 7.4.17.1-1: Data type definition of <execInstance> resource Data Type ID File Name Note execInstance CDT-execInstance-v2_7_0.xsd Table 7.4.17.1-2: Universal/Common Attributes of <execInstance> resource Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP parentID NP NP accessControlPolicyI Ds O O creationTime NP NP expirationTime O O lastModifiedTime NP NP labels O O ETSI ETSI TS 118 104 V2.7.1 (2016-10) 156 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.17.1-3: Resource Specific Attributes of <execInstance> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update execStatus NP O m2m:execStatusType INITIATED, PENDING, FINISHED, CANCELLING, CANCELLED STATUS_NON_CANC ELLABLEL Default=INITIATED execResult NP O xs:execResultType No default execDisable NP O xs:boolean No default execTarget O O m2m:nodeID No default execMode O O m2m:execModeType IMMEDIATEONCE, IMMEDIATEREPEAT, RANDOMONCE, RANDOMREPEAT Default=IMMEDIATEO NCE execFrequency O O xs:duration No default execDelay O O xs:duration Default=0 execNumber O O xs:nonNegativeInteger Default=1 execReqArgs O O m2m:execReqArgsListT ype No default Table 7.4.17.1-4: Child Resources of <execInstance> resource Child Resource Type Child Resource Name Multiplicity Ref. to Resource Type Definition <subscription> [variable] 0..n Clause 7.4.8 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.17.2 <execInstance> resource specific procedure on CRUD oerations | 7.4.17.2.0 Introduction This clause describes <execInstance> resource specific procedures for CRUD operations. 7.4.17.2.1 Update (Cancel) The <execInstance> Cancel operation is triggered by an Update primitive, if the primitive addresses the execDisable attribute. The procedure is based on Update common operations detailed in clause 7.3. The Receiver shall determine: • If there are related management operations pending on the managed entity by checking the execStatus attribute of the addressed <execInstance> sub-resource is PENDING. • If the related management operations are cancellable by checking the cmdType attribute of the parent <mgmtCmd> resource. If there are no management commands still pending on the remote entity, an error response to the Update primitive with a Response Status Code indicating "ALREADY_COMPLETE" error is returned to the Originator. If there are cancellable management commands still pending on the remote entity, the Receiver shall perform the following steps: 1) The Receiver shall identify the managed entity and the management protocol. The execTarget attribute of the addressed <execInstance> indicates the managed entity. 2) The Receiver shall establish a management session with the managed entity. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 157 oneM2M TS-0004 version 2.7.1 Release 2 3) The Receiver shall perform management command conversion and execution resulting in cancellation of the commands which are pending on the managed entity. 4) If the cancellation is successfully executed on the managed entity, the Receiver shall return a success response to the Originator and shall set execStatus of <execInstance> to CANCELLED. 5) If the cancellation is unsuccessful on the managed entity, the Receiver shall return an error response to the Originator with a Response Status Code indicating "CANCELLATION_FAILED" error. The execStatus attribute is determined from the fault codes reported by the managed entity. If there are non-cancellable management commands still pending on the remote entity, the Receiver shall return an error response to the Originator with a Response Status Code indicating "NOT_CANCELLABLE_COMMAND" error, and the execStatus attribute is changed to STATUS_NON_CANCELLABLE. 7.4.17.2.2 Retrieve This procedure shall use the Retrieve common operations detailed in clause 7.3, without primitive specific actions. The Originator shall use the steps Orig-R-1.0, Orig-R-2.0, and Orig-R-3.0 as described in clause 7.2.2.1. The Receiver shall use the steps Rcv-R-1.0 to Rcv-R-9.0 as described in clause 7.3. 7.4.17.2.3 Delete This procedure is based on the Delete common operations detailed in clause 7.3. The Receiver shall determine: • If there are related management operations pending on the managed entity by checking the execStatus attribute of the addressed <execInstance> sub-resource is PENDING. • If the related management operations are cancellable by checking the cmdType attribute of the parent <mgmtCmd> resource. If there are no management commands still pending on the remote entity, the Receiver shall delete the addressed resource and send a success response to the Originator. If there are cancellable management commands still pending on the remote entity, the Receiver shall perform the following steps: 1) The Receiver shall identify the managed entity and the management protocol. The execTarget attribute of the addressed <execInstance> indicates the managed entity. 2) The Receiver shall establish a management session with the managed entity. 3) The Receiver shall perform management command conversion and execution resulting in cancellation of the commands which are pending on the managed entity. 4) If the cancellation is successfully executed on the managed entity, the Receiver shall return a success response to the Delete request to the Originator and shall delete the <execInstance> resource. 5) If the cancellation is unsuccessful on the managed entity, the Receiver shall return an error response to the Delete request to the Originator with a Response Status Code indicating "CANCELLATION_FAILED" error. The execStatus attribute is determined from the fault codes reported by the managed entity. If there are non-cancellable management commands still pending on the remote entity, the Receiver shall return an error response to the Delete request to the Originator with a Response Status Code indicating "NOT_CANCELLABLE_COMMAND". The execStatus attribute is set to STATUS_NOT_CANCELLABLE. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 158 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.18 Resource Type <node> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.18.1 Introduction | The <node> resource represents specific information that provides properties of an oneM2M Node that can be utilized by other oneM2M operations. The <node> resource has <mgmtObj> as its child resources. Table 7.4.18.1-1: Data type definition of <node> resource Data Type ID File Name Note node CDT-node-v2_7_0.xsd Table 7.4.18.1-2: Universal/Common Attributes of <node> resource Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP parentID NP NP accessControlPolicyI Ds O O creationTime NP NP expirationTime O O lastModifiedTime NP NP labels O O dynamicAuthorization ConsultationIDs O O Table 7.4.18.1-3: Resource Specific Attributes of <node> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update nodeID M O m2m:nodeID hostedCSELink O NP m2m:ID Table 7.4.18.1-4: Child resources of <node> resource Child Resource Type Child Resource Name Multiplicity Ref. to Resource Type Definition <mgmtObj> [variable] 0..n Clasue 7.4.15, See annex D <subscription> [variable] 0..n Clause 7.4.8 <semanticDescriptor> [variable] 0..n Clause 7.4.34 <trafficPattern> [variable] 0..n Clause 7.4.42 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.18.2 <node> resource specific procedure on CRUD operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.18.2.1 Create | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 159 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.18.2.2 Retrieve | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.18.2.3 Update | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.18.2.4 Delete | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.19 Resource Type <m2mServiceSubscriptionProfile> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.19.1 Introduction | The <m2mServiceSubscriptionProfile> resource represents an M2M Service Subscription Profile. It is used to represent all data pertaining to the M2M Service Subscription Profile, i.e. the technical part of the contract between an M2M Application Service Provider and an M2M Service Provider. The detailed description can be found in clause 9.6.19 in ETSI TS 118 101 [6]. Table 7.4.19.1-1: Data type definition of <m2mServiceSubscriptionProfile> resource Data Type ID File Name Note m2mServiceSubscription Profile CDT-m2mServiceSubscriptionProfile-v2_7_0.xsd Table 7.4.19.1-2: Universal/Common Attributes of <m2mServiceSubscriptionProfile> Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP parentID NP NP expirationTime O O accessControlPolicyI Ds O O creationTime NP NP labels O O lastModifiedTime NP NP dynamicAuthorization ConsultationIDs O O ETSI ETSI TS 118 104 V2.7.1 (2016-10) 160 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.19.1-3: Resource Specific Attributes of <m2mServiceSubscriptionProfile> Attribute Name Request Optionality Data Type Default Value and Constraints Create Update serviceRoles O O m2m:serviceRoles Table 7.4.19.1-4: Child resources of <m2mServiceSubscriptionProfile> Child Resource Type Child Resource Name Multiplicity Ref. to Resource Type Definition <subscription> [variable] 0..n Clause 7.4.8 <serviceSubscribedNode > [variable] 0..n Clause 7.4.20 7.4.19.2 <m2mServiceSubscriptionProfile> resource specific procedure on CRUD operations |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.19.2.0 Introduction | This clause describes <m2mServiceSubscriptionProfile> resource specific behaviour for CRUD operations. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.19.2.1 Create | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.19.2.2 Retrieve | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.19.2.3 Update | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.19.2.4 Delete | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 161 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.20 Resource Type <serviceSubscribedNode> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.20.1 Introduction | The <serviceSubscribedNode> resource represents M2M Node information that is needed as part of the M2M Service Subscription resource. It shall contain information about the M2M Node as well as application identifiers of the Applications running on that Node. The detailed description can be found in clause 9.6.20 in ETSI TS 118 101 [6]. Table 7.4.20.1-1: Data type definition of <serviceSubscribedNode> resource Data Type ID File Name Note serviceSubscribedNode CDT-serviceSubscribedNode-v2_7_0.xsd Table 7.4.20.1-2: Universal/Common Attributes of <serviceSubscribedNode> resource Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP parentID NP NP expirationTime O O accessControlPolicyI Ds O O creationTime NP NP labels O O lastModifiedTime NP NP Table 7.4.20.1-3: Resource Specific Attributes of <serviceSubscribedNode> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update nodeID M NP m2m:nodeID CSE-ID O NP m2m:ID deviceIdentifier O NP list of m2m:deviceID ruleLinks O O list of xs:anyURI Table 7.4.20.1-4: Child resources of <serviceSubscribedNode> resource Child Resource Type Child Resource Name Multiplicity Ref. to Resource Type Definition <subscription> [variable] 0..n 7.4.8 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.20.2 <serviceSubscribedNode> resource specific procedure on CRUD operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.20.2.0 Introduction | This clause describes <serviceSubscribedNode> resource specific behaviour for CRUD operations. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.20.2.1 Create | Originator: No change from the generic procedures in clause 7.2.2.1. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 162 oneM2M TS-0004 version 2.7.1 Release 2 Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.20.2.2 Retrieve | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.20.2.3 Update | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.20.2.4 Delete | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.21 Resource Type <pollingChannel> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.21.1 Introduction | The <pollingChannel> resource is used to perform service layer long polling when an AE/CSE cannot receive a request from other entities, however it can get a request as a response to a long polling request. Actual long polling can be performed on the <pollingChannelURI> resource which is the child resource of the <pollingChannel> resource. The detailed description can be found in clause 9.6.21 in ETSI TS 118 101 [6]. Table 7.4.21.1-1: Data type definition of <pollingChannel> resource Data Type ID File Name Note pollingChannel CDT-pollingChannel-v2_7_0.xsd Table 7.4.21.1-2: Universal/Common Attributes of <pollingChannel> resource Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP parentID NP NP creationTime NP NP lastModifiedTime NP NP expirationTime O O labels O O ETSI ETSI TS 118 104 V2.7.1 (2016-10) 163 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.21.1-3: Child resources of <pollingChannel> resource Child Resource Type Name Multiplicity Ref. to Resource Type Definition <pollingChannelURI> pollingChannelURI 1 Clause 7.4.22 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.21.2 <pollingChannel> resource specific procedure on CRUD operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.21.2.0 Introduction | This clause describes <pollingChannel> resource specific behaviour for CRUD operations. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.21.2.1 Create | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Same as the generic procedures in clause 7.2.2.2 except one addition: • After Recv-6.3 procedure, the Hosting CSE shall check if the Originator ID is the same as the AE-ID or CSE- ID of the target <AE> resource or <remoteCSE> resource, respectively. If the check is failed, then the Hosting CSE shall return response primitive with a Response Status Code indicating "ORIGINATOR_HAS_NO_PRIVILEGE" error. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.21.2.2 Retrieve | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Same as the generic procedures in clause 7.2.2.2 except one addition: • After Recv-6.3 procedure, the Hosting CSE shall check if the Originator ID is the same as the AE-ID or CSE- ID of the target <AE> resource or <remoteCSE> resource, respectively. If the check is failed, then the Hosting CSE shall return response primitive with a Response Status Code indicating "ORIGINATOR_HAS_NO_PRIVILEGE" error. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.21.2.3 Update | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Same as the generic procedures in clause 7.2.2.2 except one addition: • After Recv-6.3 procedure, the Hosting CSE shall check if the Originator ID is the same as the AE-ID or CSE- ID of the target <AE> resource or <remoteCSE> resource, respectively. If the check is failed, then the Hosting CSE shall return response primitive with a Response Status Code indicating "ORIGINATOR_HAS_NO_PRIVILEGE" error. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 164 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.21.2.4 Delete | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Same as the generic procedures in clause 7.2.2.2 except one addition: • After Recv-6.3 procedure, the Hosting CSE shall check if the Originator ID is the same as the AE-ID or CSE- ID of the target <AE> resource or <remoteCSE> resource, respectively. If the check is failed, then the Hosting CSE shall return response primitive with a Response Status Code indicating "ORIGINATOR_HAS_NO_PRIVILEGE" error. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.22 Resource Type <pollingChannelURI> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.22.1 Introduction | The <pollingChannelURI> resource is the virtual child resource which is automatically generated during the parent <pollingChannel> resource creation. The detailed description can be found in clause 9.6.22 in ETSI TS 118 101 [6]. There is no data type definition for <pollingChannelURI> resource because it is a virtual resource type. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.22.2 <pollingChannelURI> resource specific procedure on CRUD operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.22.2.0 Introduction | This clause describes <pollingChannelURI> resource specific behaviour for the Retrieve operation as a service layer long polling request. CUDN requests to the <pollingChannelURI> resource shall be rejected. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.22.2.1 Create | The present document does not define Create operation on a <pollingChannelURI> resource. A Create request for the resource shall be rejected. A <pollingChannelURI> virtual resource shall only be created during its parent <pollingChannel> resource creation procedure. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.22.2.2 Retrieve | Originator: shall execute Originator actions in clause 7.2.2.1 as a service layer long polling request. It is the Originator's responsibility to initiate this procedure after it gets long polling response either successful or unsuccessful. The Originator shall send this Retrieve request as blocking request (clause 8.2.1 in ETSI TS 118 101 [6]). Receiver: shall execute the following steps in order and these are modifications to the generic procedure from Recv-6.3 to Recv-6.5 in clause 7.2.2.2: Recv-6.3 Check if the request Originator is the creator of the parent <pollingChannel> resource. If it is not the creator, the Hosting CSE shall send response primitive with a Response Status Code indicating "ORIGINATOR_HAS_NO_PRIVILEGE" error. Recv-6.4 No change from the generic procedure. Recv-6.5 If there is a pending request(s) to be sent to the Originator Create a Response primitive by setting the Content parameter with pending request(s). ETSI ETSI TS 118 104 V2.7.1 (2016-10) 165 oneM2M TS-0004 version 2.7.1 Release 2 Else Wait for a request for the Originator until the Request Expiration Timestamp of the Originator's request. If a request is available before the Request Expiration Timestamp timeout, create a Response primitive including Pending Requests primitive parameter. Otherwise, create a response primitive with a Response Status Code indicating "REQUEST_TIMEOUT" error. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.22.2.3 Update | The present document does not define Update operation on a <pollingChannelURI> resource. An Update request for the resource shall be rejected. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.22.2.4 Delete | The present document does not define Delete operation on a <pollingChannelURI> resource. A Delete request for the resource shall be rejected. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.22.2.5 Notify | Request/response delivery mechanism via <pollingChannelURI> resource is depicted in the ETSI TS 118 101 Figure 10.2.13-1(Request/response delivery via polling channel). In this procedure, the Originator is the Target CSE and the Receiver is the <pollingChannelURI> Hosting CSE, respectively, in the figure. Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: shall execute the following steps in order and these are modifications to the generic procedure from Recv-6.3 to Recv- 6.5 in clause 7.2.2.2: Recv-6.3 Check if the request Originator is the creator of the parent <pollingChannel> resource. If it is not the creator, the Hosting CSE shall send response primitive with a Response Status Code indicating "ORIGINATOR_HAS_NO_PRIVILEGE" error. Recv-6.4 No change from the generic procedure. Recv-6.5 Send the response, which was contained in the Content parameter of the Notify request, to the entity that sent the associated request to the Hosting CSE (Originator in the figure). The associated request is the request that the Hosting CSE received and forwarded to the Registree CSE over the polling channel (step 002 and step 0003 in the figure). The association shall be done by matching the Request Identifier parameter of the request delivered in <pollingChannelURI> Retrieve response (step 004 in the figure) and the Request Identifier parameter of the response delivered in the Content parameter in a <pollingChannelURI> Notify request (step 005 in the figure). |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.23 Resource Type <statsConfig> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.23.1 Introduction | The <statsConfig> resource is used to store configuration data for collecting statistics for AEs. The <eventConfig> child resource is a mechanism for defining events that trigger statistics collection activity. Additional description of the <statsConfig> resource is contained in clauses 9.6.23 and 10.2.15 of ETSI TS 118 101 [6]. Table 7.4.23.1-1: Data type definition of <statsConfig> Data Type ID File Name Note statsConfig CDT-statsConfig-v2_7_0.xsd ETSI ETSI TS 118 104 V2.7.1 (2016-10) 166 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.23.1-2: Universal/Common Attributes of <stateConfig> resource Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP parentID NP NP accessControlPolicyI Ds O O creationTime NP NP expirationTime O O lastModifiedTime NP NP labels O O creator O NP dynamicAuthorization ConsultationIDs O O Table 7.4.23.1-3: Child resources of <statsConfig> resource Child Resource Type Child Resource Name Multiplicity Ref. to Resource Type Definition <eventConfig> [variable] 0..n Clause 7.4.24 <subscription> [variable] 0..n Clause 7.4.8 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.23.2 <statsConfig> resource-specific procedure on CRUD operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.23.2.1 Create | Originator: No change from the generic procedure in clause 7.2.2.1. Receiver: This procedure follows the Generic Request Procedure for Receiver specified in clause 7.2.2.1 with the following <statsConfig> resource-specific updates. Resource-specific operation before Recv-6.2: 1) If the To primitive parameter addresses a receiver CSE that is not an IN-CSE, then the request shall be rejected with a Response Status Code indicating "BAD_REQUEST" error. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.23.2.2 Retrieve | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.23.2.3 Update | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 167 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.23.2.4 Delete | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.24 Resource Type <eventConfig> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.24.1 Introduction | The <eventConfig> resource defines events that trigger statistics collection activity on an IN-CSE. Additional description of the <eventConfig> resource is contained in clauses 9.6.24 and 10.2.15 of ETSI TS 118 101 [6]. Table 7.4.24.1-1: Data type definition of <eventConfig> Data Type ID File Name Note eventConfig CDT-eventConfig-v2_7_0.xsd Table 7.4.24.1-2: Universal/Common Attributes of <eventConfig> resource Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP parentID NP NP accessControlPolicyI Ds O O creationTime NP NP expirationTime O O lastModifiedTime NP NP labels O O creator O NP dynamicAuthorization ConsultationIDs O O ETSI ETSI TS 118 104 V2.7.1 (2016-10) 168 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.24.1-3: Resource Specific Attributes of <eventConfig> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update eventID NP NP xs:string Uniquely identifies a configurable event No default eventType M O m2m:eventType DATAOPERATION STORAGEBASED TIMERBASED No default eventStart O O m2m:timestamp No default (present only when eventType is set to TIMERBASED) eventEnd O O m2m:timestamp No default (present only when eventType is set to TIMERBASED) operationType O O list of m2m:operation CREATE RETRIEVE UPDATE DELETE NOTIFY No default (present only when eventType is set to DATAOPERATION) dataSize O O xs:nonNegativeInteger No default (present only when eventType is set to STORAGEBASED) Table 7.4.24.1-4: Child Resources of <eventConfig> resource Child Resource Type Child Resource Name Multiplicity Ref. to Resource Type Definition <subscription> [variable] 0..n Clause 7.4.8 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.24.2 <eventConfig> resource-specific procedure on CRUD operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.24.2.1 Create | Originator: This procedure follows the Generic Resource Request Procedure for Originator specified in clause 7.2.2.1, with the following <eventConfig> resource-specific updates. Resource-specific operation before Orig-1.0 "Compose Request primitive": 1) If event-based statistics collection will be used, the Originator shall generate the representation of the <eventConfig> child resource instance to produce the desired trigger condition for the intended event. For example, one representation of <eventConfig> could have eventType set to DATA OPERATION and operationType set to Retrieve. In another example, a representation could have eventType set to TIMER- BASED, eventStart set to midnight tomorrow and eventEnd set to midnight of the day after tomorrow. See Table 7.4.24.1-3 for value restrictions and default settings pertaining to the attributes of <eventConfig>. Receiver: No change from the generic procedure in clause 7.2.2.2. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 169 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.24.2.2 Retrieve | Originator: No change from the generic procedure in clause 7.2.2.1. Receiver: No change from the generic procedure in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.24.2.3 Update | Originator: No change from the generic procedure in clause 7.2.2.1. Receiver: No change from the generic procedure in clause 7.2.2.2. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.