hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.2.2.2 Generic request procedure for receiver | The Receiver shall execute the following steps in order. In case of error in any of the steps below, the Receiver shall execute "Create an error response" (refer to clause 7.3.3.13 for details) and then "Send Response primitive" (refer to clause 7.3.2.4 for details). The corresponding Response code shall be included in the Response primitive. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 87 oneM2M TS-0004 version 2.7.1 Release 2 Figure 7.2.2.2-1: Generic procedure of Receiver Recv-1.0 "Check the validity of received request primitive": See clause 7.3.2.1 for details. Recv-2.0 "Communication method?": The Receiver CSE checks whether a received request is blockingRequest, nonBlockingRequestSynch or nonBlockingRequestAsynch by using Response Type parameter (see detail in clause 8.1.2 in ETSI TS 118 101 [6]). If the request is blockingRequest or Response Type parameter is not included, it goes to step Recv-6.0 "Resource handling procedure". If the request is nonBlockingRequestSynch, it goes to step Recv-3.0 "Create <request> resource locally" If the request is nonBlockingRequestAsynch, it goes to step Recv-3.0 "Create <request> resource locally". If the request is flexBlocking, the Receiver CSE shall make the decision to respond using blocking or non-blocking based on its own local context (memory, processing capability, etc.) unless specified further in the resource-specific procedure. Recv-3.0 "Create <request> resource locally": Please refer to clause 7.3.2.2 for details. Recv-4.0 "Create a successResponse": Please refer to clause 7.3.3.12 for details. Recv-5.0 "Send Response Primitive": Please refer to clause 7.3.2.4 for details. Recv-1.0: “Check the validity of received request primitive” Recv-2.0: Communication method? Recv-6.0: Resource handling procedures Recv-3.0: “Create <request> resource locally” Recv-4.0: “Create a success Response” Recv-5.0: “Send Response primitive” nonBlockingRequestAsynch nonBlockingRequestSynch Recv-6.0: Resource handling procedures Recv-7.0: “Update <request> resource” Finish Start Recv-3.0: “Create <request> resource locally” Recv-4.0: “Create a success Response” Recv-5.0: “Send Response primitive” Recv-6.0: Resource handling procedures Recv-7.0: “Update <request> resource” Recv-8.0: “Send Notification” Recv-9.0: “Wait for Response primitive” blockingRequest ETSI ETSI TS 118 104 V2.7.1 (2016-10) 88 oneM2M TS-0004 version 2.7.1 Release 2 Recv-6.0 "Resource handling procedure": Please refer to Figure 7.2.2.2-2 for details. Recv-7.0 "Update <request> resource": Please refer to clause 7.3.2.5 for details. This step is only valid when the request is non-blocking. Recv-8.0 "Send Notification": Please refer to clause 7.5.1.2.5 for details. Recv-9.0 "Wait for a Response primitive": Please refer to clause 7.3.1.3 for details. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 89 oneM2M TS-0004 version 2.7.1 Release 2 Figure 7.2.2.2-2: Resource handling procedure The above figure describes the generic procedure to resource handling procedures. Recv-6.10: “Queue request primitive and execute CMDH message forwarding procedure” Recv-6.1: Hosting CSE of the targeted resource? Start Recv-6.3: “Check authorization of the Originator” Recv-6.4: “Check validity of resource representation for the given resource type” Recv-6.2: “Check existence of the addressed resource” Recv-6.5: “Create/Update/Retrieve/Delete/Notify operation is performed” Recv-6.6: “Announce/De-announce the resource” Finish Yes No Recv-6.7: “Create a success response” Recv-6.8: “Send Response Primitive” Recv-6.9: CMDH processing supported? Recv-6.11: “Forwarding” No Yes Recv-6.0.1: Receiver is Registrar CSE & Originator is AE & operation is create Recv-6.0.2: “Check Service Subscription Profile” Yes No Recv-6.6.1: “Communication Method?” Else blockingRequest ETSI ETSI TS 118 104 V2.7.1 (2016-10) 90 oneM2M TS-0004 version 2.7.1 Release 2 Recv-6.0.1 "Receiver is Registrar CSE, Originator is AE and operation is create?": The step checks if the receiver is Registrar CSE, the Originator is AE, and operation is create. If the receiver is Registrar CSE and Originator is an AE, goes to Recv-6.0.2 "Check Service Subscription Profile". Otherwise, goes to Recv-6.1. Recv-6.0.2 "Check Service Subscription Profile": Please refer to clause 7.3.2.7 for details. Recv-6.1 "Hosting CSE of the targeted resource?": The step checks if the receiver is a transit CSE or the Hosting CSE of the received Request by examining the To parameter of the Request primitive. If the receiver hosts the resource that the address in the To parameter represents, the receiver is the Hosting CSE (goes to Recv-6.2"Check existence of the addressed resource", Yes branch). Otherwise, the receiver is the Transit CSE (goes to Recv-6.9 "Queue request primitive and execute CMDH message forwarding procedure", No branch). Recv-6.2 "Check existence of the addressed resource": Please refer to clause 7.3.3.1 for details. Recv-6.3 "Check authorization of the Originator": Please refer to clause 7.3.3.15 for details. Recv-6.4 "Check validity of resource representation": Please refer to clause 7.3.3.3 and clause 7.3.3.4 for details. Notify is not applicable for this step. Recv-6.5 "Create/Update/Retrieve/Delete/Notify operation is performed": The step represents five common operations which are "Create the resource (clause 7.3.3.5)", "Retrieve the resource (clause 7.3.3.6)", "Update the resource (clause 7.3.3.7)", "Delete the resource (clause 7.3.3.8)" and "Notify processing (clause 7.3.3.9)". Recv-6.6 "Announce/De-announce the resource": The step represents two common operations which are "Announce the resource" and "De-announce the resource". Please refer to clause 7.3.3.10 and clause 7.3.3.11 for details. Notify is not applicable for this step. Recv-6.6.1 "Communication method?": The Receiver CSE checks whether a received request is blockingRequest or not by using Response Type parameter (see detail in clause 8.1.2 in ETSI TS 118 101 [6]). If the request was blockingRequest or Response Type parameter was not included, it goes to step Recv-6.7 "Create a success response". Otherwise, it goes back to the generic procedure of the receiver (Figure 7.2.2.2-1). Recv-6.7 "Create a success response": Please refer to clause 7.3.3.12 for details. Recv-6.8 "Send Response Primitive": Please refer to clause 7.3.3.16 for details. If the Receiver is Hosting CSE, after this step, the procedure is terminated. Recv-6.9 "CMDH processing supported?": This step checks whether the Receiver supports the CMDH processing. Recv-6.10 "Queue request primitive and execute CMDH message forwarding procedure": If CMDH message is supported, the Receiver CSE shall queue the received request primitive and execute the "CMDH message forwarding procedure". Please refer to clause H.2.4 for details. Recv-6.11 "Forwarding": If CMDH processing is not supported, carry out message forwarding as defined in clause 7.3.2.6. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3 Common operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.1 Originator actions | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.1.1 Compose request primitive | The originator shall compose a Request message that shall be mapped to a specific protocol. The Request shall include mandatory parameters which is Operation, To, From and Request Identifier. The Request may include the time related parameters which is Originating Timestamp, Request Expiration Timestamp, Result Expiration Timestamp and Operation Execution Time. The Request may include the other parameters as specified in Table 7.2.1.1-1: Request Primitive Parameters. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 91 oneM2M TS-0004 version 2.7.1 Release 2 When including a resource representation in the request primitive for create and update, the originator shall take into account the validation rules as specified in "Check validity for resource representation for create" and "Check validity for resource representation for update" respectively. EXAMPLE: Any attributes marked with NP shall not be present in the resource representation for the corresponding request primitive. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.1.2 Send a request to the receiver CSE | The originator shall determine the receiver CSE. The receiver of the Request shall be the registrar CSE of the originator in case the originator is not IN-CSE. If the originator is the IN-CSE, the receiver of the Request shall be the CSE whose identifier is the prefix of the To parameter of the Request. If this results in no matching CSE, then the request is rejected with a Response Status Code indicating "NOT_FOUND" error. If this results in multiple CSEs, the request is rejected with a Response Status Code indicating "INTERNAL_SERVER_ERROR" error. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.1.3 Wait for response primitive | The originator shall wait for the Response primitive from the receiver that corresponds to the Request primitive that was sent by the originator. Correlation between the Request and the corresponding Response is handled by the transport layer or by Request Identifier parameter of the primitive. If no Response primitive is received within a certain time, specified by server policy and/or by the underlying transport technology, this shall be handled as if a Response primitive with a Response Status Code indicating "REQUEST_TIMEOUT" error was received. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.1.4 Retrieve the <request> resource | When the Originator needs to retrieve information about an associated previously issued non-blocking request, the Originator shall request to Retrieve the attributes of the <request> resource. The Originator shall compose the Request primitive with the following parameters and send the Request to the Receiver CSE. See clauses 7.3.1.1 and 7.3.1.2. NOTE: The Originator may include optional parameters described in clause 8.1.2 of ETSI TS 118 101 [6]. Table 7.3.1.4-1: Request primitive parameter settings Parameter Name Value Operation Retrieve To This shall be set to the URI of the <request> resource received in the response (acknowledgement) to the previously issued non-blocking request. From Id of the Originator Request Identifier The identifier of this request message. Content Optionally includes the name of attributes that needs to be retrieved. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.2 Receiver CSE actions | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.2.1 Check the validity of received request primitive | The validity checking of the message carrying the received request primitive is specified by the protocol mapping Technical Specifications (CoAP binding [22], HTTP binding [23], and MQTT binding [24]). The received resource representation (e.g. in plain XML, binary XML or JSON) shall be validated against the provided schema definitions. If the Request Expiration Timestamp is given in the request and expired, the Receiver CSE shall reject the request with an "REQUEST_TIMEOUT" Response Status Code parameter value. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 92 oneM2M TS-0004 version 2.7.1 Release 2 If the received request is communicated within an established Security Association (ETSI TS 118 103 [[7]]), and • the Receiver knows that the Registree using the established Security Association is an AE, and • the Receiver knows the AE-ID(s) of the Registree using the established Security Association, and • the From parameter does not match the allowed AE-ID(s) of the Registree using the established Security Association, then the request shall be rejected with an "ORIGINATOR_HAS_NOT_REGISTERED " Response Status Code parameter value. If the received request is communicated within an established Security Association, and • the Receiver knows that the Registree using the established Security Association is a CSE, and • the Receiver knows the CSE -ID of the Registree using the established Security Association, and • if one of the following applies: - the From parameter is an CSE-ID that matches one of the Receiver's Registree CSE's CSE-ID other than the CSE-ID of the Registree using the established Security Association, or - the From parameter is an CSE-Relative C-Type AE-ID-Stem, or - the From parameter is an SP-Relative AE-ID or Absolute AE-ID with a C-Type AE-ID-Stem, and the CSE-ID portion of the From parameter matches one of the Receiver's Registree CSE's CSE-ID other than the CSE-ID of the Registree for the established Security Association, then the request shall be rejected with an "ORIGINATOR_HAS_NOT_REGISTERED" Response Status Code parameter value. NOTE: An SP-Relative-AE-ID or Absolute AE-ID with a C-Type AE-ID-Stem always includes a CSE-ID portion (see ETSI TS 118 101 [6]). If the received request is communicated outside of an established Security Association, and • If the From parameter includes an AE-ID, and • The request is not a CREATE <AE> Request, and • The From parameter does not match the AE-ID of an AE currently registered to the Receiver then the request shall be rejected with a "ORIGINATOR_HAS_NOT_REGISTERED" Response Status Code parameter value. If the received request is communicated outside of an established Security Association, and the From parameter includes a CSE-ID, then the request shall be rejected with an "SECURITY_ASSOCIATION_REQUIRED" Response Status Code parameter value. If a received request needs to be forwarded to another CSE and if CMDH processing is supported, then in addition, the "CMDH message validation procedure" defined in clause H.2.3 shall be carried out. If the message is not valid, the request shall be rejected with a Response Status Code indicating "BAD_REQUEST" error. If Resource Type is not present or is invalid in a CREATE request ,the request shall be rejected with a Response Status Code indicating "BAD_REQUEST" error. If the Filter Criteria parameter is included in a CREATE request, the request shall be rejected with a Response Status Code indicating "BAD_REQUEST" error. If the Result Content is invalid for a given operation (Refer ETSI TS 118 101 Table 8.1.2-1: Summary of Result Content Values) then the Hosting CSE shall reject the request with a Response Status Code indicating "BAD_REQUEST" error. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 93 oneM2M TS-0004 version 2.7.1 Release 2 If the receiver does not support the content format (i.e. type of serialization) requested by the originator, the request shall be rejected with a Response Status Code indicating "NOT_ACCEPTABLE" error. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.2.2 Create <request> resource locally | Creation of a <request> resource can only be done on a Receiver CSE implicitly. When the Receiver CSE receives 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 Receiver CSE supports the <request> resource type as indicated by the 'supportedResourceType' attribute of the <CSEBase> resource, the Receiver CSE shall create an instance of <request> resource based on the following steps. If the Receiver CSE does not support the <request> resource type, the 'nonBlockingRequestSynch' request shall be rejected with a Response Status Code indicating "NON_BLOCKING_REQUEST_NOT_SUPPORTED" error. For the 'nonBlockingRequestAsynch'request, a Receiver CSE that does not support the <request> resource type shall be able to respond to an acceptable request with a response containing an Acknowledgement without a reference to a resource containing the context of the request. The Receiver CSE of a non-blocking request is the Hosting CSE for the <request> resource that shall be associated with the non-blocking request. 1) Assign a value to the common attributes of <request> resource according to the following table: Table 7.3.2.2-1: Common attributes settings for <request> resource Attribute Name Value resourceType Request resourceID Hosting CSE shall assign a value to this attribute. expirationTime The value of the expirationTime shall be chosen dependent on the Request Expiration Timestamp, Result Expiration Timestamp, Operation Execution Time and Result Persistence parameters associated with the original request. If the value consistent with the Request Expiration Timestamp, Result Expiration Timestamp, Operation Execution Time and Result Persistence parameters is too long, the Hosting CSE shall reject the request. The expirationTime of the <request> resource should last longer than the specified Result Persistence if provided in the request. parentID The parent resource of a <request> resource shall be the <CSEBase> resource of the Hosting CSE. creationTime Date/time of creation of this resource. lastModifiedTime Date/time which is equal to the creationTime. accessControlPolicyIDs Populate with one ID of an <accessControlPolicy> that contains the following: In the 'privileges' attribute • Allow RUD operations to the Hosting CSE • Allow RD operations to the Originator, i.e. the value of the parameter From in the associated non-blocking request In the 'selfPrivileges' attribute 1. Allow U operations the parent <accessControlPolicy> resource to the Originator, i.e. the value of the parameter From in the associated non- blocking request labels Originator ID stateTag 0 resourceName Hosting CSE shall assign a value to this attribute. 2) Assign a value to the resource-specific attributes of <request> resource according to the following table: Table 7.3.2.2-2: Resource-specific attributes settings for <request> resource Attribute Name Value operation The value of the parameter Operation in the associated non-blocking request. target The value of the parameter To in the associated non-blocking request. originator The value of the parameter From in the associated non-blocking request. requestID The value of the parameter Request Identifier in the associated non-blocking request. metaInformation The content of this attribute is set to information in optional parameters described in clause 8.1.2 of [6] given in the associated non-blocking request. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 94 oneM2M TS-0004 version 2.7.1 Release 2 content The value of the parameter Content, if any, in the associated non-blocking request. requestStatus The Receiver CSE shall set this to "PENDING". operationResult Empty |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.2.3 Create a success response (acknowledgement) | The Receiver CSE shall create a Response primitive. The Receiver CSE shall include the following parameters in the Response primitive. Table 7.3.2.3-1: Response primitive parameter settings Parameter Name Value Response Status Code "ACCEPTED" Request Identifier The value of the parameter Request Identifier in the associated non-blocking request. Originating Timestamp Timestamp when this message was built Content Reference to the <request> of the associated non-blocking request only if <request> resource is supported. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.2.4 Send response primitive (acknowledgement) | A Response primitive shall be sent back to the originator. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.2.5 Update <request> resource | Changes in the attributes of a <request> resource shall be done by the Hosting CSE implicitly due to changes of the status (requestStatus) of the associated non-blocking request or due to the reception of an operation result (operationResult) in response to the associated non-blocking request. The Receiver CSE shall update attributes of an instance of <request> resource based on the following steps. 1) Update a value to the common attributes of <request> resource according to the following table: Table 7.3.2.5-1: Common attributes settings for <request> resource Attribute Name Value lastModifiedTime Date/time of the last modification. stateTag This value is incremented on every modification. 2) Update a value to the resource-specific attributes of <request> resource according to the following table: Table 7.3.2.5-2: Resource-specific attributes settings for <request> resource Attribute Name Value requestStatus If the Receiver CSE is a Transit CSE and the previously received request has been successfully forwarded to the next hop, this shall be set to "FORWARDED". If the Receiver CSE is a Transit CSE and the previously received request has been rejected by the next hop, this shall be set to "FAILED". If the Receiver CSE is the Target CSE (i.e. To parameter in the request message starts with the CSEBase URI of the Receiver CSE) and the originally requested operation has been completed, this shall be set to "COMPLETED". operationResult Hosting CSE shall contain the response message of the originally requested operation – if any – in line with the rc parameter in the associated non-blocking request. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.2.6 Forwarding | If the To parameter in the request does not start with the CSEBase URI of the receiver, the receiver CSE shall forward the request or shall serve the request locally (see below). ETSI ETSI TS 118 104 V2.7.1 (2016-10) 95 oneM2M TS-0004 version 2.7.1 Release 2 If the To parameter in the request starts with the CSEBase URI of the receiver, then the receiver CSE shall handle the request locally. If the Request Expiration Timestamp, Result Expiration Timestamp or Operation Execution Time is set in the request, the receiver CSE should forward the request before the earliest of the times. If the any of the timestamps are in the past, it shall reject the request with a "REQUEST_TIMEOUT" Response Status Code parameter value and not forward the request. Acting as an originator the CSE shall perform the following procedures: 1) "Send a Request to the receiver CSE". 2) "Wait for Response primitive". When the Response is received the receiver CSE shall: 1) Primitive specific procedure: Forward the Response to the original CSE. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.2.7 Check Service Subscription Profile | The receiver shall check if the originator's <m2mServiceSubscriptionProfile> has S-RoleID in serviceRoles attribute that allows to create resource type specified in resource type parameter. The receiver shall find a proper <serviceSubscribedNode> including CSE-ID of the receiver and determine serviceRoles from the parent resource of the <serviceSubscribedNode> which corresponds to <m2mServiceSubscriptionProfile> resource. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3 Hosting CSE actions | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.1 Check supported resource types | If the request is a valid request, but the Hosting CSE does not implement the requested resource type, then the Hosting CSE shall reject the request and return an error response with Response Status Code indicating "NOT IMPLEMENTED". |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.2 Check existence of the addressed resource | If the Request Expiration Timestamp is given in the request and expired, the Hosting CSE shall reject the request with an "REQUEST_TIMEOUT" Response Status Code parameter value. Otherwise, the Hosting CSE should handle the request before the time specified in Request Expiration Timestamp. The Hosting CSE shall check if the resource addressed by the To parameter exists in the repository. If the resource does not exist, the Hosting CSE shall reject the request with a Response Status Code indicating "NOT_FOUND" error. The Hosting CSE shall also check if the conditions specified in the Filter Criteria parameter in the Retrieve/Update/Delete operation are met. If the condition check fails, the Hosting CSE shall reject the request with a Response Status Code indicating "NOT_FOUND" error. If the Hosting CSE does not support the content format (i.e. type of serialization) requested by the originator, the request shall be rejected with a Response Status Code indicating "NOT_ACCEPTABLE" error. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.3 Check validity of resource representation for CREATE | The handling below shall apply to each attribute in the resource for CREATE request primitives and the handling depends on the "presence in CREATE request" column of the resource table. If the request is rejected based on the rules below, then the other attributes do not have to be checked. If the CREATE request has a Resource Type that is not listed in the child resource tables, defined in clause 7.4 corresponding to the addressed resource, then the request shall be rejected with a Response Status Code indicating "INVALID_CHILD_RESOURCE_TYPE" error. If no resource representation is present in the CREATE request, then the request is rejected with a Response Status Code indicating "BAD_REQUEST" error. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 96 oneM2M TS-0004 version 2.7.1 Release 2 If the expirationTime attribute is present in the resource representation, but its value indicates a time in the past, then the request shall be rejected with a Response Status Code indicating "BAD_REQUEST" error. There are three cases where the Hosting CSE shall configure or override an expirationTime value that differs from the value specified in the resource representation (if present). 1) The Originator does not specify an expirationTime 2) The Originator requests an expirationTime that is later than expirationTime of the parent 3) The Hosting CSE determines the expirationTime requested by the Originator does not meet its requirements (E.g. based on a local policy) In each of these cases, the Hosting CSE shall configure an expirationTime into the resource that is less than or equal to the expirationTime of the parent resource. In addition, the Hosting CSE shall communicate the modified value back to the originator in the response if the Result Content parameter permits this. If the creator attribute is present in the resource representation and supported by the type of resource to be created its value shall be NULL. If the originator provides a value for the creator attribute but resource type does not support the creator attribute, then the Hosting CSE shall reject the request with a Response Status Code indicating "BAD_REQUEST" error. If the originator provides a value for the creator attribute within the request, the Hosting CSE shall reject the request with a Response Status Code indicating "BAD_REQUEST" error. M attribute for create request If the attribute is present in the resource representation in the CREATE request, the Hosting CSE shall check if the value is acceptable according to internal policies. If the provided value is not accepted, the Hosting CSE shall reject the request with a Response Status Code indicating "BAD_REQUEST" error. If the attribute is not present in the resource representation in the CREATE request the Hosting CSE shall reject the request with a Response Status Code indicating "BAD_REQUEST" error. O attribute for create request If the attribute is present in the resource representation in the CREATE request, the Hosting CSE shall check if the value is acceptable according to internal policies. If the provided value is not accepted then the Hosting CSE shall reject the request with a Response Status Code indicating "BAD_REQUEST" error. NP attribute for create request If the attribute is present in the resource representation in the CREATE request, the Hosting CSE shall reject the request with a Response Status Code indicating "BAD_REQUEST" error. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.4 Check validity of resource representation for UPDATE | The handling below shall apply to each attribute in the resource for UPDATE request primitives and the handling depends on the "presence in UPDATE request" column of the resource table. If the request is rejected based on the rules below, then the other attributes do not have to be checked. If the expirationTime attribute is present in the resource representation, but its value indicates a time in the past, then the request shall be rejected with a Response Status Code indicating "BAD_REQUEST" error. O attribute for update request If the attribute is present in the resource representation in the UPDATE request, the Hosting CSE shall check if the value is acceptable according to internal policies. If the provided value is not accepted, the Hosting CSE shall reject the request with a Response Status Code indicating "BAD_REQUEST " error. NP attribute for update request ETSI ETSI TS 118 104 V2.7.1 (2016-10) 97 oneM2M TS-0004 version 2.7.1 Release 2 If the attribute is present in the resource representation in the UPDATE request, the Hosting CSE shall reject the request with a Response Status Code indicating "BAD_REQUEST" error. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.5 Create the resource | If the Operation Execution Time is given in the request, the Hosting CSE should perform the following procedures at the time and shall not perform the procedures before the time. A new resource shall be created and correlated to the addressed and existing parent resource. As the result of the resource creation, the lastModifiedTime attribute of the parent resource shall be set to the same value as the creationTime attribute of the created resource. The following rules shall be applied. The URI of the created resource shall be the URI of its parent resource with the resourceName appended. (e.g. http://CSEbase.operator.org/myAppID, for an application resource with resourceName "myAppID" created in the parent resource http://CSEbase.operator.org). When configuring the resourceName attribute of the new resource, the Hosting CSE shall use the name provided in the resourceName attribute within the content of the request. The Hosting CSE shall first check for the presence of any resources having a resourceName attribute that matches the one specified in the request and that have the same parent as the new resource being created. If such a resource exists, then the Hosting CSE shall reject the request with a Response Status Code indicating "CONFLICT" error. If the resourceName is not provided in the request, the Hosting CSE shall generate and assign a name to the resourceName attribute of the new resource. If expirationTime attribute is present in the resource representation of the to be created resource and the expirationTime is set to a non-negative time, then an expiration timer shall be started by the Hosting CSE. At timer expiration the related resource is deleted by "Delete the addressed resource". Attributes of the parent resource shall be updated, if applicable. For example, the currentByteSize attribute of a <container> resource will be updated upon child <contentInstance> resource creation. An attribute update of a parent resource is resource type specific, so they are specified in clause 7.4. If the creator attribute is present in the resource representation, and is supported by the type of resource to be created, and is NULL, then the Hosting CSE shall include the creator attribute in the resource to be created. The Hosting CSE shall assign the creator attribute with a value equal to the value carried in the From request parameter. If the creator attribute is not present in the resource representation of the request, the Hosting CSE shall not include the creator attribute in the resource to be created. For setting the attributes in the resource representation the following rules shall apply in CREATE request primitives: M attribute for create request If the provided value is acceptable, the Hosting CSE shall use the provided value in the resource representation of the created resource. O attribute for create request If a value is provided and accepted, then the Hosting CSE shall use the provided value in the resource representation of the created resource. If the attribute is not provided or accepted, but the multiplicity of the attribute is "1" in the resource, the Hosting CSE shall assign default value or assign value based on local policy, or the value of specified in clause 7.4. If the attribute is not present in the resource representation in the CREATE request and the multiplicity of the attribute is "0..1" in the resource, the Hosting CSE shall create the resource without the attribute unless otherwise specified in resource type-specific procedures defined in clause 7.4. NP attribute for create request If the attribute is not present in the resource representation in the CREATE request, and the multiplicity of the attribute is "1" in the resource, then the Hosting CSE shall create the resource with the default value. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 98 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.6 Retrieve the resource | If the Operation Excution Time is given in the request, the Hosting CSE should perform the following procedures at the time and shall not perform the procedures before the time. When the resource is read to provide a response to Retrieve request primitives: Full retrieve request: the request target is a resource given in the To parameter The content of the Response to the Retrieve Request shall comply to the Result Content parameter in the Request. If the Result Content is not provided in the Request, the representation of the resource which includes all the attributes shall be returned. Partial retrieve request: there are two cases: Case 1) the request target is a resource given in the To parameter and specific attribute names are provided in the Content parameter: The values of the resource attribute(s) provided in the Content parameter shall be retrieved. Case 2) the request target is a resource given in the To parameter, the resource attribute is provided in the To parameter as a fragment identifier component of URI following '#' character [2]. The resource attribute shall be represented as a short name and shall belong to short name list in Table 8.2.3-1 to Table 8.2.3-5. The resource attribute provided in the To parameter shall be retrieved. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.7 Update the resource | If the Operation Execution Time parameter is given in the request, the Hosting CSE should perform the following procedures at that time and shall not perform the procedures before that time. Attributes that are not included in the Content parameter of the addressed resource shall not be changed by the Hosting CSE. For attributes provided in the Content parameter, their content shall be updated while the following rules apply: If the announceTo attribute or announcedAttribute attribute of the resource is requested to be updated, the Hosting CSE shall update the attribute as described in the "announce the resource or attribute" and "de-announce the resource or attribute" procedures as specified in the clause 7.3.3.10 and clause 7.3.3.11, respectively. O attribute for update request If an attribute value is provided and the value is accepted, the Hosting CSE shall use the provided value in the resource representation of the updated resource. If the attribute is not provided, but the attribute exists in the target resource, the Hosting CSE shall leave the value of that attribute unchanged. If this attribute is provided in the Content parameter and does not exist in the target resource, the Hosting CSE shall create such attribute with the provided value. If this attribute is set to NULL in the Content parameter and exists in the target resource, the Hosting CSE shall delete such attribute if the deletion of the attribute is allowed by the local policy. If the expirationTime attribute is present and modified by the procedure and it is set to a non-negative time, then an expiration timer shall be re-started by the Hosting CSE. At timer expiration the related resource is deleted by "Delete the addressed resource". NP attribute for update request If the update is successful, the Hosting CSE shall set the lastModifiedTime to the current time and the Hosting CSE shall increment the stateTag if present. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.8 Delete the resource | If the Operation Excution Time is given in the request, the Hosting CSE should perform the following procedures at the time and shall not perform the procedures before the time. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 99 oneM2M TS-0004 version 2.7.1 Release 2 The addressed resource with all its attributes shall be deleted. Any expiration timer shall be stopped. This same procedure shall be invoked (recursively) for each child resource of the deleted resource in case the child resource is only linked to the deleted resource. The parent resource of the addressed resource shall be updated to remove the reference to the deleted resource. If the parent resource has a lastModificationTime attribute then this attribute shall be set to the time of the deletion. If the resource is announced, the CSE shall try to de-announce the resource correspondingly. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.9 Notify processing | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.9.1 Notify processing when To parameter is an <AE> resource | If the Operation Excution Time is given in the request, the Hosting CSE should perform the following procedures at the time and shall not perform the procedures before the time. When the Hosting CSE receives a Notify request primitive targeting (i.e. To parameter) its <AE> resource, the Hosting CSE re-targets the primitive to the AE if the <AE> resource does not have any <pollingChannel> resource as a child. 1) Get pointOfAccess attribute value of the corresponding <AE> resource. If there is no available pointOfAccess address then the Hosting CSE shall send the Notify response primitive with a Response Status Code indicating "TARGET_NOT_REACHABLE" error. 2) Forward the Notify request primitive to the first address retrieved from pointOfAccess value 3) If the forwarding is failed due to "Target not reachable", iterate 2) with the next address. 4) If the Hosting CSE cannot forward it in the end, then it send the Notify response primitive with a Response Status Code indicating "TARGET_NOT_REACHABLE" error. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.9.2 Notify processing when To parameter is the <CSEBase> resource | If the Operation Execution Time is given in the request, the Hosting CSE should perform the following procedures at the time and shall not perform the procedures before the time. When the Hosting CSE receives a Notify request primitive targeting (i.e. To parameter) its <CSEBase> resource, the Hosting CSE shall process the Content of the Notify request primitive. See clause 7.5.1. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.10 Announce the resource or attribute | If CREATE request that contains an announceTo attribute is received, • Compose the CREATE Request primitive as follows: - The link attribute is set to the URI of the original resource. - If accessControlPolicyIDs attribute of the original resource is not present, accessControlPolicyIDs attribute is set to the same value with the parent resource or from the local policy of the original resource. - Attributes marked with MA and attributes marked with OA that are included in the announcedAttribute attribute. Such attributes shall be present in the original resource and set to same value as the original resource. - The resourceType attribute is set to the announced variant of the original resource (see the Table 6.3.4.2.1-1) • If announceTo attribute contains a list of CSE-ID(s) , - Check if the parent resource of the original resource has been announced to the announcement target CSE(s). If yes , announce the original resource by sending a CREATE Request to the CSE(s) specified in the announceTo and that targets the announced parent resource. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 100 oneM2M TS-0004 version 2.7.1 Release 2 If no, check if the CSE hosting the original resource has registered and created a <remoteCSE> resource to the announcement target CSE(s). If yes , announce the original resource by sending a CREATE Request to the CSE(s) specified in the announceTo and that targets the <remoteCSE> of the CSE hosting the original resource. If no, then check if the CSE hosting the original resource has been announced to the announcement target CSE(s) and created a <remoteCSEAnnc> resource. • If yes, announce the original resource by sending a CREATE Request to the CSE(s) specified in the announceTo and that targets the <remoteCSEAnnc> resource • If no, then CSE hosting the original resource shall perform the following steps. o Announce itself to the CSE(s) specified in the announceTo attribute such that its <remoteCSEAnnc> resource is present at the announcement target CSE(s). o Send a CREATE Request to the CSE(s) specified in the announceTo of the request and that target the <remoteCSEAnnc> resource. • Otherwise, Send a CREATE Request to the CSE(s) represented by exact URI(s) in the announceTo of the request. • Wait for the Response primitive • Add the URI of successfully announced resource to the announceTo attribute of the resource • Include updated announceTo attribute in the Content parameter in the Response to the received CREATE Request. If UPDATE request that adds the URI or CSE-ID into the announceTo attribute is received, • Compose the CREATE Request primitive as follows: - Link is set to the URI of the original resource. - If accessControlPolicyIDs of the original resource is not present, accessControlPolicyIDs is set to the same value with the parent resource or from the local policy of the original resource. - Attributes marked with MA and attributes marked with OA that are included in the announcedAttribute attribute. Such attributes shall be present in the original resource and set to same value as the original resource. • If announceTo attribute contains a list of CSE-ID(s) , - Check if the parent resource of the original resource has been announced to the announcement target CSE(s). If yes , announce the original resource by sending a CREATE Request to the CSE(s) specified in the announceTo and that targets the announced parent resource. If no, check if the CSE hosting the original resource has registered and created a <remoteCSE> resource to the announcement target CSE(s). If yes , announce the original resource by sending a CREATE Request to the CSE(s) specified in the announceTo and that targets the <remoteCSE> of the CSE hosting the original resource. If no, then check if the CSE hosting the original resource has been announced to the announcement target CSE(s) and created a <remoteCSEAnnc> resource. • If yes, announce the original resource by sending a CREATE Request to the CSE(s) specified in the announceTo and that targets the <remoteCSEAnnc> resource ETSI ETSI TS 118 104 V2.7.1 (2016-10) 101 oneM2M TS-0004 version 2.7.1 Release 2 • If no, then CSE hosting the original resource shall perform the following steps. o Announce itself to the CSE(s) specified in the announceTo attribute such that its <remoteCSEAnnc> resource is present at the announcement target CSE(s). o Send a CREATE Request to the CSE(s) specified in the announceTo of the request and that target the <remoteCSEAnnc> resource. • Otherwise, Send a CREATE Request to the CSE(s) represented by exact URI(s) in the announceTo of the request. Wait for Response primitive • Add the URI of successfully announced resource to the announceTo attribute of the resource • Include updated announceTo attribute in the Content parameter in the Response to the received UPDATE Request. If UPDATE request that adds the attribute name into the announcedAttribute attribute is received, • Compose the UPDATE Request. The UPDATE Request shall provide the attribute name for the attribute to be announced, and the initial value for the attribute in the Content parameter. The initial value shall be the same with the value from the original resource. The attribute that will be announced shall be marked as OA. • Send UPDATE Requests to all announced resources listed in the announceTo attribute. • Wait for Response primitive. • Add the attribute name of the successfully announced attribute to the announcedAttribute attribute. • Include updated announcedAttribute attribute in the Content parameter in the Response to the received UPDATE Request. If an attribute(s) specified as MA (See ETSI TS 118 101 [6]) or an attribute(s) included in the announcedAttribute attribute is updated: • Compose an UPDATE Request primitive by including the updated attribute(s) with its associated updated value. • Send the UPDATE Request to all CSE(s) represented by the URI(s) in the announceTo attribute of the original resource. If an attribute(s) specified as MA (See ETSI TS 118 101 [6]) or an attribute(s) included in the announcedAttribute attribute is deleted: • Compose an UPDATE Request primitive by including the updated attribute(s) with its value set to NULL. • Send the UPDATE Request to all CSE(s) represented by the URI(s) in the announceTo attribute of the original resource. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.11 De-announce the resource or attribute | If UPDATE Request that deletes the URI from the announceTo attribute is received: • Compose the DELETE Request primitive. • Send a DELETE Request to the CSE(s) represented by URI(s) in the announceTo attribute of the resource, which is not included in the announceTo of the request. The To parameter in the DELETE Request shall be set to the URI for the announced resource that will be deleted. • Wait for Response primitive. • Remove the URI of successfully de-announced resource from the announceTo attribute of the resource. • Include updated announceTo attribute in the Content parameter in the Response to the UPDATE Request of the original resource. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 102 oneM2M TS-0004 version 2.7.1 Release 2 If DELETE Request is received: • Compose the DELETE Request primitive. • Send DELETE Requests to all announced resources addressed by the URI(s) in the announceTo attribute of the resource. • Wait for Response primitive. If UPDATE request that deletes the attribute name from the announcedAttribute attribute is received: • Compose the UPDATE Request primitive. The To parameter in the UPDATE Request shall be set to the URI for the announced resource. The UPDATE Request shall set the attribute that will be de-announced (i.e. to be deleted) in the Content parameter to NULL. The attribute that will be de-announced shall be marked as OA. • Send UPDATE Requests to all announced resources listed in the announceTo attribute of the original resource. • Wait for Response primitive. • Delete the attribute name of the successfully de-announced attribute from the announcedAttribute attribute. • Include updated announcedAttribute attribute in the Content parameter in the Response to the received UPDATE Request. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.12 Create a success response | The Hosting CSE shall create a success response primitive with a Response Status Code indicating: • " CREATED" in case of Create operation. If the Hosting CSE assigned attribute(s) not provided or modified any of the provided attributes as provided in the Request, the Content parameter shall include the assigned and/or modified attributes; • "OK" in case of Retrieve operation; • "UPDATED" in case of Update operation; • "DELETED" in case of Delete operation; and • "OK" in case of Notify operation. The Hosting CSE shall include Request Identifier parameter in the response primitive. The Hosting CSE shall include Content parameter with: • the address and/or attributes(assigned and modified by the Hosting CSE) of the created resource depending on Result Content parameter (i.e. attributes, hierarchical-address, hierarchical-address+attributes) in the request primitive. This shall apply for Create operation; • the retrieved attributes and/or child resource references depending on Result Content parameter (i.e. attributes, attributes+child-resources, child-resources, attributes+child-resource-references, child-resource-references, original-resource) in the request primitive. This shall apply for Retrieve operation; and • the modified/created/deleted attributes. This shall apply for Update operation. More details can be found in clause 7.2.1.2 (Response primitive format). NOTE: If Result Content parameter is not given in the request primitive, the default value is attributes. How to deal with each Result Content value is described in clause 8.1.2 [6]). The Hosting CSE may include To, From, Originating Timestamp, Result Expiration Timestamp, Event Category parameters. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 103 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.13 Create an error response | The receiver shall create an error response primitive with a Response Status Code indicating the detected error condition. NOTE: Possible error codes and its error handling is described in resource specific procedure. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.14 Resource discovery procedure | If the Operation Excution Time is given in the request, the Hosting CSE should perform the following procedures at the time and shall not perform the procedures before the time. A resource discovery is used to discover resources in a CSE. A Resource discovery request is done by sending Retrieve request with filterUsage, one of the Filter Criteria parameters, configured as "discovery" and the request may include other Filter Criteria parameters as well. A resource discovery request procedure shall be comprised of the following actions. Originator: The Originator shall follow the steps from Orig-1.0 to Orig-6.0 specified in clause 7.2.2.1 Generic Resource Request Procedure for Originator. In addition to Orig-1.0, the following steps shall be performed. The To parameter in the Retrieve Request indicates the root of where the discovery begins. The Retrieve Request shall include filterUsage element, which is not either "Discovery CriteriaConditional Retrieval" or "IPE On-demand Discovery", in Filter Criteria. The Retrieve Request may include other elements of Filter Criteria. Receiver: The Receiver shall follow the steps from Recv-1.0 to Recv-7.0 specified in clause 7.2.2.2 Generic Resource Request Procedure for Receiver. Hosting CSE shall not perform steps from Recv-6.3 to Recv-6.6 and perform the following steps instead. The Receiver shall find resources, which match all the configured Filter Criteria and which the Originator has "Discover" privilege, among all the children/descendent resource of the addressed resource". If the addressed resource is an <AE> resource representing the IPE by its labels attribute, the Hosting CSE shall find resources using the Filter Criteria. When the Hosting CSE finds no match, the Hosting CSE shall check the filterUsage element. If the filterUsage element is set to "IPE On-demand Discovery", then the Hosting CSE shall send the Notify request to the IPE to trigger external discovery procedure (see clause 7.5.1.2.8 for more details). If the Hosting CSE receives successful Notify response, the Hosting CSE shall find resources among the resources on the Hosting CSE listed in the Notify response using the Filter Criteria and check the Originator's "Discover" privilege. If the Hosting CSE receives an unsuccessful Notify response from the IPE, then the Hosting CSE shall use the same Response Status Code in the response to the Originator. In Recv-6.7, the Receiver shall include addresses for all the found resources in the CSE-relative resource identifier format. The Receiver shall perform Recv-6.8 and the procedure is terminated. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.15 Check authorization of the originator | Depending on the target resource type, the Hosting CSE shall use accessControlPolicyIDs of the different resources. • If the resource type does not have the accessControlPolicyIDs attribute definition, the Hosting CSE shall evaluate the accessControlPolicyIDs associated with the parent of that resource (e.g. for <schedule>, <oldest>, <latest>, <contentInstance>). ETSI ETSI TS 118 104 V2.7.1 (2016-10) 104 oneM2M TS-0004 version 2.7.1 Release 2 • Some resources provide specific handling for the accessControlPolicyIDs attribute, for such resources these procedures are to be followed (e.g. handling given in ETSI TS 118 101 clause 9.6 for <container>, <m2mServiceSubscriptionProfile>, <serviceSubscribedNode>). • For other resources, the Hosting CSE shall evaluate the accessControlPolicyIDs of the resource. In case accessControlPolicyIDs attribute value is not set, or does not point to a valid resource or is not reachable then system default policies shall apply. The evaluation procedure shall be performed as following: 1) The Hosting CSE retrieves the access control rules from privilege attribute of the <accessControlPolicy> which is linked as the accessControlPolicyIDs. If the target is <accessControlPolicy> resource, it retrieves the rules from selfPrivilege attribute instead. 2) The Hosting CSE checks the following conditions for the access control rules. If there is any rule satisfying all conditions then the evaluation is successful, otherwise it is failed. For more details, see the clause 7.1.5 in ETSI TS 118 103 [7]. • accessControlOriginators of the rule includes the Originator information. • accessControlContexts of the rule includes the request context, if the rule includes the accessControlContexts. - If the accessControlOriginators includes a groupID, the Hosting CSE checks if the Originator is a member of that group resource. • accessControlOperations of the rule matches the operation type of the request. • If the accessControlAuthenticationFlag is TRUE, then access control rule applies only if the Originator is considered to be authenticated by the Hosting CSE according to clause 7.1.2 in ETSI TS 118 103 [7]. If the evaluation failed, and the Hosting CSE does not support Dynamic Authorization, authorization failure information shall be returned to the Originator. If the evaluation failed and the Hosting CSE supports Dynamic Authorization, then it shall trigger Dynamic Authorization. For more details, see the clause 7.3 in ETSI TS 118 103 [7]. If Dynamic Authorization results in a failure, authorization failure information shall be returned to the Originator. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.16 Send response primitive | A Response primitive shall be sent back to the Originator. If the primitive is successful response and the Result Expiration Timestamp is given in the request, then the Hosting CSE should send the primitive before the Result Expiration Timestamp. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.17 Using Filter Criteria for identification of target resources | 7.3.3.17.0 Introduction When the Filter Criteria primitive parameter is present in a request primitive, it shall be applied for identification of the applicable target resources of the respective operation. This may apply to Retrieve, Delete, Discovery and Semantic Resource Discovery operations as specified in clauses 7.3.3.6, 7.3.3.8, 7.3.3.14, and 7.3.3.18 respectively. The Filter Criteria primitive parameter defines conditions on resource attributes. Resources matching the conditions shall be selected as target of the operation. Table 7.3.3.17.0-1 summarizes the various filter criteria and conditions. Each row in the table represents a different filter condition type. If multiple conditions of the same type (i.e. same condition tag) are present in the Filter Criteria parameter, these shall be combined by applying logical OR operation. This applies to condition tags labels, resourceType, contentType or attribute for multiplicity n > 1. If multiple conditions of different type (i.e. different condition tags) are present in the Filter Criteria parameter, then the combined condition shall be derived by applying the logical operation specified by the filterOperation condition. By default logical AND operation shall be used if the filterOperation condition is not present. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 105 oneM2M TS-0004 version 2.7.1 Release 2 EXAMPLE: 1. labels=floor1, stateTagSmaller=3 will match if both conditions are true [default AND when filterOperation is not specified] 2. labels=floor1, stateTagSmaller=3, filterOperation=1 will match if both conditions are true 3. labels=floor1, stateTagSmaller=3, filterOperation=2 will match if either condition is true 4. labels=floor1, labels=floor2, filterOperation=1 will match if either condition is true [ filterOperation has no effect when all condition tags are the same] 5. labels=floor1, stateTagSmaller=3, labels=floor2, filterOperation=2 will match if any of these conditions are true resource has [labels with value "floor1" OR "floor2"] OR stateTagSmaller than 3. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 106 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.3.3.17.0-1: Summary on Filter conditions Condition Tag Multiplicity Targeted Resource Attribute Matching Condition createdBefore, 0..1 creationTime creationTime < createdBefore, see clause 7.3.3.17.1 createdAfter 0..1 createdAfter ≤ creationTime , see clause 7.3.3.17.1 unmodifiedSince 0..1 lastModifiedTime lastModifiedTime < unmodifiedSince, see clause 7.3.3.17.2 modifiedSince 0..1 unmodifiedSince ≤ lastModifiedTime, see clause 7.3.3.17.2 stateTagSmaller 0..1 stateTag stateTagSmaller < stateTag, see clause 7.3.3.17.3 stateTagBigger 0..1 stateTag ≤ stateTagBigger, see clause 7.3.3.17.3 expireBefore 0..1 expirationTime expirationTime < expireBefore, see clause 7.3.3.17.4 expireAfter 0..1 expireAfter ≤ expirationTime , see clause 7.3.3.17.4 labels 0..n labels see clause 7.3.3.17.5 resourceType 0..n resourceType see clause 7.3.3.17.6 sizeBelow 0..1 contentSize contentSize < sizeBelow, see clause 7.3.3.17.7 sizeAbove 0..1 sizeAbove ≤ contentSize, see clause 7.3.3.17.7 typeOfContent 0..n contentInfo matched with typeOfContent component in contentInfo, see clause 7.3.3.17.8 attribute 0..n (variable) name and value of Filter Criteria attribute matches resource attribute, see clause 7.3.3.17.9 limit 0..1 (not applicable) Constraint on maximum number of targeted resources, see clause 7.3.3.17.10 filterUsage 0..1 (not applicable) Indicator specifying the use case of Filter Criteria parameters semanticsFilter 0..n (not applicable) Filtering conditions expressed in SPARQL [i.6]. These are applicable to the descriptor attribute of <semanticDesciptor> children associated with discoverable resources. When multiple semanticsFilter elements are provided, the matching condition is fulfilled if any of the individual conditions is matched. filterOperation 0..1 (not applicable) Indicates the logical operation (AND/OR) to be used for different conditions. The default value is logical AND. contentFilterSyntax 0..1 (not applicable) Indicates the Identifier for syntax to be applied for content-based discovery. contentFilterQuery 0..1 content The query string shall be specified when contentFilterSyntax parameter is present. See clause 7.3.3.17.13 for applicable syntax for content-based discovery. level 0..1 (not applicable) Constraint on maximum number of levels in the resource tree that retrieve operation shall span, see clause 7.3.3.17.14. offset 0..1 (not applicable) The number of direct child and descendant resources the Hosting CSE shall skip over and not include within a retrieve response, see clause 7.3.3.17.15. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.17.1 Conditions on the creationTime attribute | The Filter Criteria elements createdBefore and createdAfter define a time interval which is tested against the creationTime attribute of the applicable resources. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 107 oneM2M TS-0004 version 2.7.1 Release 2 This filter criterion shall be satisfied if any of the following three conditions is fulfilled: 1) only createdBefore given in Filter Criteria: creationTime < createdBefore 2) only createdAfter given in Filter Criteria: createdAfter ≤ creationTime) 3) both, createdBefore and createdAfter given in Filter Criteria: (createdAfter ≤ creationTime) AND (creationTime < createdBefore) NOTE: In case 3) the Filter Criteria will only generate a match if createdAfter < createdBefore. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.17.2 Conditions on the lastModifiedTime attribute | The Filter Criteria elements lastModifiedBefore and lastModifiedAfter define a time interval which is tested against the lastModifiedTime attribute of the applicable resources. This filter criterion shall be satisfied if any of the following three conditions is fulfilled: 1) only unmodiedSince given in Filter Criteria: lastModifiedTime < unmodifiedSince 2) only modifiedSince given in Filter Criteria: modifiedSince ≤ lastModifiedTime 3) both, unmodifiedSince and modifiedSince given in Filter Criteria: (modifiedSince ≤ lastModifiedTime) AND (lastModifiedTime < unmodifiedSince)) NOTE: In case 3) the Filter Criteria will only generate a match if modifiedSince < unmodifiedSince. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.17.3 Conditions on stateTag attribute | The Filter Criteria elements stateTagSmaller and stateTagBigger define a number range which is tested against the stateTag attribute of the applicable resources. This filter criterion shall be satisfied if any of the following three conditions is fulfilled: 1) only stateTagSmaller given in Filter Criteria: stateTag < stateTagSmaller 2) only stateTagBigger given in Filter Criteria: stateTagBigger ≤ stateTag 3) both, stateTagSmaller and stateTagBigger given in Filter Criteria: (stateTagBigger ≤ stateTag) AND (stateTag < stateTagSmaller) NOTE: In case 3) the Filter Criteria will only generate a match if stateTagBigger < stateTagSmaller. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.17.4 Conditions on expirationTime attribute | The Filter Criteria elements expireBefore and expireAfter define a time interval which is tested against the expirationTime attribute of the applicable resources. This filter criterion shall be satisfied if any of the following three conditions is fulfilled: 1) only expireBefore given in Filter Criteria: expirationTime < expireBefore 2) only expiredAfter given in Filter Criteria: expireAfter ≤ expirationTime 3) both, expireBefore and expireAfter given in Filter Criteria: (expireAfter ≤ expirationTime) AND (expirationTime < expireBefore) ETSI ETSI TS 118 104 V2.7.1 (2016-10) 108 oneM2M TS-0004 version 2.7.1 Release 2 NOTE: In case 3) the Filter Criteria will only generate a match if expireAfter < expireBefore. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.17.5 Conditions on labels attribute | The Filter Criteria element labels defines a list of labels which is tested against the labels attribute of the applicable resource instances. This filter criterion shall be satisfied if any of the labels in Filter Criteria matches any of the labels in the respective resource attribute. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.17.6 Conditions on resourceType attribute | The Filter Criteria element resourceType defines a list of resource types which is tested against the resourceType attribute of the resource. This filter criterion shall be satisfied if any of the numbers in the resourceType Filter Criteria element matches the resourceType attribute. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.17.7 Conditions on contentSize attribute | The Filter Criteria elements sizeBelow and sizeAbove define a number range which is tested against the value of the contentSize attribute of applicable <contentInstance> resources. This filter criterion shall be satisfied if any of the following three conditions is fulfilled: 1) only sizeBelow given in Filter Criteria: contentSize < sizeBelow 2) only sizeAbove given in Filter Criteria: sizeAbove ≤ contentSize 3) both, sizeBelow and sizeAbove given in Filter Criteria: (sizeAbove ≤ contentSize) AND (contentSize < sizeBelow) NOTE: In case 3) the Filter Criteria will only generate a match if sizeAbove < sizeBelow. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.17.8 Conditions on typeOfContent of contentInfo attribute | The Filter Criteria element typeOfContent defines a string (or multiple such strings) which is compared against the contentInfo attribute of applicable <contentInstance> resources. One or multiple such typeOfContent elements may be included in the Filter Criteria parameter. This filter criterion shall be satisfied if any of the typeOfContent elements in Filter Criteria matches the typeOfContent part of the contentInfo attribute in a <contentInstance> resource. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.17.9 Conditions on attribute name and value pairs | The Filter Criteria elements attribute defines one or more pairs (attribute/name, attribute/value, see clause 6.3.4.8) that are compared against all applicable resource representations which include a resource attribute with a name as given in 'attribute/name'. This filter criterion shall be satisfied if any of the attribute elements in the Filter Criteria parameter matches both, attribute/name and attribute/value in any applicable resource representation. Attribute names used in any of the above specific conditions shall be omitted from this attribute name and value pair condition, i.e. the following attributes shall not be used for this condition as it may conflict with the explicit criteria defined for those attributes: creationTime, lastModifiedTime, stateTag, expirationTime, labels, resourceType, contentSize and contentInfo. The attribute value may include wildcard (*) in case of discovery requests. The wildcard (*) can match 0 or more characters. For example, a wildcard can be used within the value of a creator attribute condition (E.g.creator=CAE-ID* or creator=*ID123). ETSI ETSI TS 118 104 V2.7.1 (2016-10) 109 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.17.10 Constraint on number of retrieved resources by limit element | The limit element of the Filter Criteria parameter does not represent a filter condition. It imposes a limit on the number of resources that should be retrieved with the given Retrieve request primitive. The number of resources retrieved with the request primitive (and to be included into the corresponding response primitive) shall not exceed the number indicated in the limit element of the Filter Criteria parameter. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.17.11 Filter Usage request parameter | The filterUsage element of the Filter Criteria parameter does not represent a filter condition. It indicates how the Filter Criteria parameter shall be used. If this parameter is not provided, the Retrieve request primitive which includes this element triggers a generic retrieve operation. The data type of filterUsage is defined in clause 6.3.4.2.31. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.17.12 Filter Operation request attribute | The filterOperation element of the Filter Criteria parameter does not represent a filter condition. It indicates the logical operation to be performed between the condition tags when multiple condition tags of different types are specified. If this parameter is not provided logical AND operation shall be used by default. The data type of filterOperation is defined in clause 6.3.4.2.34. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.17.13 Conditions on content-based discovery | 7.3.3.17.13.1 Introduction The Filter Criteria elements contentFilterSyntax and contentFilterQuery are used for 'content based discovery'. The contentFilterSyntax element specifies the syntax to be used by the contentFilterQuery element to express the content-based discovery conditions. A contentFilterQuery shall be included if the contentFilterSyntax parameter is present. The contentFilterQuery element contains the query expression for content-based discovery. 7.3.3.17.13.2 JSON path syntax When the contentFilterySytax element has the value 'JSON_PATH_SYNTAX', the contentFilterQuery element shall be expressed using 'jsonpath query syntax' (see Annex K.2 oneM2M 0001[6]). If the Hosting CSE does not support this syntax, NOT_IMPLEMENTED error shall be returned. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.17.14 Constraint on number of applicable levels in resource tree | The level element of the Filter Criteria parameter does not represent a filter condition. It imposes a maximum limit on the depth of child resources in the resource tree that the Hosting CSE shall perform a Retrieve request upon. The level of 1 shall indicate the direct child resources. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.17.15 Constraint on number of resources to skip over in retrieve response | The offset element of the Filter Criteria parameter does not represent a filter condition. It specifies the number of direct child resources and their descendants that the Hosting CSE shall skip over and not include within the response to a Retrieve request primitive. An offset of 1 shall indicate the first direct child resource. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.18 Semantic resource discovery | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.18.0 Introduction | Semantic resource discovery is used to find resources in a CSE based on the semantic descriptions contained in the descriptor attribute of <semanticDescriptor> resources. Since an overall semantic description (forming a graph [i.5]) may be distributed across a set of <semanticDescriptor> resources, the semantic descriptions have to be retrieved (before or as needed) during the execution of the discovery request. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 110 oneM2M TS-0004 version 2.7.1 Release 2 Semantic resource discovery is initiated by sending a Retrieve request with the discovery criteria in the semanticsFilter parameter(s) with two alternatives: a) Targeting a <semanticFanOutPoint> virtual resource, see clause 7.4.35. b) Targeting a resource other than <semanticFanOutPoint>. In this alternative the semantic resource discovery request procedure shall be comprised of the following actions: Originator: The Originator shall follow the steps from Orig-1.0 to Orig-6.0 specified in clause 7.2.2.1 Generic Resource Request Procedure for Originator. In addition to Orig-1.0, the following steps shall be performed. The To parameter in the Retrieve Request shall indicate the root of where the semantic discovery begins. The filterCriteria of the Retrieve Request shall include the filterUsage parameter configured as "discovery" and the semanticsFilter parameter. Receiver: The Receiver shall follow the steps from Recv-1.0 to Recv-7.0 specified in clause 7.2.2.2 Generic Resource Request Procedure for Receiver. After Recv-1.0 "Check the validity of received request primitive": check that the syntax of the semanticsFilter corresponds to a valid SPARQL query request [33]. If the semanticsFilter content does not correspond to a valid SPARQL query request, the Receiver shall generate a Response Status Code indicating a "NOT_ACCEPTABLE" error. The Hosting CSE shall follow the steps from Recv-1.0 to Recv-6.2 specified in clause 7.2.2.2.The Hosting CSE shall not perform steps from Recv-6.3 to Recv-6.6 and perform the following steps instead: 1) The Hosting CSE shall find the <semanticDescriptor> resource(s) to which the Originator has "Discover" access right, under the addressed resource. If the relatedSemantics attribute does not exist, the "Annotation-based method" (using resourceDescriptorLink) detailed in clause 7.3.3.18.1 shall be used. If the relatedSemantics attribute exists the "Resource link-based method" (using the relatedSemantics attribute) detailed in clause 7.3.3.18.2 shall be used. 2) The Hosting CSE shall perform Recv-6.7 "Create a success response" where the Response shall include the resources matched based on the SPARQL engine result. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.18.1 Annotation-based method | In the annotation-based method, related <semanticDescriptor> resources are identified within the RDF semantic description itself using a special annotation property called m2m:resourceDescriptorLink. This property points to another <semanticDescriptor> resource which may contain relevant information for matching the semantic filter. Whenever, during the execution of the SPARQL request (on the semantic description in the descriptor attribute of the <semanticDescriptor>) such an annotation property is found, the execution is halted, the content of the descriptor attribute of the referred to <semanticDescriptor> is retrieved, and the execution is continued on the combined content of the already present and the just retrieved semantic information. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.3.18.2 Resource link-based method | In this option, the relatedSemantics attribute contains the list of <semanticDescriptor> resources which shall be retrieved for the purpose of creating the overall graph against which the SPARQL request is executed. The Hosting CSE retrieves the <semanticDescriptor> child resource of the request target and the addresses provided in the relatedSemantics attribute. For each address from the relatedSemantics list the Hosting CSE: • checks that the Originator has "Discover" access rights, and the existence of the addressed resource. • retrieves the description in the descriptor attribute under the addressed resource. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 111 oneM2M TS-0004 version 2.7.1 Release 2 The Hosting CSE shall aggregate all the retrieved descriptors and deliver the content for SPARQL request processing, along with the semanticFilter content. NOTE: In the resource link-based method, no actions need to be performed during the execution of the SPARQL request if the notation property onem2m:resourceDescriptorLink is encountered. Afterwards, the Hosting CSE performs Recv-6.7 "Create a success response" where the Response shall include the resources matched based on the SPARQL engine result.. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.4 Management common operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.3.4.1 Identify the managed entity and the technology specific protocol | The Hosting CSE shall identify the managed entity to be managed via the <node> resource which is the parent resource in case of an addressed <mgmtObj> resource. In case of a <mgmtCmd> resource the entity to be managed is indicated in the execTarget attribute which addresses either a <node> resource or a group of resources of type <node>. Hence, in all cases the managed entity is ultimately identified through the <node> resource, from which the identifier of the device can be retrieved. Then the Hosting CSE shall determine the technology specific protocol to be used for communicating with the managed entity based on the objectID of the addressed <mgmtObj> resource. If the managed entity cannot be identified, the Hosting CSE shall reject the request with the Response Status Code indicating "EXTERNAL_OBJECT_NOT_REACHABLE" in the Response primitive. 7.3.4.2 Locate the technology specific data model objects to be managed on the managed entity The Hosting CSE shall locate the technology specific data model object to be managed on the managed entity by the objectPaths attribute of the <mgmtObj> resource addressed by the URI provided in the To primitive parameter. In the case that the To addresses an [objectAttribute], the Hosting CSE shall locate the technology specific data model object on the managed entity through the objectPaths attribute of the <mgmtObj> resource of the addressed [objectAttribute], combined with their relative position in the technology specific data model object tree. If the technology specific data model object cannot be located, the Hosting CSE shall reject the request with the Response Status Code indicating "EXTERNAL_OBJECT_NOT_FOUND" in the Response primitive. In the case that the management server is external to the Hosting CSE, the Hosting CSE shall identify the management server that is capable of performing the operation on the technology specific data model object. If the management server cannot be identified, the Hosting CSE shall reject the request with the Response Status Code indicating "EXTERNAL_OBJECT_NOT_REACHABLE" in the Response primitive. 7.3.4.3 Establish a management session with the managed entity or management server In the case that the management server is embedded with the CSE, if there is no existing management session between the Hosting CSE and the managed entity, the Hosting CSE shall also trigger the managed entity to establish a management session with the Hosting CSE by sending triggering message to the managed entity using the determined technology specific protocol in case such triggering mechanism is supported by the technology specific protocol. If the triggering mechanism is not supported by the technology specific protocol, the Hosting CSE shall reject the request with the Response Status Code indicating "MGMT_SESSION_CANNOT_BE_ESTABLISHED". If the management session cannot be established with the managed entity, the Hosting CSE shall reject the request with the Response Status Code indicating "MGMT_SESSION_CANNOT_BE_ESTABLISHED". If the management session cannot be established within a limited time span as per local policy, the Hosting CSE shall reject the request with the Response Status Code indicating "MGMT_SESSION_ESTABLISHMENT_TIMEOUT" in the Response primitive. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 112 oneM2M TS-0004 version 2.7.1 Release 2 In the case that the management server is external to the Hosting CSE, if there is no existing management session between the Hosting CSE and the management server that manages the technology specific data model objects, the Hosting CSE shall establish a session with the managed entity with the necessary access control privileges to perform the technology specific request on the technology specific protocol.. If the management session cannot be established with the management server, the Hosting CSE shall reject the request with Response Status Code indicating "MGMT_SESSION_CANNOT_BE_ESTABLISHED". If the management session cannot be established within a limited time span as per local policy, the Hosting CSE shall reject the request with Response Status Code indicating "MGMT_SESSION_ESTABLISHMENT_TIMEOUT" in the Response primitive. 7.3.4.4 Send the management request(s) to the managed entity corresponding to the received Request primitive The Hosting CSE shall send the management request(s) to the managed entity or management server in the established management session in order to perform the management operation as requested by the received Request primitive. The management request shall address the technology specific data model object on the managed entity as determined in clause 7.3.4 or in the primitive specific clauses. The management request being used is specific to the technology specific protocol according to a pre-defined mapping relationship with the Request primitive. The internal data structure of the technology specific data model object addressed by the technology specific request shall be determined based on the mapping relationship of the <mgmtObj>, or <mgmtCmd> resources and the technology specific data model objects or based on the generic mapping rule as specified in ETSI TS 118 101 [6] clauses, 9.6.15, 9.6.16 and 9.6.17. The Hosting CSE shall extract the management results received from the managed entity or management server in order to prepare a Response primitive to be sent to the originator later. Unless explicitly stated, if the management request cannot be performed successfully, the Hosting CSE shall reject the Request primitive with the management server in the Response primitive according to the mapping relationship with the technology specific protocol. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4 Resource type-specific procedures and definitions | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.0 Introduction | This clause specifies the structure of each individual resource type and the resource type specific details of procedures (i.e. differences from the generic procedures specified in clauses 7.2 and 7.3) to be performed by the originator and receiver of a request message. The applicability of each of the following resource type-specific procedures to an interface reference point (i.e. Mca, Mcc and Mcc') is defined in clause 10.2 (Resource Type-Specific Procedures) of ETSI TS 118 101 [6]. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.1 Resource type specification conventions | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.1.1 Resource type definition conventions | This clause provides general information on conventions applied to resource type specifications and how to interpret the provided information. Each resource type is defined in a tabular format as shown in the tables below. A reference to the XSD file associated with the given resource type is provided in the format shown in table 7.4.1.1-1. Further information on usage and limitations of the XSD is given in clause 6.1. Table 7.4.1.1-2: Data type definition of <resourceType> Data Type ID File Name Note Actual Data Type ID XSD file name Information about universal/common resource attributes of a resource type is provided in the format shown in table 7.4.1.1-3. The column "Request optionality" specifies the presence of each resource attribute in the Content parameter of the request primitive. This is defined as Mandatory (M), Optional (O), or NP (Not Present). The table applies only to Create and Update operations. A Retrieve request operation may include a Content parameter containing a list of attribute names to be retrieved. A Delete request shall not include a Content parameter. Universal/common resource attributes do not have any default value. However, value restrictions and notes given in Table 6.3.6-1 apply. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 113 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.1.1-4: Universal/Common Attributes of <resourceType> resource Attribute Name Request Optionality Create Update Universal/common attribute name M/O/NP O/NP Information about resource specific attributes of the resource type is provided in the format shown in Table 7.4.1.1-3. Request optionality shall be interpreted the same way as described for universal/common attributes above. Table 7.4.1.1-5: Resource Specific Attributes of <resourceType> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update resource specific attribute name M/O/NP O/NP Assigned XSD datatype Applicable constraints on attribute values and default value if applicable Request primitives shall comply with the request optionality of universal/common and resource specific attributes in Create and Update request primitives as defined for each individual resource type in the following clauses. The values of each resource attribute shall comply with its assigned datatype and any indicated constraints. See clause 6.1 for limitations on using the XSD files associated with the resource type for validation of compliance. Table 7.4.1.1-4 provides the information of child resources of the resource type. Table 7.4.1.1-6: Child resources of <resourceType> resource Child Resource Type Child Resource Name Multiplicity Ref. to Resource Type Definition <resourceType> "[variable]" or fixed name Multiplicity of child resource instances in the corresponding resource type Reference to the resource type definition in the present document. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.1.2 Resource type-specific procedure conventions | This clause describes resource type specific procedures referring generic procedures defined in clause 7.2.2. Each operation specific procedure describes procedures for the Originator and the Receiver. If the resource and operation specific procedure is the same as the generic procedure, the Originator and Receiver procedure refer to them. Otherwise, the deviation/addition is clearly described with related procedure numbers (e.g. Recv 6.1) in clause 7.2.2. If a deviation/addition procedure includes sub-procedures in one more level(s), proper numbering is used to show the levels (e.g. "1)", "a)"). If sub-procedures do not care the order, bullets are used instead of numbers |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.2 Resource type <accessControlPolicy> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.2.1 Introduction | The <accessControlPolicy> resource is comprised of privileges and selfPrivileges attributes which represent a set of access control rules defining which entities (defined as accessControlOriginators) have the privilege to perform certain operations (defined as accessContolOperations) within specified contexts (defined as accessControlContexts) and are used by the CSEs in making access decision to specific resources. The detailed description can be found in clause 9.6.2 in ETSI TS 118 101 [6]. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 114 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.2.1-1: Data type definition of <accessControlPolicy> resource Data Type ID File Name Note accessControlPolicy CDT-accessControlPolicy-v2_7_0.xsd Table 7.4.2.1-2: Universal/Common Attributes of <accessControlPolicy> resource Attribute Name Request Optionality Create Update @resourceName O NP resourceType NP NP resourceID NP NP parentID NP NP expirationTime O O labels O O creationTime NP NP lastModifiedTime NP NP announceTo O O announcedAttribute O O Table 7.4.2.1-3: Resource Specific Attributes of <accessControlPolicy> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update privileges M O m2m:setOfAcrs No default selfPrivileges M O m2m:setOfAcrs No default The following table includes the information of child resources of the resource type. Table 7.4.2.1-4: Child Resources of <accessControlPolicy> 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.2.2 accessControlPolicy resource specific procedure on CRUD operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.2.2.0 Introduction | This sub-clause describes accessControlPolicy resource specific behaviour for CRUD operations. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.2.2.1 Create | Originator: No changes 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.2.2.2 Retrieve | Originator: No changes 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) 115 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.2.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.2.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.3 Resource Type <CSEBase> | 7.4.3.1 Introduction A <CSEBase> resource shall represent a CSE. This <CSEBase> resource shall be the root for all the resources that are residing on the CSE. The detailed description can be found in clause 9.6.3 in ETSI TS 118 101 [6]. Table 7.4.3-1: Data type definition of <CSEBase> resource Data Type ID File Name Note CSEBase CDT-CSEBase-v2_7_0.xsd The value of the parentID attribute for the <CSEBase> resource shall be an empty string since the <CSEBase> resource does not have a parent. Table 7.4.3-2: Resource Specific Attributes of <CSEBase> resource Attribute Name Data Type Default Value and Constraints cseType m2m:cseTypeID No default CSE-ID m2m:ID No default supportedResourceT ype list of m2m:resourceType No default pointOfAccess m2m:poaList No default nodeLink xs:anyURI No default dynamicAuthorization ConsultationIDs list of xs:anyURI No default e2eSecInfo m2m:e2eSecInfo No default ETSI ETSI TS 118 104 V2.7.1 (2016-10) 116 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.3-3: Child resources of <CSEBase> resource Child Resource Type Child Resource Name Multiplicity Ref. to Resource Type Definition <remoteCSE> [variable] 0..n Clause 7.4.4 <remoteCSEAnnc> [variable] 0..n Clause 7.4.4 <node> [variable] 0..n Clause 7.4.18 <AE> [variable] 0..n Clause 7.4.5 <container> [variable] 0..n Clause 7.4.6 <group> [variable] 0..n Clause 7.4.13 <accessControlPolicy> [variable] 0..n Clause 7.4.2 <subscription> [variable] 0..n Clause 7.4.8 <mgmtCmd> [variable] 0..n Clause 7.4.16 <locationPolicy> [variable] 0..n Clause 7.4.10 <statsConfig> [variable] 0..n Clause 7.4.23 <statsCollect> [variable] 0..n Clause 7.4.25 <request> [variable] 0..n Clause 7.4.12 <delivery> [variable] 0..n Clause 7.4.11 <schedule> [variable] 0..1 Clause 7.4.9 <m2mServiceSubscriptionPolicy [variable] 0..n Clause 7.4.19 <serviceSubscribedAppRule> [variable] 0..n Clause 7.4.29 <notificationTargetPolicy> [variable] 0..n Clause 7.4.31 <dynamicAuthorizationConsultation > [variable] 0..n Clause 7.4.36 <flexContainer> [variable] 0..n Clause 7.4.37 <timeSeries> [variable] 0..n Clause 7.4.38 <role> [variable] 0..n Clause 7.4.40 <token> [variable] 0..n Clause 7.4.41 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.3.2 <CSEBase> resource specific procedure on CRUD+N operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.3.2.1 Create | Originator: The <CSEBase> resource shall not be created via API. Receiver: Primitive specific operation on Recv-1.0 "Check the syntax of received message": 1) 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. b) "Send the Response primitive". |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.3.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. 7.4.3.2.3 Update Originator: The <CSEBase> resource shall not be updated via API. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 117 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, 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". |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.3.2.4 Delete | Originator: The <CSEBase> resource shall not be DELETEed via API. Receiver: Primitive specific operation on Recv-1.0 "Check the syntax of received message": 1) 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. 1) "Send the Response primitive". |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.3.2.5 Notify | 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.4 Resource Type <remoteCSE> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.4.1 Introduction | A <remoteCSE> resource shall represent a remote CSE that is registered to the Registrar CSE. <remoteCSE> resources shall be located directly under the <CSEBase>. Conversely each registered CSE shall also be represented as a sub-set of <remoteCSE> resource in the registering CSE's <CSEBase>. The detailed description can be found in clause 9.6.4 in ETSI TS 118 101 [6]. Table 7.4.4.1-1: Data type definition of <remoteCSE> resource Data Type ID File Name Note remoteCSE CDT-remoteCSE-v2_7_0.xsd ETSI ETSI TS 118 104 V2.7.1 (2016-10) 118 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.4.1-2: Universal/Common Attributes of <remoteCSE> 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 dynamicAuthorization ConsultationIDs O O Table 7.4.4.1-3: Resource Specific Attributes of <remoteCSE> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update cseType O NP m2m:cseTypeID No default pointOfAccess O O m2m:poaList No default CSEBase M NP xs:anyURI No default CSE-ID M NP m2m:ID No default M2M-Ext-ID O O m2m:externalID No default Trigger-Recipient-ID O O m2m:triggerRecipientID No default requestReachability M O xs:boolean No default nodeLink O O xs:anyURI No default triggerReferenceNum ber O O xs:unsignedInt No default e2eSecInfo O O m2m:e2eSecInfo No default Table 7.4.4.1-4: Child resources of <remoteCSE> resource Child Resource Type Child Resource Name Multiplicity Ref. to Resource Type Definition <container> [variable] 0..n Clause 7.4.6 <containerAnnc> [variable] 0..n Clause 7.4.6 <flexContainer> [variable] 0..n Clause 7.4.37 <flexContainerAnnc> [variable] 0..n Clause 7.4.37 <group> [variable] 0..n Clause 7.4.13 <groupAnnc> [variable] 0..n Clause 7.4.13 <accessControlPolicy> [variable] 0..n Clause 7.4.2 <accessControlPolicyAnnc> [variable] 0..n Clause 7.4.2 <subscription> [variable] 0..n Clause 7.4.8 <pollingChannel> [variable] 0..1 Clause 7.4.21 <schedule> [variable] 0..1 Clause 7.4.9 <nodeAnnc> [variable] 0..n Clause 7.4.36 <dynamicAuthorizationConsultation> [variable] 0..n Clause 7.4.36 <flexContainer> [variable] 0..n Clause 7.4.37 <timeSeries> [variable] 0..n Clause 7.4.38 <timeSeriesAnnc> [variable] 0..n Clause 7.4.38 <remoteCSEAnnc> [variable] 0..n Clause 7.4.4 <AEAnnc> [variable] 0..n Clause 7.4.5 <locationPolicyAnnc> [variable] 0..n Clause 7.4.10 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 119 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.4.2 <remoteCSE> resource specific procedure on CRUD operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.4.2.0 Introduction | The entire CSE registration procedure including <CSE> resource creation procedure below is defined in clause 10.1.1.2.1 [6] ("CSE registration procedure"). |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.4.2.1 Create | Originator: No change from the generic procedures in clause 7.2.2.1 with the following exception: • An AE shall not originate a Create <remoteCSE> resource request. Receiver: Same as the generic procedures in clause 7.2.2.2 except replacement of Recv-6.3 step with following: 1) The Hosting CSE shall check if the credential provided by the Originator is valid. 2) If the check is failed, then the Hosting CSE shall return response primitive with a Response Status Code indicating "SECURITY_ASSOCIATION_REQUIRED" error. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.4.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.1. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.4.2.3 Update | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.1. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.4.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.1. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.5 Resource Type <AE> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.5.1 Introduction | The <AE> resource represents information about an Application Entity known to a given Common Services Entity. The detailed description can be found in clause 9.6.5 in ETSI TS 118 101 [6]. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 120 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.5.1-1: Data type definition of <AE> resource Data Type ID File Name Note AE CDT-AE-v2_7_0.xsd XSD schema for AE resource Table 7.4.5.1-2: Universal/Common Attributes of <AE> 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 dynamicAuthorization ConsultationIDs O O Table 7.4.5.1-3: Resource Specific Attributes of <AE> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update appName O O xs:string No default App-ID M NP xs:string No default AE-ID NP NP m2m:ID No default pointOfAccess O O m2m:poaList No default ontologyRef O O xs:anyURI No default nodeLink O O xs:anyURI No default requestReachability M O xs:boolean No default contentSerialization O O m2m:serializations No default e2eSecInfo O O m2m:e2eSecInfo No default Table 7.4.5.1-4: Child resources of <AE> resource Child Resource Type Child Resource Name Multiplicity Ref. to Resource Type Definition <subscription> [variable] 0..n Clause 7.4.8 <container> [variable] 0..n Clause 7.4.6 <group> [variable] 0..n Clause 7.4.13 <accessControlPolicy> [variable] 0..n Clause 7.4.2 <pollingChannel> [variable] 0..n Clause 7.4.21 <schedule> [variable] 0..1 Clause 7.4.9 <semanticDescriptor> [variable] 0..n Clause 7.4.34 <dynamicAuthorizationConsultation> [variable] 0..n Clause 7.4.36 <flexContainer> [variable] 0..n Clause 7.4.37 <timeSeries> [variable] 0..n Clause 7.4.38 <trafficPattern> [variable] 0..n Clause 7.4.42 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 121 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.5.2 <AE> resource specific procedure on CRUD+N operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.5.2.0 Introduction | This sub-clause describes AE resource specific behaviour for CRUD+N operations. The entire AE registration procedure including <AE> resource creation procedure below is defined in clause 10.1.1.2.2 of ETSI TS 118 101 [6] ("Application Entity registration procedure"). |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.5.2.1 Create | Originator: No change from the generic procedures in clause 7.2.2.1 with the with the following exception: • A CSE shall not originate a Create <AE> resource request. Receiver: Same as the generic procedures in clause 7.2.2.2 except replacement of Recv-6.3 procedure as follows: 1) The <serviceSubscribedNode> resource associated with the Hosting CSE shall be checked, using credential provided by the Originator, to determine if the requested registration is allowed by any of <serviceSubscribedAppRule> resources which are linked from the ruleLinks attribute. 2) If the check is failed, then the Hosting CSE shall return response primitive with a Response Status Code indicating "SECURITY_ASSOCIATION_REQUIRED" error. Additional primitive specific operation on Recv-6.0.1"Receiver is Registrar CSE, Originator is AE and operation is create?": 1. If the request is for an <AE> resource and if it is received at a MN-CSE or ASN-CSE with AE-ID-Stem starting with "S" but no specific AE-ID-Stem was provided with the CREATE request of the Registree AE, then the receiver shall execute the following steps in order. o Compose a Create <AEAnnc> Request primitive with the following attribute values The link attribute of the <AEAnnc> resource to be created shall be set to the SP-Relative- Resource-ID format of a - not yet existent - <AE> resource hosted on the Registrar CSE constructed with a Unstructured-CSE-relative-Resource-ID that is equal to the AE-ID-Stem value used for the Registree AE. The App-ID attribute of the <AEAnnc> resource to be created shall be present and set to the App-ID attribute value of the Registree AE. The concatenation of the string 'Credential-ID:' and the actual Credential-ID of the Security Association used by the Registree AE - if any - shall be placed into the labels attribute of the <AE Annc> resource. If no noSecurity Association was used by the Registree AE, a value of 'None' shall be used for Credential-ID. o The From parameter of the CREATE request for the <AEAnnc> resource shall be set to the SP- relative-AE-ID format of the AE-ID. o Send Create request to the IN-CSE that is associated with the Registree AE. o Wait for Response primitive. Upon reception of a successful response from the IN-CSE, the Registrar/Host CSE shall use the Unstructured-CSE-relative-Resource-ID that was used for the <AEAnnc> resource on the IN-CSE also as the assigned Unstructured-CSE-relative-Resource-ID for the <AE> resource to be created on the Registrar/Host CSE. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 122 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.5.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.5.2.3 Update | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: No change from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.5.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 with the with the following addition: Primitive Specific operation on Recv-6.6 "Announce/De-announce the resource": 1. If the request is for an <AE> resource and if it is received at a MN-CSE or ASN-CSE with AE-ID-Stem starting with "S" the receiver shall execute the following steps in order. a) Compose the Update <AEAnnc> Request primitive with link attribute set to NULL. b) Send Update request to the announced to IN-CSE. c) Wait for Response primitive. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.5.2.5 Notify | 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.6 Resource Type <container> | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.6.1 Introduction | This resource represents a container for data instances. It is used to share information among other entities and potentially to track the data. A <container> resource has no associated content, only attributes and child resources. The detailed description can be found in clause 9.6.6 in ETSI TS 118 101 [6]. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 123 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.4.6.1-1: Data type definition of <container> resource Data Type ID File Name Note container CDT-container-v2_7_0.xsd Table 7.4.6.1-2: Universal/Common Attributes of <container> 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 stateTag NP NP labels O O announceTo O O announcedAttribute O O dynamicAuthorization ConsultationIDs O O creator O NP Table 7.4.6.1-3: Resource Specific Attributes of <container> resource Attribute Name Request Optionality Data Type Default Value and Constraints Create Update maxNrOfInstances O O xs:nonNegativeInteger No default maxByteSize O O xs:nonNegativeInteger No default maxInstanceAge O O xs:nonNegativeInteger No default currentNrOfInstances NP NP xs:nonNegativeInteger No default (This is generated by the Hosting CSE and limited by the maxNrOfInstances) currentByteSize NP NP xs:nonNegativeInteger No default (This is generated by the Hosting CSE and limited by the maxByteSize) locationID O O xs:anyURI No default ontologyRef O O xs:anyURI No default disableRetrieval O NP xs:boolean Default value is false, when the parameter is not specified. Table 7.4.6.1-4: Child resources of <container> resource Child Resource Type Child Resource Name Multiplicity Ref. to in Resource Type Definition <contentInstance> [variable] 0..n Clause 7.4.7 <subscription> [variable] 0..n Clause 7.4.8 <container> [variable] 0..n Clause 7.4.6 <latest> latest 1 Clause 7.4.27 <oldest> oldest 1 Clause 7.4.28 <semanticDescriptor> [variable] 0..n Clause 7.4.34 <flexContainer> [variable] 0..n Clause 7.4.37 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 124 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.6.2 <container> resource specific procedure on CRUD operations | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.6.2.0 Introduction | This clause describes container resource specific behaviour for CRUD operations. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.6.2.1 Create | Originator: No change from the generic procedures in clause 7.2.2.1. Receiver: Primitive specific operation on Recv-6.4 is performed with following exceptions for optional attributes while executing procedures defined in clause 7.3.3.3. The Hosting CSE may assign default values based on local policy for optional attributes maxNrOfInstances , maxByteSize and maxInstanceAge. If the maxNrOfInstances , maxByteSize or maxInstanceAge attributes are present in the resource representation, but their value indicates an invalid value, then the request shall be rejected with a Response Status Code indicating "BAD_REQUEST" error. There are two cases where the Hosting CSE shall configure or overrride a maxNrOfInstances , maxByteSize or maxInstanceAge value specified in the resource representation (if present). 1) The Originator does not specify a value 2) The Hosting CSE determines the maxNrOfInstances , maxByteSize or maxInstanceAge requested by the Originator does not meet its requirements (e.g. based on a local policy) In these cases, the Hosting CSE shall configure a maxNrOfInstances , maxByteSize or maxInstanceAge into the resource according to local policy. In addition, the Hosting CSE shall communicate the modified value back to the originator in the response if the Result Content parameter permits this. No other changes from the generic procedures in clause 7.2.2.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.4.6.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.6.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.6.2.4 Delete | Originator: No change from the generic procedures in clause 7.2.2.1. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 125 oneM2M TS-0004 version 2.7.1 Release 2 Receiver: No change from the generic procedures 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.