hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.11 m2m:scheduleEntries | Table 6.3.5.11-1: Type Definition of m2m:scheduleEntries Element Path Element Data Type Multiplicity Note scheduleEntry m2m:scheduleEntry 1..n |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.12 m2m:aggregatedNotification | Used in the Notification Data Object. Table 6.3.5.12-1: Type Definition of m2m:aggregatedNotification Element Path Element Data Type Multiplicity Note notification m2m:notification 1..n ETSI ETSI TS 118 104 V2.7.1 (2016-10) 56 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.13 m2m:notification | Table 6.3.5.13-1: Type Definition of m2m:notification Element Path Element Data Type Multiplicity Note notificationEvent (anonymous) 0..1 notificationEvent/representation xs:anyType 0..1 Representation or response primitive in of resource modification in XML/JSON representation. notificationEvent/operationMonitor (anonymous) 0..1 notificationEvent/operationMonitor/o peration m2m:operation 1 m2m:operation This element shall only be present if the operationMonit or parent element is present. Otherwise it shall not. notificationEvent/operationMonitor/or iginator m2m:ID 1 m2m:ID This element shall only be present if the operationMonit or parent element is present. Otherwise it shall not. notificationEvent/notificationEventTy pe m2m:notificationEventType 1 verificationRequest xs:boolean 0..1 subscriptionDeletion xs:boolean 0..1 subscriptionReference xs:anyURI 1 creator m2m:ID 0..1 notificationForwardingURI xs:anyURI 0..1 notificationTarget m2m:ID 0..1 targetRemovalRequest xs:boolean 0..1 targetRemovalAllowance xs:boolean 0..1 IPEDiscoveryRequest (anonymous) 0..1 IPEDiscoveryRequest/originator m2m:ID 1 IPEDiscoveryRequest/filterCriteria m2m:filterCriteria 1 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.14 m2m:actionStatus | Table 6.3.5.14-1: Type Definition of m2m:actionStatus Element Path Element Data Type Multiplicity Note action xs:anyURI 0..1 Reference to the action (represented by a resource attribute) being performed status m2m:status 0..1 Indicates the status of the operation is successful, failure or in process. See Table 6.3.2.2 1 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 57 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.15 m2m:anyArgType | Table 6.3.5.15-1: Type Definition of m2m:anyArgType Element Path Element Data Type Multiplicity Note name xs:NCName 1 value xs:anyType 1 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.16 m2m:resetArgsType | Table 6.3.5.16-1: Type Definition of m2m:resetArgsType Element Path Element Data Type Multiplicity Note anyArg m2m:anyArgType 0..n |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.17 m2m:rebootArgsType | Table 6.3.5.17-1: Type Definition of m2m:rebootArgsType Element Path Element Data Type Multiplicity Note anyArg m2m:anyArgType 0..n |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.18 m2m:uploadArgsTypes | Table 6.3.5.18-1: Type Definition of m2m:uploadArgsType Element Path Element Data Type Multiplicity Note fileType xs:string 1 URL xs:anyURI 1 username xs:string 1 password xs:string 1 anyArg m2m:anyArgType 0..n |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.19 m2m:downloadArgsType | Table 6.3.5.19-1: Type Definition of m2m:downloadArgsType Element Path Element Data Type Multiplicity Note fileType xs:string 1 URL xs:anyURI 1 username xs:string 1 password xs:string 1 filesize xs:positiveInteger 1 targetFile xs:string 1 delaySeconds xs:positiveInteger 1 successURL xs:anyURI 1 startTime m2m:timestamp 1 completeTime m2m:timestamp 1 anyArg m2m:anyArgType 0..n ETSI ETSI TS 118 104 V2.7.1 (2016-10) 58 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.20 m2m:softwareInstallArgsType | Table 6.3.5.20-1: Type Definition of m2m:softwareInstallArgsType Element Path Element Data Type Multiplicity Note URL xs:anyURI 1 UUID xs:string 1 username xs:string 1 password xs:string 1 executionEnvRef xs:string 1 anyArg m2m:anyArgType 0..n |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.21 m2m:softwareUpdateArgsType | Table 6.3.5.21-1: Type Definition of m2m:softwareUpdateArgsType Element Path Element Data Type Multiplicity Note UUID xs:string 1 version xs:string 1 URL xs:anyURI 1 username xs:string 1 password xs:string 1 executionEnvRef xs:string 1 anyArg m2m:anyArgType 0..n |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.22 m2m:softwareUninstallArgsType | Table 6.3.5.22-1: Type Definition of m2m:softwareUninstallArgsType Element Path Element Data Type Multiplicity Note UUID xs:string 1 version xs:string 1 executionEnvRef xs:string 1 anyType m2m:anyArgType 0..n |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.23 m2m:execReqArgsListType | Table 6.3.5.23-1: Type Definition of m2m:execReqArgsListType Element Path Element Data Type Multiplicity Note reset m2m:resetArgsType 0..n reboot m2m:rebootArgsType 0..n upload m2m:uploadArgsType 0..n download m2m:downloadArgsType 0..n softwareInstall m2m:softwareInstallArgsTyp e 0..n softwareUpdate m2m:softwareUpdateType 0..n softwareUninstall m2m:softwareUninstallArgs Type 0..n This type is an xs:choice. It shall contain elements from no more than one row listed in the table above. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 59 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.24 m2m:mgmtLinkRef | Table 6.3.5.24-1: Type Definition of m2m:mgmtLinkRef Element Path Element Data Type Multiplicity Note (base content) xs:anyURI 1 URI (of type xs:anyURI) with name and type attributes. @name xs:NCName 1 The name attribute represents the name of the referenced resource instance. @type m2m:mgmtDefinition 1 The type attribute is restricted to the allowed specializations of resource type <mgmtObj>. In the above table, names of XML schema attributes are prefixed with a "@" character to differentiate these from Resource attribute names. The "@" character is not part of the actual attribute name. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.25 m2m:resourceWrapper | This data type is used for the m2m:resource Global Element of the Content primitive parameter as defined in clause 7.5.2. It allows insertion of Global Elements prefixed with the m2m: namespace identifier, or of Global Elements defined in another namespace. Table 6.3.5.25-1: Type Definition of m2m:resourceWrapper Element Path Element Data Type Multiplicity Note m2m:<resourceType> {other namespace identifier}:<resourceType> (anonymous) 1 A representation of a Resource with specific type as described in clause 7.4. URI xs:anyURI 1 Hierarchical URI of the resource. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.26 m2m:setOfAcrs | Table 6.3.5.26-1: Type Definition of m2m:setOfAcrs Element Path Element Data Type Multiplicity Note accessControlRules m2m:accessControlRule 0..n Data type of privileges and selfPrivileges attributes ETSI ETSI TS 118 104 V2.7.1 (2016-10) 60 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.27 m2m:accessControlRule | Table 6.3.5.27-1: Type Definition of m2m:accessControlRule Element Path Element Data Type Multiplicity Note accessControlOriginators list of xs:anyURI 1 Reserved character '*' represents any Originators qualify the accessControlOriginat ors accessControlOperations m2m:accessControlOperati ons 1 accessControlContexts 0..n accessControlContexts/accessContr olWindow m2m:scheduleEntry 0..n accessControlContexts/accessContr olIpAddresses 0..1 accessControlContexts/accessContr olIpAddresses/ipv4Addresses list of m2m:ipv4 0..1 List of IPv4 addresses accessControlContexts/accessContr olIpAddresses/ipv6Addresses list of m2m:ipv6 0..1 List of IPv6 addresses accessControlContexts/accessContr olLocationRegions m2m:locationRegion 0..1 accessControlAuthenticationFlag xs:boolean 0..1 NOTE: Some of the above elements are defined in clause 9.6.2 of ETSI TS 118 101 [6] with slightly different names as follows (name in parenthesis used in ETSI TS 118 101): accessControlWindow (accessControlTimeWindow), accessControlIpAddresses (accessControlIpAddress). The accessControlContexts/accessControlIpAddresses element may include either the ipv4Addresses element, ipv6Addresses element, or both elements. Each individual IPv4 address of data type m2m:ipv4 in the list of IPv4 addresses is represented in dotted-decimal notation with optional Classless Inter-Domain Routing (CIDR) suffix in accordance with IETF RFC 4632 [29]. Each individual IPv6 address of data type m2m:ipv6 in the list of IPv6 addresses is represented in colon separated groups of hexadecimal digits with optional network prefix in accordance with IETF RFC 5952 [30]. Example IPv4 and IPv6 addresses which comply with data types m2m:ipv4 and m2m:ipv6, respectively, are given in Table 6.3.2-1. If the accessControlAuthenticationFlag element is not present, then the value is assumed to be FALSE. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.28 m2m:locationRegion | Table 6.3.5.28-1: Type Definition of m2m:locationRegion Element Path Element Data Type Multiplicity Note circRegion List of 3 xs:float 0..1 The values represent latitude (+/-90 degrees), longitude (+/-180 degrees), and radius (metres) countryCode list of m2m:countryCode 0..1 This is an xs:choice. A locationRegion shall contain either: 1) A countryCode element, in which case circRegion shall not appear, or 2) A circRegion element, in which case countryCode shall not appear. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 61 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.29 m2m:childResourceRef | Table 6.3.5.29-1: Type Definition of m2m:childResourceRef Element Path Element Data Type Multiplicity Note (base content) xs:anyURI 1 URI of the child resource @name xs:NCName 1 Gives the name of the child resource pointed to by the URI @type m2m:resourceType 1 Gives the resourceType of the child resource pointed to by the URI @specializationID xs:anyURI 0..1 Gives resource type specialization of the child resource pointed to by the URI in case @type represents a <flexContainer> In the above table, names of XML schema attributes are prefixed with a "@" character to differentiate these from Resource attribute names. The "@" character is not part of the actual attribute name. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.30 m2m:responseTypeInfo | Table 6.3.5.30-1: Type Definition of m2m:responseTypeInfo Element Path Element Data Type Multiplicity Note responseTypeValue m2m:responseType 1 See clause 6.3.4.2.6 notificationURI List of xs:anyURI 0..1 This element may be included only when the responseType is set to "2" (nonBlockingRequest Asynch). Empty list in this element shall be allowed. See Clause 7.5.1.2.5. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.31 m2m:rateLimit | Used in <subscription>. Table 6.3.5.31-1: Type Definition of m2m:rateLimit Element Path Element Data Type Multiplicity Note maxNrOfNotify xs:nonNegativeInteger 0..1 timeWindow xs:duration 0..1 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.32 m2m:operationResult | Used for operationResult attribute in <request> resource. NOTE: This data type corresponds to the sequence of elements in the response primitive defined in clause 6.4.2. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 62 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.3.5.32-1: Type Definition of m2m:operationResult Element Path Element Data Type Multiplicity Note responseStatusCode m2m:responseStatusCode 1 See clause 6.3.4.2.9 requestIdentifier m2m:requestID 1 See clause 6.3.3 primitiveContent m2m:primitiveContent 0..1 See clause 6.3.5.5 to xs:anyURI 0..1 from m2m:ID 0..1 See clause 6.3.3 originatingTimestamp m2m:timestamp 0..1 resultExpirationTimestamp m2m:absRelTimestamp 0..1 eventCategory m2m:eventCat 0..1 See clause 6.3.3 contentStatus m2m:contentStatus 0..1 See clause 6.3.4.2.43 contentOffset xs:positiveInteger 0..1 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.33 m2m:aggregatedResponse | Used when aggregating responses by a group. Table 6.3.5.33-1: Type Definition of m2m:aggregatedResponse Element Path Element Data Type Multiplicity Note resourceID xs:anyURI 0..1 Reference to the <request> resource that can be used to retrieve the remaining member responses. responsePrimitive See Table 6.4.2-1 for detail. 0..n |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.34 m2m:mgmtResource | Used This data type is used as base type of all <mgmtObj> specializations specified in Annex D. It includes the attributes commonly used by all <mgmtObt> resource type specializations. It consists of the common attributes included in m2m:announceableResource as defined Table 6.3.6-2 and the additional common attributes shared by all <mgmtObj> specializations shown in Table 6.3.5.34-1. Table 6.3.5.34-1: Type Definition of m2m:mgmtResource Element Path Element Data Type Multiplicity Note @resourceName xs:NCName 1 common attributes as defined in m2m:announceable Resource, see Table 6.3.6-2 resourceType m2m:resourceType 1 resourceID m2m:ID 1 parentID m2m:nhURI 1 creationTime m2m:timestamp 1 lastModifiedTime m2m:timestamp 1 labels m2m:labels 0..1 accessControlPolicyIDs m2m:acpType 0..1 expirationTime m2m:timestamp 1 dynamicAuthorizationConsultationIDs list of xs:anyURI 0..1 announceTo list of xs:anyURI 0..1 announcedAttribute list of xs:NCName 0..1 mgmtDefinition m2m:mgmtDefinition 1 objectIDs m2m:listOfURIs 0..1 objectPaths m2m:listOfURIs 0..1 description xs:string 0..1 NOTE: objectAttribute is defined in the specializations of mgmtObj. See Annex D. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 63 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.35 m2m:announcedMgmtResource | This data type is used as base type of the announced variants of announceable <mgmtObj> specializations specified in Annex D. It includes the attributes commonly used by all announced <mgmtObj> resource type specializations. Note that some specializations of the <mgmtObj> resource are announceable while others are not announceable. It consists of the common attributes included in m2m:announcedResource as defined Table 6.3.6-2 and the additional common attributes shared by all announced <mgmtObj> specializations shown in Table 6.3.5.35-1. Table 6.3.5.35-1: Type Definition of m2m:announcedMgmtResource Element Path Element Data Type Multiplicity Note @resourceName xs:NCName 1 common attributes as defined in m2m:announcedResource, see Table 6.3.6-2 resourceType m2m:resourceType 1 resourceID m2m:ID 1 parentID m2m:nhURI 1 creationTime m2m:timestamp 1 lastModifiedTime m2m:timestamp 1 labels m2m:labels 0..1 accessControlPolicyIDs m2m:acpType 1 expirationTime m2m:timestamp 1 link xs:anyURI 1 dynamicAuthorizationConsultationIDs list of xs:anyURI 0..1 mgmtDefinition m2m:mgmtDefinition 1 objectIDs m2m:listOfURIs 0..1 objectPaths m2m:listOfURIs 0..1 description xs:string 0..1 NOTE: objectAttribute is defined in the specializations of mgmtObj. See Annex D. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.36 m2m:contentRef | A complex type that represents the content reference with an associated reference name and URI of the referenced resource. Table 6.3.5.36-1: Type Definition of m2m:contentRef Element Path Element Data Type Multiplicity Note URIReference (anonymous) 1..n URIReference/name xs:NCName 1 When the URIReference element occurs with multiplicity > 1, the value of each URIReference/name element shall be unique URIReference/URI xs:anyURI 1 hierarchical or non- hierarchical resourceID of a <contentInstance> resource URIReference (anonymous) 1..n |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.37 m2m:deletionContexts | Table 6.3.5.37-1: Type Definition of m2m:deletionContexts Element Path Element Data Type Multiplicity Note timeOfDay m2m:scheduleEntry 0..n locationRegions m2m:locationRegion 0..n ETSI ETSI TS 118 104 V2.7.1 (2016-10) 64 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.38 m2m:flexContainerResource | This data type is used as base type of all <flexContainer> specializations listed in clause 9.6.1.2.2 of ETSI TS 118 101 [6]. It includes the attributes commonly used by all <flexContainer> resource type specializations. It consists of the common attributes shown in Table 7.4.37.1-1 and the resource specific attributes shared by all <flexContainer> specializations shown in Table 7.4.37.1-2. Table 6.3.5.38-1: Type Definition of m2m:flexContainerResource Element Path Element Data Type Multiplicity Note @resourceName xs:NCName 1 resourceType m2m:resourceType 1 resourceID m2m:ID 1 parentID m2m:nhURI 1 creationTime m2m:timestamp 0..1 lastModifiedTime m2m:timestamp 0..1 labels m2m:labels 0..1 accessControlPolicyIDs m2m:acpType 0..1 expirationTime m2m:timestamp 0..1 dynamicAuthorizationConsultationIDs list of xs:anyURI 0..1 announceTo list of xs:anyURI 0..1 announcedAttribute list of xs:NCName 0..1 stateTag xs:nonNegativeInteger 1 creator m2m:ID 0..1 containerDefinition xs:anyURI 1 ontologyRef xs:anyURI 0..1 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.39 m2m:announcedFlexContainerResource | This data type is used as base type of the announced variants of announceable <flexContainer> specializations listed in clause 9.6.1.2.2 of ETSI TS 118 101 [6]. It includes the attributes commonly used by all announced <flexContainer> resource type specializations. Note that some specializations of the <flexContainer> resource are announceable while others are not announceable. It consists of the common attributes shown in Table 7.4.37.1-1 and the resource specific attributes shared by all announced <flexContainer> specializations shown in Table 7.4.37.1-2. Table 6.3.5.39-1: Type Definition of m2m:announcedFlexContainerResource Element Path Element Data Type Multiplicity Note @resourceName xs:NCName 1 resourceType m2m:resourceType 1 resourceID m2m:ID 1 parentID m2m:nhURI 1 creationTime m2m:timestamp 0..1 lastModifiedTime m2m:timestamp 0..1 labels m2m:labels 0..1 accessControlPolicyIDs m2m:acpType 1 expirationTime m2m:timestamp 0..1 link xs:anyURI 1 dynamicAuthorizationConsultationIDs list of xs:anyURI 0..1 stateTag xs:nonNegativeInteger 0..1 containerDefinition xs:anyURI 1 ontologyRef xs:anyURI 0..1 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.40 m2m:missingData | Used for eventNotificationCriteria attribute in <subscription> resource. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 65 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.3.5.40-1: Type Definition of m2m:missingData Element Path Element Data Type Multiplicity Note number xs:nonNegativeInteger 1 duration xs:duration 1 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.41 m2m:tokenPermission | Used in m2m:tokenPermissions. Table 6.3.5.41-1: Type Definition of m2m:tokenPermission Element Path Element Data Type Mutiplicity Note resourceIDs List of m2m:ID 0..1 privileges m2m:setOfAcrs 0..1 roleIDs List of m2m:roleID 0..1 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.42 m2m:tokenClaimSet | This data type defines how to represent the claim set of oneM2M JSON Web Tokens (JWT) required for generating secured tokens (i.e. signed or encrypted representations of JWT's) as defined in clause 7.3.2.6 of ETSI TS 118 103 [7]. Usage of this datatype is specified in ETSI TS 118 103 [7]. Table 6.3.5.42-1: Type Definition of m2m:tokenClaimSet Element Path Element Data Type Mutiplicity Note version xs:string 1 tokenID m2m:tokenID 1 holder m2m:ID 1 issuer m2m:ID 1 notBefore m2m:timestamp 1 notAfter m2m:timestamp 1 tokenName xs:string 0..1 audience list of m2m:ID 0..1 permissions m2m:tokenPermissions 0..1 extension xs:string 0..1 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.43 m2m:dynAuthLocalTokenIdAssignments | Used for Assigned Token Identifiers parameter of a response primitive. Table 6.3.5.43-1: Type Definition of m2m:dynAuthLocalTokenIdAssignments Element Path Element Data Type Multiplicity Note localTokenIdAssignment anonymous 1..n localTokenIdAssignment/localTokenID xs:NCName 1 localTokenIdAssignment/tokenID m2m:tokenID 1 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.44 m2m:dynAuthTokenSummary | Used for Token Summary provided by a Dynamic Authorization Server to an Originator. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 66 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.3.5.44-1: Type Definition of m2m:dynAuthTokenSummary Element Path Element Data Type Multiplicity Note tokenID m2m:tokenID 1 notBefore m2m:timestamp 1 notAfter m2m:timestamp 1 tokenName xs:string 0..1 Human readable audience list of m2m:ID 0..1 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.45 m2m:dynAuthTokenReqInfo | Used for Token Summary provided by a Dynamic Authorization Server to an Originator. Table 6.3.5.45-1: Type Definition of m2m:dynAuthTokenReqInfo Element Path Element Data Type Multiplicity Note dasInfo anonymous 1..n dasInfo/URI xs:anyURI 1 Dynamic Authorization Server URI dasInfo/dasRequest m2m:dynAuthDasRequest 0..1 Information to send to the DAS dasInfo/securedDasRequest m2m:dynAuthJWT 0..1 Secured Information to send to the DAS |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.46 m2m:dynAuthDasRequest | Used in m2m:securityInfo. Table 6.3.5.46-1: Type Definition of m2m:dynAuthDasRequest Element Path Element Data Type Multiplicity Note originator m2m:ID 1 targetedResourceType m2m:resourceType 1 operation m2m:operation 1 originatorIP (anonymous) 0..1 originatorIP/ipv4Address m2m:ipv4 0..1 These elements shall only be present if the originatorIP parent element is present. Exactly one of these elements shall be present. originatorIP/ipv6Address m2m:ipv6 0..1 originatorLocation m2m:locationRegion 0..1 originatorRoleIDs List of m2m:roleID 0..1 requestTimestamp m2m:absRelTimestamp 0..1 targetedResourceID xs:anyURI 0..1 proposedPrivilegesLifetime m2m:absRelTimestamp 0..1 roleIDsFromACPs List of m2m:roleID 0..1 tokenIDs List of m2m:tokenID 0..1 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.47 m2m:dynAuthDasResponse | Used in m2m:securityInfo. Table 6.3.5.47-1: Type Definition of m2m:dynAuthDasResponse Element Path Element Data Type Multiplicity Note dynamicACPInfo (anonymous) 0..1 dynamicACPInfo/ grantedPrivileges m2m:setOfAcrs 0..1 These elements shall only be present if the dynamicACPInfo parent element is present. Otherwise they shall not. dynamicACPInfo/ privilegesLifetime m2m:absRelTimestamp 0..1 tokens List of m2m:dynAuthJWT 0..1 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 67 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.48 m2m:securityInfo | Used for the Global Element m2m:securityInfo included into the Content primitive parameter. Table 6.3.5.48-1: Type Definition of m2m:securityInfo Element Path Element Data Type Multiplicity Note securityInfoType m2m:securityInfoType 1 dasRequest m2m:dynAuthDasRequest 0..1 This element shall only be present if securityInfoType is set to a value of "1" (Dynamic Authorization Request) dasResponse m2m:dynAuthDasResponse 0..1 This element shall only be present if securityInfoType is set to a value of "2" (Dynamic Authorization Response) esprimRandObject m2m:receiverESPrimRandObject 0..1 This element shall only be present if securityInfoType is set to a value of "4" (Receiver E2E Rand Object Response) esprimObject m2m:e2eCompactJWE 0..1 This element shall only be present if securityInfoType is set to a value of "5" (ESPrim Object) escertkeMessage xs:base64Binary 0..1 This element shall only be present if securityInfoType is set to a value of "6" (ESCertKE Message) |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.49 m2m:listOfChildResourceRef | Table 6.3.5.49-1: Type Definition of m2m:listOfChildResourceRef Element Path Element Data Type Multiplicity Note resourceRef m2m:childResourceRef 1..n References of resources with name and type |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.50 m2m:originatorESPrimRandObject | Used for originatorESPrimRandObject parameter in End-to-End Security of Primitives. Table 6.3.5.50-1: Type Definition of m2m:originatorESPrimRandObject Element Path Element Data Type Multiplicity Note esprimRandID xs:NCName 1 esprimRandValue xs:NCName 1 esprimRandExpiry m2m:absRelTimestamp 1 See clause 6.3.3 esprimKeyGenAlgID m2m:esprimKeyGenAlgID 1 See clause 6.3.4.2.40 esprimProtocolAndAlgIDs List of m2m:esprimProtocolAndAlgID 1 See clause 6.3.4.2.41 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.51 m2m:receiverESPrimRandObject | Used in m2m:securityInfo. Table 6.3.5.51-1: Type Definition of m2m:receiverESPrimRandObject Element Path Element Data Type Multiplicity Note esprimRandID xs:NCName 1 esprimRandValue xs:NCName 1 esprimRandExpiry m2m:absRelTimestamp 1 See clause 6.3.3 esprimKeyGenAlgIDs List of m2m:esprimKeyGenAlgID 1 See clause 6.3.4.2.40 esprimProtocolAndAlgIDs List of m2m:esprimProtocolAndAlgID 1 See clause 6.3.4.2.41 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 68 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.52 m2m:e2eSecInfo | Used for the e2eSecInfo attribute of the <CSEBase>, <AE> and <remoteCSE> resources. Table 6.3.5.52-1: Type Definition of m2m:e2eSecInfo Element Path Element Data Type Multiplicity Note supportedE2ESecFeatures List of m2m:suid 1 See clause 6.3.4.2.38 certificates List of xs:base64Binary 0..1 sharedReceiverESPrimRandObject m2m:receiverESPrimRandObject 0..1 See clause 6.3.5.51 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.53 m2m:tokenPermissions | Used for permissions attribute in <token> resource and for the permissions element in m2m:tokenClaimSet. Table 6.3.5.53-1: Type Definition of m2m:tokenPermissions Element Path Element Data Type Mutiplicity Note permission m2m:tokenPermission 0..n |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.54 m2m:backOffParameters | Used for Used in the backOffParameters attribute in the <cmdhNwAccessRule> resource. Table 6.3.5.54-1: Type Definition of m2m:backOffParameters Element Path Element Data Type Mutiplicity Note backOffParametersSet (anonymous) 1..n backOffParametersSet/networkAction m2m:networkAction 0..1 backOffParametersSet/initialBackoffTime xs:nonNegativeInteger 1 Unit: ms backOffParametersSet/additionalBackoffTime xs:nonNegativeInteger 1 Unit: ms backOffParametersSet/maximumBackoffTime xs:nonNegativeInteger 1 Unit: ms backOffParametersSet/optionalRandomBackoffTime xs:nonNegativeInteger 0..1 Unit: ms |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.55 m2m:listOfDataLinks | Table 6.3.5.55-1: Type Definition of m2m:listOfDataLinks Element Path Element Data Type Mutiplicity Note dataLinkEntry m2m:dataLink 1..n This data type is a list of triples, each triple containing the following fields: 1. A text string with the name of a data link 2. A URI of the resource (container or flexContainer) that holds the data 3. A text field for identifying simple- type data ETSI ETSI TS 118 104 V2.7.1 (2016-10) 69 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.5.56 m2m:dataLink | Table 6.3.5.56-1: Type Definition of m2m:dataLink Element Path Element Data Type Multiplicity Note @name m2m:anyURI 1 The name attribute represents the name of the input- / outputDataPoint or operationInput / - Output as specified in the ontology for the referenced resource instance. dataContainerID m2m:ID 1 URI of the referenced <container> or <flexContainer> resource instance attributeName xs:NCName 0..1 Contains (a) the name of a customAttribute in case the URI points to a <flexContainer> or (b) the string "#latest" in case the URI points to a <container> NOTE: In the above table, names of XML schema attributes are prefixed with a "@" character to differentiate these from Resource attribute names. The "@" character is not part of the actual attribute name. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.3.6 Universal and Common attributes | ETSI TS 118 101 [6] defines a number of Universal Attributes (which appear in all resources) and Common Attributes (which appear in more than one resource and have the same meaning whenever they do appear). The type and values shall be supported according to the description given in Table 6.3.6-1. If a Resource is represented as an XML document then the resource attributes (if present) appear in the order listed in this table. They appear before any resource-specific attributes. Table 6.3.6-1: Universal and Common Attributes Attribute Name Data Type Value restrictions and Notes resourceType m2m:resourceType This attribute is only determined at creation time by the Hosting CSE resourceID m2m:ID This attribute is determined at creation time by the hosing CSE and used for non-hierarchical addressing method parentID m2m:nhURI This attribute is determined by the Hosting CSE and specified in all resource types. For <CSEBase> however, the value of this attribute shall be an empty string. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 70 oneM2M TS-0004 version 2.7.1 Release 2 Attribute Name Data Type Value restrictions and Notes creationTime m2m:timestamp This attribute is determined by the Hosting CSE when the resource is locally created lastModifiedTime m2m:timestamp This attribute is determined by the Hosting CSE when the addressed resource is modified by means of the UPDATE operation labels m2m:labels Absence of this attribute means there are no labels accessControlPolicyIDs m2m:acpType accessControlPolicyI Ds expirationTime m2m:timestamp expirationTime link xs:anyURI Absence of this attribute means that this is not an announced resource announceTo list of xs:anyURI Absence of this attribute means that this is not an announced resource announcedAttribute list of xs:NCName Absence of this attribute means that this is not an announced resource stateTag xs:nonNegativeInteger This attribute is determined by the Hosting CSE. When a resource is created this counter is set to '0' and it will be incremented on every modification of the resource resourceName xs:NCName dynamicAuthorizationC onsultationIDs list of xs:anyURI dynamicAuthorization ConsultationIDs creator m2m:ID The AE-ID or CSE-ID of the entity which created the resource containing this attribute. Table 6.3.6-2 describes some complex types that group together the universal and common attributes, to be used by Resource Type definitions. Note that stateTag and creator only appear in a limited number of resource types, and therefore are not included in these definitions, instead they are declared in the corresponding XSD files of the resources that support them. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 71 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.3.6-2: Complex Data Types declaring groups of resource common attributes XSD type name Child Elements Child Element Datatype Multiplicity Description m2m:resource @resourceName xs:NCName 1 resourceType m2m:resourceType 1 resourceID m2m:ID 1 parentID m2m:nhURI 1 creationTime m2m:timestamp 1 lastModifiedTime m2m:timestamp 1 labels m2m:labels 0..1 m2m:regularResource @resourceName xs:NCName 1 Declares the universal / common attributes included in the non- announceable resource types. resourceType m2m:resourceType 1 resourceID m2m:ID 1 parentID m2m:nhURI 1 creationTime m2m:timestamp 1 lastModifiedTime m2m:timestamp 1 labels m2m:labels 0..1 accessControlPolicyIDs m2m:acpType 0..1 expirationTime m2m:timestamp 1 dynamicAuthorizationCo nsultationIDs list of xs:anyURI 0..1 m2m:announceableResource @resourceName xs:NCName 1 Declares the universal / common attributes included in the majority of announceable resource types. resourceType m2m:resourceType 1 resourceID m2m:ID 1 parentID xs:anyURI 1 creationTime m2m:timestamp 1 lastModifiedTime m2m:timestamp 1 labels m2m:labels 0..1 accessControlPolicyIDs m2m:acpType 0..1 expirationTime m2m:timestamp 1 dynamicAuthorizationCo nsultationIDs list of xs:anyURI 0..1 announceTo list of xs:anyURI 0..1 announcedAttribute list of xs:NCName 0..1 m2m:announcedResource @resourceName xs:NCName 1 Declares the universal / common attributes in the announced variant of the preceding resources resourceType m2m:resourceType 1 resourceID m2m:ID 1 parentID m2m:nhURI 1 creationTime m2m:timestamp 1 lastModifiedTime m2m:timestamp 1 labels m2m:labels 0..1 accessControlPolicyIDs m2m:acpType 1 expirationTime m2m:timestamp 1 link xs:anyURI 1 dynamicAuthorizationCo nsultationIDs list of xs:anyURI 0..1 m2m:subordinateResource @resourceName xs:NCName 1 Declares the universal / common attributes included in the non- announceable resource types without accessControlPolicyI Ds resourceType m2m:resourceType 1 resourceID m2m:ID 1 parentID m2m:nhURI 1 creationTime m2m:timestamp 1 lastModifiedTime m2m:timestamp 1 labels m2m:labels 0..1 expirationTime m2m:timestamp 1 @resourceName xs:NCName 1 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 72 oneM2M TS-0004 version 2.7.1 Release 2 XSD type name Child Elements Child Element Datatype Multiplicity Description m2m:announceableSubordinateRe source resourceType m2m:resourceType 1 Declares the universal / common attributes used by resource types that are subordinate children of other resources resourceID m2m:ID 1 parentID xs:anyURI 1 creationTime m2m:timestamp 1 lastModifiedTime m2m:timestamp 1 labels m2m:labels 0..1 expirationTime m2m:timestamp 1 announceTo list of xs:anyURI 0..1 announcedAttribute list of xs: NCName 0..1 m2m:announcedSubordinateResou rce @resourceName xs:NCName 1 Declares the common / universal attributes used in the announced variants of the subordinate resource types resourceType m2m:resourceType 1 resourceID m2m:ID 1 parentID m2m:nhURI 1 creationTime m2m:timestamp 1 lastModifiedTime m2m:timestamp 1 labels m2m:labels 0..1 expirationTime m2m:timestamp 1 link xs:anyURI 1 NOTE: In Table 6.3.6-2, names of XML schema attributes are prefixed with a "@" character to differentiate these from Resource attribute names. The "@" character is not part of the actual attribute name. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.4 Message parameter data types | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.4.1 Request primitive parameter data types | The data types of request primitive parameters are specified in this clause. Detailed request primitive parameter descriptions and usage can be found in clause 8.1.2 of the ETSI TS 118 101 [6]. Further details on the representation of primitives are specified in clauses 7.2.1.1 and 8. Table 6.4.1-1 shows the structure of the request primitive. This is defined as the m2m:requestPrimitive data type in the XSD file CDT- requestPrimitive-v2_7_0.xsd. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 73 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.4.1-1: Data Types for Request primitive parameters Primitive Parameter Data Type Multiplicity Default Handling NOTE 2 Note Operation m2m:operation 1 Not applicable See clause 6.3.4.2.5 To xs:anyURI 1 Not applicable From m2m:ID 0..1 Not applicable See clause 6.3.3 Also see note 2 below. Request Identifier m2m:requestID 1 Not applicable See clause 6.3.3 Resource Type m2m:resourceType 0..1 No default See clause 6.3.4.2.1 Content m2m:primitiveContent 0..1 No default See clause 6.3.5.5 Role IDs List of m2m:roleID 0..1 Not applicable Originating Timestamp m2m:timestamp 0..1 No default Request Expiration Timestamp m2m:absRelTimestamp 0..1 Can be given by CMDH policy (Annex D.12) "Result Expiration Timestamp" shall be later than "Request Message Expiration Timestamp" Result Expiration Timestamp m2m:absRelTimestamp 0..1 Can be given by CMDH policy (Annex D.12) Operation Execution Time m2m:absRelTimestamp 0..1 Can be given by CMDH policy (Annex D.12) Response Type m2m:responseTypeInfo 0..1 Use 'blockingRequest' See clause 6.3.5.30 Result Persistence m2m:absRelTimestamp 0..1 Can be given by CMDH policy (Annex D.12) Result Content m2m:resultContent 0..1 Use 'attributes' See clause 6.3.4.2.7 Event Category m2m:eventCat 0..1 No default See clause 6.3.3 Delivery Aggregation xs:boolean 0..1 Can be given by CMDH policy (Annex D.12), otherwise FALSE Group Request Identifier xs:string 0..1 No default Filter Criteria m2m:filterCriteria 0..1 No default See clause 6.3.5.8 Discovery Result Type m2m:discResType 0..1 Use 'structured' See clause 6.3.4.2.8 Tokens List of m2m:dynAuthJWT 0..1 Not applicable See clause 6.3.3 Token IDs List of m2m:tokenID 0..1 Not applicable LocalTokenIDs List of xs:NCName 0..1 No default Token Request Indicator xs:boolean 0..1 No default NOTE 1: Default handling is the request handling procedure on a Transit/Hosting CSE when the request parameter is not included in a request primitive. This is not applicable for mandatory parameters which are marked as 'M' in Table 7.1.1.1 1. NOTE 2: From parameter shall be present for all requests except for <AE> CREATE where it is optional. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.4.2 Response primitive parameter data types | The data types of response primitive parameters are specified in this clause. Detailed response message parameter descriptions and usage can be found in clause 8.1.3 of ETSI TS 118 101 [6]. Further details on the representation of primitives are specified in clauses 7.1.1.1 and 8. Table 6.4.2-1 shows the structure of the response primitive. This is defined as the m2m:responsePrimitive data type in the XSD file CDT- responsePrimitive-v2_7_0.xsd. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 74 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.4.2-1: Data Types for Response primitive parameters Primitive Parameter Data Type Multiplicity Note Response Status Code m2m:responseStatusCode 1 See clause 6.3.4.2.9 Request Identifier m2m:requestID 1 See clause 6.3.3 Content m2m:primitiveContent 0..1 See clause 6.3.5.5 To m2m:ID 0..1 See clause 6.3.3 From m2m:ID 0..1 Originating Timestamp m2m:timestamp 0..1 See Table 6.3.3-1 Result Expiration Timestamp m2m:absRelTimestamp 0..1 See Table 6.3.3-1 Event Category m2m:eventCat 0..1 See clause 6.3.3 Content Status m2m:contentStatus 0..1 See clause 6.3.4.2.43 Content Offset xs:positiveInteger 0..1 Assigned Token Identifiers m2m:dynAuthLocalTokenIdAssignments 0..1 See clause 6.3.5.43 Token Request Information m2m:dynAuthTokenReqInfo 0..1 See clause 6.3.5.45 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5 Resource data types | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.1 Description | Each oneM2M Resource Data Type is defined using XML Schema (XSD), and supplied as a separate XSD document. This XML Schema defines the attributes of the Resource in accordance with ETSI TS 118 101 [6]. It represents an entire resource. In other words if and only if a requestor retrieves an entire resource in XML format, the XML that is returned shall be valid with respect to the schema for that resource. Note that the payload of a Create or Update request primitive does not necessarily have to be valid according to the schema, as this payload is not required to contain values for all the resource attributes. For example, a resource might contain mandatory read-only attributes which do not appear in a Create or Update request. Each Resource Type , along with its Announced variant (if there is one) is defined in a separate XSD file. The name of that file should be prefixed with 'CDT-' and followed by the resource type name and version of the present document. The individual Resource Types inherit from a set of base resource types. These definitions, which can be found in the file CDT-commonTypes-v2_7_0.xsd, contain definitions for the common and universal attributes, and establish an inheritance hierarchy shown in Figure 6.5.1-1. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 75 oneM2M TS-0004 version 2.7.1 Release 2 Figure 6.5.1-1: Resource Types |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.2 resource | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.2.1 Description | This XSD type definition includes the six universal attributes that are present in all oneM2M resource type definitions. It forms the root of the resource inheritance hierarchy. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.2.2 Reference | See Table 6.3.6-2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.2.3 Usage | This type is used indirectly by all resource types. It is used directly just by the <CSEBase> resource type. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.3 regularResource | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.3.1 Description | This type definition includes the universal and common attributes used by the non-annouceable M2M resources. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.3.2 Reference | See Table 6.3.6-2. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 76 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.3.3 Usage | This type is used by the following resource types: <delivery>, <eventConfig>, <execInstance>, <m2mServiceSubscriptionProfile>, <mgmtCommand>, <request>, <serviceSubscribedNode>, <statsCollect>, <statsConfig>, <subscription>, <serviceSubscribedAppRule>, <notificationTargetMgmtPolicyRef>, <notificationTargetPolicy>, <policyDeletionRules>, <dynamicAuthorizationConsultation>, <role>, <token> |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.4 announceableResource | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.4.1 Description | This type definition includes the universal and common attributes used by M2M resource types that are capable of being announced. In addition to the attributes of a regularResource, it includes (as optional) the common attributes that are used by the announcement mechanism. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.4.2 Reference | See Table 6.3.6-2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.4.3 Usage | This type is used by the following resource types: <AE>, <container>, <group>, <locationPolicy>, <node>, <remoteCSE>, <semanticDescriptor>, <timeSeries>, <trafficPattern> It is also used by the specializations of <mgmtObj>. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.5 announcedResource | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.5.1 Description | This type definition includes the universal and common attributes used by a resource that is announcing an announceable resource. In addition to the attributes of a regularResource, it includes (as optional) the link common attribute. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.5.2 Reference | See Table 6.3.6-2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.5.3 Usage | This type is used by the following resource types: <AEAnnc>, <containerAnnc>, <groupAnnc>, <locationPolicyAnnc>, <nodeAnnc>, <remoteCSEAnnc>, <semanticDescriptorAnnc>, <trafficPatternAnnc>. It is also used by the xxxAnnc variants of the <mgmtObj> specializations. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.6 announceableSubordinateResource | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.6.1 Description | This type definition includes the common attributes used by resource types that are subordinate children of other resource types. It excludes attributes like accessControlPolicyIDs, as this attribute is defined for such resources. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 77 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.6.2 Reference | See Table 6.3.6-2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.6.3 Usage | This type is used by the following resource types: <accessControlPolicy>, <contentInstance>, <schedule>, <timeSeries>, <timeSeriesInstance>. It is also used by the xxxAnnc variants of the <mgmtObj> specializations. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.7 announcedSubordinateResource | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.7.1 Description | This type definition includes the common attributes used by the Announced variants of the resource types that are subordinate children of other resource types. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.7.2 Reference | See Table 6.3.6-2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.7.3 Usage | This type is used by the following resource types: <accessControlPolicyAnnc>, <contentInstanceAnnc>, <scheduleAnnc>, <timeSeriesAnnc>, <timeSeriesInstanceAnnc>. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.8 announcedSubordinateResource | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.8.1 Description | This type definition includes the universal and common attributes used by the non-annouceable M2M resources except the accessControlPolicyIDs attribute. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.8.2 Reference | See Table 6.3.6-2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.5.8.3 Usage | This type is used by the following resource types: <pollingChannel>. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.6 Response status codes | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.6.1 Introduction | The present clause specifies the assignment of oneM2M Response Status Code (RSC) values, which are returned in the Response Status Code parameter of Response primitive. The RSC may be delivered as oneM2M defined structured data, or the mapped native status code for transport protocol binding (e.g. HTTP, CoAP, MQTT). ETSI ETSI TS 118 104 V2.7.1 (2016-10) 78 oneM2M TS-0004 version 2.7.1 Release 2 |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.6.2 RSC framework overview | The RSCs are categorized as one of 6 classes: Table 6.6.2-1: Definition of Response Status Code class Status Class Code Class Interpretation Informational 1xxx The request is successfully received, but the request is still on process. Success 2xxx The request is successfully received, understood, and accepted. Redirection 3xxx (Not used in present release) Originator Error 4xxx The request was malformed by the Originator and, is rejected. Receiver Error 5xxx The requested operation cannot be performed due to an error condition at the Receiver CSE. Network Service Error 6xxx The requested operation cannot be performed due to an error condition at the Network Service Entity. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.6.3 Definition of Response Status Codes | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.6.3.1 Overview | The tables in the following clauses specify the RSCs for oneM2M releases. Each RSC includes: a response status represented as numeric code. The supplemental information may be returned when it is needed. 6.6.3.2 Informational response class Table 6.6.3.2-1 specifies the RSCs for acknowledgement responses for each release. Table 6.6.3.2-1: Informational response class Numeric Code Description 1000 ACCEPTED |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.6.3.3 Successful response class | Table 6.6.3.2-1 specifies the RSCs for successful responses. Table 6.6.3.3-1: RSCs for successful response class Numeric Code Description 2000 OK 2001 CREATED 2002 DELETED 2004 UPDATED |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.6.3.4 Redirection response class | In the present document, no values in this response class are defined. Table 6.6.3.4-1: RSCs for redirection response class Numeric Code Description |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.6.3.5 Originator error response class | Table 6.6.3.5-1 specifies the RSCs for Originator error responses. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 79 oneM2M TS-0004 version 2.7.1 Release 2 41xx codes are oneM2M specific. Table 6.6.3.5-1: RSCs for Originator error response class Numeric Code Description 4000 BAD_REQUEST 4004 NOT_FOUND 4005 OPERATION_NOT_ALLOWED 4008 REQUEST_TIMEOUT 4101 SUBSCRIPTION_CREATOR_HAS_NO_PRIVILEGE 4102 CONTENTS_UNACCEPTABLE 4103 ORIGINATOR_HAS_NO_PRIVILEGE 4104 GROUP_REQUEST_IDENTIFIER_EXISTS 4105 CONFLICT 4106 ORIGINATOR_HAS_NOT_REGISTERED 4107 SECURITY_ASSOCIATION_REQUIRED 4108 INVALID_CHILD_RESOURCE_TYPE 4109 NO_MEMBERS 4110 GROUP_MEMBER_TYPE_INCONSISTENT 4111 ESPRIM_UNSUPPORTED_OPTION 4112 ESPRIM_UNKNOWN_KEY_ID 4113 ESPRIM_UNKNOWN_ORIG_RAND_ID 4114 ESPRIM_UNKNOWN_RECV_RAND_ID 4115 ESPRIM_BAD_MAC |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.6.3.6 Receiver error response class | Table 6.6.3.6-1 specifies the RSCs for Receiver error responses. 51xx codes are oneM2M specific, which are used in generic procedures. 52xx codes are oneM2M specific, which are used in resource specific procedures. Table 6.6.3.6-1: RSCs for Receiver error response class Numeric Code Description 5000 INTERNAL_SERVER_ERROR 5001 NOT_IMPLEMENTED 5103 TARGET_NOT_REACHABLE 5105 RECEIVER_HAS_NO_PRIVILEGE 5106 ALREADY_EXISTS 5203 TARGET_NOT_SUBSCRIBABLE 5204 SUBSCRIPTION_VERIFICATION_INITIATION_FAILED 5205 SUBSCRIPTION_HOST_HAS_NO_PRIVILEGE 5206 NON_BLOCKING_REQUEST_NOT_SUPPORTED 5207 NOT_ACCEPTABLE 5208 DISCOVERY_DENIED_BY_IPE 5209 GROUP_MEMBERS_NOT_RESPONDED 5210 ESPRIM_DECRYPTION_ERROR 5211 ESPRIM_ENCRYPTION_ERROR 5212 SPARQL_UPDATE_ERROR |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.6.3.7 Network system error response class | Table 6.6.3.7-1 specifies the RSCs for when the external system reported errors over Mcn reference point. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 80 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.6.3.7-1: RSCs for Network system error response class Numeric Code Description 6003 EXTERNAL_OBJECT_NOT_REACHABLE 6005 EXTERNAL_OBJECT_NOT_FOUND 6010 MAX_NUMBER_OF_MEMBER_EXCEEDED 6020 MGMT_SESSION_CANNOT_BE_ESTABLISHED 6021 MGMT_SESSION_ESTABLISHMENT_TIMEOUT 6022 INVALID_CMDTYPE 6023 INVALID_ARGUMENTS 6024 INSUFFICIENT_ARGUMENTS 6025 MGMT_CONVERSION_ERROR 6026 MGMT_CANCELLATION_FAILED 6028 ALREADY_COMPLETE 6029 MGMT_COMMAND_NOT_CANCELLABLE |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.7 oneM2M specific MIME media types | The present sub-clause defines oneM2M specific MIME media types which may be used by protocol bindings. The oneM2M specific MIME media types are defined under the vendor tree of "application" mediate type which is prefixed with 'application/vnd.onem2m-'. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 81 oneM2M TS-0004 version 2.7.1 Release 2 Table 6.7-1: oneM2M specific MIME media types oneM2M specific MIME subtype mapped oneM2M data type Note vnd.onem2m-res+xml m2m:resource For oneM2M resource operation. The type of oneM2M resource in content shall be indicated by "ty" parameter. XML serialization rule is applied. (See clause 7.5.2) vnd.onem2m-res+json m2m:resource Same information of above. JSON serialization rule is applied. (See clause 7.5.2) vnd.onem2m-res+cbor m2m:resource Same information of above. CBOR serialization rule is applied. (See clause 7.5.2) vnd.onem2m-ntfy+xml m2m:notification or m2m:aggregatedNotification For Notify operation for resource subscription. XML serialization rule is applied. (See clause 7.5.1) vnd.onem2m-ntfy+json m2m:notification or m2m:aggregatedNotification Same information of above. JSON serialization rule is applied. (See clause 7.5.1) vnd.onem2m-ntfy+cbor m2m:notification or m2m:aggregatedNotification Same information of above. CBOR serialization rule is applied. (See clause 7.5.1) vnd.onem2m-preq+xml m2m:requestPrimitive For exchanging serialized oneM2M request primitive. XML serialization rule is applied. (See clause 6.4.1 and 7.2.1.1) vnd.onem2m-preq+json m2m:requestPrimitive Same information of above. JSON serialization rule is applied. (See clause 6.4.1 and 7.2.1.1) vnd.onem2m-preq+cbor m2m:requestPrimitive Same information of above. CBOR serialization rule is applied. (See clause 6.4.1 and 7.2.1.1) vnd.onem2m-prsp+xml m2m:responsePrimitive For exchanging Response parameters. XML serialization rules is applied. (See clause 6.4.2 and 7.2.1.2) vnd.onem2m-prsp+json m2m:responsePrimitive Same information of above. JSON serialization rule is applied. (See clause 6.4.2 and 7.2.1.2) vnd.onem2m-prsp+cbor m2m:responsePrimitive Same information of above. CBOR serialization rule is applied. (See clause 6.4.2 and 7.2.1.2) |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 6.8 Virtual Resources | A virtual resource is used to trigger processing and/or retrieve results, but does not have a permanent representation in a CSE. Table 6.8-1 lists the Virtual Resources. Table 6.8-1: Virtual Resources Virtual Resource Type resourceName Parent Resource Notes <latest> latest <container> See clause 7.4.27 <oldest> oldest <container> See clause 7.4.28 <fanOutPoint> fanOutPoint <group> See clause 7.4.14 <semanticFanOutPoint> semanticFanOutPoint <group> See clause 7.4.35 <pollingChannelURI> pollingChannelURI <pollingChannel> See clause 7.4.22 <notificationTargetSelfReference> notificationTargetSelfReference <subscription> See clause 7.4.33 ETSI ETSI TS 118 104 V2.7.1 (2016-10) 82 oneM2M TS-0004 version 2.7.1 Release 2 Each resource instance listed in "Parent Resource" column of Table 6.8-1 has one virtual resource child of each type listed against it in the table. These child resource instances have fixed resourceNames, as shown in the second column. A virtual resource shall be addressed using the hierarchical addressing method formed by taking the structured or unstructured resource identifier of the parent resource and appending a "/" followed by the resourceName of the virtual resource. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7 oneM2M procedures | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.1 Introduction | The following clauses (7.2 to 7.6) describe prerequisites such as primitive format and procedure outline with three generic scenarios that are Originator, Receiver, and Resource Handling in accordance with CRUD+N operations. In addition, for specific resource type they provide common or resource specific attributes, data type definition for the attributes, and child resources as well as they explain resource specific procedures on CRUD operations to communicate with oneM2M compliant M2M Platform System by oneM2M protocols and APIs as follows: • Primitive formats and generic procedures • Common operations • Resource type-specific definitions and procedures • Notification definition and procedures |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.2 Primitive format and generic procedure | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.2.1 Primitive format | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.2.1.1 Request primitive format | Table 7.2.1.1-1 summarizes the primitive parameters of the Request primitive, indicating their presence depending on the C, R, U, D or N operations. "M" indicates mandatory, "O" indicates optional, "NP" indicates not present. Refer to clause 8.1.2 of the ETSI TS 118 101 [6] for additional information on the request primitive parameters. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 83 oneM2M TS-0004 version 2.7.1 Release 2 Table 7.2.1.1-1: Request Primitive Parameters Primitive Parameter CREATE RETRIEVE UPDATE DELETE NOTIFY Operation M M M M M To M M M M M From O See note M M M M Request Identifier M M M M M Resource Type M NP NP NP NP Content M O M NP M Role IDs O O O O O Originating Timestamp O O O O O Request Expiration Timestamp O O O O O Result Expiration Time O O O O O Operation Execution Time O O O O O Response Type O O O O O Result Persistence O O O O NP Result Content O O O O NP Event Category O O O O O Delivery Aggregation O O O O O Group Request Identifier O O O O O Filter Criteria NP O O O NP Discovery Result Type NP O NP NP NP Tokens O O O O O Token IDs O O O O O NOTE: The From parameter is Mandatory for all requests except for AE CREATE. For AE CREATE, it is Optional. The Content parameter in a Request shall contain one of the following: 1) A partial Resource. This applies to Create and Update request primitives. In the case of Create request the Content parameter shall contain a single root element whose name is the name of the Resource and whose content consists of one or more attributes, child Resources or childResource references. In the case of an Update request primitive, the Content parameter shall contain the attribute and new values. Attributes to be deleted from the resource shall be indicated without a value. In both cases the resource type is as defined in clause 7.4, however since a partial resource is being transferred it is not required to be valid according to the XSD for that resource in terms of the presence of resource attributes. Any attribute that is present, however, shall comply to the data type defined in the XSD of that resource. 2) A Notification Data Object. This applies to Notification request primitives. The data type of the data object is named <m2m:notification> and is described in Clause 7.5.1 3) An Aggregated Notification. This applies to Notification request primitives. The data type of the data object is named <m2m:aggregatedNotification> and contains multiple <m2m:notification> objects. This is described in clause 7.5.1. 4) An AttributeList element, as described in clause 7.5.2. This is used in partial retrieve request primitives to indicate a list of attribute names whose values shall be retrieved in the response. 5) A ResponsePrimitive object as described in clause 7.5.1. This applies to Notification request primitives which are sent when accessing resources in asynchronous non-blocking mode. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.2.1.2 Response primitive format | Table7.2.1.2-1 summarizes the primitive parameters for Response primitive, indicating their presence depending on the C, R, U, D or N operations of the associated Request primitive and whether this operation was successful or caused an error. "M" indicates mandatory, "O" indicates optional, "NP" indicates not present. Refer to clause 8.1.3 of ETSI TS 118 101 [6] for additional information on the request primitive parameters. NOTE: Response Code and Status Code parameters are merged into the Response Status Code parameter. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 84 oneM2M TS-0004 version 2.7.1 Release 2 Table7.2.1.2-1 : Response Primitive Parameters Primitive parameter Ack CREATE Success RETRIEVE Success UPDATE Success DELETE Success NOTIFY Success Error Response Status Code M M M M M M M Request Identifier M M M M M M M Content O O M O O O O To O O O O O O O From O O O O O O O Originating Timestamp O O O O O O O Result Expiration Timestamp O O O O O O O Event Category O O O O O O O The Content parameter in a Response shall contain one of the following: 1) A complete or partial Resource. This applies to a response primitive sent in reply to create and retrieve request message. A partial resource also applies to a response primitive sent in reply to update request message. The Content parameter shall contain a single root element whose name is the name of the Resource and whose content consists of one or more attributes, child resources or childResource references. In this case the resource type is as defined in clause 7.4. However if a partial resource is being transferred, it is not required to be valid according to the XSD for that resource, in terms of the presence of resource attributes. Any attribute that is present, however, shall comply to the data type defined in the XSD of that resource. 2) The URI of a resource. This is included directly as the content of the Content parameter (like in case 6) 3) A partial resource and its hierarchical URI. These are included in a root element called m2m:resource defined in clause 7.5.2. The URI is included as an attribute of m2m:resource. 4) A list of URIs. This can be used for transferring the childResource URIs in a Discovery response. These are included in an element called m2m:URIList defined in clause 7.5.2. 5) A list of childResourceRef. This can be used for transferring the child resource references in a Discovery response. These are included in an element called m2m:resourceRefList defined in clause 7.5.2. 6) An Aggregated Response. This is sent as a result of a Group operation. This uses the element m2m:aggregatedResponse defined in clause 7.5.2. 7) Human-readable error message. This is included in an element called m2m:debugInfo defined in clause 7.5.2. |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.2.2 Description of generic procedures | |
cbf164e0a9061a5bee8f92b0fb68219c | 118 104 | 7.2.2.1 Generic resource request procedure for originator | A generic resource Request procedure shall be comprised of the following actions. Additional actions specific to individual procedures are listed in the respective clauses by referencing these actions and providing additional steps. The Originator shall execute the following steps in order: ETSI ETSI TS 118 104 V2.7.1 (2016-10) 85 oneM2M TS-0004 version 2.7.1 Release 2 Finish Orig-1.0: “Compose of a Request primitive” Orig-5.1: “Receive a Response primitive from the Hosting CSE” Orig-6.0: “Process Response primitive” nonBlockingRequestAsynch Orig-2.0: “Send a Request primitive to the Receiver CSE” Start Orig-5.0: “Send a Request primitive with op=R” Orig-5.2: “Completion of operation by Response Status Code parameter” Processing Success Orig-8.0: “Create a Response primitive with op=N” Orig-3.0: “Check Response Type” Orig-5.3: “Extract a result from Response primitive of Orig-5.1” nonBlockingRequestSynch Orig-9.0: “Send a Response primitive with op=N” Orig-7.0: “Receive a Request primitive with op=N” Fail Orig-9.1: “Extract Response primitive of Orig-2.0 from Orig-7.0” Orig-4.1: “Wait for Response primitive (Ack)” Orig-4.1: “Wait for Response primitive (Ack)” Orig-4.0: “Wait for Response primitive” blockingRequest Figure 7.2.2.1-1: Generic procedure of Originator Orig-1.0 "Compose Request primitive": Please refer to clause 7.3.1.1 for details. Orig-2.0 "Send a Request primitive to the Receiver CSE": The Request primitive shall be included mandatory parameters which are Operation, To, From and Request Identifier parameter. Please refer to clause 7.3.1.2 for details. Orig-3.0 "Check Response Type": In this step, the Originator checks that the communication method is either blockingRequest, nonBlockingRequestSynch, nonBlockingRequestAsynch or flexBlocking by using the Response Type parameter (see detail in clause 8.1.2 in the ETSI TS 118 101 [6]). If the Response Type parameter does not exist, the communication method is ‘blockingRequest' as specified at clause 6.4.1. If the Response Type is blockingRequest it waits for Response primitive and goes to step Orig-4.0. If the Response Type is nonBlockingRequestSync, it waits for acknowledgement of the Response primitive and goes to step Orig-4.1. If the Response Type is nonBlockingRequestAsynch, it waits for acknowledgement of Response primitive and goes to step Orig-4.1. If the Response Type is flexBlocking, the Originator shall wait for a Response primitive as in Orig-4.0 and Orig-4.1 below, If the Response primitive is an acknowledgement it shall proceed according to Orig-4.1 (nonBlockingRequestSynch or nonBlockingRequestAsynch) otherwise it shall proceed according to Orig-4.0 (blockingRequest). Orig-4.0 and Orig-4.1 "Wait for Response primitive": Please refer to clause 7.3.1.3 for details. ETSI ETSI TS 118 104 V2.7.1 (2016-10) 86 oneM2M TS-0004 version 2.7.1 Release 2 Orig-5.0 "Send a Request primitive with op=R": The Request primitive shall be included mandatory parameters which are Operation, To, From and Request Identifier parameter. See clause 7.3.1.4 for details. Orig-5.1 "Receive a Response primitive from the Hosting CSE": The Originator shall receive mandatory parameters which are Response Status Code, Request Identifier and Content parameter. A Request Identifier shall be identical to the Orig-5.0. An information of Content parameter is the result of the Orig-2.0 when the Receiver completed handling of Request primitive of Orig-2.0. Orig-5.2 "Completion of operation by Response Status Code parameter": When the Response Status Code is successful and Content parameter exists, it goes to Orig-5.3. When the Response Status Code is acknowledgment which indicates processing at the Receiver, it goes to Orig-5.0. When the Response Status Code is error such as Originator error (4XXX) or Receiver error (5XXX) or Network error (6XXX) or absence of Content parameter, it goes to finish with error. Orig-5.3 "Extract a result from Response primitive of Orig-5.1": The information of operationResult attribute of the <request> resource in Content parameter from Orig-5.1 is extracted from Response primitive which is included Request Identifier, Response Status Code and optional Content parameter. The <request> resource shall be included mandatory attributes as specified in clause 9.6.12 [6]. The Request Identifier in operationResult attribute shall be identical of Orig-2.0 Orig-6.0 "Process Response primitive": A Request Identifier shall be identical to the Orig-2.0. The Originator processes the response. Orig-7.0 "Receive a Request primitive with op=N": The Originator receives Request primitive with mandatory parameters which are Operation, To, From, Request Identifier and Content parameter. An Operation parameter shall be Notify. A Content parameter is the notification information as specified in clause 7.5.1.1. Orig-8.0 "Create a Response primitive with op=N": The Originator creates Response primitive with mandatory parameters which are Response Status Code and Request Identifier parameter. A Request Identifier shall be identical to the Orig-7.0. Orig-9.0 "Send a Response primitive with op=N": The Response primitive which is created at Orig-8.0 shall be sent to the Receiver. Please refer to clause 7.3.2.3 for details. Orig-9.1"Extract Response primitive of Orig-2.0 from Orig-7.0": The information of operationResult attribute in <request> resource from Orig-7.0 in Response primitive is included Request Identifier, Response Status Code and optional Content parameters. The <request> resource shall be included mandatory attributes as specified in clause 9.6.12 of ETSI TS 118 101 [6]. The Request Identifier in operationResult attribute shall be identical of Orig-2.0. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.