hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.26.3 Common Attributes for Announced Resources | Table 9.6.26.3-1 lists the common attributes for the announced resources. Table 9.6.26.3-1: Commonly Used Attributes for Announced Resources Attribute Name Mandatory /Optional Description accessControlPolicyIDs Conditionally Mandatory The list of identifiers (either an ID or a URI) of an <accessControlPolicy> resource announced by the original resource See clause 9.6.1.3.2 for further information on this attribute. If this attribute was not present in the original resource, the original resource shall include this attribute by providing the accessControlPolicyIDs from the original resource's parent resource or from the local policy according at the original resource. stateTag Conditionally Mandatory An incremental counter of modification on the resource. See clause 9.6.1.3.2 for information on this attribute. labels Conditionally Mandatory Tokens used as keys for discovering resources as announced by the original resource. See clause 9.6.1.3 for further information on this attribute. The attribute is conditionally mandatory, which means that the attribute shall exist in the announced resource if it is present in the original resource. registrationStatus Optional Only optional for announced <AE> resource. Denotes status of the announced AE registration. If ACTIVE, the announced <AE> resource and all its child resources may be discoverable. If INACTIVE, the announced <AE> registration and all its child resources shall not be discoverable. The attribute is conditionally mandatory, which means that the attribute shall exist in the announced resource if it is present in the original resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 200 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.27 Resource Type latest | The <latest> resource is a virtual resource because it does not have a representation. It is the child resource of a <container>, <timeSeries>or <flexContainer> resource. When a request addresses the <latest> resource, the Hosting CSE shall apply the request to the latest <contentInstance>, <timeSeriesInstance> or <flexContainerInstance> resource among all existing <contentInstance>, <timeSeriesInstance> or <flexContainerInstance> resources of the <container> or <timeSeries> or <flexContainer> resource. The <latest> resource inherits access control policies that apply to the parent resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.28 Resource Type oldest | The <oldest> resource is a virtual resource because it does not have a representation. It is the child resource of a <container>, <timeSeries> or <flexContainer> resource. When a request addresses the <oldest> resource, the Hosting CSE shall apply the request to the oldest <contentInstance>, <timeSeriesInstance> or <flexContainerInstance> resource among all existing <contentInstance>, <timeSeriesInstance> or <flexContainerInstance> resources of the <container>, <timeSeries> or <flexContainer> resource. The <oldest> resource inherits access control policies that apply to the parent resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.29 Resource Type serviceSubscribedAppRule | The <serviceSubscribedAppRule> resource represents a rule that defines allowed Role-ID, App-ID and AE-ID combinations that are acceptable for registering an AE on a Registrar CSE and is only stored on IN-CSE. In addition, the <serviceSubscribedAppRule> resource also represents a rule that defines the users that are allowed to issue requests via the allowed AEs defined by this resource. The rules in a <serviceSubscribedAppRule> resource shall apply for CSEs for which the associated <serviceSubscribeNode> resource is linked with the <serviceSubscribedAppRule> via the ruleLinks attribute of the <serviceSubscribedNode> resource. The rules contained in a <serviceSubscribedAppRule> resource defines a mapping between: a) one or more Credential-ID(s); b) combinations of one or more Role-ID(s), one or more App-ID(s) and one or more AE-ID(s) which are allowed to be used for registering AE(s) that issued a registration request via a Security Association established with the credentials associated with the Credential-ID(s) listed in a); and c) a list of identifiers of <serviceSubscribedUserProfile> resources that represent the users that are allowed to issue requests via the allowed AEs defined by this resource. When AEs are allowed to register with no Security Association, then a Credential-ID is not applicable. The parent resource of a <serviceSubscribedAppRule> resource is the <CSEBase> resource of the IN-CSE hosting the <serviceSubscribedNode> resource(s) that point to the <serviceSubscribedAppRule> resource. The <serviceSubscribedAppRule> resource shall contain the child resource specified in table 9.6.29-1. Table 9.6.29-1: Child resources of <serviceSubscribedAppRule> resource Child Resources of <serviceSubscribedAppRule> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 where the type of this resource is described. [variable] <transaction> 0..n See clause 9.6.48. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 201 (oneM2M TS-0001 version 4.15.0 Release 4) The <serviceSubscribedAppRule> resource shall contain the attributes specified in table 9.6.29-2. Table 9.6.29-2: Attributes of <serviceSubscribedAppRule> resource Attributes of <serviceSubscribedAppRule> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3 lastModifiedTime 1 RO See clause 9.6.1.3. dynamicAuthorizationConsultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. applicableCredIDs 0..1 (L) RW List of credential IDs for which this rule is applicable, i.e. for registration requests coming into a CSE via a Security Association Endpoint (SEA) [2], that was authenticated using credentials that match with any of these credential-IDs, the current rule applies. This can contain a '*' for any credential ID or not specified' for a case when there is no security association. Also Wildcards within an element of this list are possible (e.g. 'C123*X' for any Credential ID that starts with 'C123' and ends with 'X') to define sets or ranges of Credential-IDs. allowedApp-IDs 0..1 (L) RW List of App-IDs that shall be considered to be allowed for AE registration requests received via Security Association Endpoint (SEA) [2] associated with credentialID stored in the attribute applicableCredID. This can contain '*' for any App-ID. Also Wildcards within an element of this list are possible (e.g. 'C123*X' for any App-ID that starts with 'C123' and ends with 'X') to define sets or ranges of App-IDs. allowedAEs 0..1 (L) RW List of allowed AE-ID-Stems to be used for the registering AEs. This can contain zero or more specific AE-ID-Stem values, 'S*' for any SP- Assigned AE-ID-Stem, 'C*' for any CSE-assigned AE-ID-Stem, or '*' for any AE-ID-Stem. Also Wildcards within an element of this list are possible (e.g. 'C123*X' for any AE-ID that starts with 'C123' and ends with 'X') to define sets or ranges of AE-ID-Stems. allowedRole-IDs 0..1(L) RW List of Role-IDs that shall be considered to be allowed in Request operations. allowedUsers 0..1 (L) RW A list of identifiers of <serviceSubscribedUserProfile> resources. The M2M Service Users specified within the M2M-User-ID attributes of the referenced <serviceSubscribedUserProfile> resources represent the users that are allowed to issue requests via the allowed AEs defined by this resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.30 Resource Type semanticDescriptor | The <semanticDescriptor> resource is used to store a semantic description pertaining to a resource and potentially sub-resources. Such a description may be provided according to ontologies. The semantic information is used by the semantic functionalities of the oneM2M system and is also available to applications or CSEs. [i.28] provides an informative example of a descriptor attribute. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 202 (oneM2M TS-0001 version 4.15.0 Release 4) The <semanticDescriptor> resource shall contain the child resources specified in table 9.6.30-1. Table 9.6.30-1: Child resources of <semanticDescriptor> resource Child Resources of <semanticDescriptor> Child Resource Type Multiplicity Description <semanticDescript orAnnc> Child Resource Types [variable] <subscription> 0..n See clause 9.6.8 where the type of this resource is described. <subscription> [variable] <transaction> 0..n See clause 9.6.48. <transaction> The <semanticDescriptor> resource shall contain the attributes specified in table 9.6.30-2. Table 9.6.30-2: Attributes of <semanticDescriptor> resource Attributes of <semanticDescriptor> Multiplicity RW/ RO/ WO Description <semanticDescrip torAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA lastModifiedTime 1 RO See clause 9.6.1.3. NA labels 0..1 (L) RW See clause 9.6.1.3. MA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationCo nsultationIDs 0..1 (L) RW See clause 9.6.1.3. OA creator 0..1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA descriptorRepresentatio n 1 RW Indicates the type used for the serialization of the descriptor attribute, e.g. RDF/XML, OWL/XML. OA semanticOpExec 0..1 RW This attribute cannot be retrieved. Contains a SPARQL query request for execution of semantic operations on the descriptor attribute e.g. SPARQL update as described in [3]. NA descriptor 1 RW Stores a semantic description pertaining to a resource and potentially sub-resources. Such a description shall be according to subject-predicate-object triples as defined in the RDF graph-based data model [4]. Examples of such descriptors in RDF can be found in [i.28]. OA ontologyRef 0..1 WO A reference (URI) of the ontology used to represent the information that is stored in the descriptor attribute. If this attribute is not present, the ontologyRef from the parent resource is used if present. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 203 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <semanticDescriptor> Multiplicity RW/ RO/ WO Description <semanticDescrip torAnnc> Attributes relatedSemantics 0..1(L) WO List of resource identifiers containing related semantic information to be used in processing semantic queries. The resource identifiers may reference either a <group> resource or <semanticDescriptor> resources and <contentInstance> resources with semantic information in their content attributes as indicated by their contentInfo attribute. In the latter case, the resource identifier may reference a <latest> resource representing the most recent <contentInstance> in a container. OA semanticValidated 0..1 RO A Boolean value representing the validation result of the triples in the descriptor attribute. The validation is against the referenced ontology as pointed by the ontologyRef attribute as well as other associated <semanticDescriptor> resources (and their referenced ontologies) linked by relatedSemantics attribute and triples in the descriptor attribute. OA validationEnable 0..1 RW A Boolean value indicating whether the triples in the descriptor attribute needs to be validated by the hosting CSE. NOTE: The hosting CSE may override this value according to local policy to enforce or disable semantic validation despite the suggested value from the issuer. OA |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.31 Resource Type notificationTargetMgmtPolicyRef | The <notificationTargetMgmtPolicyRef> resource is a child resource of a <subscription> resource and lists a reference to the policy to be followed by the hosting CSE for every Target Notification of a subscription. The policy is applied by the hosting CSE when it receives a request to stop receiving a notification from a Target Notification. If no policy is defined for the Target Notification, then the hosting CSE shall apply the default policy. The default policy is either created by the subscription originator or the hosting CSE shall have a system created default one to apply. The system created default policy shall be configurable by the M2M Service Provider. Table 9.6.31-1: Child resources of <notificationTargetMgmtPolicyRef> resource Child Resources of <notificationTargetMgmtPolicyRef> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 [variable] <transaction> 0..n See clause 9.6.48 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 204 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.31-2: Attributes of <notificationTargetMgmtPolicyRef> resource Attributes of <notificationTargetMgmtPolicyRef> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. dynamicAuthorizationConsultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. notificationTargetURI 1 (L) RW address(es) of the resource subscriber receiving a notification. The notificationTarget URI shall be listed in the notificationURI attribute of the parent <subscription> resource, otherwise the default Notification Target policy shall apply. notificationlPolicyID 0..1 RW A link to the <notificationTargetPolicy> resource applicable to the notificationTargetURI. If none is specified than the default policy shall apply to the targetNotificationURI. See clause 9.6.32 for an explanation of the <notificationTargetPolicy> resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.32 Resource Type notificationTargetPolicy | The <notificationTargetPolicy> resource is a child resource of <CSEBase> resource and lists the policies to be applied by the hosting CSE. A policy has (a) rules(s), represented by the <policyDeletionRules> and an action. The action is applied when the rules in the policy are fulfilled. Rules are grouped in 2 groups to support a combination of rules for flexibility e.g. ((rule 1 AND rule 2) OR rule 3). A maximum of two groups of <policyDeletionRules> can be defined. The relationship to be applied between the 2 groups (AND/OR) shall be defined in the ruleRelationShip attribute. If no rules are defined for a <notificationTargetPolicy> then the action is executed. Each policy has the policyLabel which can take any form. There shall be at minimum a single notificationTargetPolicy which can be defined by the subscription originator with the label "default" to be applied when no specific policy is defined for a Target Notification. If a default policy is required and none is defined by the subscription originator, then the system defined default policy shall be applied. Table 9.6.32-1: Child resources of <notificationTargetPolicy> resource Child Resources of <notificationTargetPolicy> Child Resource Type Multiplicity Description [variable] <policyDeletionRules> 0..2 Groups listing the rules that apply to this policy and that needs to be fulfilled for the listed action to take place. Only two groups of rules shall be supported. See clause 9.6.33 [variable] <subscription> 0..n See clause 9.6.8 [variable] <transaction> 0..n See clause 9.6.48 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 205 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.32-2: Attributes of <notificationTargetPolicy> resource Attributes of <notificationTargetPolicy> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. dynamicAuthorizationConsultati onIDs 0..1 (L) RW See clause 9.6.1.3. creator 0..1 RO See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. action 1 RW Defines the action to be performed if the groups of rules are fulfilled. The action includes one of the following; accept request, reject request, seek authorization from subscription originator before responding, or inform the subscription originator without taking any action. policyLabel 1 RW At minimum a default policy shall be specified. The policyLabel "Default" shall be used in this case. rulesRelationship 0..1 RW Shall be either AND or OR This attribute is mandatory if more than one policy DeletionRule is specified. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.33 Resource Type policyDeletionRules | The <policyDeletionRules> resource lists the rules to be applied by the hosting CSE during policy execution. Each <policyDeletionRules> can define any number of rules with an AND or OR relationship to be applied between them. The attribute deletionRulesRelation define the relationship between rules. It can have an AND or OR value. Table 9.6.33-1: Child resources of <policyDeletionRules> resource Child Resources of <policyDeletionRules> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 [variable] <transaction> 0..n See clause 9.6.48 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 206 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.33-2: Attributes of <policyDeletionRules> resource Attributes of <policyDeletionRules> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. dynamicAuthorizationCo nsultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. deletionRules 0..1(L) RW Lists the applicable rules. The rules include at minimum; time of the day, geographical location of the Target Notification. Where the rule applies. deletionRulesRelation 0..1 RW Defines the relation to be applied between the deletionRules. This shall be either AND or OR. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.34 Resource Type notificationTargetSelfReference | The <notificationTargetSelfReference> resource is a virtual resource, which does not have a representation and it is the child resource of a <subscription> resource. Whenever a Delete Request is sent to the <notificationTargetSelfReference > resource from a Notification Target which wants to remove itself from the Notification Target list (i.e. notificationURI) later, the Notifier shall act according to the action attribute defined in the <notificationTargetPolicy> resource which is linked from the <notificationTargetMgmtPolicyRef> resource defined for the specific notificationURI. If no specific policy is defined for the notification URI then the default policy shall apply. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.35 Resource Type flexContainer | The <flexContainer> resource type is a customizable container for data instances. It is a template for the definition of flexible specializations of data containers. Like a <container> resource, specializations of this <flexContainer> resource type are used to share information with other entities and potentially to track the data. While the <container> resources include data to be made accessible to oneM2M entities inside <contentInstance> children, a specialization of the <flexContainer> resource includes associated content directly inside the <flexContainer> by means of zero or more [customAttribute] attribute(s). The attribute name and attribute data type of [customAttribute] attributes are defined explicitly for each specialization of <flexContainer>, i.e. the specific set of attribute name and type are defined in a corresponding XSD-file. Example usage of <flexContainer>: As a specialization of <flexContainer> that includes two [customAttribute] attributes, named "temperature"(xs:float type) and "humidity"(xs:positiveInteger type) can be specified in some TS. The actual data types of [customAttribute] will be described both in the specification document or XSD file which are referred by the value of containerDefinition attribute. If a <flexContainer> resource is created with at least one of the attributes maxNrOfInstances, maxByteSize or maxInstanceAge, then the hosting CSE shall automatically create a copy of the <flexContainer> resource in the form of a <flexContainerInstance> resource, child of the current <flexContainer> resource; and each time a <flexContainer> custom attribute is modified, a new <flexContainerInstance> child resource shall be added, which contains a copy of the <flexContainer> after update. In this case, virtual resources <latest> and <oldest> shall be available. The <flexContainer> resource shall contain the child resource specified in table 9.6.35-1. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 207 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.35-1: Child resources of <flexContainer> resource Child Resources of <flexContainer> Child Resource Type Multiplicity Description <flexContainerAnnc> Child Resource Type [variable] <semanticDescriptor> 0..n See clause 9.6.30 <semanticDescriptor>, <semanticDescriptorAnnc> [variable] <subscription> 0..n See clause 9.6.8 <subscription> [variable] <container> 0..n See clause 9.6.6 <container> <containerAnnc> [variable] <flexContainer> 0..n <flexContainer> resource can include any of its specializations as child resource <flexContainer> <flexContainerAnnc> [variable] <flexContainerInstance> 0..n Timestamped copy of the <flexContainer> resource <flexContainerInstance> la <latest> 0..1 See clause 9.6.27 None ol <oldest> 0..1 See clause 9.6.28 None [variable] <timeSeries> 0..n See clause 9.6.36 <timeSeries>, <timeSeriesAnnc> [variable] <transaction> 0..n See clause 9.6.48 <transaction> [variable] <action> 0..n See clause 9.6.61 None The <flexContainer> resource shall contain the attributes specified in table 9.6.35-2. Table 9.6.35-2: Attributes of <flexContainer> resource Attributes of <flexContainer> Multiplicity RW/ RO/ WO Description <flexContainer Annc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 0..1 (note) RW See clause 9.6.1.3. MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. MA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 0..1 (note) RO See clause 9.6.1.3. NA lastModifiedTime 0..1 (note) RO See clause 9.6.1.3. NA stateTag 1 RO See clause 9.6.1.3. This stateTag attribute value shall be incremented when a custom attribute of the flexContainer is modified. NA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationCons ultationIDs 0..1 (L) RW See clause 9.6.1.3. OA creator 0..1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA location 0..1 RW See clause 9.6.1.3. OA maxNrOfInstances 0..1 RW Maximum number of direct child <flexContainerInstance> resources in the <flexContainer> resource. OA maxByteSize 0..1 RW Maximum size in bytes of custom attributes that is allocated for the <flexContainer> resource for all direct child <flexContainerInstance> resources. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 208 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <flexContainer> Multiplicity RW/ RO/ WO Description <flexContainer Annc> Attributes maxInstanceAge 0..1 RW Maximum age of a direct child <flexContainerInstance> resources in the <flexContainer> resource. The value is expressed in seconds. OA currentNrOfInstances 0..1 RO Current number of direct child <flexContainerInstance> resources in the <flexContainer> resource. It is limited by the maxNrOfInstances. The currentNrOfInstances attribute of the <flexContainer> resource shall be updated on successful creation or deletion of direct child <flexContainerInstance> resource of <flexContainer> resource. OA currentByteSize 0..1 RO Current size in bytes of custom attributes stored in all direct child <flexContainerInstance> resources of the <flexContainer> resource. It is limited by the maxByteSize. The currentByteSize attribute of the <flexContainer> resource shall be updated on successful creation or deletion of a direct child <flexContainerInstance> resource of <flexContainer> resource. OA containerDefinition 1 WO This contains an identifier reference (URI) to the <flexContainer> schema definition which shall be used by the CSE to validate the syntax of the <flexContainer> resource. This URI may refer to one of the oneM2M <flexContainer> definitions specified in the following documents: • Generic Interworking [6] • AllJoyn Interworking [7] • Home Domain Information Model [8] A list of oneM2M <flexContainer> definitions is also provided in clause 9.6.1.2.2 of ETSI TS 118 104 [3]. Other URI for other <flexContainer> definitions may be specified. MA ontologyRef 0..1 RW A reference (URI) of the ontology used to represent the information that is stored in the present <flexContainer> resource. OA contentSize 1 RO Sum of the size in bytes of all of the custom attributes. NA nodeLink 0..1 RW The resource identifier of a <node> resource that stores the node specific information of the NoDN on which the interworked service represented by this <flexContainer> resource resides. OA [customAttribute] 0..n RW Specialization-specific attribute(s). Name and data type defined in each specialization of <flexContainer> resource. OA NOTE: When an instance of <flexContainer> is a child of a <flexContainer> resource, these attributes can be optional. Their presence is determined by the respective definition referred to by the containerDefinition attribute. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 209 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.36 Resource Type timeSeries | The <timeSeries> resource represents a container for Time Series Data instances. It is used to share information with other entities and potentially to track, detect and report the missing data in Time Series. A <timeSeries> resource has no associated content. It has only attributes and child resources. Table 9.6.36-1: Child resources of <timeSeries> resource Child Resources of <timeSeries> Child Resource Type Multiplicity Description <timeSeriesAnnc> Child Resource Types [variable] <semanticDescriptor> 0..n See clause 9.6.30 <semanticDescriptor>, <semanticDescriptorAnnc> [variable] <timeSeriesInstance> 0..n See clause 9.6.37 <timeSeriesInstance>, <timeSeriesInstanceAnnc> [variable] <subscription> 0..n See clause 9.6.8 <subscription> la <latest> 1 See clause 9.6.27 None ol <oldest> 1 See clause 9.6.28 None [variable] <transaction> 0..n See clause 9.6.48 <transaction> [variable] <action> 0..n See clause 9.6.61 None The <timeSeries> resource shall contain the attributes specified in table 9.6.36-2. Table 9.6.36-2: Attributes of <timeSeries> resource Attributes of <timeSeries> Multiplicity RW/ RO/ WO Description <timeSeriesAn nc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3 MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. MA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationCons ultationIDs 0..1 (L) RW See clause 9.6.1.3. OA creator 0..1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA location 0..1 RW See clause 9.6.1.3. OA maxNrOfInstances 0..1 RW Maximum number of direct child <timeSeriesInstance> resources in the <timeSeries> resource. OA maxByteSize 0..1 RW Maximum size in bytes of data that is allocated for the <timeSeries> resource for all direct child<timeSeriesInstance> resources. OA maxInstanceAge 0..1 RW Maximum age of a direct child <timeSeriesInstance> resource in the <timeSeries> resource. The value is expressed in seconds. OA currentNrOfInstances 1 RO Current number of direct child <timeSeriesInstance> resource in the <timeSeries> resource. It is limited by the maxNrOfInstances. The currentNrOfInstances attribute of the <timeSeries> resource shall be updated on successful creation or deletion of direct child < timeSeriesInstance > resource of <timeSeries > resource. NA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 210 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <timeSeries> Multiplicity RW/ RO/ WO Description <timeSeriesAn nc> Attributes currentByteSize 1 RO Current size in bytes of data stored in all direct child <timeSeriesInstance> resources of a <timeSeries> resource. It is limited by the maxByteSize. The currentByteSize attribute of the <timeSeries> resource shall be updated on successful creation or deletion of direct child < timeSeriesInstance > resource of <timeSeries > resource. NA periodicInterval 0..1 RW If the Time Series Data is periodic, this attribute shall contain the expected amount of time between two instances of Time Series Data. OA periodicIntervalDelta 0..1 RW If the Time Series Data is periodic, this attribute contains a +/- delta value relative to periodicInterval for the purpose of detecting missing data. The value of this attribute shall be less than or equal to (periodicInterval/2). If the attribute is omitted the hosting CSE can use a local policy to determine a default value. OA missingDataDetect 1 RW Indicates whether the Receiver shall detect the missing Time Series Data if it is periodic. The default value is false. NA ontologyRef 0..1 RW A reference (URI) of the ontology used to represent the information that is stored in the child <timeSeriesInstance> resources of the present <timeSeriesData> resource (see note). OA missingDataMaxNr 0..1 RW Maximum number of entries in the missingDataList if the periodicInterval is set and the missingDataDetect is TRUE. OA missingDataList 0..1(L) RO The list of the dataGenerationTime value representing the missing Time Series Data in descending order by time if the periodicInterval is set and the missingDataDetect is TRUE. NA missingDataCurrentNr 0..1 RO Current number of the missing Time Series Data in the missingDataList. NA missingDataDetectTimer 0..1 RW The missingDataDetectTimer is a duration after which a <timeSeriesInstance> shall be considered missing by the hosting CSE. If periodicIntervalDelta is present, the value of this attribute shall be greater than periodicIntervalDelta. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 211 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <timeSeries> Multiplicity RW/ RO/ WO Description <timeSeriesAn nc> Attributes contentInfo 0..1 WO This attribute contains information to understand the contents of the content attribute of <timeSeriesInstance>. It shall be composed of two mandatory components consisting of an Internet Media Type (as defined in the IETF RFC 6838 [i.36]) and an encoding type. In addition, an optional content security component may also be included. The format of this attribute is defined in ETSI TS 118 104 [3]. This attribute should be used to represent the content information of the content attribute of child <timeSeriesInstance> resources so that AEs can understand the content. OA NOTE: The access to this URI is out of scope of oneM2M. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.37 Resource Type timeSeriesInstance | The <timeSeriesInstance> resource represents a data instance in the <timeSeries> resource. The <timeSeriesInstance> resource shall not be modified once created. An AE shall be able to delete a <timeSeriesInstance> resource explicitly or it may be deleted by the platform based on policies. If the platform has policies for <timeSeriesInstance> retention, these shall be represented by the attributes maxByteSize, maxNrOfInstances and/or maxInstanceAge attributes in the <timeSeries> resource. If multiple policies are in effect, the strictest policy shall apply. The <timeSeriesInstance> resource inherits the same access control policies of the parent <timeSeries> resource, and does not have its own accessControlPolicyIDs attribute. Table 9.6.37-1: Child resources of <timeSeriesInstance> resource Child Resources of <timeSeriesInstance> Child Resource Type Multiplicity Description <timeSeriesInstanceAnnc> Child Resource Types [variable] <transaction> 0..n See clause 9.6.48 <transaction> The < timeSeriesInstance> resource shall contain the attributes specified in table 9.6.37-2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 212 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.37-2: Attributes of <timeSeriesInstance> resource Attributes of <timeSeriesInstance> Multiplicity RW/ RO/ WO Description <timeSeriesIns tanceAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA labels 0..1 (L) WO See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA expirationTime 1 WO See clause 9.6.1.3. NA announceTo 0..1 (L) WO See clause 9.6.1.3. NA announcedAttribute 0..1 (L) WO See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA lastModifiedTime 1 RO See clause 9.6.1.3. NA dataGenerationTime 1 WO This attribute contains the time when the data was generated by the Originator. The value of this attribute shall be unique among the child <timeSeriesInstance> resources belonging to the same parent <timeSeries> resource. OA content 1 WO This attribute contains the data generated by the AE/CSE. OA contentSize 1 RO Size in bytes of the content attribute. NA sequenceNr 0..1 WO This attribute contains the data sequence number generated by the AE/CSE. OA |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.38 Resource Type role | The <role> resource represents a role that is assigned to an AE or CSE. The <role> resource shall contain the child resources specified in table 9.6.38-1. Table 9.6.38-1: Child resources of <role> resource Child Resources of <role> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 [variable] <transaction> 0..n See clause 9.6.48 The <role> resource shall contain the attributes specified in table 9.6.38-2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 213 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.38-2: Attributes of <role> resource Attributes of <role> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. dynamicAuthorizationCo nsultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. roleID 1 WO The identifier of the role. issuer 1 WO The identifier of the entity that is responsible for assigning the role to the AE or CSE. holder 1 WO The identifier of the AE or CSE that the role is assigned. notBefore 1 WO Start time of the role can be used for access control. notAfter 1 WO End time of the role can be used for access control. roleName 0..1 WO Human readable name of the <role>. tokenLink 0..1 RW This attribute contains a reference to a token in which this role assignment is described. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.39 Resource Type token | The <token> resource is used for storing a token that is issued to an AE or CSE. Details of the token may also be stored here in plaintext. The <token> resource shall contain the child resources specified in table 9.6.39-1. Table 9.6.39-1: Child resources of <token> resource Child Resources of <token> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 [variable] <transaction> 0..n See clause 9.6.48 The <token> resource shall contain the attributes specified in table 9.6.39-2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 214 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.39-2: Attributes of <token> resource Attributes of <token> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. dynamicAuthorizationCo nsultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. tokenID 1 WO The identifier of the token. tokenObject 1 WO Used to store the token. See clause 7.3.2.4 ETSI TS 118 103 [2] for further details of a token. version 0..1 WO Version of the token. issuer 0..1 WO The identifier of the entity that is responsible for issuing the token to the AE or CSE. audience 0..1 (L) WO List of identifiers of the CSEs expected to accept the token. holder 0..1 WO The identifier of the AE or CSE to which the token is issued. notBefore 0..1 WO Start time of the token can be used for access control. notAfter 0..1 WO End time of the token can be used for access control. tokenName 0..1 WO Human readable name of the <token>. permissions 0..1 (L) WO List of token permissions associated with the token. The structure of token permission is specified in table 9.6.39-3. extension 0..1 WO Extension information held by the token, e.g. application- specific information. The structure of token permission is specified in table 9.6.39-3. Table 9.6.39-3: Structure of token permission Element Multiplicity Description Note resourceIDs 0..1 The resources to which this permission applies. If the privileges element is present, then this element shall be present. privileges 0..1 A set of access control rules applicable to the identified resources (for the identified holder). At least one of these shall be present. roleIDs 0..1 A set of role IDs applicable to the identified resources (for the identified holder). |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.40 Resource Type dynamicAuthorizationConsultation | The < dynamicAuthorizationConsultation> resource shall be used by a CSE to perform consultation-based dynamic access control to resources as specified in the present document and in ETSI TS 118 103 [2]. The <dynamicAuthorizationConsultation> resource is comprised of configuration information that a resource Hosting CSE may use to determine whether or not to initiate a consultation-based dynamic authorization request. For a resource that is not of <dynamicAuthorizationConsultation> resource type, the common attribute dynamicAuthorizationConsultationIDs for such resources (defined in table 9.6.1.3.2-1) may contain a list of identifiers which link that resource to <dynamicAuthorizationConsultation> resources. The <dynamicAuthorizationConsultation> resource shall contain the child resources specified in table 9.6.40-1. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 215 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.40-1: Child resources of <dynamicAuthorizationConsultation> resource Child Resources of <dynamicAuthorization Consultation> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 [variable] <transaction> 0..n See clause 9.6.48 The <dynamicAuthorizationConsultation> resource shall contain the attributes specified in table 9.6.40-2. Table 9.6.40-2: Attributes of <dynamicAuthorizationConsultation> resource Attributes of <dynamicAuthorizationCon sultation> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. dynamicAuthorizationConsult ationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. dynamicAuthorizationEnabled 1 RW Controls whether consultation-based dynamic authorization is enabled or disabled. If disabled, Hosting CSE shall NOT initiate consultation-based dynamic authorization. Valid values are "TRUE" or "FALSE". dynamicAuthorizationPoA 1 (L) RW A list of contact URIs of supporting consultation-based dynamic authorization. dynamicAuthorizationLifetime 0..1 RW The preferred lifetime of dynamic access control privileges that CSE shall specify as a parameter when issuing a consultation-based dynamic authorization request. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.41 Resource Type authorizationDecision | An <authorizationDecision> resource represents an access control decision point that is responsible for making access control decisions. <authorizationDecision> resources are the child resources of a <CSEBase> resource. When an UPDATE request addresses an <authorizationDecision> resource, the Hosting CSE may act as a Policy Decision Point (PDP) that is defined in ETSI TS 118 103 [2]. The PDP shall make an access control decision according to the access control policies and provide the access control decision in the response of the request. The resource specific attributes of <authorizationDecision> resource type are classed into two categories according to their usage. The decision and status attributes are used for describing an access control decision responses and the others are used for describing access control decision requests. An access control decision request shall be provided to a PDP through an UPDATE operation on an <authorizationDecision> resource that represents the PDP, and the updated resource attributes shall be the attributes used for describing access control decision request parameters. The mandatory and optional parameters used for describing an access control decision request are specified in ETSI TS 118 103 [2]. When an UPDATE request that represents a valid access control decision request addresses an <authorizationDecision> resource, the PDP procedure bound to the <authorizationDecision> resource shall be triggered. The PDP procedure shall make an access control decision and then update the decision and/or status attributes. The decision and/or status attributes that represents an access control decision response shall be returned to the requester in the UPDATE response. An UPDATE request that does not represent a valid access control decision request shall not trigger the bound PDP procedure. Before triggering a PDP procedure, accessing an <authorizationDecision> resource is governed by the access control policies assigned to this resource. For the lifecycle management of <authorizationDecision> resources, see ETSI TS 118 103 [2]. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 216 (oneM2M TS-0001 version 4.15.0 Release 4) The <authorizationDecision> resource shall contain the child resources specified in table 9.6.41-1. Table 9.6.41-1: Child resources of <authorizationDecision> resource Child Resources of <authorizationDecision> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 [variable] <transaction> 0..n See clause 9.6.48 The <authorizationDecision> resource shall contain the attributes specified in table 9.6.41-2. Table 9.6.41-2: Attributes of <authorizationDecision> resource Attributes of <authorizationDecision> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. dynamicAuthorizationCons ultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. decision 0..1 RO Authorization decision for an access control decision request. See clause 7 in ETSI TS 118 103 [2]. status 0..1 RO Status of an authorization evaluation process. See clause 7 in ETSI TS 118 103 [2]. to 0..1 RW Same as the To parameter in the request sent from the Originator to the Hosting CSE. See clause 7 in ETSI TS 118 103 [2]. from 0..1 RW Same as the From parameter in the request sent from the Originator to the Hosting CSE. See clause 7 in ETSI TS 118 103 [2]. operation 0..1 RW Same as the Operation parameter in the request sent from the Originator to the Hosting CSE. See clause 7 in ETSI TS 118 103 [2]. requestedResourceType 0..1 RW Resource type that the Originator wants to create. See clause 7 in ETSI TS 118 103 [2]. filterUsage 0..1 RW Same as the filterUsage parameter in the request sent from the Originator to the Hosting CSE. See clause 7 in ETSI TS 118 103 [2]. roleIDs 0..1 (L) RW Same as the Role IDs parameter in the request sent from the Originator to the Hosting CSE. See clause 7 in ETSI TS 118 103 [2]. tokenIDs 0..1 (L) RW Same as the Token IDs parameter in the request sent from the Originator to the Hosting CSE. See clause 7 in ETSI TS 118 103 [2]. tokens 0..1 (L) RW Same as the Tokens parameter in the request sent from the Originator to the Hosting CSE. See clause 7 in ETSI TS 118 103 [2]. requestTime 0..1 RW Time stamp when the request message was received at the hosting CSE. Obtained by the hosting CSE's system time clock. See clause 7 in ETSI TS 118 103 [2]. originatorLocation 0..1 RW Location information about the Originator of the request. Obtained over the Mcn reference point. See clause 7 in ETSI TS 118 103 [2]. originatorIP 0..1 RW IP source address associated with the IP packets that carry the request message. Obtained over the Mcn reference point. See clause 7 in ETSI TS 118 103 [2]. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 217 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.42 Resource Type authorizationPolicy | An <authorizationPolicy> resource represents an access control policy retrieval point that is responsible for retrieving access control policies. <authorizationPolicy> resources are the child resources of a <CSEBase> resource. When an UPDATE request addresses an <authorizationPolicy> resource, the Hosting CSE acts as a Policy Retrieval Point (PRP) as defined in ETSI TS 118 103 [2]. The PRP shall retrieve the applicable access control policies according to the access control policy request and provide the retrieved access control policies in the UPDATE response. The resource specific attributes of <authorizationPolicy> resource type are classed into two categories according to their usage. The policies, combiningAlgorithm and status attributes are used for describing access control policy responses. The others are used for describing access control policy requests. An access control policy request shall be provided to a PRP through an UPDATE operation on an <authorizationPolicy> resource that represents the PRP, and the updated resource attributes shall be the attributes used for describing access control policy request parameters. The mandatory and optional parameters used for describing an access control policy request are specified in ETSI TS 118 103 [2]. When an UPDATE request that represents a valid access control policy request addresses an <authorizationPolicy> resource, the PRP procedure bound to the <authorizationPolicy> resource shall be triggered. The PRP procedure shall retrieve applicable access control policies and then update the policies, combiningAlgorithm and/or status attributes. The policies, combiningAlgorithm and/or status attributes that represents an access control policies response shall be returned to the requester in the UPDATE response. An UPDATE request that does not represent a valid access control policy request shall not trigger the bound PRP procedure. Before triggering a PRP procedure, accessing an <authorizationPolicy> resource is governed by the access control policies assigned to this resource. For the lifecycle management of <authorizationPolicy> resources, see ETSI TS 118 103 [2]. The <authorizationPolicy> resource shall contain the child resources specified in table 9.6.42-1. Table 9.6.42-1: Child resources of <authorizationPolicy> resource Child Resources of <authorizationPolicy> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 [variable] <transaction> 0..n See clause 9.6.48 The <authorizationPolicy> resource shall contain the attributes specified in table 9.6.42-2. Table 9.6.42-2: Attributes of <authorizationPolicy> resource Attributes of <authorizationPolicy> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. dynamicAuthorizationCo nsultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. policies 0..1 (L) RO List of access control policies for an access control policy request. Each access control policy contains a set of access control rules as specified in clause 9.6.2. See clause 7 in ETSI TS 118 103 [2]. combiningAlgorithm 0..1 RO Algorithm used for combining multiple access control policies. See clause 7 in ETSI TS 118 103 [2]. status 0..1 RO Status of retrieving access control policies. See clause 7 in ETSI TS 118 103 [2]. to 0..1 RW Same as the To parameter in the access control decision request. See clause 7 in ETSI TS 118 103 [2]. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 218 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.43 Resource Type authorizationInformation | The <authorizationInformation> resource represents an access control information retrieval point that is responsible for retrieving access control information. <authorizationInformation> resources are the child resources of a <CSEBase> resource. When an UPDATE request addresses an <authorizationInformation> resource, the Hosting CSE acts as a Policy Information Point (PIP) as defined in ETSI TS 118 103 [2]. The PIP shall retrieve the required access control information according to the access control information request and provide the access control information in the UPDATE response. The resource specific attributes and child resources of <authorizationInformation> resource type are classed into two categories according to their usage. The <role> and <token> resources and status attribute are used for describing access control information responses. The others are used for describing access control information requests. An access control information request shall be provided to a PIP through an UPDATE operation on an <authorizationInformation> resource that represents the PIP, and the updated resource attributes shall be the attributes used for describing access control information request parameters. The mandatory and optional parameters used for describing an access control information request are specified in ETSI TS 118 103 [2]. When an UPDATE request that represents a valid access control information request addresses an <authorizationInformation> resource, the PIP procedure bound to the <authorizationInformation> resource shall be triggered. The PIP procedure shall retrieve required access control information and then create corresponding <role> and/or <token> child resources and/or update status attributes. The <role> and/or <token> child resources and/or status attributes that represents an access control information response shall be returned to the requester in the UPDATE response. An UPDATE request that does not represent a valid access control information request shall not trigger the bound PIP procedure. Before triggering a PIP procedure, accessing an <authorizationInformation> resource is governed by the access control policies assigned to this resource. For the lifecycle management of <authorizationInformation> resources, see ETSI TS 118 103 [2]. The <authorizationInformation> resource shall contain the child resources specified in table 9.6.43-1. Table 9.6.43-1: Child resources of <authorizationInformation> resource Child Resources of <authorizationInformation> Child Resource Type Multiplicity Description [variable] <role> 0..n See clause 9.6.38 [variable] <token> 0..n See clause 9.6.39 [variable] <subscription> 0..n See clause 9.6.8 [variable] <transaction> 0..n See clause 9.6.48 The <authorizationInformation> resource shall contain the attributes specified in table 9.6.43-2. Table 9.6.43-2: Attributes of <authorizationInformation> resource Attributes of <authorizationInformati on> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. dynamicAuthorizationCo nsultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. status 0..1 RO Status of retrieving access control information. See clause 7 in ETSI TS 118 103 [2]. from 0..1 RW Same as the From parameter in the request. See clause 7 in ETSI TS 118 103 [2]. roleIDs 0..1 (L) RW Same as the Role IDs parameter in the request. See clause 7 in ETSI TS 118 103 [2]. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 219 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <authorizationInformati on> Multiplicity RW/ RO/ WO Description tokenIDs 0..1 (L) RW Same as the Token IDs parameter in the request. See clause 7 in ETSI TS 118 103 [2]. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.44 Resource Type localMulticastGroup | The <localMulticastGroup> resource is used by a member hosting CSE to indicate that this CSE is a member of a multicast group. <localMulticastGroup> is created as the child resource of the <CSEBase> resource. And there may be multiple <localMulticastGroup> resources under the same <CSEBase>. The <localMulticastGroup> resource shall contain the child resources specified in table 9.6.44-1. Table 9.6.44-1: Child resources of <localMulticastGroup> resource Child Resources of <localMulticastGroup> Child Resource Type Multiplicity Description [variable] <transaction> 0..n See clause 9.6.48 The <localMulticastGroup> resource shall contain the attributes specified in table 9.6.44-2. Table 9.6.44-2: Attributes of <localMulticastGroup> resource Attributes of < localMulticastGroup > Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. dynamicAuthorizationConsultationI Ds 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. announceTo 0..1(L) RW See clause 9.6.1.3. announcedAttribute 0..1(L) RW See clause 9.6.1.3. announceSyncType 0..1 RW See clause 9.6.1.3. externalGroupID 0..1 RW It is used by an M2M Service Provider (M2M SP) when services targeted to a group of M2M Devices are requested from the Underlying Network. It is assumed to be a globally unique ID exposed by the underlying network to identify a group of M2M Devices (e.g. ASN, MN) that is mapped to an internally used identifier for group related services. multicastAddress 1 RW The multicast address assigned by the Group Hosting CSE for the Member Hosting CSE to join the multicast group. The procedure of multicast address assignment is specified in IETF RFC 5771 [11] and IETF RFC 2375 [12]. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 220 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of < localMulticastGroup > Multiplicity RW/ RO/ WO Description multicastGroupFanoutTarget 1 RW Represents a unique fan out target that a Member Hosting CSE shall accept and process incoming multicast requests for this multicast group. It is assigned by the Group Hosting CSE to identify the collection of all the member resources of this multicast group across different member Hosting CSEs. It shall be used in the To parameter of the multicast request sent to the member Hosting CSEs. If a Member Hosting CSE receives a request while listening on the multicastAddress defined for this multicast group, and the incoming request has a specified target that matches this attribute, then the request shall be processed by the Member Hosting CSE. Otherwise, the request shall be ignored. memberList 1(L) RW List of local member resourceIDs in the multicast group which are hosted on the same member hosting CSE. Each member resource ID corresponds to a member resource. A <localMulticastGroup> resource with an empty member list shall not be allowed. responseTarget 1 RW Indicates the target that the multicast member hosting CSE sends the notification to when finishing the operation in the multicast message from the group hosting CSE. The default value should be the CSE-ID of the group hosting CSE. responseTimeWindow 0..1 RW Upon receiving a multicast request, this attribute defines the upper bound on the amount of delay the Member Hosting CSE shall wait before sending a response message. The Member Hosting CSE shall wait a randomized time that is less than the value of this attribute. This randomized delay helps prevent network congestion caused by multiple Member Hosting CSEs responding at the same time as one another. TMGI 0..1 RW The Temporary Mobile Group Identity is allocated to identify the MBMS bearer service as specified in ETSI TS 123 246 [i.32]. It is used to uniquely identify the 3GPP multicast or broadcast message with externalGroupID together. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.45 Resource Type AEContactList | An <AEContactList> resource shall contain <AEContactListPerCSE> child resources, one for each CSE that has sent a NOTIFY request to the CSE about the creation, update, or deletion of a resource that references an Application Entity resource identifier. The <AEContactList> resource shall only be created as a child of <CSEBase> in the IN-CSE. The <AEContactList> resource shall contain the child resources specified in table 9.6.45-1. Table 9.6.45-1: Child resources of <AEContactList> resource Child Resources of <AEContactList> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 [variable] <AEContactListPerCSE> 0..n See clause 9.6.46 [variable] <transaction> 0..n See clause 9.6.48 The <AEContactList> resource shall contain the attributes specified in table 9.6.45-2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 221 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.45-2: Attributes of <AEContactList> resource Attributes of < AEContactList > Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 RO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RO See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RO See clause 9.6.1.3. dynamicAuthorizationCons ultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RO See clause 9.6.1.3. numberImpactedCSEs 1 RO The number of Hosting CSEs that have reported that they have a reference to an Application Entity resource identifier. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.46 Resource Type AEContactListPerCSE | An <AEContactListPerCSE> resource shall represent information about a CSE that has resources that reference an Application Entity resource identifier (SP-relative-Resource-IDs of an AE). For example, these Application Entity resource identifiers may occur in announcement links, notification targets, group member IDs, or in the OriginatorID list of the accessControlOriginators parameter tied to an <accessControlPolicy> resource. The <AEContactListPerCSE> resource shall only be created in the IN-CSE. The <AEContactListPerCSE> resource shall contain the attributes specified in table 9.6.46-1. Table 9.6.46-1: Attributes of <AEContactListPerCSE> resource Attributes of <AContactListPerCSE> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 RO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RO See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RO See clause 9.6.1.3. dynamicAuthorizationCons ultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RO See clause 9.6.1.3. CSE-ID 1 RO The identifier of the Hosting CSE which has a reference to an Application Entity resource identify (SP-relative- Resource-ID that points to an AE). Hosting CSEs notify the IN-CSE when they have a reference to an <AE> resource through e.g. announcements, notification targets, group member IDs, <accessControlPolicy> resource OriginatorID lists. AE-IDList 0..1(L) RO List of Application Entity resource identifiers hosted on CSE with identifier CSE-ID. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.47 Resource Type transactionMgmt | The <transactionMgmt> resource is used to initiate and manage the atomic and consistent processing of a transaction consisting of multiple oneM2M request primitives. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 222 (oneM2M TS-0001 version 4.15.0 Release 4) The <transactionMgmt> resource supports the child resources specified in table 9.6.47-1. Table 9.6.47-1: Child resources of <transactionMgmt> resource Child Resources of <transactionMgmt> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 The <transactionMgmt> resource supports the attributes specified in table 9.6.47-2. Table 9.6.47-2: Attributes of <transactionMgmt> resource Attributes of <transactionMgmt> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. expirationTime 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. dynamicAuthorizationCo nsultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. creator 1 RO This attribute is configured with the identifier of the entity that originated the request to create this <transactionMgmt> resource. dynamicAuthorizationCo nsultationIDs 0..1 (L) RW See clause 9.6.1.3. transactionLockTime 0..1 WO This attribute contains timing information that the <transactionMgmt> Hosting CSE uses to configure the corresponding transactionLockTime attribute of each <transaction> resource it creates for this transaction. If this attribute is not set, the <transactionMgmt> Hosting CSE may configure the transactionLockTime attribute of each <transaction> resource with a default value based on local policy. transactionExecuteTime 0..1 WO This attribute contains timing information that the <transactionMgmt> Hosting CSE uses to configure the corresponding transactionExecuteTime attribute of each <transaction> resource it creates for this transaction. If this attribute is not set, the <transactionMgmt> Hosting CSE may configure the transactionExecuteTime attribute of each <transaction> resource with a default value based on local policy. transactionCommitTime 0..1 WO This attribute contains timing information that the <transactionMgmt> Hosting CSE use to configure the corresponding transactionCommitTime attribute of each <transaction> resource it creates for this transaction. If this attribute is not set, the <transactionMgmt> Hosting CSE may configure the transactionCommitTime attribute of each <transaction> resource with a default value based on local policy. transactionExpirationTim e 0..1 WO This attribute contains timing information of when the transaction is set to expire. The <transactionMgmt> Hosting CSE shall use this value to configure the expirationTime attribute of the <transaction> resources it creates. If this attribute is not set, the <transactionMgmt> Hosting CSE may configure the expirationTime attribute of each <transaction> resource with a default value based on local policy. If the transaction fails to complete before this time elapses, the <transactionMgmt> Hosting CSE shall abort the transaction. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 223 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <transactionMgmt> Multiplicity RW/ RO/ WO Description transactionMode 0..1 WO This attribute is used by the Hosting CSE to determine whether it is responsible for controlling the execution of the transaction (via the transactionControl attribute) or whether the creator is responsible for controlling it. The allowed values are: • CSE_CONTROLLED (Default) • CREATOR_CONTROLLED transactionLockType 0..1 WO This attribute indicates the type of lock that is required on the targeted resource in order to perform the transaction. The <transactionMgmt> Hosting CSE shall use the value in this attribute to configure the corresponding transactionLockType attribute of each <transaction> resource it creates. The following are the supported types of locks: • BLOCK_ALL - Block oneM2M request primitives not associated with this transaction from performing any CRUD operations on the targeted resource while it is locked for this transaction. This shall be the default value if this attribute is not configured. • ALLOW_RETRIEVES - Block oneM2M request primitives not associated with this transaction from performing any operation except RETRIEVE on the targeted resource while it is locked for this transaction. transactionControl 0..1 RW This attribute is used to control the state of the transaction. The allowed values are: • INITIAL (default) • LOCK • EXECUTE • COMMIT • ABORT If the transactionMode is set to "CSE_CONTROLLED", then only the <transactionMgmt> Hosting CSE shall be allowed to update this attribute. If the transactionMode is set to "CREATOR_CONTROLLED", then only the creator shall be allowed to update this attribute. This attribute should either not be present in a <transactionMgmt> create request or have a value of "INITIAL". transactionState 1 RO This attribute contains the current state of the transaction. Only the <transactionMgmt> Hosting CSE shall be allowed to update this attribute. It calculates the value of this attribute based on collective transactionState of the individual <transaction> resources associated with this <transactionMgmt> resource. The allowed values are: • INITIAL • LOCKED • EXECUTED • COMMITTED • ERROR • ABORTED ETSI ETSI TS 118 101 V4.15.0 (2022-09) 224 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <transactionMgmt> Multiplicity RW/ RO/ WO Description To update this attribute to a new state, all of the transactionState attributes of the individual <transaction> resources should be consistent and reflect the value of the new state. The exception is updating this attribute to "ERROR". If any of the transactionState attributes of the individual <transaction> resources have a value of "ERROR", then the <transactionMgmt> Hosting CSE shall update transactionState of this <transactionMgmt> resource to "ERROR". Before doing so however, the <transactionMgmt> Hosting CSE shall check if the transactionMaxRetries attribute is configured with a non- zero value and if so whether the retry limit has been exhausted. If not exhausted, the <transactionMgmt> Hosting CSE shall attempt to retry the transaction. If the transactionMaxRetries attribute is configured with a zero value or the retry limit is exhausted, then this attribute shall be set to "ERROR". A creator may subscribe to this attribute to receive notifications of changes to transactionState. transactionMaxRetries 0..1 RW If set, this attribute shall be used by the <transactionMgmt> Hosting CSE to determine the max number of times it may attempt to retry a transaction when detecting an "ERROR" transactionState from one or more <transaction> Hosting CSEs. If not set or if the max number of retries is exhausted, and the <transactionMgmt> Hosting CSE detects an "ERROR" transactionState from one or more <transaction> Hosting CSEs, then the transactionState of the <transactionMgmt> resource shall be updated to "ERROR". transactionMgmtHandlin g 0..1 RW This attribute is used by the <transactionMgmt> Hosting CSE to determine whether to persist or delete the <transactionMgmt> resource after its completion (i.e. transactionState is set to "COMMITTED" or "ABORTED"). The allowed values are: • DELETE (default) • PERSIST If set to "PERSIST" the <transactionMgmt> resource shall be deleted when the expirationTime elapses. requestPrimitives 1(L) WO This attribute contains an aggregated list of oneM2M request primitives associated with this transaction. When processing this transaction, the <transactionMgmt> Hosting CSE shall create a corresponding <transaction> resource for each oneM2M request primitive in this list. Each <transaction> resource shall be created as a child resource under the resource targeted by its respective request primitive. responsePrimitives 1(L) RO This attribute contains an aggregated list of oneM2M response primitives associated with this transaction. This attribute shall be updated by the <transactionMgmt> Hosting CSE and includes the individual responsePrimitive attributes received from the <transaction> Hosting CSE(s). The creator may subscribe to this attribute to receive notifications each time this attribute is updated with new response primitive(s). ETSI ETSI TS 118 101 V4.15.0 (2022-09) 225 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.48 Resource Type transaction | The <transaction> resource is used to initiate and manage the atomic and consistent processing of a single oneM2M request primitive of a oneM2M transaction. With the exception of the <request>, <delivery>, <transaction> and <transactionMgmt> resources, a <transaction> resource may be created as a child resource of any resource targeted by a oneM2M transaction. A <transaction> create request may be originated by a CSE that hosts an associated <transactionMgmt> resource. Alternatively, a <transaction> resource can be used independent of <transactionMgmt> resource for the case where an application wishes to create individual <transaction> resources itself. In order to process a transaction across multiple targeted resources, multiple <transaction> resources are created on the corresponding Hosting CSE(s) of the targeted resources. Depending on the intention of the application that is coordinating the transaction, each <transaction> resource represents a oneM2M requestPrimitive that needs to be performed on a targeted resource. The requestPrimitive of different <transaction> resources may be different or the same based on the desired outcome of the transaction. The time related attributes of different <transaction> resources (i.e. transactionLockTime, transactionExecuteTime and transactionCommitTime) may be different or the same as well to coordinate the desired order or schedule of the transaction. The <transaction> resource supports the child resources specified in table 9.6.48-1. Table 9.6.48-1: Child resources of <transaction> resource Child Resources of <transaction> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 [variable] <action> 0..n See clause 9.6.61 The <transaction> resource supports the attributes specified in table 9.6.48-2. Table 9.6.48-2: Attributes of <transaction> resource Attributes of <transaction> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. expirationTime 1 WO See clause 9.6.1.3. The value of the expirationTime serves as the expiration time of the transaction. parentID 1 RO See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RO See clause 9.6.1.3. labels 0..1 (L) RO See clause 9.6.1.3. creator 1 RO This attribute is configured with the CSE-ID of the <transactionMgmt> Hosting CSE or AE-ID of the AE that created this <transaction> resource. dynamicAuthorizationCon sultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. transactionID 1 WO This attribute is configured with the identifier of the transaction. This attribute is configured by the <transactionMgmt> Hosting CSE with the resource identifier of the <transactionMgmt> resource. If an AE creates the <transaction> resource, then this attribute is configured with an AE specified identifier. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 226 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <transaction> Multiplicity RW/ RO/ WO Description transactionControl 1 RW This attribute shall be used to configure or change the state of the transaction. The allowed values are: • LOCK • EXECUTE • COMMIT • ABORT Only the creator of this <transaction> resource is allowed to update this attribute. transactionState 1 RO This attribute contains the current state of the transaction. Only the Hosting CSE of this <transaction> resource shall be allowed to update this attribute. The allowed values are: • LOCKED • EXECUTED • COMMITTED • ERROR • ABORTED transactionLockTime 0..1 WO This attribute contains timing information that the <transaction> Hosting CSE itself shall use to schedule when it sets transactionControl to LOCK rather than relying on an UPDATE request to set the value of transactionControl to LOCK. transactionExecuteTime 0..1 WO This attribute contains timing information that the <transaction> Hosting CSE itself shall use to schedule when it sets transactionControl to EXECUTE rather than relying on an UPDATE request to set the value of transactionControl to EXECUTE. If the targeted resource is not locked at this scheduled time, the <transaction> Hosting CSE shall first lock the resource before executing the request primitive. transactionCommitTime 0..1 WO This attribute contains timing information that the <transaction> Hosting CSE itself shall use to schedule when it sets transactionControl to COMMIT rather than relying on an UPDATE request to set the value of transactionControl to COMMIT. If the targeted resource is not locked or the request primitive has not yet been executed at this scheduled time, the <transaction> Hosting CSE shall first lock the resource and execute the request primitive at this time before committal. transactionLockType 0..1 WO This attribute indicates the type of lock that is required on the targeted resource in order to perform the transaction. The following are the supported types of locks: • BLOCK_ALL - Block oneM2M request primitives not associated with this transaction from performing any CRUD operations on the targeted resource while it is locked for this transaction. This shall be the default value if this attribute is not configured. • ALLOW_RETRIEVES - Block oneM2M request primitives not associated with this transaction from performing any operation except RETRIEVE on the targeted resource while it is locked for this transaction. requestPrimitive 1 WO This attribute contains the request primitive to be executed on the parent of this <transaction> resource. responsePrimitive 1 RO This attribute contains the oneM2M response primitive associated with this transaction. This attribute is updated by the <transaction> Hosting CSE after it executes the requestPrimitive on the parent resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 227 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.49 Resource Type triggerRequest | The <triggerRequest> resource is used to initiate a device trigger request. This resource type shall only be instantiated on an IN-CSE. The successful creation of a <triggerRequest> resource results in the CSE initiating a trigger request to a targeted device (e.g. 3GPP UE). A pending trigger request can be replaced with a new trigger request by updating the <triggerRequesst> resource. A pending trigger request can be cancelled by deleting the <triggerRequesst> resource. The <triggerRequest> resource shall contain the child resource specified in table 9.6.49-1. Table 9.6.49-1: Child resources of <triggerRequest> resource Child Resources of <triggerRequest> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 of the present document. The <triggerRequest> resource shall contain the attributes specified in table 9.6.49-2. Table 9.6.49-2: Attributes of <triggerRequest> resource Attributes of <triggerRequest> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. dynamicAuthorizationConsultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. M2M-Ext-ID 1 WO M2M External Identifier of the device being triggered. See clause 7.1.8. This attribute shall be configured by the Originator when the resource is created. Trigger-Recipient-ID 1 RW Trigger-Recipient-ID of the ASN/MN-CSE or ADN-AE that is hosted on the device being triggered. See clause 7.1.10. This attribute shall be configured by the Originator when the resource is created and may also be updated when performing a trigger replace procedure. See clause 8.3.3.2.2. This attribute is application port ID for device trigger to uniquely identify the triggered application. triggerPurpose 1 RW The purpose of the trigger. See clause 8.3.3.2.1. This attribute may be configured by the Originator when the resource is created and may also be updated when performing a trigger replace procedure. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 228 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <triggerRequest> Multiplicity RW/ RO/ WO Description The allowed values are: • establishConnection • enrolmentRequest • registrationRequest • executeCRUD If not specified by the Originator, the default is "establishConnection". triggerStatus 1 RO The status of the trigger request. The Hosting CSE shall control the value of this attribute. The following values are valid values. • PROCESSING • ERROR-NSE-NOT-FOUND • TRIGGER-TRIGGERED • TRIGGER-DELIVERED • TRIGGER-FAILED • TRIGGER-REPLACED • TRIGGER-EXPIRED • TRIGGER-UNCONFIRMED • TRIGGER-TERMINATED • TRIGGER-SUCCESS triggerValidityTime 1 RW The time duration for which the trigger request is valid. After this time expires, the trigger shall be recalled (i.e. cancelled) by the Hosting CSE. This attribute may be configured by the Originator when the resource is created and may also be updated when performing a trigger replace procedure. See clause 8.3.3.2.2. If this attribute is not set, the CSE may configure the triggerValidityTime attribute based on local policy. triggerInfoAE-ID 0..1 RW When the triggerPurpose is "executeCRUD", this attribute is mandatory otherwise it is not applicable. This attribute is configured with the AE-ID of the ASN/MN-AE that should perform the CRUD operation. When this attribute is configured, the trigger originator shall also configure the triggerInfoAddress, triggerInfoOperation and targetedResourceType attributes. triggerInfoAddress 0..1 RW When the triggerPurpose is "enrolmentRequest", this field shall be configured with the absolute URI of the <MEFBase> resource of the MEF that the ASN/MN-CSE or ADN-AE shall enrol to. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 229 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <triggerRequest> Multiplicity RW/ RO/ WO Description When the triggerPurpose is "establishConnection" and the pointOfAccess attribute of the <AE> or <remoteCSE> representing the ASN/MN-CSE or ADN-AE needs updating, this field shall be configured with an unstructured CSE-Relative-Resource- ID of the <remoteCSE> or <AE> resource. If this attribute is not provided, the trigger recipient shall establish a network connection with its registrar CSE but not update its pointOfAccess. When the triggerPurpose is "registrationRequest", and this field is provided by the trigger originator, then this field shall be configured with the unstructured CSE-Relative-Resource-ID of the Registrar CSE's <cseBase> resource that the trigger recipient shall register to. When the triggerPurpose is "registrationRequest", and this field is not provided by the trigger originator, the trigger recipient shall register to the Registrar CSE using a pre-provisioned address of the Registrar CSE. The pre- provisioning method is outside the scope of the present document. When the triggerPurpose is "executeCRUD", this attribute shall be configured with an unstructured CSE-Relative-Resource-ID of the resource that the ASN/MN-AE shall perform the CRUD operation on. When this attribute is configured for "executeCRUD", the trigger originator shall also configure the triggerInfoAE-ID, triggerInfoOperation and targetedResourceType attributes. triggerInfoOperation 0..1 RW When the triggerPurpose is "executeCRUD", this attribute is mandatory otherwise it is not applicable. This attribute is configured with the CRUD operation that the ASN/MN-AE should perform on the targeted resource specified by triggerInfoAddress. When this attribute is configured, the trigger originator shall also configure the triggerInfoAE-ID, triggerInfoAddress and targetedResourceType attributes. targetedResourceType 0..1 RW When the triggerPurpose is "executeCRUD", this attribute is mandatory otherwise it is not applicable. This attribute is configured with the resource type of the targeted resource specified by triggerInfoAddress. When this attribute is configured, the trigger originator shall also configure the triggerInfoAE-ID, triggerInfoAddress and triggerInfoOperation attributes. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 230 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <triggerRequest> Multiplicity RW/ RO/ WO Description triggerReference 0..1 RO This attribute is a reference number which is allocated by the CSE of a transaction and is used in all subsequent messages related to that transaction to support device triggering. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.50 Resource Type ontologyRepository | An <ontologyRepository> resource is a child resource of the <CSEBase> resource. The <ontologyRepository> resource may have one or multiple <ontology> child resources to represent and manage both internal and external ontologies in the oneM2M system. By performing the CRUD operations on the <ontology> resources, explicit ontologies can be imported (created), discovered, retrieved, updated and deleted inside the oneM2M system, and can be used for semantic validation when they are referenced by <semanticDescriptor> resources. The details of <ontology> resource are specified in clause 9.6.51. The <ontologyRepository> resource may also contain a (virtual) child resource <semanticValidation> as the interface to accept semantic validation request from an AE or a CSE. Upon receiving an Update request with <semanticDescriptor> resource representation addressing the <semanticValidation> resource, the hosting CSE shall perform the semantic validation against the <semanticDescriptor> resource received in the request. The details of <semanticValidation> resource are specified in clause 9.6.52. The <ontologyRepository> resource shall contain the child resources as specified in table 9.6.50-1. Table 9.6.50-1: Child resources of <ontologyRepository> resource Child Resources of <ontologyRepository> Child Resource Type Multiplicity Description <ontologyRepositoryAnnc> Child Resource Types [variable] <ontology> 0..n See clause 9.6.51 <ontologyAnnc> smv <semanticValidation> 1 See clause 9.6.52 None [variable] <subscription> 0..n See clause 9.6.8 <subscription> [variable] <ontologyMapping> 0..n See clause 9.6.70 <ontologyMappingAnnc> [variable] <ontologyMappingAlog rithmRepository> 0..n See clause 9.6.71 <ontologyMappingAlogrithmR epositoryAnnc> The <ontologyRepository > resource above contains the attributes specified in table 9.6.50-2. Table 9.6.50-2: Attributes of <ontologyRepository> resource Attribute Name Multiplicity RW/RO/WO Description <ontologyRepo sitoryAnnc> Attributes resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. NA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. NA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. MA lastModifiedTime 1 RO See clause 9.6.1.3. MA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationConsultationIDs 0..1 (L) RW See clause 9.6.1.3. OA creator 0..1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 231 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.51 Resource Type ontology | The <ontology> resource is a child resource of the <ontologyRepository> resource. The <ontology> resource is used to store the representation of an ontology. This representation may contain ontology descriptions in a variety of formats, given the requirements for re-use of existing ontologies, for support of ontologies available only externally and for support of ontology imported into the system. The ontology description is made available to the semantic-related functions of the oneM2M system provided by applications or CSEs. Given the possible need to have access to multiple versions of an ontology, and to different formats, a ontologyFormat attribute provides information necessary for the system to interpret the information available in the ontologyContent attribute. The <ontology> resource above contains the child resources specified in table 9.6.51-1. Table 9.6.51-1: Child resources of <ontology> resource Child Resources of <semanticDescriptor> Child Resource Type Multiplicity Description <ontologyAnnc> Child Resource Types [variable] <subscription> 0..n See clause 9.6.8 where the type of this resource is described. <subscription> The <ontology> resource above contains the attributes specified in table 9.6.51-2. Table 9.6.51-2: Attributes of <ontology> resource Attribute Name Multiplicity RW/RO/WO Description <ontologyAnnc> Attributes resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. NA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. NA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. MA lastModifiedTime 1 RO See clause 9.6.1.3. MA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationConsultationIDs 0..1 (L) RW See clause 9.6.1.3. OA creator 0..1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA description 0..1 RW Text description of the ontology. OA ontologyFormat 1 RW Attribute providing information about the format of the ontologyContent attribute. It may indicate the content as: IRI - for an ontology to be accessed via the IRI [i.37] provided in the ontologyContent attribute OR File format - for an ontology for which the document is stored in the ontologyContent attribute. In this case ontologyFormat provides ontology format, e.g. OWL/XML, RDF/Turtle. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 232 (oneM2M TS-0001 version 4.15.0 Release 4) Attribute Name Multiplicity RW/RO/WO Description <ontologyAnnc> Attributes ontologyContent 1 RW Depending on the ontologyFormat attribute, it may be interpreted either as: The IRI of the corresponding ontology document OR The content of the corresponding ontology document. OA semanticOpExec 0..1 RW This attribute cannot be retrieved. Contains a SPARQL query request for execution of semantic operations on the ontologyContent attribute e.g. SPARQL update as described in ETSI TS 118 104 [3]. NA |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.52 Resource Type semanticValidation | The <semanticValidation> resource is a virtual resource because it does not have a representation. It is the child resource of a <ontologyRepository> resource. It is the interface to accept a semantic validation (Update) request which includes a <semanticDescriptor> resource to be validated. The Hosting CSE shall perform the semantic validation functionality by checking the validity (i.e. conformance) of the triples in the descriptor attribute of the received <semanticDescriptor> resource, as well as any linked <semanticDescriptor> resources linked by the relatedSemantics attribute or the onem2m:resourceDescriptorLink annotation property (see clause 10.2.14) in the descriptor attribute, against the referenced ontologies (including the reference ontologies of the linked <semanticDescriptor> resources, if any) as pointed by the ontologyRef attribute. If the ontologyRef attribute is absent, the Hosting CSE shall return an error. The Hosting CSE may need to retrieve (and cache) the linked <semanticDescriptor> resources and their referenced ontologies from a remote CSE to perform the semantic validation process. The aspects to be checked in the semantic validation process is specified in oneM2M TS-0034 [14]. The <semanticValidation> resource does not have a resource representation by itself and consequently it does not have an accessControlPolicyIDs attribute. The <accessControlPolicy> resource used for access control policy validation is indicated by the accessControlPolicyIDs attribute in the parent <ontologyRepositoy> resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.53 Resource Type semanticMashupJobProfile | The <semanticMashupJobProfile> resource represents a Semantic Mashup Job Profile (SMJP). A SMJP describes the profile and necessary information required for a specific mashup service such as input parameters, member resources, mashup function, and output parameters. Based on the profile described in the SMJP, Originators (e.g. AEs) can create corresponding semantic mashup instances where semantic mashup results will be generated and stored. The <semanticMashupJobProfile> resource shall contain the child resources specified in table 9.6.53-1. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 233 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.53-1: Child resources of <semanticMashupJobProfile> resource Child Resources of <semanticMashup JobProfile> Child Resource Type Multiplicity Description <semanticMashupJob ProfileAnnc> Child Resource Types <variable> <semanticMash upInstance> 0..n Represents semantic mashup instances which have been created based on this <semanticMashupJobProfile> resource. This child resource is optional as related<semanticMashupJobProfile> and <semanticMashupInstance> may be stored separately within the resource tree or on different CSEs. See clause 9.6.54. <semanticMashupInsta nce>, <semanticMashupInsta nceAnnc> <variable> <semanticDesc riptor> 0..1 Describes general semantic information about this <semanticMashupJobProfile> resource. See clause 9.6.30. <semanticDescriptor>, <semanticDescriptorAn nc> <variable> <subscription> 0..n Represents subscriptions on this resource. See clause 9.6.8. <subscription> The <semanticMashupJobProfile> resource shall contain the attributes specified in table 9.6.53-2. Table 9.6.53-2: Attributes of <semanticMashupJobProfile> resource Attributes of <semanticMashu pJobProfile> Multiplicity RW/ RO/ WO Description <semanticMashup JobProfileAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA accessControlPoli cyIDs 0..1 (L) RW See clause 9.6.1.3. MA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribut e 0..1 (L) RW See clause 9.6.1.3. NA announceSyncTy pe 0..1 RW See clause 9.6.1.3. MA dynamicAuthoriza tionConsultationID s 0..1 (L) RW See clause 9.6.1.3. OA creator 0..1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA memberFilter 1 RW Semantically describes the types of member resources which are involved in this semantic mashup job profile <semanticMashupJobProfile>. When a <semanticMashupInstance> is created based on this <semanticMashupJobProfile>, the member resources of the <semanticMashupInstance> shall be discovered and selected based on this memberFilter attribute. The value of this attribute is a SPARQL query. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 234 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <semanticMashu pJobProfile> Multiplicity RW/ RO/ WO Description <semanticMashup JobProfileAnnc> Attributes smiID 0..1(L) RO List of resource identifiers of related semantic mashup instance resources which have been created based on this <semanticMashupJobProfile>. OA inputDescriptor 0..1 RW Semantically (i.e. using semantic triples) describes the types of input parameters, which are required in order to use this <semanticMashupJobProfile> to create <semanticMashupInstance>. Some semantic mashup job profiles may not need input parameters and as such this attribute is optional. OA outputDescriptor 1 RW Semantically (e.g. in semantic triples) describes the types of output parameters generated as semantic mashup results if using this <semanticMashupJobProfile>. OA functionDescriptor 1 RW Semantically (e.g. in semantic triples) describes the mashup function of this <semanticMashupJobProfile>. The mashup function specifies how semantic mashup results should be generated based on input parameters (defined by the inputDescriptor attribute) and original member resources (defined by the memberFilter attribute). OA |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.54 Resource Type semanticMashupInstance | <semanticMashupInstance> models and represents a Semantic Mashup Instance (SMI) resource. A CSE/AE as a Mashup Requestor can request to create <semanticMashupInstance> resources at another oneM2M CSE which implements the semantic mashup function. Each created <semanticMashupInstance> resource corresponds to a semantic mashup job profile (i.e. a <semanticMashupJobProfile> resource); in other words, how the <semanticMashupInstance> resource should execute the mashup operation to calculate the mashup result is specified in the corresponding <semanticMashupJobProfile> resource. Note that the <semanticMashupInstance> and its corresponding <semanticMashupJobProfile> resources may be placed at the same CSE or at different CSEs, and the smjpID attribute of the <semanticMashupInstance> allows locating the corresponding <semanticMashupJobProfile> resource. If the <semanticMashupInstance> resource has a <semanticMashupResult> as its child resource, the Mashup Requestor may use it to retrieve the mashup result. The <semanticMashupInstance> resource shall contain the child resources specified in table 9.6.54-1. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 235 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.54-1: Child resources of <semanticMashupInstance> resource Child Resources of <semanticMash upInstance> Child Resource Type Multiplicity Description <semanticMashu pInstanceAnnc> Child Resource Types <variable> <semanticMashup Result> 0..n Contains mashup result. A <semanticMashupInstance> resource may have multiple <semanticMashupResult> child resources, with each mashup result instance resulting from different input parameters and/or member resource values. The hosting CSE generates <semanticMashupResult> each time when it executes the mashup operation and calculate a new semantic mashup result. <semanticMashup Result>, <semanticMashup ResultAnnc> <variable> <semanticDescript or> 0..1 Describes general semantic information about this <semanticMashupInstance> resource. <semanticDescrip tor>, <semanticDescrip torAnnc> <variable> <subscription> 0..n Stands for any subscription on this <semanticMashupInstance>. <subscription> msp <mashup> 1 This is a standard oneM2M virtual resource. When a Mashup Requestor sends a RETRIEVE operation on this virtual resource, it triggers a re- calculation and re-generation of the mashup result. None The <semanticMashupInstance> resource shall contain the attributes specified in table 9.6.54-2. Table 9.6.54-2: Attribute of <semanticMashupInstance> resource Attributes of <semanticMashupI nstance> Multiplicity RW/ RO/ WO Description <semanticMashup InstanceAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA accessControlPolicy IDs 0..1 (L) RW See clause 9.6.1.3. MA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizatio nConsultationIDs 0..1 (L) RW See clause 9.6.1.3. OA creator 0..1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA smjpID 1 RW Denotes the identifier (e.g. URI) of the semantic mashup job profile resource <semanticMashupJobProfile> which this <semanticMashupInstance> is based on. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 236 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <semanticMashupI nstance> Multiplicity RW/ RO/ WO Description <semanticMashup InstanceAnnc> Attributes smjpInputParameter 0..1 RW Contains the value of all input parameters which are required to calculate the mashup result. Note that the types of these input parameters are specified by the inputDescriptor attribute of the corresponding <semanticMashupJobProfile> which is denoted by the smjpID attribute of this <semanticMashupInstance> resource. This attribute is not needed if the corresponding <semanticMashupJobProfile> does not have inputDescriptor attribute. OA memberStoreType 1 RW Indicates the way which member resources should be stored under this <semanticMashupInstance>. For example: • If memberStoreType="URI Only", the mashupMember attribute contains the URI of each member resource; • If memberStoreType="URI and Value", the mashupMember attribute contains both the URI and the value of each member resource. OA mashupMember 0..1(L) RW Stores the URI and/or value of each mashup member resource, which is dependent on the value of memberStoreType attribute. OA resultGenType 1(L) RW Describes how the mashup result should be generated using this <semanticMashupInstance>. Example values for this attribute could be one of the following or a combination of them. • If resultGenType="When SMI Is Created", the semantic mashup result is generated when this <semanticMashupInstance> is created by running semantic functions specified by the corresponding <semanticMashupJobProfile>. • If resultGenType="When Mashup Requestor Requests", the mashup result is to be calculated and generated when requested or triggered by a Mashup Requestor which sends a RETRIEVE operation on the virtual child resource mashup. • If resultGenType="Periodically", the CSE which hosts <semanticMashupInstance> calculates and generates the semantic mashup result periodically based on the periodForResultGen attribute. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 237 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <semanticMashupI nstance> Multiplicity RW/ RO/ WO Description <semanticMashup InstanceAnnc> Attributes • If resultGenType="When A Mashup Member Is Updated", the CSE which hosts <semanticMashupInstance> calculates and generates the semantic mashup result whenever there is any update on the mashupMember attribute of <semanticMashupInstance>. periodForResultGen 0..1 RW Is the time period for re-calculating and generating the semantic mashup result. When it is the time to re-calculate the semantic mashup result, the CSE hosting this <semanticMashupInstance> needs to retrieve the latest content value of each member resource if it is not obtained yet. This attribute is needed when resultGenType="Periodically". OA |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.55 Resource Type mashup | The <mashup> resource is a virtual resource because it does not have a representation. It is the child resource of a <semanticMashupInstance> resource. When a RETRIEVE operation is sent to the <mashup> resource, it triggers a calculation and generation of the mashup result based on its parent resource <semanticMashupInstance>. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.56 Resource Type semanticMashupResult | <semanticMashupResult> resource stores the mashup result. It is the child resource of a <semanticMashupInstance> resource. A <semanticMashupResult> resource shall be automatically generated by a Hosting CSE when it executes a semantic mashup operation on a <semanticMashupInstance> resource. The <semanticMashupResult> resource shall contain the child resources specified in table 9.6.56-1 and the attributes specified in table 9.6.56-2. Table 9.6.56-1: Child resources of <semanticMashupResult> resource Child Resources of <semanticMashupR esult> Child Resource Type Multiplicity Description <semanticMashupResultA nnc> Child Resource Types <variable> <semanticDescriptor> 0..1 Describes general semantic information for this <semanticMashupResult > resource. <semanticDescriptor>, <semanticDescriptorAnnc> <variable> <subscription> 0..n Stands for any subscription on this <semanticMashupResult > resource. <subscription> ETSI ETSI TS 118 101 V4.15.0 (2022-09) 238 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.56-2: Attribute of <semanticMashupResult> resource Attributes of <semanticMashup Result> Multiplicity RW/ RO/ WO Description <semanticMashupIns tanceAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA accessControlPolicy IDs 0..1 (L) RW See clause 9.6.1.3. MA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizatio nConsultationIDs 0..1 (L) RW See clause 9.6.1.3. OA creator 0..1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA smjpInputParameter 0..1 RO Contains the value of all input parameters which are required to calculate the mashup result. Note that the types of these input parameters are specified by the inputDescriptor attribute of the corresponding <semanticMashupJobProfile> which is denoted by the smjpID attribute of the parent resource <semanticMashupInstance>. This attribute is not needed if the corresponding <semanticMashupJobProfile> does not have inputDescriptor attribute. The value of this attribute shall be automatically copied from the smjpInputParameter attribute of the parent resource <semanticMashupInstance>. This attribute shall not be updated by other entities except the Hosting CSE. OA mashupResultForm at 1 RO Stands for the format of mashupResult representation (e.g. Integer, Float, Text, XML, JSON, etc.). The value of this attribute shall be obtained by a Hosting CSE directly from outputDescriptor attribute of corresponding <semanticMashupJobProfile> resource. This attribute shall not be updated by other entities except the Hosting CSE. OA mashupResult 1 RO Contains the representation of mashup result. The value of this attribute shall be only generated by the Hosting CSE when it executes a semantic mashup operation. This attribute shall not be updated by other entities except the Hosting CSE. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 239 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.57 Resource Type multimediaSession | A <multimediaSession> resource shall represent information about a multimedia session involving two AEs. This resource is created by the session originator as the child of the <AE> resource which represents a session target. The creation, update or deletion of the <multimediaSession> resource triggers the AEs to manage (e.g. establish, tear-down) the multimedia session. The multimedia session described in the <multimediaSession> resource is managed by the two AEs using non-oneM2M protocols. NOTE: Additional features (e.g. manage QoS settings for a session in an underlying network) involving Mcn reference point will be considered in future releases. The <multimediaSession> resource shall contain the child resources specified in table 9.6.57-1. Table 9.6.57-1: Child resources of <multimediaSession> resource Child Resources of <multimediaSession> Child Resource Type Multiplicity Description <multimediaSession Annc> Child Resource Types [variable] <subscription> 0..n See clause 9.6.8 <subscription> [variable] <transaction> 0..n See clause 9.6.48 <transaction> The <multimediaSession> resource shall contain the attributes specified in table 9.6.57-2. Table 9.6.57-2: Attributes of <multimediaSession> resource Attributes of <multimediaSession> Multiplicity RW/ RO/ WO Description <multimediaSe ssionAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. MA resourceName 1 WO See clause 9.6.1.3. MA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. MA dynamicAuthorizationConsultat ionIDs 0..1 (L) RW See clause 9.6.1.3. OA custodian 0..1 RW See clause 9.6.1.3. NA creationTime 1 RW See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA labels 0..1 (L) RO See clause 9.6.1.3 where this common attribute is described. MA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA sessionOriginatorID 1 WO The AE-ID of the multimedia session originator. OA acceptedSessionDescriptions 1(L) RW This is the final accepted and agreed upon session description(s) based on the received response from the target of the multimedia session. When this attribute is set by the session target, the session originator establishes a session with a non-oneM2M protocol. The session description is compliant to the Session Description Protocol [17]. OA offeredSessionDescriptions 1(L) RW A list of session descriptions offered by the Originator of the session to the target. The session descriptors are compliant to the Session Description Protocol [17]. NA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 240 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <multimediaSession> Multiplicity RW/ RO/ WO Description <multimediaSe ssionAnnc> Attributes sessionState 1 RW The current state of the multimedia session. The supported values are ONLINE and OFFLINE. This attribute is set either by the session originator or the target. When this attribute is OFFLINE, the Hosting CSE shall allow updates to offeredSessionDescriptions and/or acceptedSessionDescription. Otherwise, the Hosting CSE shall reject the updates to these attributes. When the session is in the OFFLINE state, the corresponding AE session endpoints shall not initiate the flow of media between one another. When in the ONLINE state, the AEs are free to initiate the flow of media. OA |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.58 Resource Type crossResourceSubscription | The <crossResourceSubscription> resource represents a cross-resource subscription over a set of target resources which could be existing <subscription> and/or other subscribable oneM2M resources. The Hosting CSE shall generate a cross-resource notifications only when expected changes occur on a designated number of target resources concurrently within a time window. The <crossResourceSubscription> resource shall specify the involved target resources in order to generate cross-resource notification. The <crossResourceSubscription> resource shall contain the child resources specified in table 9.6.58-1. Table 9.6.58-1: Child resources of <crossResourceSubscription> resource Child Resources of <crossResourceSubscription> Child Resource Type Multiplicity Description notificationSchedule <schedule> 0..1 See clause 9.6.9. [variable] <notificationTargetMgm tPolicyRef> 0..n See clause 9.6.31. nstr <notificationTargetSelfR eference> 1 See clause 9.6.34. [variable] <transaction> 0..n See clause 9.6.48 The <crossResourceSubscription> resource shall contain the attributes specified in table 9.6.58-2. Table 9.6.58-2: Attributes of <crossResourceSubscription> resource Attributes of <crossResourceSubscription> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. announceTo 0..1 (L) RW See clause 9.6.1.3. announcedAttribute 0..1 (L) RW See clause 9.6.1.3. announceSyncType 0..1 RW See clause 9.6.1.3. dynamicAuthorizationConsultatio nIDs 0..1 (L) RW See clause 9.6.1.3. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 241 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <crossResourceSubscription> Multiplicity RW/ RO/ WO Description creator 1 RO See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. expirationCounter 0..1 RW See clause 9.6.8. notificationURI 1 (L) RW See clause 9.6.8. notificationEventCat 0..1 RW See clause 9.6.8. subscriberURI 0..1 WO See clause 9.6.8. regularResourcesAsTarget 0..1 RW This attribute indicates a list of regular resources (i.e. normal resources rather than <subscription> resources), which shall be used as the target resource for this cross- resource subscription. Here, the regular resource is referred to as any subscribable oneM2M resources. subscriptionResourcesAsTarget 0..1 RW This attribute indicates a list of existing <subscription> resources, which shall be used as the target resource for this cross-resource subscription. timeWindowType 1 RW This attribute indicates the type of time window mechanisms (e.g. timeWindowType=1 stands for periodic time window without any overlapping and timeWindowType=2 represents sliding time window where current time window will be slid to become next time window when a cross-resource notification is generated for instance) which will be used to determine the generation of a cross-resource notification. timeWindowSize 1 RW This attribute indicates the size or time duration (e.g. in seconds) of the time window, based on which cross- resource notifications shall be generated. Note that the maximum window size (e.g. 60 seconds) may be enforced by the Hosting CSE for a subscriber; if the timeWindowSize indicated or requested by a subscriber is larger than the maximum window size, the Hosting CSE may reject the subscriber's request for cross-resource subscription. eventNotificationCriteriaSet 0..1(L) RW This attribute lists eventNotificationCriteria for each regular target resource as indicated in regularResourcesAsTarget attribute and involved in a cross-resource subscription. If there is only one eventNotificationCriteria contained in this attribute, it shall be applied to all target resources as indicated by regularResourcesAsTarget attribute. If only subscriptionResourcesAsTarget attribute appears (i.e. no regularResourcesAsTarget attribute), eventNotificationCriteriaSet shall not be needed. See clause 9.6.8 for the description of eventNotificationCriteria. notificationStatsEnable 1 RW When set to "TRUE", the Hosting CSE shall clear any statistics that were previously stored in the notificationStatsInfo attribute and start recording notification statistics for each notification generated for this resource. When set to "FALSE", the Hosting CSE shall stop recording notification statistics for this resource and maintain the current value of the notificationStatsInfo attribute. Default is "FALSE". ETSI ETSI TS 118 101 V4.15.0 (2022-09) 242 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <crossResourceSubscription> Multiplicity RW/ RO/ WO Description notificationStatsInfo 0..1(L) RO A list containing notification statistics recorded by the Hosting CSE for each notification target specified by the notificationURI attribute of this resource. The Hosting CSE shall maintain a separate set of notification statistics that include: • Total number of notification requests sent to a notification target • Total number of notification responses received from a notification target Refer to ETSI TS 118 104 [3] for further details regarding the format of this attribute. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.59 Resource Type flexContainerInstance | The <flexContainerInstance> resource represents a data instance in the <flexContainer> resource. The <flexContainerInstance> resource shall be created by the Hosting CSE when: • the parent <flexContainer> is created or one or more of the parent's custom attributes are modified, or the parent is modified by an UPDATE request that contains no attribute at all; and • at least one of the maxNrOfInstances, maxByteSize or maxInstanceAge attributes is present. An update of any of the universal, common, or resource specific attributes of the parent <flexContainer>, except custom attributes, does not cause the creation of a new <flexContainerInstance> resource. The <flexContainerInstane> shall remain unchanged once created. An AE can delete a <flexContainerInstance> resource explicitly or it may be deleted by the Hosting CSE following the retention policy defined by the maxNrOfInstances, maxByteSize and maxInstanceAge attributes. The <flexContainerInstance> resource inherits the same access control policies of the parent <flexContainer> resource, and does not have its own accessControlPolicyIDs attribute. The <flexContainerInstance> resource shall contain the attributes specified in table 9.6.59-1. Table 9.6.59-1: Attributes of <flexContainerInstance> resource Attributes of <flexContainerInstance> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 RO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. labels 0..1 (L) RO See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. expirationTime 1 RO See clause 9.6.1.3. contentSize 1 RO Sum of the size in bytes of all of the custom attributes. originator 1 RO This attribute is configured with the identifier of the entity that originated the request that caused the creation of this <flexContainerInstance> resource, i.e. the originator of the CREATE or UPDATE request of the parent <flexContainer> resource, which resulted in this creation by the Hosting CSE. [customAttribute] 0..n RO Specialization-specific attribute(s). Name and data type defined in each specialization of parent <flexContainer> resource. These custom attributes are copies of all of the parent <flexContainer> resource custom attributes when the <flexContainerInstance> resource is created. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 243 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.60 Resource Type backgroundDataTransfer | The <backgroundDataTransfer> resource is used to request that the CSE negotiates a background data transfer for a set of field nodes, with the Underlying Network. The resource attributes provide the characteristics of the background data transfer, optional guidance for transfer policy selection and the field nodes involved with the data transfer. The <backgroundDataTransfer> resource contains the child resources specified in table 9.6.60-1. Table 9.6.60-1: Child resources of <backgroundDataTransfer> resource Child Resources of <backgroundDataTransfer> Child Resource Type Multiplicity Description <backgroundDataTransfer> Child Resource Types [variable] <subscription> 0..n See clause 9.6.8. <subscription> The <backgroundDataTransfer> resource contains the attributes specified in table 9.6.60-2. Table 9.6.60-2: Attributes of <backgroundDataTransfer> resource Attributes of <backgroundDataTransfer> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. dynamicAuthorizationConsulta tionIDs 0..1 (L) RW See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. creator 0..1 RO See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. volumePerNode 1 WO Expected data volume for the background data transfer. numberOfNodes 1 WO Desired number of nodes for the background data transfer. desiredTimeWindow 0..1 WO Desired time window for the background data transfer. transferSelectionGuidance 0..1(L) WO List that includes guidance to CSE in selecting from multiple transfer policies provided by underlying network. Possible values include:" lowest cost", "highest throughput given maximum cost of X", etc. If not included, the CSE may independently choose from among multiple transfer policies. geographicInformation 0..1 WO Provides geographic information for the policy request. groupLink 0..1 RW This attribute shall be used if the background data transfer is requested for sending a request to a group of field domain nodes. It is assumed that a <group> resource, with a memberIDs list including all field domain nodes that need to be reached, has already been created. This attribute contains the resource identifier of the <group> resource of field domain nodes for which the background data transfer applies. The backgroundDataTransfer resource may have either a groupLink attribute or a list of memberIDs. If the memberIDs attribute contains a valid list of member resource IDs, the groupLink attribute shall be ignored. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 244 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <backgroundDataTransfer> Multiplicity RW/ RO/ WO Description memberIDs 0..1 (L) RW List of member resource IDs for which the transfer policy applies. The valid resource types are <remoteCSE> and <AE>. The backgroundDataTransfer resource may have either a groupLink attribute or a list of memberIDs. If the memberIDs attribute contains a valid list of member resource IDs, the groupLink attribute shall be ignored. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.61 Resource Type action | The <action> resource defines an operation (i.e. a oneM2M primitive) performed by the Hosting CSE on a target resource when criteria defined by the <action> resource and any applicable child <dependency> resources of the <action> resource have been met. The <action> resource and any applicable child <dependency> resources include the following information: • A subject resource that is monitored by the Hosting CSE to detect if/when the evaluation criteria specified by the <action> resource are met. • An object resource that the Hosting CSE targets the primitive, defined by the <action> resource, towards if/when the evaluation criteria specified by the <action> resource and any applicable child <dependency> resources are met. • An input resourcethat may provide input parameters for the action. • Conditions that are monitored by the Hosting CSE to determine if the primary event occurs. • Dependencies that are evaluated by the Hosting CSE to determine if the action is to be conditionally performed. • Parameters providing priorities of the action and dependencies. The <action> resource shall contain the child resources specified in table 9.6.61-1. Table 9.6.61-1: Child resources of <action> resource Child Resources of <action> Child Resource Type Multiplicity Description <actionAnnc> Child Resource Types [variable] <dependency> 0..n See clause 9.6.62 <dependencyAnnc> [variable] <subscription> 0..n See clause 9.6.8 <subscription> [variable] <transaction> 0..n See clause 9.6.48 <transaction> The <action> resource shall contain the attributes specified in table 9.6.61-2. Table 9.6.61-2: Attributes of <action> resource Attributes of <action> Multiplicity RW/ RO/ WO Description <actionAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. MA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA announceTo 0..1 (L) RW See clause 9.6.1.3. NA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 245 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <action> Multiplicity RW/ RO/ WO Description <actionAnnc> Attributes announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationCon sultationIDs 0..1 (L) RW See clause 9.6.1.3. OA creator 1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA actionPriority 0..1 RW Attribute indicating the priority level of this <action> resource compared with other <action> resources on this Hosting CSE having the same subject (defined by the subjectResourceID if present or otherwise the parent resource), evalCriteria, evalMode, evalParameter and dependencies. The value of this attribute shall determine the order in which the Hosting CSE performs the actionPrimitive on the objectResourceID defined for this <action> resource relative to the actionPrimitive performed on the objectResourceID attributes defined by these other <action> resources when the events and conditions defined by the same subject, evalCriteria, evalMode, evalParameter and dependencies have been met. The priority level is formatted as a number with highest priority indicated by the lowest value. Local policies are applied for equal or unspecified priorities. OA subjectResourceID 0..1 RW The resource identifier of the resource that is the subject of monitoring for evaluation of the evalCriteria attribute. The subject can be any resource in the system. If this attribute is not configured, the subject is the parent resource of this <action> resource. OA evalCriteria 1 RW This attribute provides the conditions determining if the action is to be triggered, contingent upon any dependencies also being satisfied. The evalCriteria attribute, in conjunction with the subject, forms the primary event expression that is monitored by the Hosting CSE. If/when the conditions of this primary event are met, the Hosting CSE shall then evaluate any <dependency> resources referenced in the dependencies attribute of this resource to determine if the action is to be triggered. See further description below and in table 9.6.61-3. OA evalMode 1 RW This attribute provides the control mode of the evaluation of the primary event (i.e. before any dependencies are evaluated) as defined by the evalCriteria and subject of this <action> resource. The supported values are: 0 = off 1 = once 2 = periodic 3 = continuous OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 246 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <action> Multiplicity RW/ RO/ WO Description <actionAnnc> Attributes evalControlParam 0..1 RW When evalMode has a value of "periodic", the evalControlParam represents the periodicity in seconds. If no value of this attribute is configured, then the Hosting CSE shall use local policies to determine the periodicity value. When evalMode has a value of "continuous" the evaluation is restarted as soon as an action has been triggered. In this case, if evalControlParam is specified, it determines the number of times the Hosting CSE shall trigger the event, otherwise it is repeated indefinitely. When evalMode has a value of "off" or "once", this attribute shall not be present. OA dependencies 0..1 (L) RW List of dependencies in priority order. This is an ordered list of the resource identifiers of applicable child <dependency> resources of this <action> resource. OA objectResourceID 1 RW The identifier of a resource or attribute that the Hosting CSE targets the actionPrimitive towards when detecting that the evalCriteria and any dependencies defined in the dependencies attribute have been met. MA actionPrimitive 1 RW This attribute stores the primitive that is performed on the objectResourceID when the Hosting CSE detects that the evalCriteria and any dependencies defined in the dependencies attribute have been met. The Hosting CSE shall ignore the value configured in the To parameter of the actionPrimitive and configure it with the resource identifier defined by objectResourceID. The Hosting CSE shall also configure the value of the Resource Type parameter with the resource type of the resource referenced by objectResourceID. If the input attribute of the <action> resource is configured, the Hosting CSE shall override the value of the Content parameter in the actionPrimitive with the value stored in the input attribute. MA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 247 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <action> Multiplicity RW/ RO/ WO Description <actionAnnc> Attributes input 0..1 RW Input used by the Hosting CSE to override the Content parameter in the actionPrimitive. The attribute may be formatted as: • a string; • a resource identifier; or • the identifier of a resource attribute. The Hosting CSE overrides the Content parameter in the actionPrimitive with the following (respectively): • the given string; • the resource representation of the referenced resource; • the value of the referenced resource attribute. OA actionResult 1 RO After performing the actionPrimitive on the objectResourceID, the Hosting CSE stores the response primitive in this attribute. OA The conditions represented in the evalCriteria attribute determine if the action is to be triggered, subject to any dependencies also being satisfied. The evalCriteria attribute is comprised of triples (subject, operator, threshold) with the parameters shown and described in table 9.6.61-3. Table 9.6.61-3: Parameters in evalCriteria triple Name Description subject This parameter shall indicate an attribute of the subject or dependency resource e.g. "tempContainer.content". operator This parameter is a keyword used to construct the evaluation logic, e.g. 'equals', 'not equals', 'greater than', 'less than', 'greater or equal', 'less or equal', 'string match', etc. threshold This parameter provides a value used to evaluate the criteria. The value type shall match the type of the attribute used as subject. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.62 Resource Type dependency | The <dependency> resource represents conditions that determine if the action specified in the parent <action> resource is triggered (i.e. a oneM2M primitive performed by the Hosting CSE on a target resource). An <action> may reference zero or more <dependency> resources. The <dependency> resources provide conditions that always need to be checked before the action is triggered. The difference between the evalCriteria specified by an <action> resource and the one specified by a <dependency> resource is that the former applies to the subject resource and triggers an evaluation, while the latter applies to other resources which provide conditions used in evaluation. The <dependency> resource shall contain the child resources specified in table 9.6.62-1. Table 9.6.62-1: Child resources of <dependency> resource Child Resources of <action> Child Resource Type Multiplicity Description <dependencyAnnc> Child Resource Types [variable] <subscription> 0..n See clause 9.6.8 <subscription> [variable] <transaction> 0..n See clause 9.6.48 <transaction> The <dependency> resource shall contain the attributes specified in table 9.6.62-2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 248 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.62-2: Attributes of <dependency> resource Attributes of <action> Multiplicity RW/ RO/ WO Description <dependencyAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. If no accessControlPolicyIDs value is configured, the accessControlPolicyIDs of the parent resource shall be applied for privilege checking. MA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationCon sultationIDs 0..1 (L) RW See clause 9.6.1.3. OA creator 0..1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA sufficient 1 RW Indicates if this dependency is sufficient for triggering the action specified in the parent <action> resource. The Allowed values are: • FALSE • TRUE The action specified in the parent <action> resource shall be triggered if the evalCriteria of the parent <action> resource is met, and if at least one <dependency> resource, specified in the dependencies attribute of the parent <action> resource, having its sufficient attribute set to TRUE, has evalCriteria that have been met. The action specified in the parent <action> resource shall also be triggered if the evalCriteria of the parent <action> resource are met and all the <dependency> resources, specified in the dependencies attribute of the parent <action> resource, having their sufficient attribute set to FALSE, have evalCriteria that have been met. OA evalCriteria 1 RW Provides conditions determining if the dependency matches the criteria. The evalCriteria attribute in conjunction with the referencedResourceID attribute forms the dependency to be evaluated. See further description in table 9.6.61-3. OA referencedResourceID 1 RW The resource identifier of the resource for which the evalCriteria is evaluated for the dependency. MA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 249 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.63 Resource Type e2eQosSession | The <e2eQosSession> resource defines end-to-end (E2E) QoS session requirements for the exchange of oneM2M request and response primitives between oneM2M entities. This resource consists of a set of QoS parameters and an applicable set of oneM2M entities that exchange oneM2M requests and responses with one another and function as the session endpoints. A Hosting CSE uses the information configured within this resource to configure and manage E2E QoS between these session endpoints. For example, the Hosting CSE can manage the establishment and tear-down of QoS session(s) in underlying network(s) that interconnect oneM2M entities with one another. A Hosting CSE can also use this information to manage the scheduling and store-and-forwarding of requests and responses that it performs at the oneM2M service layer. When establishing a QoS session in an underlying network, a Hosting CSE can configure the QoS parameters based on the requirements defined by the <e2eQosSession> resource. For cases where the oneM2M entities are separated by multiple hops, each hop may require the establishment and configuration of a separate underlying network QoS session. For this case, a Hosting CSE can coordinate with its registrar and registree CSEs to assist it with the configuration of a QoS session in each respective underlying network involved in a multi-hop E2E QoS session such that the E2E QoS requirements defined within the <e2eQosSession> can be satisfied across the multiple hops. NOTE: This current solution supports the 0-hop scenario and the 1-hop scenario involving a <e2eQosSession> Hosting CSE that is the registrar CSE of the session endpoints. The details for how an E2E QoS session is supported for multiple hop scenarios greater than 1-hop are outside the scope of the present document and left to implementation. The following are some examples of E2E oneM2M communication flows that an <e2eQosSession> resource Hosting CSE can manage using this QoS information. EXAMPLE 1: A first oneM2M entity that is a session endpoint sends a request to the <e2eQosSession> resource Hosting CSE and the To parameter targets a remote oneM2M entity that is also a session endpoint of the same QoS session. The <e2eQosSession> resource Hosting CSE can establish an individual underlying network QoS session between itself and each of the session endpoints such that each underlying network QoS session meets the QoS requirements defined in the <e2eQosSession> resource. In doing so, the E2E exchange of oneM2M request and response primitives between the session endpoint entities meets the E2E QoS requirements defined in the <e2eQosSession> resource. EXAMPLE 2: A first oneM2M entity that is a session endpoint is a subscriber to a <flexContainer> resource that is hosted by the <e2eQosSession> resource Hosting CSE. A second oneM2M entity, that is also a session endpoint of the same QoS session, sends a request to update the <flexContainer> resource. The update results in a notification being sent to the first oneM2M entity. The <e2eQosSession> resource Hosting CSE can establish an individual underlying network QoS session between itself and each of the session endpoints such that each underlying network QoS sessions meets the QoS requirements defined in the <e2eQosSession> resource. In doing so, the E2E exchange involving the second oneM2M entity sending the <flexContainer> update request and the resulting notification request that is sent to the first oneM2M entity meets the E2E QoS requirements defined in the <e2eQosSession> resource. The <e2eQosSession> resource contains the child resources specified in table 9.6.63-1. Table 9.6.63-1: Child resources of <e2eQosSession> resource Child Resources of <e2eQosSession> Child Resource Type Multiplicity Description <e2eQosSession> Child Resource Types [variable] <subscription> 0..n See clause 9.6.8. <subscription> [variable] <transaction> 0..n See clause 9.6.48. <transaction> The <e2eQosSession> resource contains the attributes specified in table 9.6.63-2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 250 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.63-2: Attributes of <e2eQosSession> resource Attributes of <e2eQosSession> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. dynamicAuthorizationConsultatio nIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. announceSyncType 0..1 RW See clause 9.6.1.3. sessionEndpoints 1(L) WO Indicates the oneM2M endpoints within this oneM2M E2E QoS session. The end points include AE-IDs or CSE-IDs. If an AE-ID is used and the AE is not a Registree of the <e2eQosSession> Hosting CSE, then the AE-ID will be formatted as a SP-Relative-AE-ID or Absolute-AE-ID to allow the <e2eQosSession> Hosting CSE to extract the CSE-ID of the CSE that hosts the destination endpoint <AE> resource. e2eQosRequirements 1(L) RW Defines the E2E QoS requirements expressed as a list of tuples. Each tuple in the list defines a single QoS session requirement applicable to the bi- directional exchange of oneM2M requests and responses between all the endpoints. Each tuple in the list contains the set of elements as defined below in table 9.6.63-3. e2eQosPolicies 0..1(L) RW Defines E2E session QoS policies expressed as a list of tuples. Each tuple in the list defines a single policy that the <e2eQosSession> Hosting CSE uses to manage the session. Each tuple in the list contains the set of elements as defined below in table 9.6.63-4. e2eQosStatus 1 RO Indicates the status of the E2E QoS session setup by the hosting CSE with the underying network. The possible values are: - ENABLED - FAILED - DISABLED - USAGE_EXHAUSTED ETSI ETSI TS 118 101 V4.15.0 (2022-09) 251 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.63-3: Elements of an e2eQosRequirements tuple Name Mandatory/Optional Description qosLevel M Defines the required QoS level for this session. Expressed as a range from 0 (lowest) to 100 (highest). How a <e2eQosSession> Hosting CSE uses this parameter to manage the QoS of a session is implementation dependent (e.g. a Hosting CSE may map this value to an underlying network operator's session QoS parameter values). resourceIDList O Defines the resource identifier list between the endpoints which the QoS requirement applies to. If a Resource-ID is used and the resource is not hosted by the <e2eQosSession> Hosting CSE, then it will be formatted as a SP-Relative- Resource-ID or Absolute-Resource-ID to allow the <e2eQosSession> Hosting CSE to extract the CSE-ID of the CSE that hosts the destination endpoint resource. The use of a Resource-ID enables a destination E2E QoS session endpoint to be defined at the granularity of an individual targeted resource. sessionSchedule O Defines the time periods for when bi-directional exchange of oneM2M requests and responses between the session endpoints at the specified qosLevel is required to be enabled. If this parameter is not specified, then the scheduling of the oneM2M requests and responses between the session endpoints will be managed at the discretion of the <e2eQosSession> Hosting CSE based on the specified qosLevel. The schedule is composed of seven fields consisting of second, minute, hour, day of month, month, day of week and year. numOfRequests O Defines the minimum number of requests required to be transferred at the specified qosLevel via the bi-directional exchange of oneM2M requests and responses between the session endpoints. If this parameter is not specified, then the number of requests and responses allowed between the session endpoints will be managed at the discretion of the <e2eQosSession> Hosting CSE based on the specified qosLevel. numOfBytes O Defines the minimum number of bytes required to be transferred at the specified qosLevel via the bi-directional exchange of oneM2M requests and responses between the session endpoints. If this parameter is not specified, then the number of bytes allowed to be transferred between the session endpoints will be managed at the discretion of the <e2eQosSession> Hosting CSE based on the specified qosLevel. Table 9.6.63-4: Elements of an e2eQosPolicy tuple Name Mandatory/Optional Description status M When the e2eQosStatus attribute of the <e2eQosSession> resource transitions to the value specified in this element, the <e2eQosSession> Hosting CSE performs the action specified in the action element. The following are the allowed status values: - FAILED - DISABLED - USAGE_EXHAUSTED action M Defines a session related action that is performed by the <e2eQosSession> Hosting CSE when the value of an e2eQosStatus attribute of the <e2eQosSession> resource transitions to the value specified by the status element. The following are the allowed action values: - RE-ENABLE: The <e2eQosSession> Hosting CSE will attempt to re-enable the E2E QoS session in a manner that is consistent with the e2eQosRequirements. - DISABLE: The <e2eQosSession> Hosting CSE will disable the E2E QoS session (if already not disabled). - DELETE: The Hosting CSE will delete the E2E QoS session. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 252 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.64 Resource Type nwMonitoringReq | The <nwMonitoringReq> resource is used by an Originator (e.g. AE) to request network status information from an Underlying Network. The resource provides the status information for a particular geographic area of an Underlying Network such as congestion status and number of devices. The <nwMonitoringReq> resource contains the child resources specified in table 9.6.64-1. Table 9.6.64-1: Child resources of <nwMonitoringReq> resource Child Resources of <nwMonitoringReq> Child Resource Type Multiplicity Description <nwMonitoringReq> Child Resource Types [variable] <subscription> 0..n See clause 9.6.8. <subscription> The <nwMonitoringReq> resource contains the attributes specified in table 9.6.64-2. Table 9.6.64-2: Attributes of <nwMonitoringReq> Resource Attributes of <nwMonitoringReq> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. dynamicAuthorizationConsulta tionIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. announceSyncType 0..1 RW See clause 9.6.1.3. monitorEnable 1 RW Indicates the type of network monitoring request: MonitorCongestion: Monitor congestion status in an area. MonitorDeviceNumber: Monitor number of devices in an area. monitorStatus 1 RO Indicates the response status from the underlying network. The possible values are: DISABLED: Default. ENABLED: Enable the Hosting CSE to interact with the NSE. FAILED: Indicate an error response from the NSE. failureReason 0..1 RO Indicates the failure reason from the NSE. The attribute is applicable, if monitorStatus indicates FAILED. The possible values are: BAD_REQUEST: Incorrect parameters were passed in the request issued by the Hosting CSE. In this case, the Hosting CSE may be configured with the parameters which the NSE is able to support. UNAUTHORIZED: The Hosting CSE is not authorized to issue request to the NSE. In this case, the Hosting CSE may be configured with the parameters which the NSE is able to support. FORBIDDEN: This represents the case when the NSE is able to understand the request but unable to fulfil the request due to errors (e.g. congestionLevel and/or geographicArea may be set to wrong values). In this case, the Originator may be configured with the values within the range defined by MNO policies. NOT_FOUND: The resource URI was incorrect. In this case, the Hosting CSE may be configured with the URI which the NSE is able to support. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 253 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <nwMonitoringReq> Multiplicity RW/ RO/ WO Description LENGTH_REQUIRED: The NSE refuses to accept the request without a Content-Length header field. In this case, the Hosting CSE may be configured with the Content-Length header field. PAYLOAD_TOO_LARGE: The request contains a payload larger than the NSE is able to process. In this case, the Originator may retry the request without optional attribute(s). UNSUPPORTED_MEDIA_TYPE: The resource is in a format which is not supported by the NSE for the method. In this case, the Hosting CSE may be configured with the payload which the NSE is able to support. TOO_MANY_REQUESTS: Indicates that due to excessive traffic which, if continued over time, may lead to (or may increase) an overload situation. In that case, the Originator may reduce the frequency of requests or avoid immediate retries. INTERNAL_SERVER_ERROR: The NSE encountered an unexpected condition that prevented it from fulfilling the request. SERVICE_UNAVAILABLE: The NSE is unable to handle the request. geographicArea 1(L) RW Indicates a list of geographic area where the Originator wants to retrieve an Underling Network information. This attribute shall be configured if monitorEnable is set to MonitorCongestion or MonitorDeviceNumber. congestionLevel 0..1(L) RW Indicates a list of congestion level(s) with abstracted value (e.g. HIGH, MEDIUM or LOW) or exact value (e.g. between 0 and 31) that the IN-CSE requests to be informed of when reached. This attribute shall be configured if monitorEnable is set to MonitorCongestion. congestionStatus 0..1 RO Indicates the network status indicator that is abstracted value for congestion status (e.g. HIGH, MEDIUM or LOW) or exact value for congestion status (e.g. between 0 and 31) received from the NSE. numberOfDevices 0..1 RO Indicates the network status indicator that is an integer for congestion status or the number of devices. externalGroupID 0..1 RW It is used by an M2M Service Provider (M2M SP) when services targeted to a group of M2M Devices are requested from the Underlying Network. It is assumed to be a globally unique ID exposed by the underlying network to identify a group of M2M Devices (e.g. ADN, ASN, MN) for group related services. This attribute may be configured if monitorEnable is set to MonitorDeviceNumber. M2M-Ext-IDs 0..1(L) RO See clause 7.1.8 where this attribute is described. This attribute is used only for the case of dynamic association between the M2M-Ext-ID with the CSE-ID or AE-ID. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.65 Resource Type semanticRuleRepository | A <semanticRuleRepository> resource is a child resource of the <CSEBase> resource. The <semanticRuleRepository> resource may have one or multiple <reasoningRules> child resources to represent different sets of reasoning rules in the oneM2M system. A reasoning initiator can create <reasoningJobInstance> child resources of a <semanticRuleRepository> resource to initiate desired reasoning operations. The <semanticRuleRepository> resource shall contain the child resources specified in table 9.6.65-1 and the attributes specified in table 9.6.65-2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 254 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.65-1: Child resources of <semanticRuleRepository> resource Child Resources of <semanticRuleRep ository> Child Resource Type Multiplicity Description <ruleRepositoryAnnc> Child Resource Types [variable] <reasoningRules> 0..n <reasoningRules> resource for describing a set of reasoning rules. <reasoningRulesAnnc> [variable] <subscription> 0..n See [i.3], clause 9.6.8. <subscription> [variable] <reasoningJobInst ance> 0..n <reasoningJobInstance> resource for describing a specific reasoning job instance. <reasoningJobInstanceAnnc> Table 9.6.65-2: Attributes of <semanticRuleRepository> resource Attribute Name <semanticRuleRepository> Multiplicity RW/RO/WO Description <ruleRepos itoryAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. NA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. NA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. MA lastModifiedTime 1 RO See clause 9.6.1.3. MA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationConsultationIDs 0..1 (L) RW See clause 9.6.1.3. OA custodian 0..1 RW See clause 9.6.1.3. NA |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.66 Resource Type reasoningRules | A <reasoningRules> resource can be used to store a set of related reasoning rules (e.g. for supporting a particular application). A <reasoningRules> resource is a child resource of the <semanticRuleRepository> resource. By performing the CRUD operations on the <reasoningRules> resources, various reasoning rules (e.g. user-defined reasoning rules based on business logic) can be created, discovered, retrieved, updated and deleted inside the oneM2M system. The <reasoningRules> resource shall contain the child resources specified in table 9.6.66-1 and the attributes specified in table 9.6.66-2. Table 9.6.66-1: Child resources of <reasoningRules> resource Child Resources of <reasoningRules> Child Resource Type Multiplicity Description <reasoningRulesAnnc> Child Resource Types [variable] <subscription> 0..n See [1], clause 9.6.8 <subscription> ETSI ETSI TS 118 101 V4.15.0 (2022-09) 255 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.66-2: Attributes of <reasoningRules> resource Attribute Name <reasoningRules> Multiplicity RW/RO/WO Description <reasoningRules Annc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. NA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. NA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. MA lastModifiedTime 1 RO See clause 9.6.1.3. MA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationConsultationIDs 0..1 (L) RW See clause 9.6.1.3. OA custodian 0..1 RW See clause 9.6.1.3. NA ontologyRef 1(L) WO A reference (URIs) of the ontologies used to represent the reasoning rules that are stored in the content attribute. OA ruleRepresentationFormat 1 RW Indicates the format of the rules, e.g. Rule Interchange Format (RIF). OA ruleRepresentation 1 RW Stores a set of rules. OA |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.67 Resource Type reasoningJobInstance | A <reasoningJobInstance> resource represents a specific reasoning job instance for enabling the two types of reasoning operations (One type is a one-time reasoning operation and the other type is a continuous reasoning operation). A reasoning initiator such as an AE or a CSE may initiate a desired reasoning operation by creating a <reasoningJobInstance> resource as a child resource of a <semanticRuleRepository> resource. The <reasoningJobInstance> resource shall contain the child resources specified in table 9.6.67-1 and the attributes specified in table 9.6.67-2. Table 9.6.67-1: Child resources of <reasoningJobInstance> resource Child Resources of <reasoningJobInstance> Child Resource Type Multiplicity Description <reasoningJobInstance> Child Resource Types [variable] <subscription> 0..n See clause 9.6.8 <subscription> ETSI ETSI TS 118 101 V4.15.0 (2022-09) 256 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.67-2: Attributes of <reasoningJobInstance> resource Attribute Name Multiplicity RW/RO/WO Description <reasoningJobIn stance> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. NA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. NA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. MA lastModifiedTime 1 RO See clause 9.6.1.3. MA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationConsultationIDs 0..1 (L) RW See clause 9.6.1.3. OA custodian 0..1 RW See clause 9.6.1.3. NA reasoningType 1 WO The type of the reasoning job represented by this resource. The supported values of this attribute include: • "one-time" • "continuous" OA reasoningMode 0..1 WO The supported values of this attribute include: • "Periodic" - the reasoning job represented by this resource is executed periodically. • "When the invovled FS/RS changes" - if the factSet and/or ruleSet attributes change, the reasoning job represented by this resource is executed. This attribute is present only when the value of reasoningType is set to "continuous". OA reasoningPeriod 0..1 RW The time period for executing the reasoning job represented by this resource. For example, every two hours. This attribute is present only when the value of mode is present and set to "Periodic". OA factSet 1 (L) RW A list of URIs of the resources that store the facts used by this reasoning job. OA ruleSet 1 (L) RW A list of URIs of resources that store the reasoning rules used by this reasoning job. OA resultRepresentation 1 RO The latest reasoning result produced by this reasoning job. OA resultRepresentationFormat 1 RW Indicates the type of serialization of the result attribute, e.g. RDF/XML, OWL/XML. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 257 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.68 Resource Type serviceSubscribedUserProfile | The <serviceSubscribedUserProfile> resource contains user profile information for a given M2M Service User such as its M2M-User-ID. A oneM2M <m2mServiceSubscriptionProfile> resource shall have a <serviceSubscribedUserProfile> child resource for each authorized M2M Service User associated with the M2M Service Subscription. A <serviceSubscribedAppRule> resource may have an allowedUsers attribute that can be configured with a list of <serviceSubscribedUserProfile> resource identifiers, wherein the allowedUsers represents the users that are allowed to originate requests via the allowed AEs specified by the <serviceSubscribedAppRule>. The <serviceSubscribedUserProfile> resource shall contain the child resources specified in table 9.6.68-1. Table 9.6.68-1: Child resources of <serviceSubscribedUserProfile> resource Child Resources of <serviceSubscribedUserProfile> Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 [variable] <transaction> 0..n See clause 9.6.48 The <serviceSubscribedUserProfile> resource shall contain the attributes specified in table 9.6.68-2. Table 9.6.68-2: Attributes of <serviceSubscribedUserProfile> resource Attributes of <serviceSubscribedUserProfile> Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3. resourceID 1 RO See clause 9.6.1.3. resourceName 1 WO See clause 9.6.1.3. parentID 1 RO See clause 9.6.1.3. expirationTime 1 RW See clause 9.6.1.3. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. creationTime 1 RO See clause 9.6.1.3. labels 0..1 (L) RW See clause 9.6.1.3. lastModifiedTime 1 RO See clause 9.6.1.3. dynamicAuthorizationConsultationIDs 0..1 (L) RW See clause 9.6.1.3. custodian 0..1 RW See clause 9.6.1.3. M2M-User-ID 1 RW The M2M-User-ID that is assigned to this M2M Service User. maxNumAEs 0..1 RW For this M2M Service User, the Hosting CSE shall limit the maximum number of <AE> resources created on the Hosting CSE to this limit, if configured. If a request is received to create an <AE> resource once this limit is reached, the Hosting CSE shall return an error indicating that the maximum number of allowed <AE> resources has been reached. maxNumNodes 0..1 RW For this M2M Service User, the Hosting CSE shall limit the maximum number of <node> resources created on the Hosting CSE to this limit, if configured. If a request is received to create a <node> resource once this limit is reached, the Hosting CSE shall return an error indicating the maximum number of allowed <node> resources has been reached. maxNumBytes 0..1 RW For this M2M Service User, the Hosting CSE shall limit the aggregate amount of bytes stored on the Hosting CSE to this limit, if configured. This limit shall be applied to Content Sharing Resources only (i.e. <container>, <contentInstance>, <flexContainer>, <flexContainerInstance>, <timeSeries> and <timeSeriesInstance>). If a request is received to create a Content Sharing Resource that will result in exceeding this limit, the Hosting CSE shall return an error that the maximum number of allowed bytes has been reached. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 258 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <serviceSubscribedUserProfile> Multiplicity RW/ RO/ WO Description A Hosting CSE may take the value of the maxNumBytes attribute as well as other attributes (e.g. maxNumContainers, maxNumContentInstances, etc.) into account when determining a limit to enforce on the maxByteSize attribute of individual Content Sharing Resources, if applicable. How a Hosting CSE allocates the maxNumBytes across individual Content Sharing Resources is based on local policy. maxRequestRate 0..1 RW If a Hosting CSE receives requests from this M2M Service User at a rate which exceeds the limit defined by this attribute, the Hosting CSE may throttle the processing of the requests. The Hosting CSE may throttle processing of requests by delaying responses and/or by returning an error indicating that the maximum allowed request rate has been reached. maxNumContainers 0..1 RW For this M2M Service User, the Hosting CSE shall limit the maximum number of <container> resources created on the Hosting CSE to this limit, if configured. If a request is received to create a <container> resource once this limit is reached, the Hosting CSE shall return an error indicating the maximum number of allowed <container> resources has been reached. maxNumInstancesPerContainer 0..1 RW For this M2M Service User, the Hosting CSE shall limit the value of the maxNrOfInstances attribute of a <container> resource on the Hosting CSE to this limit, if configured. maxNumTimeSeries 0..1 RW For this M2M Service User, the Hosting CSE shall limit the maximum number of <timeSeries> resources created on the Hosting CSE to this limit, if configured. If a request is received to create a <timeSeries> resource once this limit is reached, the Hosting CSE shall return an error indicating the maximum number of <timeSeries> resources has been reached. maxNumInstancesPerTimeSeries 0..1 RW For this M2M Service User, the Hosting CSE shall limit the value of the maxNrOfInstances attribute of a <timeSeries> resource on the Hosting CSE to this limit, if configured. maxMembersPerGroup 0..1 RW For this M2M Service User, the Hosting CSE shall limit the value of the maxNrOfMembers attribute of a <group> resource on the Hosting CSE to this limit, if configured. maxNotificationRate 0..1 RW The Hosting CSE shall restrict the maximum rate of notifications sent to this M2M Service User to this limit, if configured. A Hosting CSE shall also restrict the maximum value of the rateLimit attribute of a <subscription> resource for this M2M Service User to this limit, if configured. maxNumFlexContainers 0..1 RW For this M2M Service User, the Hosting CSE shall limit the maximum number of <flexContainer> resources created on the Hosting CSE to this limit, if configured. If a request is received to create a <flexContainer> resource once this limit is reached, the Hosting CSE shall return an error indicating the maximum number of allowed <flexContainer> resources has been reached. maxNumInstancesPerFlexContainer 0..1 RW For this M2M Service User, the Hosting CSE shall limit the value of the maxNrOfInstances attribute of a <flexContainer> resource on the Hosting CSE to this limit, if configured. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 259 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <serviceSubscribedUserProfile> Multiplicity RW/ RO/ WO Description defaultAccessControlPrivileges 0..1(L) RW A list of resource identifiers of default access control policies to link to a resource if/when the accessControlPolicyIDs attribute of a resource created by this M2M Service User is not configured. This list of default access control policies is combined with any default access control policies specified by the defaultAccessControlPrivileges attribute of the parent <m2mServiceSubscriptionProfile> resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.69 Resource Type timeSyncBeacon | A <timeSyncBeacon> resource is created by an entity requesting time synchronization services from the Hosting CSE. As a result, the Hosting CSE provides time synchronization services in the form of beacon notifications. The beacon notifications include time-synchronization information (e.g. current time of the Hosting CSE). When receiving a beacon notification, the receiver can extract the Hosting CSE's current time, compare it against its own current time and compute an offset. This offset can then be used to synchronize the current time of the receiver to the current time of the Hosting CSE. The <timeSyncBeacon> resource shall contain the child resources specified in table 9.6.69-1. Table 9.6.69-1: Child resources of <timeSyncBeacon> resource Child Resources of <timeSyncBeacon> Child Resource Type Multiplicity Description <timeSyncBeaconAnnc> Child Resource Types [variable] <subscription> 0..n See clause 9.6.8 None [variable] <transaction> 0..n See clause 9.6.48 <transaction> The <timeSyncBeacon> resource shall contain the attributes specified in table 9.6.69-2. Table 9.6.69-2: Attributes of <timeSyncBeacon> resource Attributes of <timeSyncBeacon> Multiplicity RW/ RO/ WO Description <timeSyncBeacon Annc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. MA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationCon sultationIDs 0..1 (L) RW See clause 9.6.1.3. OA custodian 0..1 RW See clause 9.6.1.3. NA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 260 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <timeSyncBeacon> Multiplicity RW/ RO/ WO Description <timeSyncBeacon Annc> Attributes beaconRequester 0..1 WO This attribute is configured with the AE-ID or CSE-ID of the entity requesting beacon notifications from the Hosting CSE (see note). This attribute shall be configured if the beaconCriteria attribute is set to "Loss of Synchronization". This attribute is not applicable if the beaconCriteria attribute is set to "Periodic". OA beaconCriteria 1 RW Criteria for the beacon generation. • Periodic (Default) - Beacon is sent periodically based on the period defined by timeSynchBeaconInterval • Loss of Synchronization - Beacon is sent as a result of a detection in a loss of synchronization exceeding the threshold defined by beaconThreshold OA beaconInterval 0..1 RW The requested frequency of beacons expressed as the minimum time between two beacon notifications sent by the Hosting CSE to the beaconRequester. This attribute is applicable if beaconCriteria is set to "Periodic". If this attribute is not configured and beaconCriteria is set to "Periodic", then the Hosting CSE shall use a default value based on local policies. OA beaconThreshold 0..1 RW Synchronization time offset threshold. This attribute is applicable if beaconCriteria is set to "Loss of Synchronization". When the delta between the current time of the Hosting CSE and the current time of the beaconRequester exceeds this defined threshold, then the Hosting CSE shall send beacon notification(s) to the beaconNotificationURIs. If this attribute is not configured and beaconCriteria is set to "Loss of Synchronization" then the Hosting CSE shall use a default value based on local policies. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 261 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <timeSyncBeacon> Multiplicity RW/ RO/ WO Description <timeSyncBeacon Annc> Attributes The current time of a beaconRequester can be monitored by the Hosting CSE using Originating Timestamp parameters present in the request and response messages that a beaconRequester sends to the Hosting CSE. If these parameters are not present and the Hosting CSE is unable to monitor the current time of the beaconRequester, then the Hosting CSE shall not send beacon notifications. beaconNotificationURIs 1 (L) RW This attribute shall be configured as a list consisting of one or more beacon notification targets. This attribute uses the same format as the notificationURI attribute defined for the <subscription> resource (see table 9.6.8-2). OA NOTE: The AE-ID and CSE-ID identifiers should be shortened to use CSE-Relative or SP-Relative formats when appropriate based on their context of use (see clause 7.2). |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.70 Resource Type ontologyMapping | The <ontologyMapping> resource is used for the mapping between two different ontologies. It contains necessary input parameters, such as the Resource-IDs of the source and target ontologies and the mapping method description (which includes the parameters of mapping policy and mapping algorithm), to perform ontology mapping. It may also contain the output ontology mapping results. The <ontologyMapping> resource shall contain the child resources specified in table 9.6.70-1. Table 9.6.70-1: Child resources of <ontologyMapping> resource Child Resources of <ontologyMapping> Child Resource Type Multiplicity Description <ontologyMappingAnnc> Child Resource Types [variable] <subscription> 0..n See clause 9.6.8. <subscription> The <ontologyMapping> resource shall contain the attributes specified in table 9.6.70-2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 262 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.70-2: Attributes of <ontologyMapping> resource Attribute Name Multiplicity RW/RO/WO Description <ontologyMapping Annc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA accessControlPolicyI Ds 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA lastModifiedTime 1 RO See clause 9.6.1.3. NA labels 0..1 (L) RW See clause 9.6.1.3. MA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizatio nConsultationIDs 0..1 (L) RW See clause 9.6.1.3. OA creator 0..1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA sourceOntology 1 RW Contains the resourceID of the source ontology to be mapped. OA targetOntology 1 RW Contains the resourceID of the target ontology to be mapped. OA mappingPolicy 1 RW Determines the policy of applying the ontology mapping algorithms between the sourceOntology and targetOntology. It is an enumeration type and the value shall be: • single: only one mapping algorithm shall be used. • multiple: two or more mapping algorithms of different types shall be used. • traversal: all provided mapping algorithms shall be used in a traversal way. OA mappingAlgorithmLin ks 1 (L) RW Links to a <ontologyMappingAlgorithmRepository> resource, or one or multiple <ontologyMappingAlgorithm> resources. OA mappingResultForm at 1 RW Indicates the required format of the generated content in the mappingResult attribute. OA mappingResult 1 RO Stores the mapping results (e.g. RDF/XML) generated by the hosting CSE. OA |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.71 Resource Type ontologyMappingAlgorithmRepository | The <ontologyMappingAlgorithmRepository> resource is used for storing a collection of ontology mapping algorithms which are represented as <ontologyMappingAlgorithm> resources, which are referenced from the <ontologyMapping> resource. The <ontologyMappingAlgorithmRepository> resource shall contain the child resources specified in table 9.6.71-1. Table 9.6.71-1: Child resources of <ontologyMappingAlgorithmRepository> resource Child Resources of <ontologyMapping> Child Resource Type Multiplicity Description <ontologyMapping AlgorithmRepositor yAnnc>Child Resource Types [variable] <ontologyMappin gAlgorithm> 0..n Each <ontologyMappingAlgorithm> represents an ontology mapping algorithm. <ontologyMappingAl gorithmAnnc> [variable] <subscription> 0..n See clause 9.6.8 where the type of this resource is described. <subscription> ETSI ETSI TS 118 101 V4.15.0 (2022-09) 263 (oneM2M TS-0001 version 4.15.0 Release 4) The <ontologyMappingAlgorithmRepository> resource shall contain the attributes specified in table 9.6.71-2. Table 9.6.71-2: Attributes of <ontologyMappingAlgorithmRepository> resource Attribute Name Multiplicity RW/ RO/ WO Description <ontologyMappingAlgorithm Annc>Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA lastModifiedTime 1 RO See clause 9.6.1.3. NA labels 0..1 (L) RW See clause 9.6.1.3. MA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationC onsultationIDs 0..1 (L) RW See clause 9.6.1.3. OA creator 0..1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.72 Resource Type ontologyMappingAlgorithm | The <ontologyMappingAlgorithm> resource is used for representing an executable ontology mapping algorithm. The <ontologyMappingAlgorithm> resource shall not contain any child resource. It shall contain the attributes specified in table 9.6.72-1. Table 9.6.72-1: Attributes of <ontologyMappingAlgorithm> resource Attribute Name Multiplicity RW/ RO/ WO Description <ontologyMappin gAlgorithmAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA accessControlPolicy IDs 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA lastModifiedTime 1 RO See clause 9.6.1.3. NA labels 0..1 (L) RW See clause 9.6.1.3. MA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizatio nConsultationIDs 0..1 (L) RW See clause 9.6.1.3. OA creator 0..1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA executable 0..1 RW Contains the binary executable of the ontology mapping algorithm. For a pre-configured algorithm already stored in the system, this attribute may be omitted. The system may invoke the algorithm according to the resourceName or resourceID attribute based on its local policy configuration. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 264 (oneM2M TS-0001 version 4.15.0 Release 4) Attribute Name Multiplicity RW/ RO/ WO Description <ontologyMappin gAlgorithmAnnc> Attributes algorithmType 0..1 RW Indicates the type of the ontology mapping algorithm. It shall be an enumeration type with the possible values as follows: • linguistic-feature extraction algorithm: compute the similarity based on linguistic string distance between the concepts of the source and target ontologies. • structural-feature extraction algorithm: compute the similarity based on the graph structure between the source and target ontologies. • external resource acquisition algorithm: compute the similarity based on external resources (e.g. well-known dictionary, knowledge base, expert system) • logical reasoning algorithm: compute the similarity based on the reasoning of description logic. • others: any other types that are not specified here. This attribute may be used by an originator for discovering and selecting the candidate algorithms as the input to the ontology mapping task. It may also be used by the hosting CSE that performs the ontology mapping task to determine the proper ontology mapping algorithms according to the specified mapping policy. OA description 0..1 RW Human readable description of the ontology mapping algorithm. OA |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.73 Resource Type primitiveProfile | The <primitiveProfile> resource is a message template that defines request or response message parameters and/or resource attributes that are applied (i.e. added or removed) by a Hosting CSE to requests and responses that it receives or generates. For example, a <primitiveProfile> resource may be used to reduce the size of requests and responses flowing back-and-forth between an Originator and a Hosting CSE. Each <primitiveProfile> resource can be applied to different messages that originate from specified AEs and CSEs that target specified resources, and that perform specified operations on these targeted resources. When a CSE receives a request, it will first identify any applicable <primitiveProfile> resources based on the Primitive Profile Identifier specified in the request and use the information contained within the <primitiveProfile> resource to process the request as well as to generate an appropriate response. A <primitiveProfile> resource can also be applied to a notification that is generated by a <subscription> resource Hosting CSE if the <subscription> resource has a primitiveProfileID attribute configured with a resource identifier of a <primitiveProfile> resource as defined in clauses 9.6.8 and 10.2.10. A <primitiveProfile> resource can also be applied to the response generated by a Hosting CSE for a non-blocking asynchronous or non-blocking synchronous request having a Primitive Profile Identifier parameter as defined in clause 10.2.25.1. The <primitiveProfile> resource shall contain the child resource specified in table 9.6.73-1. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 265 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.73-1: Child resources of <primitiveProfile> resource Child Resources of <primitiveProfile> Child Resource Type Multiplicity Description <primitiveProfileAnnc> Child Resource Type [variable] <subscription> 0..n See clause 9.6.8 <subscription> [variable] <transaction> 0..n See clause 9.6.48 <transaction> The <primitiveProfile> resource shall contain the attributes specified in table 9.6.73-2: • The IDList, resourceTypes, operations, resourceIDs, releaseVersions and applicability attributes are used by the Hosting CSE to determine the applicability of the <primitiveProfile> resource to a received request primitive and response primitive associated with a request. A <primitiveProfile> resource may be applied to a request or response based off the originating entity, the targeted resource, the type of operation and/or the release version as indicated by these attributes and/or a combination of them, e.g. CREATE <contentInstance> at /targetUri -from App01 using Release 2. • The other attributes of a <primitiveProfile> resource specify what actions to apply to request and response primitives. For example, the <primitiveProfile> may specify to add or replace an expirationTime attribute within the resource representation contained within the content of a request or response primitive. • A <primitiveProfile> resource may be announced to another CSE for discovery purposes. However, the announced profile (i.e. <primitiveProfileAnnc>) shall not be applied to request or response primitives by the announced to CSE. Table 9.6.73-2: Atributes of <primitiveProfile> resource Attributes of <primitiveProfile> Multiplicity RW/ RO/ WO Description <primitiveProfile Annc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 0..1 RW See clause 9.6.1.3. MA accessControlPolicy IDs 0..1 (L) RW See clause 9.6.1.3. MA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 0..1 RO See clause 9.6.1.3. NA lastModifiedTime 0..1 RO See clause 9.6.1.3. NA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizatio nConsultationIDs 0..1 (L) RW See clause 9.6.1.3. OA creator 0..1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA IDList 1 (L) RW List of identifiers of the entities that the profile applies to. For a request that is received by the Hosting CSE and that contains a Primitive Profile Identifier parameter matching the resource identifier of this <primitiveProfile> resource, the From request parameter is compared against this attribute to determine whether the profile is applicable to the originator of the request. E.g. "CAE01" In this case, this <primitiveProfile> will only be applied to requests received from CAE01 and/or responses returned for requests received from CAE01. Wildcards may also be used (e.g. "*", "AE*"). OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 266 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <primitiveProfile> Multiplicity RW/ RO/ WO Description <primitiveProfile Annc> Attributes The Hosting CSE shall ignore this attribute when applying the primitive profile to requests generated by the Hosting CSE (i.e. notifications). resourceTypes 0..1(L) RW List of resource types that the profile applies to. E.g. <flexContainer>, <container> OA operations 0..1 (L) RW List of request operations and/or corresponding responses that the profile applies to. E.g. RETRIEVE, UPDATE, etc. OA resourceIDs 0..1 (L) RW List of targeted Resource-IDs that the profile applies to. Wildcards may also be used. E.g. CSE01/CAE01/flexContainer01" E.g. "CSE01/AE01/*" OA releaseVersions 0..1 (L) WO List of release version indicators that the profile applies to. E.g. "Release 2, Release 3" OA additions 0..1 (L) RW A list of attribute and/or parameter names with optional values that may be added to a primitive if not already present. If an attribute or parameter in this list is already present in the primitive and a value is defined, then this value is used to replace the value of this attribute or parameter. The mandatory request and response parameters of Operation, To, From, Request Identifier, Release Version Indicator or Response Status Code parameters are not permitted in this list. The optional parameters of Filter Criteria, OriginatingTime, GroupRequestIdentifier, Tokens and AssignedTokenIdentifiers are also not permitted in this list. Only attributes/parameters with simple data types are permitted in this list. Attributes/parameters having complex data types (as specified in ETSI TS 118 104 [3]) are not permitted. Each entry in this list contains the name of an attribute or parameter and a value. The Hosting CSE shall add or replace the attribute/parameter and value in a primitive if the applicability criteria defined by the other attributes of this profile resource have been met. In the case of a request primitive, this addition shall be done before the Hosting CSE performs its normal processesing of the request. In the case of a response primitive, this addition shall be done before the Hosting CSE sends the response to the Originator. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 267 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <primitiveProfile> Multiplicity RW/ RO/ WO Description <primitiveProfile Annc> Attributes deletions 0..1 (L) RW A list of attribute and/or parameter names that indicates the attributes and/or parameters that are to be deleted from a primitive primitive. The mandatory request and response parameters of Operation, To, From, Request Identifier, Release Version Indicator or Response Status Code parameters are not permitted in this list. The optional parameters of Filter Criteria, OriginatingTime, GroupRequestIdentifier, Tokens and AssignedTokenIdentifiers are also not permitted in this list. Each entry in this list contains the name of an attribute or parameter. The Hosting CSE shall delete the attribute/parameter from a primitive if the applicability criteria defined by the other attributes of this profile resource have been met. In the case of a request primitive, this deletion shall be done before the Hosting CSE performs its normal processesing of the request. In the case of a response primitive, this deletion shall be done before the Hosting CSE sends the response to the Originator. OA applicability 0..1(L) RW A list of indicators that define the types of requests and responses that the profile is applicable to. permitted values are: - Requests to the Hosting CSE - Responses from the Hosting CSE - Notifications from the Hosting CSE OA |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.74 Resource Type state | A process consists of one or more states. Each state in a process is defined by a <state> resource. A <state> resource includes status information maintained for the state and actions performed by the Hosting CSE when a process is in the state. A <state> resource also defines criteria used by a Hosting CSE for transitioning to the next <state> resource in a process. The <state> resource shall contain the child resources specified in table 9.6.74-1. Table 9.6.74-1: Child resources of <state> resource Child Resources of <state> Child Resource Type Multiplicity Description <stateAnnc> Child Resource Types [variable] <subscription> 0..n See clause 9.6.8 <subscription> [variable] <transaction> 0..n See clause 9.6.48 <transaction> [variable] <action> 0..1 See clause 9.6.61 <action> The <state> resource shall contain the attributes specified in table 9.6.74-2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 268 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.74-2: Attributes of <state> resource Attributes of <state> Multiplicity RW/ RO/ WO Description <stateAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. MA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationCon sultationIDs 0..1 (L) RW See clause 9.6.1.3. OA creator 1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA stateActive 1 RO Indicates whether this state is currently the active state of the process. The supported values for this attribute are "True" and "False". OA stateAction 0..1 RW A resource identifier of a child <action> resource that a Hosting CSE performs when this state is the active state in the process. OA stateTransitions 0..1(L) RW A list of criteria that a Hosting CSE uses to determine if/when to transition from this state to another state in the process. Each entry in this list is defined as a tuple consisting of the following two elements: • evalCriteria: conditions expressed in the same format as evalCriteria defined in table 9.6.61-3 and where the subject parameter of the evalCriteria is configured with a resource identifier of a subject resource. • next state: the resource identifier of a <state> resource. If this <state> resource represents a final state in the process, this attribute shall be absent. OA |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.75 Resource Type processManagement | A <processManagement> resource defines a process that a Hosting CSE manages on behalf of an AE and that consists of a sequence of states. Each state in a process is represented using a <state> resource defined in clause 9.6.74. The <processManagement> resource shall contain the child resources specified in table 9.6.75-1. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 269 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.75-1: Child resources of <processManagement> resource Child Resources of <processManagement> Child Resource Type Multiplicity Description <processManagement Annc> Child Resource Types [variable] <state> 0..n This resource describes the details of a particular state of a process. <state> [variable] <subscription> 0..n See clause 9.6.8 <subscription> [variable] <transaction> 0..n See clause 9.6.48 <transaction> The <processManagement> resource shall contain the attributes specified in table 9.6.75-2. Table 9.6.75-2: Attributes of <processManagement> resource Attributes of <processManagement> Multiplicity RW/ RO/ WO Description <processManage mentAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. MA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationCon sultationIDs 0..1 (L) RW See clause 9.6.1.3. OA creator 1 RO See clause 9.6.1.3. NA custodian 0..1 RW See clause 9.6.1.3. NA processStatus 1 RO The status of the process. The allowed values include: • "Disabled": The process is disabled. The Hosting CSE shall wait until the processControl attribute is updated with a value of "Enabled" before enabling the process. When a <processManagement> resource is created, the Hosting CSE shall assign a default value of "Disabled" to processStatus. The Hosting CSE shall also disable the process and set processStatus to "Disabled" when receiving an update to the processControl attribute with a value of "Disable". OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 270 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <processManagement> Multiplicity RW/ RO/ WO Description <processManage mentAnnc> Attributes • "Enabled": The Hosting CSE has enabled the process after receiving an update to the processControl attribute with a value of "Enable". Once enabled, the Hosting CSE shall monitor any criteria defined in the activateConditions attribute. If the Hosting CSE detects that the specified activateConditions have been met or that no criteria have been specified, the Hosting CSE shall update the processStatus attribute to "Activated". • "Activated": The Hosting CSE has activated the process. Once activated, the Hosting CSE shall monitor and perform actions based on the <state> resources and the endConditions attribute defined for the process. • "Paused": The Hosting CSE has paused the process after recieving an update of the processControl attribute to a value of "Pause". The Hosting CSE shall keep the process paused in the current state until the processControl attribute is updated with a value of "Reactivate" to resume the process or "Disable" to exit the process. • "Completed": The Hosting CSE has completed the process by processing a final state in the process or detecting specified endConditions have been met. • "Aborted": The Hosting CSE has aborted the process due to detecting an error condition. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 271 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <processManagement> Multiplicity RW/ RO/ WO Description <processManage mentAnnc> Attributes processControl 1 RW This attribute is configured by an AE to instruct the Hosting CSE to enable, disable, pause and reactivate the processing of the process. The supported values for the attribute are: • Enable: The Hosting CSE shall enable the process and update processStatus to "Enabled" if the current processStatus is "Disabled". • Disable: The Hosting CSE shall disable the process and update processStatus to "Disabled". • Pause: The Hosting CSE shall pause the process and update processStatus to "Paused" if the current processStatus is "Activated". • Reactivate: The Hosting CSE shall reactivate the process and update processStatus to "Activated" if the current processStatus is "Paused" This attribute shall not be present in a <processManagement> create request. OA currentState 1 RO The resource identifier of the child <state> resource that has stateActive set to "True". If the processStatus is "Enabled" or "Disabled", the value of this attribute shall be NULL. OA activateConditions 0..1 (L) RW This attribute specifies a list of conditions that shall be met for the Hosting CSE to begin the process. This attribute has the same format as the evalCriteria defined in table 9.6.61-3 where the subject parameter of the evalCriteria is configured with a resource identifier and attribute of a subject resource. When processStatus is "Enabled" and any of the specified activateConditions in this list have been met or if no activateConditions have been specified, the Hosting CSE shall update processStatus to "Activated", and currentState to the value defined in initialState and start processing the process. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 272 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <processManagement> Multiplicity RW/ RO/ WO Description <processManage mentAnnc> Attributes endConditions 0..1 (L) RW This attribute specifies a list of early exit criteria that the Hosting CSE shall monitor to detect if/when to stop processing the defined states of the process. This attribute has the same format as the evalCriteria defined in table 9.6.61-3. where the subject parameter of the evalCriteria is configured with a resource identifier and attribute of a subject resource. This attribute allows for an asynchronous exit of the process from any state. When any of the exit conditions present in this list have been met, the Hosting CSE shall set the processStatus attribute to "Completed" and set the status of the current child <state> resources to "False". If no endConditions are specified, the Hosting CSE shall transition to "Completed" after processing a final <state> resource of the process. OA initialState 1 RW The resource identifier of the first <state> resource of the process. OA |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 9.6.76 Resource Type softwareCampaign | The <softwareCampaign> resource provides policies and rules for the management of software by a Hosting CSE. A <softwareCampaign> resource is used to trigger a Hosting CSE to install, uninstall, activate or deactivate software via the creation and management of [software] specialization(s) by the Hosting CSE. An AE can create <softwareCampaign> resource(s) on a Hosting CSE to instruct the Hosting CSE to manage the software versions of its Registrees (e.g. MN/ASN-CSEs) on the AE's behalf. For example, a service provider (e.g. IN-AE) can create <softwareCampaign> resource(s) on a Hosting CSE (e.g. IN-CSE) to install and manage software on one or more Registree CSEs or AEs of the Hosting CSE. The <softwareCampaign> resource shall contain the child resources specified in table 9.6.76-1. Table 9.6.76-1: Child resources of <softwareCampaign> resource Child Resources of <softwareCampaign> Child Resource Type Multiplicity Description <softwareCampaignAnnc> Child Resource Types [variable] <subscription> 0..n See clause 9.6.8 <subscription> [variable] <transaction> 0..n See clause 9.6.48 <transaction> [variable] <schedule> 0..n See clause 9.6.9 <schedule> The <softwareCampaign> resource shall contain the attributes specified in table 9.6.76-2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 273 (oneM2M TS-0001 version 4.15.0 Release 4) Table 9.6.76-2: Attributes of <softwareCampaign> resource Attributes of <softwareCampaign> Multiplicity RW/ RO/ WO Description <softwareCam paignAnnc> Attributes resourceType 1 RO See clause 9.6.1.3. NA resourceID 1 RO See clause 9.6.1.3. NA resourceName 1 WO See clause 9.6.1.3. NA parentID 1 RO See clause 9.6.1.3. NA expirationTime 1 RW See clause 9.6.1.3. MA accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3. MA labels 0..1 (L) RW See clause 9.6.1.3. MA creationTime 1 RO See clause 9.6.1.3. NA lastModifiedTime 1 RO See clause 9.6.1.3. NA announceTo 0..1 (L) RW See clause 9.6.1.3. NA announcedAttribute 0..1 (L) RW See clause 9.6.1.3. NA announceSyncType 0..1 RW See clause 9.6.1.3. MA dynamicAuthorizationCo nsultationIDs 0..1 (L) RW See clause 9.6.1.3. OA campaignEnabled 1 RW Default value is FALSE. When set to "TRUE", the Hosting CSE shall monitor the trigger criteria defined by this resource and if/when met, initiate the start of a new software campaign defined by this resource. When set to "FALSE", the Hosting CSE shall attempt to cancel the software campaign if the software campaign has been initiated but not yet finished. This attribute is read-only when the value of the campaignStatus attribute is CANCELLING. OA campaignStatus 1 R0 Defines the status of the software campaign. The supported values include: PENDING - The Hosting CSE has not yet initiated this software campaign. This is the default value when the <softwareCampaign> resource is created. INITIATED - The Hosting CSE has started performing this software campaign but it has not yet finished. FINISHED - The Hosting CSE has completed this software campaign. CANCELLING - The Hosting CSE is attempting to cancel this software campaign which it has already initiated. CANCELLED - The Hosting CSE has cancelled this software campaign. STATUS_NOT_CANCELLABLE - The Hosting CSE has attempted but is unable to cancel this software campaign which it has already initiated. OA custodian 0..1 RW See clause 9.6.1.3. NA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 274 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <softwareCampaign> Multiplicity RW/ RO/ WO Description <softwareCam paignAnnc> Attributes version 1 RW The version of the software. The Hosting CSE copies the value of this attribute to the version attribute of the [software] specializations that it creates or updates based on this <softwareCampaign> resource. This attribute is read-only when the value of thecampaignEnabled attribute is "TRUE". OA softwareName 1 RW The name of the software. The Hosting CSE copies the value of this attribute to the softwareName attribute of the [software] specializations that it creates or updates based on this <softwareCampaign> resource. This attribute is read-only when the value of the campaignEnabled attribute is "TRUE". OA URL 1 RW The URL from which the software package can be downloaded. The Hosting CSE copies the value of this attribute to the URL attribute of the [software] specializations that it creates or updates based on this <softwareCampaign> resource. This attribute is read-only when the value of the campaignEnabled attribute is "TRUE". OA softwareTargets 1(L) RW A list of target entities that the software campaign defined by this resource is to be performed upon. Each entry in the list is specified as a resource identifier of a Registree's <node> resource corresponding to a Registree targeted for software management by the Hosting CSE. The Hosting CSE targets the specified <node> resource(s) when creating or updating [software] specialization(s) associated with this resource. This attribute is read-only when the value of the campaignEnabled attribute is "TRUE". OA softwareTriggerCriteria 0..1(L) RW Defines the conditions that the Hosting CSE monitors to detect if/when to perform the specified software campaign defined by this resource. This attribute consists of a subjectResourceID parameter and an evalCriteria parameter having the same format and definitions as those specified in the <action> resource defined in clause 9.6.61. If this attribute is not configured then the Hosting CSE shall attempt to perform the software campaign unconditionally upon creation of this resource. This attribute is read-only when the value of the campaignEnabled attribute is "TRUE". OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 275 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <softwareCampaign> Multiplicity RW/ RO/ WO Description <softwareCam paignAnnc> Attributes softwareOperation 1 RW Defines the software management operation to be performed by the Hosting CSE for this software campaign. The Hosting CSE uses the value of this attribute to configure the install, uninstall, activate and deactivate attributes of the [software] specializations it creates or updates based on this <softwareCampaign> resource. The supported values include: - INSTALL - UNINSTALL - ACTIVATE - DEACTIVATE This attribute is read-only when the value of the campaignEnabled attribute is "TRUE". OA softwareLinks 1(L) RO A list of resource identifiers of the [software] specializations created by the Hosting CSE based on this <softwareCampaign> resource. OA aggregatedSoftwareStat us 1 RO An aggregated status that the Hosting CSE computes based on aggregating the values of the individual statuses present in the individualSoftwareStatuses attribute of this resource. The supported values include: UNINITIALIZED - All the individual statuses present in the individualSoftwareStatuses attribute of this resource have a value of UNINITIALIZED. IN_PROCESS - At least one of the individual statuses present in the individualSoftwareStatuses attribute of this resource has a value of IN_PROCESS. SUCCESSFUL - All the individual statuses present in the individualSoftwareStatuses attribute of this resource have a value of SUCCESSFUL. FAILURE - None of the individual statuses present in the individualSoftwareStatuses attribute of this resource have a value of UNINITIALIZED or IN_PROCESS and at least one of the individual statuses has a value of FAILURE. OA ETSI ETSI TS 118 101 V4.15.0 (2022-09) 276 (oneM2M TS-0001 version 4.15.0 Release 4) Attributes of <softwareCampaign> Multiplicity RW/ RO/ WO Description <softwareCam paignAnnc> Attributes individualSoftwareStatus es 1(L) RO A list of status information for each of the softwareTargets. Each entry in the list is a tuple consisting of a resource identifier of an individual [software] specialization and the status of the [software] specialization. The Hosting CSE shall keep the entries in this list updated as defined in clause 10.2.28. The supported values for the individual status match the supported values of the installStatus and activeStatus attributes of a [software] specialization and include: - UNINITIALIZED - IN_PROCESS - SUCESSFUL - FAILURE The Hosting CSE shall use the value of the softwareOperation attribute of this <softwareCampaign> resource to determine whether to configure an individual status using the installStatus or activeStatus attribute of a [software] specialization. If the softwareOperation is INSTALL or UNINSTALL, then the Hosting CSE shall use the installStatus. If the softwareOperation is ACTIVATE or DEACTIVATE, then the Hosting CSE shall use the activeStatus. OA |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10 Information Flows | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.1 Basic Procedures | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.1.1 Overview | As a pre-condition to the execution of the following procedures, M2M operational security procedures as specified in clauses 11.3.1 through 11.3.4 shall have been performed. Also the Registrar CSE shall ensure that the Originator is associated with a valid and an ACTIVE <m2mServiceSubscriptionProfile> i.e. the status attribute value is set to ACTIVE. In case of failure, the error shall be reported as specified in ETSI TS 118 104 [3]. The procedures in the following clauses assume blocking requests as described in clause 8.2.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.1.2 CREATE (C) | Originator requests to create a resource by using the CREATE method. See clause 8.1.2 for the parameters to be included in the Request message. Hosting CSE: If the request is allowed by the given privileges and service subscription limits of the Originator, the Receiver shall create the resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 277 (oneM2M TS-0001 version 4.15.0 Release 4) Figure 10.1.2-1: Procedure for CREATing a Resource Step 001: The Originator shall send mandatory parameters and may send optional parameters in Request message for CREATE operation as specified in clause 8.1.2. Step 002: The Receiver shall: 1) Check if the Originator has the appropriate privileges for performing the request. Privileges of the targeted resource are linked by the accessControlPolicyIDs attribute. Different handlings for a target resource which does not have the accessControlPolicyIDs attribute by the resource type definition(e.g. schedule resource type) or a target resource which has the definition but the attribute has no value and so on are defined in table 9.6.1.3.2-1 (common attributes description). 2) Check if the CREATE operation complies with service subscription limits defined within the Originator's service subscription profile resources (i.e. <m2mServiceSubscriptionProfile>, <serviceSubscribedNode>, <serviceSubscribedAppRules> and <serviceSubscribedUserProfile> resources). Further details for checking the service subscription limits of the Originator are defined in ETSI TS 118 104 [3]. 3) Verify that the name for the created resource as suggested by the resourceName attribute in Content parameter, if provided by the Originator in the CREATE Request message, does not already exist among child resources of the target resource. If no child within the targeted resource exists with the same resourceName as suggested by the Originator, use that name for the resource to be created. If a child uses the resourceName already, the Receiver shall reject the request and return an error to the Originator. If the name was not suggested by the Originator, assign a name generated by the Receiver to the resource to be created. NOTE: The name of a resource in general is not the same as its Resource ID. While a name of a resource only needs to be unique among the children of the same parent resource, the Resource ID needs to be unique in context of the Hosting CSE. When the name of the resource to be created is assigned by the Receiver, it may choose to use a name that is identical to the Unstructured-CSE-relative-Resource ID. 4) Assign a Resource-ID (see resourceID attribute in common attribute table 9.6.1.3.2-1) to the resource to be created. 5) Assign values for mandatory RO mode attributes of the resource and override values provided for other mandatory attributes, where needed, and where allowed by the resource type definition and if not provided by the Originator itself. 6) The Receiver shall assign a value to the following common attributes specified in clause 9.6.1.3: a) parentID; b) creationTime; c) expirationTime: if not provided by the Originator, the Receiver shall assign the maximum value possible (within the restriction of the Receiver policies). If the value provided by the Originator cannot be supported, due to either policy or subscription restrictions, the Receiver will assign a new value; d) lastModifiedTime: which is equals to the creationTime; ETSI ETSI TS 118 101 V4.15.0 (2022-09) 278 (oneM2M TS-0001 version 4.15.0 Release 4) e) Any other RO (Read Only) attributes within the restriction of the Receiver policies. 7) The Receiver shall check whether a creator attribute is included in the Content parameter of the request. If included, the creator attribute shall not have a value in the Content parameter of the request. If the creator attribute is included in the request and the creator attribute is supported for the type of resource being created, then the Receiver shall include the creator attribute in the resource to be created. The Receiver shall assign a value equal to the value carried in the From request parameter. In the event that the originator provides a value for the creator attribute within the request, this request shall be deemed invalid. On the other hand if the creator attribute is not included in the Content parameter of the request, then the Receiver shall not include the creator attribute in the resource to be created. 8) The Receiver shall check whether the accessControlPolicyID attribute is supported for the type of created resource. If supported and an accessControlPolicyID attribute is included in the Content parameter of the request, then the Receiver shall assign the accessControlPolicyID attribute of the created resource with the value defined in the request. If an accessControlPolicyID attribute is not included in the Content parameter of the request, then the Receiver shall check whether the defaultAccessControlPrivileges attribute of the Originator's <m2mServiceSubscriptionProfile> resource is configured. If configured, the Receiver shall assign the accessControlPolicyID attribute of the created resource with the value defined in the defaultAccessControlPrivileges attribute. If the defaultAccessControlPrivileges attribute of the Originator's <m2mServiceSubscriptionProfile> resource is not configured, the Receiver shall not assign a value to the accessControlPolicyID attribute of the created resource and default access policies as defined in clause 9.6.1.3.2 shall apply. 9) On successful validation of the Create Request, the Receiver shall create the requested resource. 10) The Receiver shall check if the created child resource leads to changes in its parent resource's attribute(s), if so the parent resource's attribute(s) shall be updated. 11) The Receiver shall check if the created child resource references an Application Entity Resource ID, if so the Hosting CSE shall send a NOTIFY request to the IN-CSE, requesting to add the entry to the <AEContactList> resource. Step 003: The Receiver shall respond with mandatory parameters and may send optional parameters in Response message for CREATE operation as specified in clause 8.1.3. General Exceptions: 1) The Originator does not have the privileges to create a resource on the Receiver. The Receiver responds with an error. 2) The resource with the specified name (if provided) already exists at the Receiver. The Receiver responds with an error. 3) The provided information in Content is not accepted by the Receiver (e.g. missing mandatory parameter). The Receiver responds with an error. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.1.3 RETRIEVE (R) | The RETRIEVE operation shall be used for retrieving the information stored for any of the attributes for a resource at the Receiver CSE. The Originator CSE or AE may request to retrieve a specific attribute by including the name of such attribute in the Content parameter in the request message. Originator requests retrieval of all attributes or a specific attribute of the target resource by using RETRIEVE Request. See clause 8.1.2 for the information to be included in the Request message. If only some specific attributes need to be retrieved, the name of such attributes shall be included in the Content parameter of the Request message. Receiver performs local processing to verify the existence of requested resource and checks the service subscription limits and privileges of the Originator for retrieving the information related to the resource. After successful verification, the Receiver shall return the requested information, otherwise an error indication shall be returned. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 279 (oneM2M TS-0001 version 4.15.0 Release 4) Figure 10.1.3-1: Procedure for RETRIEVing a Resource Step 001: The Originator shall send mandatory parameters and may send optional parameters in Request message for RETRIEVE operation as specified in clause 8.1.2. Step 002: The Receiver shall verify the existence (including Filter Criteria checking, if it is given) of the target resource or the attribute and check if the Originator has appropriate privileges to retrieve information stored in the resource/attribute. This privilege checking follows the rules defined in table 9.6.1.3.2-1 (common attributes description). The Receiver shall also verify if the RETRIEVE operation complies with service subscription limits defined within the Originator's service subscription profile resources (i.e. <m2mServiceSubscriptionProfile>, <serviceSubscribedNode>, <serviceSubscribedAppRules> and <serviceSubscribedUserProfile> resources). Further details for checking the service subscription limits of the Originator are defined in ETSI TS 118 104 [3]. Step 003: The Receiver shall respond with mandatory parameters and may send optional parameters in Response message for RETRIEVE operation as specified in clause 8.1.3. General Exceptions: 1) The targeted resource/attribute in To parameter does not exist. The Receiver responds with an error. 2) The Originator does not have privileges to retrieve information stored in the resource on the Receiver. The Receiver responds with an error. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.1.4 UPDATE (U) | The UPDATE operation shall be used for updating the information stored for any of the attributes at a target resource. Especially important is the expirationTime, since a failure in refreshing this attribute may result in the deletion of the resource. The Originator CSE or AE can request to update, create or delete specific attribute(s) at the target resource by including the name of such attribute(s) and its values in the Content parameter of the request message. Originator requests update any of the attributes at the target resource by using UPDATE Request message. The Originator shall send new (proposed) values for the attribute(s) that need to be updated. The UPDATE operation allows to modify or create previously non-existing attributes of the resource type (defined in clause 9.6) that are indicated as "RW" (Read Write) for the specific resource type definition. The Originator requests to delete attributes at the target resource by using UPDATE Request message. The Originator shall send the name of the attributes to be deleted (defined in clause 9.6) for the specific resource type with their value set to NULL, in the Request message. See clause 8.1.2 for the information to be included in the Request message. The Receiver verifies the existence of the addressed resource, the validity of the attributes provided, the privileges to modify them and the service subscription limits of the Originator. After successful verification, the Receiver shall update the attributes provided and shall return a Response message to the Originator with the operation results as specified in clause 8.1.3. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 280 (oneM2M TS-0001 version 4.15.0 Release 4) If the attributes provided do not exist, after verifying the existence of the addressed resource, the Receiver validates the attributes provided and the privileges to create them. On successful validation, the Receiver shall create the attributes provided with their associated values and shall return a Response message to the Originator with the operation results as specified in clause 8.1.3. If the attributes provided have their value set to NULL, after verifying the existence of the addressed resource, the Receiver validates the attributes provided and the Update privileges of the Originator. On successful validation, the Receiver shall delete such attributes and shall return a Response message to the Originator with the operation results as specified in clause 8.1.3. Figure 10.1.4-1: Procedure for UPDATing a Resource Step 001: The Originator shall send mandatory parameters and may send optional parameters in Request message for UPDATE operation as specified in clause 8.1.2. Step 002: The Receiver shall verify the existence (including Filter Criteria checking, if it is given) of the requested resource and if the Originator has the appropriate privilege to update the resource. This privilege checking follows the rules defined in table 9.6.1.3.2-1 (common attributes description). The Receiver shall also perform an additional check whether a custodian attribute is included in the Content parameter of the request. If included, the Receiver shall check if the resource has a custodian attribute already configured. If the custodian attribute is configured in the resource, the Receiver shall check if it is configured with the identifier of the Originator and therefore permitted to update the custodian attribute. Otherwise, if the custodian attribute is not configured in the resource, then the Receiver shall check if the Originator is the Originator that originally created the targeted resource and therefore is permitted to update the custodian attribute. On successful verification, the Receiver shall update the resource as requested. If the attributes provided do not exist, the Receiver shall verification if the Originator has appropriate privileges to create the attributes at the target resource. The Receiver shall also verify if the UPDATE operation complies with service subscription limits defined within the Originator's service subscription profile resources (i.e. <m2mServiceSubscriptionProfile>, <serviceSubscribedNode>, <serviceSubscribedAppRules> and <serviceSubscribedUserProfile> resources). Further details for checking the service subscription limits of the Originator are defined in ETSI TS 118 104 [3]. On successful verification, the Receiver shall create the attributes with their associated values at the resource as requested. If the attributes provided have their value set to NULL, the Receiver shall verify if the Originator has Update privilege to delete the attributes at the target resource. On successful verification, the Receiver shall delete such attributes. The Receiver shall check if the updated target resource is a child of a parent resource having a stateTag attribute and increment the stateTag if present. The Receiver shall check if the update causes a change to a reference to an Application Entity Resource ID. If so the Hosting CSE shall send a NOTIFY request to the IN-CSE, requesting to update the entry to the <AEContactList> resource. Step 003: The Receiver shall respond with mandatory parameters and may send optional parameters in Response message for UPDATE operation as specified in clause 8.1.3. General Exceptions: 1) The targeted resource in To parameter does not exist. The Receiver responds with an error. 2) The Originator does not have the privilege to Update the resource including create non-existing attributes or delete existing attributes on the Receiver. The Receiver responds with an error. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 281 (oneM2M TS-0001 version 4.15.0 Release 4) 3) The provided information in the Content is not accepted by the Receiver. The Receiver responds with an error. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.1.5 DELETE (D) | The DELETE operation shall be used by an Originator CSE or AE to delete a resource at a Receiver CSE. For such operation, the DELETE procedure shall consist of the deletion of all related information of the target resource. Originator requests deletion of a resource by using a DELETE Request message. See clause 8.1.2 for the information to be included in the Request message. Receiver The Receiver verifies the existence of the requested resource, and the privileges and service subscription limits of the Originator for deleting the resource. Figure 10.1.5-1: Procedure for DELETING a Resource Step 001: The Originator shall send mandatory parameters and may send optional parameters in Request message for DELETE operation as specified in clause 8.1.2. Step 002: The Receiver shall verify the existence (including Filter Criteria checking, if it is given) of the requested resource and if the Originator has the appropriate privilege to delete the resource. This privilege checking follows the rules defined in table 9.6.1.3.2-1 (common attributes description). The Receiver shall also verify if the DELETE operation complies with service subscription limits defined within the Originator's service subscription profile resources (i.e. <m2mServiceSubscriptionProfile>, <serviceSubscribedNode>, <serviceSubscribedAppRules> and <serviceSubscribedUserProfile> resources). Further details for checking the service subscription limits of the Originator are defined in ETSI TS 118 104 [3]. On successful verification, the Receiver shall check for child resources and delete all child resources and the associated references in parent resources and it shall remove the resource itself. The Receiver shall check if the deleted child resource leads to changes in its parent resource's attribute(s), if so the parent resource's attribute(s) shall be updated. If the deleted resource had a reference to an Application Entity Resource ID, the Hosting CSE shall send a NOTIFY request to the IN-CSE, requesting to delete the entry from the <AEContactList> resource. Step 003: The Receiver shall respond with mandatory parameters and may send optional parameters in Response message for DELETE operation as specified in clause 8.1.3. General Exceptions: 1) The targeted resource in To information does not exist. The Receiver responds with an error. 2) The Originator does not have the privileges to delete the resource on the Receiver. The Receiver responds with an error. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.1.6 NOTIFY (N) | The NOTIFY operation shall be used for notifying information. All the specific notification procedures defined in this present document are listed in clause 10.1.6 (Notification procedures). ETSI ETSI TS 118 101 V4.15.0 (2022-09) 282 (oneM2M TS-0001 version 4.15.0 Release 4) The Originator requests to notify an entity by using NOTIFY method. See clause 8.1.2 for the information to be included in a Request message. The Receiver responds to the Originator with the operation results as specified in clause 8.1.3. 002: NOTIFY Request 004: NOTIFY Response Originator (CSE or AE) Receiver (Hosting CSE or AE) 001: Local Processing (Notification Triggered) 003: Local Processing Figure 10.1.6-1: Procedure for NOTIFYing Information Step 001: A notification to be sent to the Receiver is triggered in the Originator. The Originator shall verify if the NOTIFY operation complies with service subscription limits defined within the Receiver's service subscription profile resources (i.e. <m2mServiceSubscriptionProfile>, <serviceSubscribedNode>, <serviceSubscribedAppRules> and <serviceSubscribedUserProfile> resources). Further details for checking the service subscription limits of the Receiver are defined in ETSI TS 118 104 [3]. Step 002: The Originator shall send mandatory parameters and may send optional parameters in Request message for NOTIFY operation as specified in clause 8.1.2. Step 003: Local Processing. Step 004: The Receiver shall respond with mandatory parameters and may send optional parameters in Response message for NOTIFY operation as specified in clause 8.1.3. General Exceptions: • See ETSI TS 118 103 [2]. In the present document, notification procedures are defined in the following procedures: • <subscription> resource handling (clause 10.2.10) - to notify Receiver(s) of modifications of a resource for an associated <subscription> resource - to notify aggregated notifications from <subscription> member resources of <group> resource - to request Receiver(s) to perform resource subscription verification - to notify deletion of the <subscription> resource - to seek authorization from the subscription creator during a notification target deletion • Asynchronous non-blocking request handling (clause 8.2.2.3) - to send the result of the request ETSI ETSI TS 118 101 V4.15.0 (2022-09) 283 (oneM2M TS-0001 version 4.15.0 Release 4) • <pollingChannelURI> resource handling (clause 10.2.5.19) - to send the response corresponding to a request delivered via service layer long polling • IPE on-demand discovery handling (clause 10.2.6) - to notify Receiver(s) (i.e. IPE) for on-demand discovery request • End-to-End security handling (clause 11.4) - to send the request/response that cannot be readable by Transit CSEs • Dynamic authorization consultation handling (clause 11.5) - to seek authorization to access a resource from Dynamic Authorization Server • Change in AE Registration Point (clause 10.2.16) - to notify Receivers that an AE has changed registration point • Change in a resource with reference to an Application Entity Resource ID (clauses 10.1.2 (CREATE), 10.1.4 (UPDATE), 10.1.5 (DELETE) and 9.6.1.3.1 (expiration timer expiry) - to notify IN-CSE that the Originator has a new/updated reference to an Application Entity Resource identifier • <crossResourceSubscription> resource handling (clause 10.2.10) - to notify Receiver(s) of cross-resource notification generated by a <crossResourceSubscription> Hosting CSE - to notify deletion of the <crossResourceSubscription> resource - to request Receiver(s) to perform cross-resource subscription verification - to seek authorization from the cross-resource subscription creator during a notification target deletion • <timeSyncBeacn> handling (clause 10.2.24) - to notify Receivers of time synchronization information of the Hosting CSE |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2 Functional procedures | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.1 Overview | The basic procedure for the corresponding operations as specified in clause 10.1 shall be performed with the modifications specific to the resource type procedures as described in clause 10.2. For resources without defined resource type-specific operations, the basic operations in clause 10.1 shall apply. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.2 Registration | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.2.1 AE registration | AE Registration towards a Registrar CSE is a process to enable an AE to use services offered by the oneM2M System. It is achieved through the create <AE> procedure. The registration details can be viewed and updated using retrieve <AE> and update <AE> procedures, respectively. The delete <AE> procedure is used to de-register an AE from its Registrar CSE. AE Registration helps the M2M Service Provider to offer its services only to authorized AEs and to protect its platform from malicious AE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 284 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.2.2 Create <AE> | This procedure shall be used for creating an <AE> resource. This operation is part of the registration procedure for AEs on the Registrar CSE (which is also the Hosting CSE), as described in clause 10.2.2.2. Table 10.2.2.2-1: <AE> CREATE <AE> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: From: Registree AE only Content: The resource content shall provide the information as defined in clause 9.6.5 Processing at Originator before sending Request According to clause 10.2.2.2 Processing at Receiver According to clause 10.2.2.2 Information in Response message All parameters defined in table 8.1.3-1 Processing at Originator after receiving Response According to clause 10.2.2.2 Exceptions According to clause 10.2.2.2 The procedure for AE registration follows the message flow description depicted in figure 10.2.2.2-1. It defines in which cases additional procedures need to be initiated by the Registrar CSE for creating or updating of <AEAnnc> resources hosted on the M2M SP's IN-CSE in case an AE-ID-Stem starting with an 'S' character shall be used, see table 7.2-1 for the definition of AE-ID-Stem. The above additional procedures i.e. steps related to announcement shall not be required when Registrar CSE is the IN-CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 285 (oneM2M TS-0001 version 4.15.0 Release 4) Case f AE-ID-Stem starts with ‘C’ and was provided by AE Re-registration to new Registrar CSE Case e AE-ID-Stem starts with ‘S’ and was provided by AE Re-registration to new Registrar CSE Case d AE-ID-Stem starts with ‘C’ and was provided by AE Step 5d Case c AE-ID-Stem starts with ‘C’ and was not provided by AE Case b AE-ID-Stem starts with ‘S’ and was provided by AE Initial registration or re-registration to same Registrar CSE Case a AE-ID-Stem starts with ‘S’ and was not provided by AE Registree AE Registree AE Request(CREATE <AE>) <AE> includes App-ID Registrar CSE Registrar CSE Security Association Establishment IN-CSE IN-CSE Determine combination(s) of allowed AE-ID-Stem value(s) and App-ID from used Certificate directly (if any) or by lookup in service subscription profile (Credential-ID, Registrar CSE) May require optional retrieve of information from service subscription profile if not available on Registrar CSE Check if <AE> create request is consistent with allowed combinations determined in step 3 Step 1 Step 2 Step 3 Step 4 Validate UPDATE or CREATE <AEannc> request (including Credential-ID, Reg. CSE), update or create <AEannc> resource Request(CREATE <AEannc>) Shall include a specific ‘S*’ value for ‘From’ parameter if specific AE-ID-Stem was determined in step 3 Step 5a Validate CREATE <AEannc> request (including Credential-ID, Reg. CSE), select specific AE-ID-Stem starting wth ‘S’ if not already provided, create <AEannc> resource Step 6a Response(CREATE <AEannc>) Step 7a create <AE> resource using AE-ID-Stem value returned from IN-CSE Step 8a Request(UPDATE or CREATE<AEannc>) Step 5b Step 6b Response(UPDATE or CREATE <AEannc>) Step 7b create <AE> resource using AE-ID-Stem provided by AE Step 8b create <AE> resource using AE-ID-Stem starting with ‘C’ and provided by AE select AE-ID-Stem starting with ‘C’ and create <AE> resource using that AE-ID-Stem Step 5c Response(CREATE <AE>) Step 9 AE/App/Node Optional Validate UPDATE or CREATE <AEannc> request update or create new <AEannc> resource Change status of old <AEannc> resource to INACTIVE Transfer child-resources of old <AEAnnc> resource Update all references tied to old AE registration point Request(UPDATE or CREATE<AEannc>) Step 5e Step 6e Response(UPDATE or CREATE <AEannc>) Step 7e create <AE> resource using AE-ID-Stem provided by AE Step 8e Step 5f create <AE> resource using AE-ID-Stem starting with ‘C’ and provided by AE Request(NOTIFY) Step 6f Process NOTIFY Response(NOTIFY) Step 7f Step 7f Step 8f Figure 10.2.2.2-1: Procedure for Creating an <AE> Resource ETSI ETSI TS 118 101 V4.15.0 (2022-09) 286 (oneM2M TS-0001 version 4.15.0 Release 4) Originator: The Originator shall be the Registree AE. Receiver: The Receiver shall allow the creation of the <AE> resource according to the m2m service subscription validation. Note that access control for resource access (e.g. using <accessControlPolicy> resources) is omitted. To validate the m2m service subscription profile, the Receiver shall check the corresponding <serviceSubscribedNode> resource, by matching the CSE-ID in the m2m service subscription profile against the Receiver owned CSE-ID. Subsequently the Receiver shall check whether the Registree AE is included in the linked (i.e. ruleLinks attribute) <serviceSubscribedAppRules> resource(s). Step 001: Optional: In case the Registree AE intends to use a Security Association to perform the registration, a Security Association Establishment procedure (see clause 11.2.2) shall get carried out first. In some cases (e.g. registration of AE internal to an MN or ASN), this may not be required depending on deployment choices of the M2M SP. Therefore, this step is optional. This optional Security Association can be established between the following entities: • The Registree AE and the Registrar CSE - in which case the specific AE that is subsequently sending the request to get registered shall be authenticated. • The Node on which the Registree AE is hosted and the Registrar CSE - in which case only the Node from which the registration request is received at the Registrar CSE shall be authenticated. In this case one or more AEs hosted on the authenticated node may communicate over either a single Security Association or over individual Security Associations. NOTE: The Node authentication should be used only when the M2M Service Provider trusts the AE (on the Node) to provide the correct AE-ID and App-ID. The present document does not provide mechanisms by which the M2M Service Provider can obtain assurance about the trustworthiness of the AE when using Node authentication. For example, such a mechanism (by which the M2M Service Provider can obtain assurance about the trustworthiness of the AE) could be provided by executing the M2M Application on a secure environment. The identifier of the security credentials used for establishing the Security Association in this step shall be termed 'Credential-ID' for the remainder of this procedure description. If no Security Association has been performed the Credential-ID is not applicable. Step 002: The Originator shall send the information defined in clause 10.1.2 for the registration CREATE procedure with the following specific information in the CREATE Request message: From: AE-ID-Stem or Not Present: i) In case the Registree AE has already registered successfully before, then deregistered and intends to register again to the same Registrar CSE with the same AE-ID-Stem value as before, the Registree AE shall include that AE-ID-Stem value into the From parameter. ii) In case the Registree AE intends to initiate a fresh registration with a pre-provisioned AE-ID-Stem value, the Registree AE shall include that pre-provisioned AE-ID-Stem value into the From parameter. iii) In case the Registree AE has not registered successfully before and intends to get an M2M-SP-assigned AE- ID-Stem starting with an 'S' character assigned to itself but it does not have any specific value to suggest, it shall set the From parameter to the character 'S'. iv) In case the Registree AE has not registered successfully before and intends to get a Registrar CSE-assigned AE-ID-Stem starting with a 'C' character assigned to itself but it does not have any specific value to suggest, it shall set the From parameter to the character 'C'. v) In case the Registree AE intends to initiate a fresh registration and has no preference for the AE-ID-Stem value, the From parameter shall not be sent. vi) In case the Registree AE has already registered successfully to a Registrar CSE, and now intends to register to a different Registrar CSE (i.e. Registree AE has changed its registration point), the Registree AE shall include its AE-ID-Stem value (from the prior registration) into the From parameter. The CSE shall allow unknown AEs to attempt the 'CREATE' before they are granted this permission. See ETSI TS 118 103 [2] for further details about authentication for the AE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 287 (oneM2M TS-0001 version 4.15.0 Release 4) Step 003: The Receiver shall determine whether the request to register the Registree AE meets any of the following conditions: • In case the Security Association Establishment in step 001 was performed using security credentials in form of a Certificate that included an App-ID and an AE-ID-Stem attribute, check if they match with the App-ID attribute in the Content parameter of the request and the AE-ID-Stem in the From parameter of the request. • Check if the applicable service subscription profile lists a combination of (allowed AE-ID-Stem value and allowed App-ID value) for the Credential-ID and the Registrar CSE-ID (see clause 11.2.2) that match with the App-ID attribute in the Content parameter of the request and the AE-ID-Stem in the From parameter of the request. If the information needed to perform that checking is not available to the Registrar CSE locally, the Registrar CSE shall retrieve that information from the applicable service subscription profile(s) from the IN-CSE. If the From parameter was not set in the request and the allowed AE-ID-Stem includes a wild card ("*") in the applicable service subscription profile(s), the Registrar CSE shall assign the starting character ('S', 'C') in accordance with provisioned Service Provider policy. The applicable rules for this checking are contained in the <serviceSubscribedAppRule> resource(s) which are linked to by the ruleLinks attribute of the <m2mServiceSubscribedNode> resource(s) associated with the Registrar CSE. The <m2mServiceSubscribedNode> resource(s) associated with the Registrar CSE can be retrieved from the IN-CSE by applying the Filter Criteria parameter set to "CSE-ID={Registrar-CSE-ID}"where {Registrar-CSE-ID} needs to be substituted by the actual CSE-ID of the Registrar-CSE. If none of the conditions are met, the registration is not allowed and the Receiver shall respond with an error. Step 004: If the From parameter of the request provides a complete AE-ID-Stem value, i.e. case i), ii), or vi) of step 002 applied, the Registrar CSE shall check whether an <AE> resource with an Unstructured-CSE-relative- Resource-ID identical to the AE-ID-Stem value provided in the From parameter of the request does already exist on the Registrar CSE. If so, there is still an active registration using the same AE-ID-Stem on the Registrar CSE and the Registrar CSE shall respond with an error. If not, the Registrar CSE shall perform action (3) in step 002 of clause 10.1.2. If the From parameter of the request provides a complete AE-ID-Stem and starts with 'S', i.e. case i), ii), or vi) of step 002 applied and 'S' is the first character of the provided AE-ID-Stem, and if the Registrar CSE determines that this is an initial registration or a re-registration to the same Registrar CSE, the procedure continues with case b) of the present step 004. If the From parameter of the request provides a complete AE-ID-Stem and starts with 'S', i.e. case i), ii) or vi) of step 002 applied and 'S' is the first character of the provided AE-ID-Stem, and if the Registrar CSE determines that this is a re-registration due to a change in registration point, and if the Registree AE requests not to be tracked as it changes its registration point (trackRegistrationPoints= FALSE), the procedure continues as an initial registration, with case b) of the present step 004. If the From parameter of the request provides a complete AE-ID-Stem and starts with 'S', i.e. case i), ii) or vi) of step 002 applied and 'S' is the first character of the provided AE-ID-Stem, and if the Registrar CSE determines that this is a re-registration due to a change in registration point, and if the Registree AE requests to be tracked as it changes its registration point (trackRegistrationPoints = TRUE), the procedure continues as a re-registration to a new Registrar CSE, with case e) of the present step 004. If From parameter of the request provides a complete AE-ID-Stem and starts with 'C', i.e. case i), ii), or vi) of step 002 applied and 'C' is the first character of the provided AE-ID-Stem, and if the Registrar CSE determines that this is an initial registration or a re-registration to the same Registrar CSE, the procedure continues with case d) of the present step 004. If From parameter of the request provides a complete AE-ID-Stem and starts with 'C', i.e. case i), ii) or vi) of step 002 applied and 'C' is the first character of the provided AE-ID-Stem, and if the Registrar CSE determines that this is a re- registration due to a change in registration point, and if the Registree AE requests not to be tracked as it changes its registration point (trackRegistrationPoints = FALSE), the procedure continues as an initial registration, with case d) of the present step 004. If From parameter of the request provides a complete AE-ID-Stem and starts with 'C', i.e. case i) or ii) or vi) of step 002 applied and 'C' is the first character of the provided AE-ID-Stem, and if the Registrar CSE determines that this is a re- registration due to a change in registration point, and if the Registree AE requests to be tracked as it changes its registration point (trackRegistrationPoints = TRUE), the procedure continues as a re-registration to a new Registrar CSE, with case f) of the present step 004. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 288 (oneM2M TS-0001 version 4.15.0 Release 4) If the From parameter of the request is equal to the value 'S', i.e. case iii) of step 002 applied, the procedure continues with case a) of the present step 004. If the From parameter of the request is equal to the value 'C', i.e. case iv of step 002 applied, the procedure continues with case c) of the present step 004. If the From parameter of the request is not sent, the Registrar CSE shall perform action (3) in step 002 of clause 10.1.2 to assign the resourceID with starting character ('S', 'C') in accordance with provisioned Service Provider policy and shall set the corresponding value in AE-ID-Stem. If the assigned value in AE-ID-Stem attribute starts with 'S', the procedure continues with case b) else the procedure continues with case d). Case a) AE-ID-Stem starts with 'S' and AE does not include an AE-ID-Stem (initial registration): Condition: In step 003 it was determined that the AE-ID-Stem value to be used for the Registree AE starts with an 'S' character but no specific AE-ID-Stem was provided with the CREATE request of the Registree AE. This case applies when the Registree AE is supposed to use an M2M-SP-assigned AE-ID and wants to perform the initial registration: Step 005a: The Receiver shall send a CREATE request for an <AEAnnc> resource to the IN-CSE in order to create an <AEAnnc> resource on the IN-CSE that is associated with the Registree AE. The following information shall be sent with that CREATE request: • In case no specific AE-ID-Stem value to be used for the Registree AE was determined during step 003, the value 'S' shall be used in what follows for the AE-ID-Stem. Otherwise use the value determined in step 003. • The From parameter of the CREATE request for the <AEAnnc> resource shall be set to the SP-relative-CSE- ID or Absolute-CSE-ID followed by '/S'. • 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 an 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 Security Association was used by the Registree AE, then Credential-ID is not applicable. Step 006a: Upon reception of the CREATE <AEAnnc> request, the IN-CSE shall validate the request and verify whether the provided values of the App-ID attribute and the AE-ID-Stem in the From parameter is allowed for the combination of Credential-ID included in the labels attribute and the CSE-ID of the Registrar CSE included in the link attribute, according to the applicable service subscription profile. If that verification is successful and no specific AE- ID-Stem is provided, i.e. if the From parameter contains only the character 'S', the IN-CSE shall select an AE-ID-Stem in line with the applicable service subscription profile. Step 007a: When the validation and verification in step 006a completed successfully, the IN-CSE shall create <AEAnnc> resource with an Unstructured-CSE-relative-Resource-ID equal to the value of the AE-ID-Stem, replace the AE-ID-Stem for the trailing 'S' character in the Unstructured-CSE-relative-Resource-ID present in the link attribute if the AE-ID-Stem was selected by the IN-CSE, and send a successful response to the Registrar CSE. Step 008a: Upon reception of a successful response from the IN-CSE, the Registrar 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 CSE and continue with action (4) of Step 002 of the non-registration related CREATE procedure in clause 10.1.2. Case b) AE-ID-Stem starts with 'S' and AE includes an AE-ID-Stem (initial registration or re-registration to the same Registrar CSE): Condition: In step 003 it was determined that the AE-ID-Stem value to be used for the Registree AE starts with an 'S' character and a specific AE-ID-Stem was provided with the CREATE request of the Registree AE. This case applies when the Registree AE is supposed to use an M2M-SP-assigned AE-ID and wants to perform initial registration or re- registration using its already assigned AE-ID-Stem. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 289 (oneM2M TS-0001 version 4.15.0 Release 4) Step 005b: The receiver shall determine if an <AEAnnc> resource already exists on the IN-CSE that is associated with the Registree AE. The Receiver shall send an UPDATE request for an <AEAnnc> resource to the IN-CSE in order to update the already existing <AEAnnc> resource on the IN-CSE that is associated with the Registree AE in case of re- registration or the Receiver shall send a CREATE request for an <AEAnnc> resource to the IN-CSE in order to create an <AEAnnc> resource on the IN-CSE that is associated with the Registree AE in case of initial registration. The following information shall be sent with that UPDATE or CREATE request: • The To parameter shall contain the SP-relative-Resource-ID format of the Resource ID for the <AEAnnc> resource which shall be constructed from the CSE-ID of the IN-CSE and the AE-ID-Stem that the Registree AE provided. • From parameter of the CREATE or UPDATE request for the <AEAnnc> resource shall be set to the SP- relative-CSE-ID or Absolute-CSE-ID followed by '/' and the AE-ID-Stem value. • The link attribute of the <AEAnnc> resource shall be set (in case of initial registration) or updated (in case of re-registration) to the SP-Relative-Resource-ID format of a - not yet existent - <AE> resource hosted on the Registrar CSE constructed with an Unstructured-CSE-relative-Resource-ID that is equal to the AE-ID-Stem value used for the Registree AE. • The labels attribute of the <AEAnnc> resource shall be set (in case of initial registration) or updated (in case of re-registration) to the concatenation of the string 'Credential-ID:' and the Credential-ID of the Security Association used by the Registree AE, replacing the existing entry starting with 'Credential-ID:' if present. If no Security Association was used by the Registree AE, then Credential-ID is not applicable. Step 006b: Upon reception of the CREATE or UPDATE <AEAnnc> request, the IN-CSE shall validate the request and verify whether the values suggested to be set or to be updated for the Credential-ID included in the labels attribute - if any - and the CSE-ID of the Registrar CSE included in the From parameter still match with any of the allowed combinations of App-ID attribute and the AE-ID-Stem in the link attribute according to the applicable service subscription profile. Step 007b: When the validation and verification in step 006b completed successfully, the IN-CSE shall create <AEAnnc> resource with an Unstructured-CSE-relative-Resource-ID equal to the value of the provided AE-ID-Stem or update the <AEAnnc> resource in line with the parameters provided in step 005b. Step 008b: Upon reception of a successful response from the IN-CSE, the Registrar CSE shall use the Unstructured- CSE-relative-Resource-ID equal to the AE-ID-Stem provided by the Registree AE for the <AE> resource to be created on the Registrar CSE and continue with action (4) of step 002 of the non-registration related CREATE procedure in clause 10.1.2. Case c) AE-ID-Stem starts with 'C' and AE does not include an AE-ID-Stem (initial registration): Condition: In step 003 it was determined that the AE-ID-Stem value to be used for the Registree AE starts with a 'C' character but no specific AE-ID-Stem was provided with the CREATE request of the Registree AE. This case applies when the Registree AE is not supposed to use an M2M-SP-assigned AE-ID and wants to perform the initial registration: Step 005c: The Registrar CSE shall select an AE-ID-Stem starting with a 'C' character and use it for the Unstructured- CSE-relative-Resource-ID for the <AE> resource to be created on the Registrar CSE and continue with action (4) of step 002 of the non-registration related CREATE procedure in clause 10.1.2. Case d) AE-ID-Stem starts with 'C' and AE includes an AE-ID-Stem (initial registration or re-registration registration to the same Registrar CSE): Condition: In Step 003 it was determined that the AE-ID-Stem value to be used for the Registree AE starts with a 'C' character and a specific AE-ID-Stem was provided with the CREATE request of the Registree AE. This case applies when the Registree AE is not supposed to use an M2M-SP-assigned AE-ID and wants to perform initial registration or re-registration using its already assigned AE-ID-Stem. Step 005d: The Registrar CSE shall use the Unstructured-CSE-relative-Resource-ID equal to the AE-ID-Stem in the From parameter for the <AE> resource to be created on the Registrar CSE and continue with action (4) of step 002 of the non-registration related CREATE procedure in clause 10.1.2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 290 (oneM2M TS-0001 version 4.15.0 Release 4) Case e) AE-ID-Stem starts with 'S' and AE includes an AE-ID-Stem (re-registration to a new Registrar CSE): Condition: In step 003 it was determined that the AE-ID-Stem value to be used for the Registree AE starts with an 'S' character and a specific AE-ID-Stem was provided with the CREATE request of the Registree AE. This case applies when the Registree AE is supposed to use an M2M-SP-assigned AE-ID and wants to perform a re-registration to a new Registrar CSE, using its already assigned AE-ID-Stem from a registration to a prior Registrar CSE. Step 005e: The receiver shall determine if an <AEAnnc> resource already exists on the IN-CSE that is associated with the Registree AE. If so, the Receiver shall send an UPDATE request for an <AEAnnc> resource to the IN-CSE in order to update the already existing <AEAnnc> resource on the IN-CSE that is associated with the Registree AE in case of re- registration. Otherwise, if there is no already existing <AEAnnc> resource associated with the Registree AE, the Receiver shall send a CREATE request for an <AEAnnc> resource to the IN-CSE in order to create an <AEAnnc> resource on the IN-CSE that is associated with the Registree AE. The following information shall be sent with that UPDATE or CREATE request: • The To parameter shall contain the SP-relative-Resource-ID format of the Resource ID for the <AEAnnc> resource which shall be constructed from the CSE-ID of the IN-CSE and the AE-ID-Stem that the Registree AE provided. • From parameter of the CREATE or UPDATE request for the <AEAnnc> resource shall be set to the SP- relative-CSE-ID or Absolute-CSE-ID followed by '/' and the AE-ID-Stem value. • The link attribute of the <AEAnnc> resource shall be set or updated, to the SP-Relative-Resource-ID format of a - not yet existent - <AE> resource hosted on the Registrar CSE constructed with an Unstructured-CSE- relative-Resource-ID that is equal to the AE-ID-Stem value used for the Registree AE. • The labels attribute of the <AEAnnc> resource shall be set or updated to the concatenation of the string 'Credential-ID:' and the Credential-ID of the Security Association used by the Registree AE, replacing the existing entry starting with 'Credential-ID:' if present. If no Security Association was used by the Registree AE, then Credential-ID is not applicable. Step 006e: Upon reception of the CREATE or UPDATE <AEAnnc> request, the IN-CSE shall validate the request and verify whether the values suggested to be set or to be updated for the Credential-ID included in the labels attribute - if any - and the CSE-ID of the Registrar CSE included in the From parameter still match with any of the allowed combinations of App-ID attribute and the AE-ID-Stem in the link attribute according to the applicable service subscription profile. Step 007e: When the validation and verification in step 006e completed successfully, the IN-CSE shall create <AEAnnc> resource with an Unstructured-CSE-relative-Resource-ID equal to the value of the provided AE-ID-Stem or update the <AEAnnc> resource in line with the parameters provided in step 005e. The IN-CSE shall change the registrationStatus attribute of the old <AEAnnc> resource (tied to the old registration point) to INACTIVE, and shall transfer all child-resources under the old <AEAnnc> resource to the newly created or updated <AEAnnc> resource. The IN-CSE shall update all references to the SP-Relative-Resource-ID references (e.g. in Announce links, Notification targets, group Member ID, <accessControlPolicy> resource OriginatorID lists) tied to the prior AE registration point, so that these refer to the new AE registration point. The IN-CSE shall manage the change in AE registration point, as described in clause 10.2.16.1. Step 008e: Upon reception of a successful response from the IN-CSE, the Registrar CSE shall use the Unstructured- CSE-relative-Resource-ID equal to the AE-ID-Stem provided by the Registree AE for the <AE> resource to be created on the Registrar CSE and continue with action (4) of step 002 of the non-registration related CREATE procedure in clause 10.1.2. Case f) AE-ID-Stem starts with 'C' and AE includes an AE-ID-Stem (re-registration to a new Registrar CSE): Condition: In step 003 it was determined that the AE-ID-Stem value to be used for the Registree AE starts with a 'C' character and a specific AE-ID-Stem was provided with the CREATE request of the Registree AE. This case applies when the Registree AE is not supposed to use an M2M-SP-assigned AE-ID and wants to perform a re-registration to a new Registrar CSE and it wants to have its registration points tracked: Step 005f: The Registrar CSE shall use the Unstructured-CSE-relative-Resource-ID equal to the AE-ID-Stem in the From parameter for the <AE> resource to be created on the Registrar CSE. Step 006f: The Registrar CSE shall send a NOTIFY request to the IN-CSE. The Content parameter shall contain the SP-relative-Resource-ID at the prior registration point and the SP-relative-Resource-ID at the new registration point. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 291 (oneM2M TS-0001 version 4.15.0 Release 4) Step 007f: Upon reception of the NOTIFY request, the IN-CSE shall manage the change in AE registration point, as described in clause 10.2.16.1. Step 008f: Upon reception of a successful response from the IN-CSE, the receiver shall then continue with action (4) of step 002 of the non-registration related CREATE procedure in clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.2.3 Retrieve <AE> | This procedure shall be used for retrieving the representation of the <AE> resource. Table 10.2.2.3-1: <AE> RETRIEVE <AE> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <AE> resource as defined in clause 9.6.5 Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.2.4 Update <AE> | This procedure shall be used for updating the attributes and the actual data of an <AE> resource. Table 10.2.2.4-1: <AE> UPDATE <AE> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: attributes of the <AE> resource as defined in clause 9.6.5 which need be updated Processing at Originator before sending Request According to clause 10.1.4 Processing at Receiver According to clause 10.1.4 If the pointOfAccess attribute is updated and there are any messages in the buffer for store-and-forward procedure, Receiver shall send all buffered messages Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response According to clause 10.1.4 Exceptions According to clause 10.1.4 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.2.5 Delete <AE> | This procedure shall be used for deleting the <AE> resource with all related information. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 292 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.2.5-1: <AE> DELETE <AE> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 Application Entity Deregistration is performed by requesting a Delete operation for the <AE> resource representing the Application Entity. In case an <AE> resource hosted on a MN-CSE or ASN-CSE with AE-ID-Stem starting with "S" is requested to be deleted, the <AEAnnc> resource that was created on the IN-CSE during the initial registration of the associated Application Entity shall be updated with the value "INACTIVE" for the link attribute, indicating that the associated Application Entity is currently not registered. After this update of the <AEAnnc> resource is completed, the procedure for AE Deregistration shall follow the procedure described in this clause. In case an <AE> resource with AE-ID-Stem not starting with "S" is requested to be deleted, the procedure for AE Deregistration follows the procedure described in clause 10.1.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.2.6 CSE registration | CSE Registration towards a Registrar CSE is a process to enable a CSE to use services offered by the oneM2M System. During the process of CSE registration, a Registree CSE creates a <remoteCSE> resource as a child of the <CSEBase> resource of its Registrar CSE. The Create procedure shall be not apply to <CSEBase>. <CSEBase> can be created via management operation not defined in this version of the specification. The Update procedure shall not apply to <CSEBase>. <CSEBase> can be updated via management operation not defined in this version of the specification. The Delete procedure shall not apply to <CSEBase>. <CSEBase> can be deleted via management operation not defined in this version of the specification. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.2.7 Create <remoteCSE> | This procedure shall be used for creating a <remoteCSE> resource. It is part of the registration procedure for remote CSEs on the Registrar CSE (which is also the Hosting CSE), as described in this clause. Table 10.2.2.7-1: <remoteCSE> CREATE <remoteCSE> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: From: Originator CSE-ID. Content: The resource content shall provide the information as defined in clause 9.6.4. Processing at Originator before sending Request According to clause 10.2.2.7. Processing at Receiver According to clause 10.2.2.7 with the following specific processing: If the Receiver CSE has registered to another CSE, the Receiver CSE shall send an update request to its Registrar CSE to add the CSE-IDs of the Originator CSE and the Originator CSE's descendants into the descendantCSEs attribute of the Receiver CSE's <remoteCSE> hosted by the Registrar CSE. If the IN-CSE is the receiver and if the M2M SP policies do allow access to the CSEs across multiple domains, then the IN shall create the appropriate entry in the M2M SP's DNS for successfully registered CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 293 (oneM2M TS-0001 version 4.15.0 Release 4) <remoteCSE> CREATE Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: Address of the created <remoteCSE> resource, according to clause 10.2.2.7. Processing at Originator after receiving Response The Originator upon receipt of successful CREATE response message, shall create <remoteCSE> resource locally and thereafter, it may issue a Retrieve request to its Registrar CSE's <CSEBase> resource to update the optional attributes of locally created <remoteCSE> resource. Exceptions According to clause 10.2.2.7. The procedure for CSE Registration follows the procedure described in clause 10.1.2, but with some deviations. Below is the detailed description on how to perform the CSE Registration and which part of the procedure deviates from the one described in clause 10.1.2. The Registration procedure requires the creation of two resources (a <remoteCSE> on the Receiver CSE and a <remoteCSE> on the Originator CSE) rather than one resource. The Registration procedure is always initiated by a CSE in the field domain except in the inter-domain case described in clause 6.5. Originator: The Originator shall be the registering CSE. Receiver: The Receiver shall create the <remoteCSE> resource. Figure 10.2.2.7-1: Procedure for CREATEing a <remoteCSE> Resource ETSI ETSI TS 118 101 V4.15.0 (2022-09) 294 (oneM2M TS-0001 version 4.15.0 Release 4) All the parameters of the request and steps that are not indicated do not deviate from clause 10.1.2. Step 001: The Originator shall send mandatory parameters and may send optional parameters in Request message for CREATE operation as specified in clause 8.1.2. Step 002: The Receiver shall: 1) The registrar CSE shall allow unknown remote CSE to attempt to 'CREATE' when it was authenticated by credential provided by the entity. See ETSI TS 118 103 [2] further detail about authentication for the CSE. 2) Perform sub-steps: 2) to 8), from step 002 from clause 10.1.2 are applicable. The access control which is sub-step 1) is omitted. In step 6 of clause 10.1.2, the Receiver shall set CSE-ID attribute to the value carried in the From request parameter. NOTE: Optionally, if the M2M Service Provider supports inter-domain communication, the Receiver could perform this step if the attribute CSEBase (part of the Content parameter of the request) contains the public domain of the CSE. The Receiver could construct the domain as described in clauses 6.4 and 6.5. The Receiver could add an AAA or AAAA record in DNS with the public domain name of the Originator CSE and the IP address of the IN-CSE associated with the Originator. Step 003: See clause 10.1.2. Step 004: The Originator, upon receipt of the successful CREATE response message, shall create a <remoteCSE> resource locally under its <CSEBase> resource. This resource is representing the Receiver CSE. The Originator shall provide the appropriate values to all mandatory parameters as described in clause 9.6.4. Step 005: The Originator may issue a RETRIEVE Request towards the Receiver (same To as for the CREATE request message) to obtain the optional attributes of the <remoteCSE> resource created at the Originator in step 004 (e.g. labels, accessControlPolicyIDs attributes). The RETRIEVE procedure is described in clause 10.1.3. See clause 8.1.2 for the information to be included in the Request message. Step 006: The Receiver verifies that the Originator has the appropriate privileges to access the information. Step 007: The Receiver sends a RETRIEVE response message, according to the procedure described in clause 10.1.3. See clause 8.1.3 for the information to be included in the Response message. Step 008: The Originator shall update the created <remoteCSE> resource for the Receiver with the information obtained in step 007. General Exceptions: All exceptions from clause 10.1.2 are applicable; in addition the following exception may occur: 1) The Originator does not have the privileges to retrieve the attributes of the Receiver CSE. The Receiver responds with an error. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.2.8 Retrieve <remoteCSE> | This procedure shall be used for retrieving the representation of the <remoteCSE> resource with its attributes. Table 10.2.2.8-1: <remoteCSE> RETRIEVE <remoteCSE> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <remoteCSE> resource as the Originator requested Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 295 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.2.9 Update <remoteCSE> | This procedure shall be used for updating the attributes and the actual data of an <remoteCSE> resource. Table 10.2.2.9-1: <remoteCSE> UPDATE <remoteCSE> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: attributes of the <remoteCSE> resource as defined in clause 9.6.4 which need be updated Processing at Originator before sending Request According to clause 10.1.4 Processing at Receiver According to clause 10.1.4 with the following specific processing: If the descendantCSEs attribute is updated, and the Receiver CSE has registered to another CSE, the Receiver CSE shall send an update request to its Registrar CSE to make the corresponding updates to the descendantCSEs attribute of the Receiver CSE's <remoteCSE> hosted by the Registrar CSE. If the pointOfAccess attribute is updated and there are any messages in the buffer for store-and-forward procedure, Receiver shall send all buffered messages Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response According to clause 10.1.4 Exceptions According to clause 10.1.4 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.2.10 Delete <remoteCSE> | This procedure shall be used for deleting the <remoteCSE> resource with all related information. Table 10.2.2.10-1: <remoteCSE> DELETE <remoteCSE> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 with the following specific processing: If the Receiver CSE has registered to another CSE, the Receiver CSE shall send an update request to its Registrar CSE to delete the CSE-IDs of the Originator CSE and the Originator CSE's descendants in the descendantCSEs attribute of the Receiver CSE's <remoteCSE> hosted by the Registrar CSE. If the IN-CSE is the receiver and it has created an entry in the DNS to allow access to the CSE across multiple M2M domains, then it shall delete the entry from the DNS Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 The procedure for CSE Deregistration follows the procedure described in clause 10.1.5, but with some exceptions. Below is the detailed description on how to perform the CSE Deregistration and which part of the procedure deviates from the one described in clause 10.1.5. The Deregistration procedure accompanies the deletion of two resources (a <remoteCSE> on the Hosting CSE and a <remoteCSE> on the Originator CSE) rather than one resource. The Deregistration procedure can be initiated by either Registree CSE or Registrar CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 296 (oneM2M TS-0001 version 4.15.0 Release 4) Figure 10.2.2.10-1: Procedure for DELETING a <remoteCSE> Resource Step 001: See clause 10.1.5. Step 002: See clause 10.1.5. Step 003: See clause 10.1.5. Step 004: The Originator, upon receipt of the DELETE response, shall delete a <remoteCSE> resource locally under its <CSEBase> resource. General Exceptions: All exceptions from clause 10.1.5 are applicable; in addition the following exception may occur: 1) If the Receiver rejects the DELETE request and responds with an error in the DELETE response, the Originator cannot perform the action described in the step 004. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.2.11 Retrieve <CSEBase> | This procedure shall be used for retrieving the representation of the <CSEBase> resource with its attributes. Table 10.2.2.11-1: <CSEBase> RETRIEVE <CSEBase> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clauses 10.1.3 and 10.2.2.7 Processing at Receiver According to clauses 10.1.3 and 10.2.2.7 Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <CSEBase> resource as requested by the Originator Processing at Originator after receiving Response According to clauses 10.1.3 and 10.2.2.7 When this procedure is used during CSE Registration, a <remoteCSE> resource is created using the retrieved resource Exceptions According to clauses 10.1.3 and 10.2.2.7 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 297 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3 Authorization | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.1 Introduction | This clause describes the procedures for creation, retrieval, update and deletion of the different types of authorization resources (i.e. <accessControlPolicy>, <dynamicAuthorizationConsultation>, <role> and <token>). These resources are used by a CSE to control access to other resources based on the different authorization methods as specified in the present document and in ETSI TS 118 103 [2]. When processing a request to a targeted resource, the Hosting CSE shall progress through the different types of authorization (if supported) as shown in figure 10.2.3.1-1. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 298 (oneM2M TS-0001 version 4.15.0 Release 4) Authorize using selfPrivileges Target is <accessControlPolicy> resource? Request Received Authorized? accessControlPolicyIDs is NULL? Authorized? Indirect Dynamic Authorization Supported Request contains Token? Authorize using token(s) Authorized? Direct Dynamic Authorization Supported dynamicAuthorizationConsultationIDs is not NULL? Authorize by consulting DAS Distributed Authorization Supported (authorizationDecisionResourceIDs, authorizationPolicyResourceIDs and authorizationInformationResourceIDs are not NULL) Authorize using distributed authorization Authorized? Authorized? Access granted – process request Access denied - reject request Return Response No Yes Yes Yes No No No Yes Yes No Yes No Yes No No Yes Yes Access granted – process request No Yes Authorized? No No Authorize using default access privileges Authorized? Yes No Authorize using <accessControlPolicy> privileges Yes Target resource supports accessControlPolicyIDs attribute? Yes No Authorize using parent’s accessControlPolicyIDs privileges Figure 10.2.3.1-1: Different types of authorization flow chart ETSI ETSI TS 118 101 V4.15.0 (2022-09) 299 (oneM2M TS-0001 version 4.15.0 Release 4) If the Hosting CSE receives a request targeting a resource of type <accessControlPolicy>, the Hosting CSE shall evaluate the set of access control rules configured within the selfPrivileges attribute and shall permit the operation if allowed by at least one access control rule. Otherwise the Hosting CSE shall deny access to the <accessControlPolicy> resource and return an error to the Originator. If a targeted resource is not of type <accessControlPolicy> and does not support an accessControlPolicyIDs attribute, the Hosting CSE shall evaluate the accessControlPolicyIDs of the targeted resource's parent. If a targeted resource is not of type <accessControlPolicy> and if the accessControlPolicyIDs is supported, the Hosting CSE shall evaluate the accessControlPolicyIDs of the targeted resource. If the accessControlPolicyIDs attribute is not NULL, the Hosting CSE shall evaluate the set of access control rules configured within the privileges attributes of each of the <accessControlPolicy> resources and shall permit the operation if allowed by at least one access control rule. If the accessControlPolicyIDs attribute is NULL, the Hosting CSE shall apply the default access privileges by first checking if the custodian attribute is configured. If so, the default policy shall provide unrestricted access only to the custodian. If the custodian attribute is not configured, then the default policy shall provide unrestricted access only to the Originator of the successful resource creation request.The Hosting CSE shall keep track of the Originator of the successful resource creation request even when the resource does not support a creator attribute. Otherwise, if the request includes token information, the Hosting CSE may perform Indirect Dynamic Authorization if supported, as described in clause 11.5.3, and permit the operation if allowed. Otherwise, if the dynamicAuthorizationConsultationIDs attribute is not NULL, the Hosting CSE may perform Direct Dynamic Authorization if supported, as described in clause 11.5.2, and permit the operation if allowed. Otherwise, the Hosting CSE may perform Distributed Authorization if supported, as described in clause 11.6, and permit the operation if allowed. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.2 Authorization using <accessControlPolicy> | This clause describes the procedures for creation, retrieval, update and deletion of the <accessControlPolicy> resource. The <accessControlPolicy> resource is used by a CSE to control access to other resources as specified in clauses 9.6.2 and 11.3.4. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.3 Create <accessControlPolicy> | This procedure shall be used to create an <accessControlPolicy> resource. Table 10.2.3.3-1: <accessControlPolicy> CREATE <accessControlPolicy> CREATE Information in Request message Same as clause 10.1.2. Pre-Processing at Originator Same as clause 10.1.2. Processing at Receiver Same as clause 10.1.2. Information in Response message Same as clause 10.1.2. Post-Processing at Originator Same as clause 10.1.2. Exceptions Same as clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.4 Retrieve <accessControlPolicy> | This procedure shall be used to retrieve attributes and child resource information of the <accessControlPolicy> resource. Table 10.2.3.4-1: <accessControlPolicy> RETRIEVE <accessControlPolicy> RETRIEVE Information in Request message Same as clause 10.1.3. Pre-Processing at Originator Same as clause 10.1.3. Processing at Receiver Addition to clause 10.1.3: • The Receiver shall check access control rules defined in selfPrivileges of the <accessControlPolicy> resource>. Information in Response message Same as clause 10.1.3. Post-Processing at Originator Same as clause 10.1.3. Exceptions Addition to clause 10.1.3. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 300 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.5 Update <accessControlPolicy> | This procedure shall be used to update attributes information of the <accessControlPolicy> resource. Table 10.2.3.5-1: <accessControlPolicy> UPDATE <accessControlPolicy> UPDATE Information in Request message Same as clause 10.1.4. Pre-Processing at Originator Same as clause 10.1.4. Processing at Receiver Addition to clause 10.1.4: • The Receiver shall check access control rules defined in selfPrivileges of the <accessControlPolicy> resource. Information in Response message Same as clause 10.1.4. Post-Processing at Originator Same as clause 10.1.4. Exceptions Addition to clause 10.1.4. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.6 Delete <accessControlPolicy> | This procedure shall be used to delete the <accessControlPolicy> resource. Table 10.2.3.6-1: <accessControlPolicy> DELETE <accessControlPolicy> DELETE Information in Request message Same as clause 10.1.5. Pre-Processing at Originator Same as clause 10.1.5. Processing at Receiver Addition to clause 10.1.5: • The Receiver shall check access control rules defined in selfPrivileges of the <accessControlPolicy> resource. Information in Response message Same as clause 10.1.5. Post-Processing at Originator Same as clause 10.1.5. Exceptions Addition to clause 10.1.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.7 Authorization using <dynamicAuthorizationConsultation> | This clause describes the procedures for creation, retrieval, update and deletion of the <dynamicAuthorizationConsultation> resource. The <dynamicAuthorizationConsultation> resource is used by a CSE to control access to resources in a dynamic manner as specified in clause 11.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.8 Create <dynamicAuthorizationConsultation> | This procedure shall be used to create a <dynamicAuthorizationConsultation> resource. Table 10.2.3.8-1: <dynamicAuthorizationConsultation> CREATE <dynamicAuthorizationConsultation> CREATE Information in Request message Same as clause 10.1.2. Pre-Processing at Originator Same as clause 10.1.2. Processing at Receiver Same as clause 10.1.2. Information in Response message Same as clause 10.1.2. Post-Processing at Originator Same as clause 10.1.2. Exceptions Same as clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.9 Retrieve <dynamicAuthorizationConsultation> | This procedure shall be used to retrieve attributes and child resource information of the <dynamicAuthorizationConsultation> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 301 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.3.9-1: <dynamicAuthorizationConsultation> RETRIEVE <dynamicAuthorizationConsultation> RETRIEVE Information in Request message Same as clause 10.1.3. Pre-Processing at Originator Same as clause 10.1.3. Processing at Receiver Same as clause 10.1.3. Information in Response message Same as clause 10.1.3. Post-Processing at Originator Same as clause 10.1.3. Exceptions Addition to clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.10 Update <dynamicAuthorizationConsultation> | This procedure shall be used to update attributes information of the <dynamicAuthorizationConsultation> resource. Table 10.2.3.10-1: <dynamicAuthorizationConsultation> UPDATE <dynamicAuthorizationConsultation> UPDATE Information in Request message Same as clause 10.1.4. Pre-Processing at Originator Same as clause 10.1.4. Processing at Receiver Addition to clause 10.1.4. Information in Response message Same as clause 10.1.4. Post-Processing at Originator Same as clause 10.1.4. Exceptions Addition to clause 10.1.4. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.11 Delete <dynamicAuthorizationConsultation> | This procedure shall be used to delete the <dynamicAuthorizationConsultation> resource. Table 10.2.3.11-1: <dynamicAuthorizationConsultation> DELETE <dynamicAuthorizationConsultation> DELETE Information in Request message Same as clause 10.1.5. Pre-Processing at Originator Same as clause 10.1.5. Processing at Receiver Addition to clause 10.1.5. Information in Response message Same as clause 10.1.5. Post-Processing at Originator Same as clause 10.1.5. Exceptions Addition to clause 10.1.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.12 Authorization using <role> | This clause describes the procedures for creation, retrieval, update and deletion of the <role> resource. The <role> resource is used to assign a role to an AE or CSE. The role is used to control access to resources in a role-based manner as specified in ETSI TS 118 103 [2]. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.13 Create <role> | This procedure shall be used for creating a <role> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 302 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.3.13-1: <role> CREATE <role> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: From: Identifier of the AE that initiates the request To: Address the resource where the <role> resource is intended to be created Content: The resource content shall provide the information as defined in clause 9.6.38 Processing at Originator before sending Request According to clause 10.1.2 Processing at Receiver According to clause 10.1.2 Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: Address of the created <role> resource, according to clause 10.1.2 Processing at Originator after receiving Response According to clause 10.1.2 Exceptions According to clause 10.1.2 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.14 Retrieve <role> | This procedure shall be used for retrieving the attributes of a <role> resource. Table 10.2.3.14-1: <role> RETRIEVE <role> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: void Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <role> resource as defined in clause 9.6.38 Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.15 Update <role> | This procedure shall be used for updating attributes of a <role> resource. Table 10.2.3.15-1: <role> UPDATE <role> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.4 Processing at Receiver According to clause 10.1.4 Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response According to clause 10.1.4 Exceptions According to clause 10.1.4 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 303 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.16 Delete <role> | This procedure shall be used for deleting an existing <role> resource. Table 10.2.3.16-1: <role> DELETE <role> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.17 Authorization using <token> | This clause describes the procedures for creation, retrieval, update and deletion of the <token> resource. The <token> resource is used for storing a token that is issued to an AE or CSE. The token is used to control access to resources in a dynamic manner as specified in clause 11.5 of the present document and in ETSI TS 118 103 [2]. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.18 Create <token> | This procedure shall be used for creating a <token> resource. Table 10.2.3.18-1: <token> CREATE <token> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: From: Identifier of the AE that initiates the request To: Address the resource where the <token> resource is intended to be created Content: The resource content shall provide the information as defined in clause 9.6.39 Processing at Originator before sending Request According to clause 10.1.2 Processing at Receiver According to clause 10.1.2 Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: Address of the created <token> resource, according to clause 10.1.2 Processing at Originator after receiving Response According to clause 10.1.2 Exceptions According to clause 10.1.2 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.19 Retrieve <token> | This procedure shall be used for retrieving the attributes of a <token> resource. Table 10.2.3.19-1: <token> RETRIEVE <token> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: void Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <token> resource as defined in clause 9.6.39 Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 304 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.20 Update <token> | This procedure shall be used for updating attributes of a <token> resource. Table 10.2.3.20-1: <token> UPDATE <token> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.4 Processing at Receiver According to clause 10.1.4 Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response According to clause 10.1.4 Exceptions According to clause 10.1.4 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.21 Delete <token> | This procedure shall be used for deleting an existing <token> resource. Table 10.2.3.21-1: <token> DELETE <token> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.22 Authorization using <authorizationDecision> | Each <authorizationDecision> resource represents an entrance of a Policy Decision Point (PDP) that is responsible for making access control decisions. Multiple <authorizationDecision> resources can be created under one <CSEBase> resource. The access control policies associated to an <authorizationDecision> resource can be used to group access control decision requesters, i.e. which CSEs can retrieve access control decisions from a given <authorizationDecision> resource. The resource specific attributes of an <authorizationDecision> resource can be classified into two categories according to their usages. One category is used for describing access control decisions, e.g. decision and status attributes. The other category is used for describing access control decision requests, e.g. to, from, operation, roleIDs and so on. An UPDATE operation on an <authorizationDecision> resource may trigger an access control decision making process. After making an access control decision, the access control decision or error status is returned back to the decision requester via an UPDATE response. The details of distributed authorization procedures are described in ETSI TS 118 103 [2]. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.23 Create <authorizationDecision> | This procedure shall be used for creating an <authorizationDecision> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 305 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.3.23-1: <authorizationDecision> CREATE <authorizationDecision> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.41, and all the values of resource specific attributes shall be set to null. Processing at Originator before sending Request According to clause 10.1.2 Processing at Receiver According to clause 10.1.2 Information in Response message According to clause 10.1.2 Processing at Originator after receiving Response According to clause 10.1.2 Exceptions According to clause 10.1.2 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.24 Retrieve <authorizationDecision> | This procedure shall be used for retrieving <authorizationDecision> resource. Table 10.2.3.24-1: <authorizationDecision> RETRIEVE <authorizationDecision> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: void Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <authorizationDecision> resource as defined in clause 9.6.38 Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.25 Update <authorizationDecision> | This procedure shall be used for updating attributes of an <authorizationDecision> resource. Originator: The Originator shall request to obtain an access control decision by using UPDATE operation on an <authorizationDecision> resource. The access control decision request shall be specified with resource specific attributes except the decision attribute. Receiver: The Receiver shall execute an access control decision making process according to the access control decision request provided in the UPDATE request and return the access control decision in the UPDATE response. Table 10.2.3.25-1: <authorizationDecision> UPDATE <authorizationDecision> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply. Processing at Originator before sending Request According to clause 10.1.4 with the following additions: Content: The representation of an access control decision request constructed using updated attributes. See clause 7 in ETSI TS 118 103 [2] for the mandatory and optional parameters. Processing at Receiver According to clause 10.1.4 with the following additions: • Check the validity of the access control decision request constructed using updated attributes. See clause 7 in ETSI TS 118 103 [2] for the mandatory and optional parameters. • Obtain applicable access control policies and requested access control information, and then make an access control decision. See clause 7 in ETSI TS 118 103 [2] for more details. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 306 (oneM2M TS-0001 version 4.15.0 Release 4) <authorizationDecision> UPDATE • Update the decision and status attributes with the access control decision evaluation result. See clause 7 in ETSI TS 118 103 [2] for possible access control decision evaluation results. • After sending the response message, all the resource specific attributes shall be deleted. Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.3.26 Delete <authorizationDecision> | This procedure shall be used for deleting an existing <authorizationDecision> resource. Table 10.2.3.26-1: <authorizationDecision> DELETE <authorizationDecision> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.