TIA-5022 004-2015 Service Layer Core Protocol Specification (oneM2M TS-0004-v1 0 1).pdf

1、 TIA-5022.004 October 2015Service Layer Core Protocol Specification (oneM2M TS-0004-v1.0.1) NOTICE TIA Engineering Standards and Publications are designed to serve the public interest through eliminating misunderstandings between manufacturers and purchasers, facilitating interchangeability and impr

2、ovement of products, and assisting the purchaser in selecting and obtaining with minimum delay the proper product for their particular need. The existence of such Standards and Publications shall not in any respect preclude any member or non-member of TIA from manufacturing or selling products not c

3、onforming to such Standards and Publications. Neither shall the existence of such Standards and Publications preclude their voluntary use by Non-TIA members, either domestically or internationally. Standards and Publications are adopted by TIA in accordance with the American National Standards Insti

4、tute (ANSI) patent policy. By such action, TIA does not assume any liability to any patent owner, nor does it assume any obligation whatever to parties adopting the Standard or Publication. This Standard does not purport to address all safety problems associated with its use or all applicable regula

5、tory requirements. It is the responsibility of the user of this Standard to establish appropriate safety and health practices and to determine the applicability of regulatory limitations before its use. Any use of trademarks in this document are for information purposes and do not constitute an endo

6、rsement by TIA or this committee of the products or services of the company. (From Project No. TIA-PN-5022.004, formulated under the cognizance of the TIA TR-50 M2M- Smart Device Communications.) Published by TELECOMMUNICATIONS INDUSTRY ASSOCIATION Technology (b) there is no assurance that the Docum

7、ent will be approved by any Committee of TIA or any other body in its present or any other form; (c) the Document may be amended, modified or changed in the standards development or any editing process. The use or practice of contents of this Document may involve the use of intellectual property rig

8、hts (“IPR”), including pending or issued patents, or copyrights, owned by one or more parties. TIA makes no search or investigation for IPR. When IPR consisting of patents and published pending patent applications are claimed and called to TIAs attention, a statement from the holder thereof is reque

9、sted, all in accordance with the Manual. TIA takes no position with reference to, and disclaims any obligation to investigate or inquire into, the scope or validity of any claims of IPR. TIA will neither be a party to discussions of any licensing terms or conditions, which are instead left to the pa

10、rties involved, nor will TIA opine or judge whether proposed licensing terms or conditions are reasonable or non-discriminatory. TIA does not warrant or represent that procedures or practices suggested or provided in the Manual have been complied with as respects the Document or its contents. If the

11、 Document contains one or more Normative References to a document published by another organization (“other SSO”) engaged in the formulation, development or publication of standards (whether designated as a standard, specification, recommendation or otherwise), whether such reference consists of man

12、datory, alternate or optional elements (as defined in the TIA Procedures for American National Standards) then (i) TIA disclaims any duty or obligation to search or investigate the records of any other SSO for IPR or letters of assurance relating to any such Normative Reference; (ii) TIAs policy of

13、encouragement of voluntary disclosure (see TIA Procedures for American National Standards Annex C.1.2.3) of Essential Patent(s) and published pending patent applications shall apply; and (iii) Information as to claims of IPR in the records or publications of the other SSO shall not constitute identi

14、fication to TIA of a claim of Essential Patent(s) or published pending patent applications. TIA does not enforce or monitor compliance with the contents of the Document. TIA does not certify, inspect, test or otherwise investigate products, designs or services or any claims of compliance with the co

15、ntents of the Document. ALL WARRANTIES, EXPRESS OR IMPLIED, ARE DISCLAIMED, INCLUDING WITHOUT LIMITATION, ANY AND ALL WARRANTIES CONCERNING THE ACCURACY OF THE CONTENTS, ITS FITNESS OR APPROPRIATENESS FOR A PARTICULAR PURPOSE OR USE, ITS MERCHANTABILITY AND ITS NONINFRINGEMENT OF ANY THIRD PARTYS IN

16、TELLECTUAL PROPERTY RIGHTS. TIA EXPRESSLY DISCLAIMS ANY AND ALL RESPONSIBILITIES FOR THE ACCURACY OF THE CONTENTS AND MAKES NO REPRESENTATIONS OR WARRANTIES REGARDING THE CONTENTS COMPLIANCE WITH ANY APPLICABLE STATUTE, RULE OR REGULATION, OR THE SAFETY OR HEALTH EFFECTS OF THE CONTENTS OR ANY PRODU

17、CT OR SERVICE REFERRED TO IN THE DOCUMENT OR PRODUCED OR RENDERED TO COMPLY WITH THE CONTENTS. TIA SHALL NOT BE LIABLE FOR ANY AND ALL DAMAGES, DIRECT OR INDIRECT, ARISING FROM OR RELATING TO ANY USE OF THE CONTENTS CONTAINED HEREIN, INCLUDING WITHOUT LIMITATION ANY AND ALL INDIRECT, SPECIAL, INCIDE

18、NTAL OR CONSEQUENTIAL DAMAGES (INCLUDING DAMAGES FOR LOSS OF BUSINESS, LOSS OF PROFITS, LITIGATION, OR THE LIKE), WHETHER BASED UPON BREACH OF CONTRACT, BREACH OF WARRANTY, TORT (INCLUDING NEGLIGENCE), PRODUCT LIABILITY OR OTHERWISE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. THE FOREGOING

19、NEGATION OF DAMAGES IS A FUNDAMENTAL ELEMENT OF THE USE OF THE CONTENTS HEREOF, AND THESE CONTENTS WOULD NOT BE PUBLISHED BY TIA WITHOUT SUCH LIMITATIONS. oneM2M Partners Type 1 (ARIB, ATIS, CCSA, ETSI, TIA, TTA, TTC) Page 3 of 217 This is a draft oneM2M document and should not be relied upon; the f

20、inal version, if any, will be made available by oneM2M Partners Type 1. Contents Contents . 3 1 Scope 13 2 References 13 2.1 Normative references . 13 2.2 Informative references . 14 3 Definitions and abbreviations . 14 3.1 Definitions . 14 3.2 Abbreviations . 15 4 Conventions . 16 5 Protocol design

21、 principles and requirements 16 5.1 Introduction . 16 5.1.1 Interfaces to the underlying networks 17 5.2 API design guidelines 17 5.3 Primitives. 18 5.3.1 Introduction 18 5.3.2 Primitives modelling . 19 5.3.3 Primitive principles. 19 5.3.4. Serialization of primitives . 19 5.4 Design principles . 19

22、 5.4.1 Introduction 19 5.4.2 Extensibility . 20 5.4.3 Scalability. 20 5.4.4 Fault tolerance and robustness 20 5.4.5 Efficiency . 20 5.4.6 Inter-operability 20 5.4.7 Self-operation and self-management . 21 6 oneM2M protocols/API overview 21 6.1 Introduction . 21 6.2 Addressing . 22 6.2.1 Summary of o

23、neM2M Identifiers 22 6.2.2 oneM2M Entity Addressing 22 6.2.3 oneM2M Resource Addressing . 23 6.3 Common data types 24 6.3.1 Simple data types incorporated from XML schema . 24 6.3.2 oneM2M simple data types . 26 6.3.3 oneM2M enumerated data types . 29 6.3.3.1 Introduction. 29 6.3.3.2 Enumeration typ

24、e definitions . 30 6.3.3.2.1 m2m:resourceType 30 6.3.3.2.2 m2m:cseTypeID 30 6.3.3.2.3 m2m:locationSource 30 6.3.3.2.4 m2m:stdEventCats . 31 6.3.3.2.5 m2m:operation. 31 6.3.3.2.6 m2m:responseType 31 6.3.3.2.7 m2m:resultContent 31 6.3.3.2.8 m2m:discResType . 32 6.3.3.2.9 m2m:responseStatusCode 32 6.3.

25、3.2.10 m2m:requestStatus . 32 6.3.3.2.11 m2m:memberType . 32 6.3.3.2.12 m2m:consistencyStrategy 33 6.3.3.2.13 m2m:cmdType. 33 6.3.3.2.14 m2m:execModeType . 34 6.3.3.2.15 m2m:execStatusType . 34 oneM2M Partners Type 1 (ARIB, ATIS, CCSA, ETSI, TIA, TTA, TTC) Page 4 of 217 This is a draft oneM2M docume

26、nt and should not be relied upon; the final version, if any, will be made available by oneM2M Partners Type 1. 6.3.3.2.16 m2m:execResultType 34 6.3.3.2.17 m2m:pendingNotification 35 6.3.3.2.18 m2m:notificationContentType . 35 6.3.3.2.19 m2m:resourceStatus . 35 6.3.3.2.20 m2m:status 36 6.3.3.2.21 m2m

27、:batteryStatus . 36 6.3.3.2.22 m2m:mgmtDefinition 36 6.3.3.2.23 m2m:logTypeId . 37 6.3.3.2.24 m2m:logStatus . 37 6.3.3.2.25 m2m:eventType . 37 6.3.3.2.26 m2m:statsRuleStatusType 38 6.3.3.2.27 m2m:statModelType 38 6.3.3.2.28 m2m:encodingType . 38 6.3.3.2.29 m2m:accessControlOperations . 38 6.3.3.2.30

28、 m2m:SRole-ID 39 6.3.4 Complex data types 39 6.3.4.1 m2m:deliveryMetaData . 39 6.3.4.2 m2m:aggregatedRequest . 39 6.3.4.3 m2m:metaInformation . 40 6.3.4.4 m2m:primitiveContent 40 6.3.4.5 m2m:batchNotify 40 6.3.4.6 m2m:eventNotificationCriteria 40 6.3.4.7 m2m:filterCriteria . 41 6.3.4.8 m2m:attribute

29、 41 6.3.4.9 m2m:attributeList 41 6.3.4.10 m2m:scheduleEntries 42 6.3.4.11 m2m:aggregatedNotification . 42 6.3.4.12 m2m:notification . 42 6.3.4.13 m2m:actionStatus 42 6.3.4.14 m2m:anyArgType . 43 6.3.4.15 m2m:resetArgsType 43 6.3.4.16 m2m:rebootArgsType . 43 6.3.4.17 m2m:uploadArgsTypes . 43 6.3.4.18

30、 m2m:downloadArgsType 43 6.3.4.19 m2m:softwareInstallArgsType 44 6.3.4.20 m2m:softwareUpdateArgsType . 44 6.3.4.21 m2m:softwareUninstallArgsType 44 6.3.4.22 m2m:execReqArgsListType 44 6.3.4.23 m2m:mgmtLinkRef . 45 6.3.4.24 m2m:resourceWrapper 45 6.3.4.25 m2m:setOfAcrs . 45 6.3.4.26 m2m:accessControl

31、Rule 46 6.3.4.27 m2m:locationRegion . 46 6.3.4.28 m2m:childResourceRef . 46 6.3.4.29 m2m:responseTypeInfo . 47 6.3.4.30 m2m:rateLimit 47 6.3.4.31 m2m:operationResult 47 6.3.4.32 m2m:aggregatedResponse . 47 6.3.5 Universal and Common attributes . 47 6.3.6 Filter criteria . 51 6.3.6.1 creationTime con

32、dition 51 6.3.6.2 lastModifiedTime condition 51 6.3.6.3 State Tag condition . 51 6.3.6.4 expirationTime condition 51 6.3.6.5 labels Match condition 52 6.3.6.6 resourceType Match condition 52 6.3.6.7 contentSize condtion . 52 6.3.6.8 typeOfContent condition . 52 6.3.6.9 attribute Match condition 53 6

33、.3.6.10 Limit results request parameter 53 6.3.6.11 Filter Usage request parameter 53 6.4 Message parameter data types 53 oneM2M Partners Type 1 (ARIB, ATIS, CCSA, ETSI, TIA, TTA, TTC) Page 5 of 217 This is a draft oneM2M document and should not be relied upon; the final version, if any, will be mad

34、e available by oneM2M Partners Type 1. 6.4.1 Request primitive parameter data types . 53 6.4.2 Response primitive parameter data types 54 6.5 Resource data types 54 6.5.1 Description . 54 6.5.2 resource 55 6.5.2.1 Description 55 6.5.2.2 Reference 55 6.5.2.3 Usage 55 6.5.3 regularResource 55 6.5.3.1

35、Description 55 6.5.3.2 Reference 55 6.5.3.3 Usage 56 6.5.4 announceableResource 56 6.5.4.1 Description 56 6.5.4.2 Reference 56 6.5.4.3 Usage 56 6.5.5 announcedResource 56 6.5.5.1 Description 56 6.5.5.2 Reference 56 6.5.5.3 Usage 56 6.5.6 announceableSubordinateResource . 56 6.5.6.1 Description 56 6.

36、5.6.2 Reference 57 6.5.6.3 Usage 57 6.5.7 announcedSubordinateResource . 57 6.5.7.1 Description 57 6.5.7.2 Reference 57 6.5.7.3 Usage 57 6.6 Response status codes 57 6.6.1 Introduction 57 6.6.2 RSC framework overview . 57 6.6.3 Definition of Response Status Codes 58 6.6.3.1 Overview 58 6.6.3.2 Infor

37、mational response class 58 6.6.3.3 Successful response class 58 6.6.3.4 Redirection response class . 58 6.6.3.5 Originator Error response class 58 6.6.3.6 Receiver Error response class 58 6.6.3.7 Network System Error response class 59 6.7 oneM2M specific MIME media types 59 6.8 Virtual Resources . 6

38、0 7 oneM2M procedures 62 7.1 Primitive format and generic procedure 62 7.1.1 Primitive format . 62 7.1.1.1 Request primitive format . 62 7.1.1.2 Response primitive format. 63 7.1.2 Description of generic procedures . 64 7.1.2.1 Generic resource request procedure for originator . 64 7.1.2.2 Generic r

39、equest procedure for receiver 65 7.2 Common operations . 68 7.2.1 Originator actions . 68 7.2.1.1 Compose request primitive 68 7.2.1.2 Send a request to the receiver CSE 69 7.2.1.3 Wait for response primitive . 69 7.2.1.4 Retrieve the resource 69 7.2.2 Receiver CSE actions . 69 7.2.2.1 Check the val

40、idity of received request primitive 69 7.2.2.2 Create resource locally 70 7.2.2.3 Create a success response (acknowledgement) 71 7.2.2.4 Send response primitive (acknowledgement) . 72 7.2.2.5 Update resource 72 oneM2M Partners Type 1 (ARIB, ATIS, CCSA, ETSI, TIA, TTA, TTC) Page 6 of 217 This is a dr

41、aft oneM2M document and should not be relied upon; the final version, if any, will be made available by oneM2M Partners Type 1. 7.2.2.6 Forwarding 72 7.2.2.7 Check Service Subscription Profile . 72 7.2.3 Hosting CSE actions . 73 7.2.3.1 Check existence of the addressed resource. 73 7.2.3.2 Check val

42、idity of resource representation for CREATE . 73 7.2.3.3 Check validity of resource representation for UPDATE. 73 7.2.3.4 Create the resource 74 7.2.3.5 Retrieve the resource . 75 7.2.3.6 Update the resource . 75 7.2.3.7 Delete the resource 76 7.2.3.8 Notify re-targeting . 76 7.2.3.9 Announce the re

43、source or attribute 76 7.2.3.10 De-announce the resource or attribute . 77 7.2.3.11 Create a success response 78 7.2.3.12 Create an error response 78 7.2.3.13 Resource discovery procedure . 79 7.2.3.14 Check authorization of the originator 79 7.2.4 Management common operations 80 7.2.4.1 Identify th

44、e managed entity and the management protocol. 80 7.2.4.2 Locate the external management objects to be managed on the managed entity . 80 7.2.4.3 Establish a management session with the managed entity or management server . 80 7.2.4.4 Send the management request(s) to the managed entity corresponding

45、 to the received Request primitive . 81 7.3 Resource type-specific procedures and definitions . 81 7.3.1 Resource type specification conventions . 81 7.3.1.1 Resource type definition conventions 81 7.3.1.2 Resource type-specific procedure conventions. 82 7.3.2 Resource type 82 7.3.2.1 Introduction.

46、82 7.3.2.2 accessControlPolicy resource specific procedure on CRUD operations . 83 7.3.2.2.1 Create 83 7.3.2.2.2 Retrieve . 83 7.3.2.2.3 Update . 83 7.3.2.2.4 Delete 83 7.3.3 Resource Type 84 7.3.3.1 Introduction. 84 7.3.3.2 resource specific procedure on CRUD operations 85 7.3.3.2.1 Create 85 7.3.3

47、.2.2 Retrieve . 85 7.3.3.2.3 Update . 85 7.3.3.2.4 Delete 85 7.3.4 Resource Type . 86 7.3.4.1 Introduction. 86 7.3.4.2 resource specific procedure on CRUD operations . 87 7.3.4.2.1 Create 87 7.3.4.2.2 Retrieve . 87 7.3.4.2.3 Update . 87 7.3.4.2.4 Delete 87 7.3.5 Resource Type . 87 7.3.5.1 Introducti

48、on. 87 7.3.5.2 resource specific procedure on CRUD+N operations 88 7.3.5.2.1 Create 88 7.3.5.2.2 Retrieve . 89 7.3.5.2.3 Update . 89 7.3.5.2.4 Delete 89 7.3.5.2.5 Notify 89 7.3.6 Resource Type 89 7.3.6.1 Introduction. 89 7.3.6.2 resource specific procedure on CRUD operations 90 7.3.6.2.1 Create 91 7

49、.3.6.2.2 Retrieve . 91 7.3.6.2.3 Update . 91 oneM2M Partners Type 1 (ARIB, ATIS, CCSA, ETSI, TIA, TTA, TTC) Page 7 of 217 This is a draft oneM2M document and should not be relied upon; the final version, if any, will be made available by oneM2M Partners Type 1. 7.3.6.2.4 Delete 91 7.3.7 Resource Type 91 7.3.7.1 Introduction. 91 7.3.7.2 resource specific procedure on CRUD operations 92 7.3.7.2.1 Create 92 7.3.7.2.2 Retrieve . 92 7.3.7.2.3 Update . 93 7.3.7.2.4 Delete 93 7.3.8 Resource Type 93 7.3.8.1 Introduction. 93 7.3.8.2 resource specific procedure on CRUD operations 94