OCF Core Specification VERSION 2.1.0 | November 2019 CONTACT [email protected] Copyright Open Connectivity Foundation, Inc. © 2019 All Rights Reserved. 2 Legal Disclaimer 3 4 NOTHING CONTAINED IN THIS DOCUMENT SHALL BE DEEMED AS GRANTING YOU ANY 5 KIND OF LICENSE IN ITS CONTENT, EITHETable-Annex A.1R EXPRESSLY OR IMPLIEDLY, 6 OR TO ANY INTELLECTUAL PROPERTY OWNED OR CONTROLLED BY ANY OF THE 7 AUTHORS OR DEVELOPERS OF THIS DOCUMENT. THE INFORMATION CONTAINED HEREIN 8 IS PROVIDED ON AN "AS IS" BASIS, AND TO THE MAXIMUM EXTENT PERMITTED BY 9 APPLICABLE LAW, THE AUTHORS AND DEVELOPERS OF THIS SPECIFICATION HEREBY 10 DISCLAIM ALL OTHER WARRANTIES AND CONDITIONS, EITHER EXPRESS OR IMPLIED, 11 STATUTORY OR AT COMMON LAW, INCLUDING, BUT NOT LIMITED TO, IMPLIED 12 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. OPEN 13 CONNECTIVITY FOUNDATION, INC. FURTHER DISCLAIMS ANY AND ALL WARRANTIES OF 14 NON-INFRINGEMENT, ACCURACY OR LACK OF VIRUSES. 15 The OCF logo is a trademark of Open Connectivity Foundation, Inc. in the United States or other 16 countries. *Other names and brands may be claimed as the property of others. 17 Copyright © 2016-2019 Open Connectivity Foundation, Inc. All rights reserved. 18 Copying or other form of reproduction and/or distribution of these works are strictly prohibited. 19 Copyright Open Connectivity Foundation, Inc. © 2016-2019. All rights Reserved 20 CONTENTS 21 1 Scope .............................................................................................................................. 1 22 2 Normative references ...................................................................................................... 1 23 3 Terms, definitions, and abbreviated terms ....................................................................... 3 24 3.1 Terms and definitions.............................................................................................. 3 25 3.2 Abbreviated terms ................................................................................................... 7 26 4 Document conventions and organization .......................................................................... 8 27 4.1 Conventions ............................................................................................................ 8 28 4.2 Notation .................................................................................................................. 8 29 4.3 Data types .............................................................................................................. 9 30 5 Architecture ................................................................................................................... 11 31 5.1 Overview .............................................................................................................. 11 32 5.2 Principle ............................................................................................................... 11 33 5.3 Functional block diagram ...................................................................................... 12 34 5.4 Framework ............................................................................................................ 14 35 6 Identification and addressing ......................................................................................... 14 36 6.1 Introduction ........................................................................................................... 14 37 6.2 Identification ......................................................................................................... 15 38 6.2.1 Device and Platform identification .................................................................. 15 39 6.2.2 Resource identification and addressing ......................................................... 15 40 6.3 Namespace: .......................................................................................................... 16 41 6.4 Network addressing .............................................................................................. 16 42 7 Resource model ............................................................................................................ 17 43 7.1 Introduction ........................................................................................................... 17 44 7.2 Resource .............................................................................................................. 18 45 7.3 Property ................................................................................................................ 18 46 7.3.1 Introduction ................................................................................................... 18 47 7.3.2 Common Properties ....................................................................................... 19 48 7.4 Resource Type ..................................................................................................... 20 49 7.4.1 Introduction ................................................................................................... 20 50 7.4.2 Resource Type Property ................................................................................ 21 51 7.4.3 Resource Type definition ............................................................................... 21 52 7.4.4 Multi-value "rt" Resource ............................................................................... 23 53 7.5 Device Type .......................................................................................................... 23 54 7.6 OCF Interface ....................................................................................................... 24 55 7.6.1 Introduction ................................................................................................... 24 56 7.6.2 OCF Interface Property .................................................................................. 24 57 7.6.3 OCF Interface methods .................................................................................. 25 58 7.7 Resource representation ....................................................................................... 43 59 7.8 Structure ............................................................................................................... 43 60 7.8.1 Introduction ................................................................................................... 43 61 7.8.2 Resource relationships (Links) ....................................................................... 43 62 7.8.3 Collections..................................................................................................... 49 Copyright Open Connectivity Foundation, Inc. © 2016-2019. All rights Reserved 63 7.8.4 Atomic Measurement ..................................................................................... 51 64 7.9 Query Parameters ................................................................................................. 53 65 7.9.1 Introduction ................................................................................................... 53 66 7.9.2 Use of multiple parameters within a query ..................................................... 53 67 7.9.3 Application to multi-value "rt" Resources ....................................................... 53 68 7.9.4 OCF Interface specific considerations for queries .......................................... 54 69 8 CRUDN ......................................................................................................................... 54 70 8.1 Overview .............................................................................................................. 54 71 8.2 CREATE ............................................................................................................... 55 72 8.2.1 Overview ....................................................................................................... 55 73 8.2.2 CREATE request ........................................................................................... 55 74 8.2.3 Processing by the Server ............................................................................... 55 75 8.2.4 CREATE response ......................................................................................... 56 76 8.3 RETRIEVE ............................................................................................................ 56 77 8.3.1 Overview ....................................................................................................... 56 78 8.3.2 RETRIEVE request ........................................................................................ 56 79 8.3.3 Processing by the Server ............................................................................... 56 80 8.3.4 RETRIEVE response ..................................................................................... 56 81 8.4 UPDATE ............................................................................................................... 57 82 8.4.1 Overview ....................................................................................................... 57 83 8.4.2 UPDATE request ........................................................................................... 57 84 8.4.3 Processing by the Server ............................................................................... 57 85 8.4.4 UPDATE response ......................................................................................... 58 86 8.5 DELETE ...............................................................................................................