{"id":386066,"date":"2024-10-20T03:33:42","date_gmt":"2024-10-20T03:33:42","guid":{"rendered":"https:\/\/pdfstandards.shop\/product\/uncategorized\/bs-iso-iec-30118-102021\/"},"modified":"2024-10-26T06:29:29","modified_gmt":"2024-10-26T06:29:29","slug":"bs-iso-iec-30118-102021","status":"publish","type":"product","link":"https:\/\/pdfstandards.shop\/product\/publishers\/bsi\/bs-iso-iec-30118-102021\/","title":{"rendered":"BS ISO\/IEC 30118-10:2021"},"content":{"rendered":"

This document defines functional requirements for the OCF Cloud to Cloud Application Programming Interface (API).<\/p>\n

PDF Catalog<\/h4>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PDF Pages<\/th>\nPDF Title<\/th>\n<\/tr>\n
2<\/td>\nundefined <\/td>\n<\/tr>\n
7<\/td>\nForeword <\/td>\n<\/tr>\n
8<\/td>\nIntroduction <\/td>\n<\/tr>\n
10<\/td>\n1 Scope
2 Normative references <\/td>\n<\/tr>\n
11<\/td>\n3 Terms, definitions and abbreviated terms
3.1 Terms and definitions
3.2 Symbols and abbreviated terms <\/td>\n<\/tr>\n
12<\/td>\n4 Document conventions and organization
4.1 Conventions
4.2 Notation <\/td>\n<\/tr>\n
13<\/td>\n5 Overview
5.1 Introduction <\/td>\n<\/tr>\n
14<\/td>\n5.2 OCF Cloud architecture alignment with ISO IEC 17789
5.3 General OCF Cloud API for Cloud Services elements <\/td>\n<\/tr>\n
15<\/td>\n5.4 Cloud to Cloud operational overview
5.4.1 Introduction
5.4.2 Conceptual architecture
5.4.3 Authorizing OCF Cloud connectivity <\/td>\n<\/tr>\n
16<\/td>\n5.4.4 Synchronization of user’s set of Devices
5.4.5 Keeping up-to-date: Notifications of changes on other OCF Clouds
5.4.6 Handling of requests and responses for connected Devices
6 Authentication and authorization <\/td>\n<\/tr>\n
17<\/td>\n7 Account linking API
7.1 General <\/td>\n<\/tr>\n
18<\/td>\n7.2 OAuth2.0 access token scopes <\/td>\n<\/tr>\n
19<\/td>\n8 Devices API
8.1 Introduction
8.2 Parameters supported in Requests <\/td>\n<\/tr>\n
20<\/td>\n8.3 Retrieve all Devices
8.3.1 Summary <\/td>\n<\/tr>\n
21<\/td>\n8.3.2 Request and response payload <\/td>\n<\/tr>\n
22<\/td>\n8.3.3 Responses
8.4 Retrieve one Device
8.4.1 Summary <\/td>\n<\/tr>\n
23<\/td>\n8.4.2 Request and response payload
8.4.3 Responses <\/td>\n<\/tr>\n
24<\/td>\n8.5 Retrieve specific Resource
8.5.1 Summary
8.5.2 Request and response payload <\/td>\n<\/tr>\n
25<\/td>\n8.5.3 Responses
8.6 Update a Resource on a Device
8.6.1 Summary <\/td>\n<\/tr>\n
26<\/td>\n8.6.2 Request and response payload
8.6.3 Responses <\/td>\n<\/tr>\n
27<\/td>\n9 Events API
9.1 Introduction <\/td>\n<\/tr>\n
28<\/td>\n9.2 Events authentication
9.2.1 Introduction
9.2.2 Create event signature
9.2.1 Verify the event signature <\/td>\n<\/tr>\n
29<\/td>\n9.3 Parameters supported
9.4 Events API subscription and notification payload definitions
9.4.1 Subscription request <\/td>\n<\/tr>\n
30<\/td>\n9.4.2 Subscription response <\/td>\n<\/tr>\n
31<\/td>\n9.4.3 Notification request <\/td>\n<\/tr>\n
33<\/td>\n9.4.4 Notification response
9.5 Subscribe and unsubscribe to devices level event types
9.5.1 Summary <\/td>\n<\/tr>\n
34<\/td>\n9.5.2 Request and response payload
9.5.3 Responses
9.6 Subscribe and unsubscribe to device level events
9.6.1 Summary <\/td>\n<\/tr>\n
35<\/td>\n9.6.2 Request and response payload
9.6.3 Responses <\/td>\n<\/tr>\n
36<\/td>\n9.7 Subscribe and unsubscribe to resource level events
9.7.1 Summary
9.7.2 Request and response payload <\/td>\n<\/tr>\n
37<\/td>\n9.7.3 Responses
9.8 Notification of devices level events
9.8.1 Summary <\/td>\n<\/tr>\n
38<\/td>\n9.8.2 Request and response payload
9.8.3 Responses
9.9 Notification of Device level events
9.9.1 Summary <\/td>\n<\/tr>\n
39<\/td>\n9.9.2 Request and response payload
9.9.3 Responses
9.10 Notification of Resource level events
9.10.1 Summary <\/td>\n<\/tr>\n
40<\/td>\n9.10.2 Request and response payload
9.10.3 Responses <\/td>\n<\/tr>\n
41<\/td>\nAnnex A Representative flows
A.1 Introduction
A.2 OAuth2.0 application registration
A.3 Account linking <\/td>\n<\/tr>\n
42<\/td>\nA.4 Retrieval of all Devices
A.4.1 Summary
A.4.2 Flow <\/td>\n<\/tr>\n
43<\/td>\nA.4.3 Flow description
A.5 Retrieval of a single Device
A.5.1 Summary
A.5.2 Flow <\/td>\n<\/tr>\n
44<\/td>\nA.5.3 Flow description
A.6 Retrieval of a single Resource
A.6.1 Summary
A.6.2 Flows
A.6.2.1 Success path <\/td>\n<\/tr>\n
45<\/td>\nA.6.2.2 Success path flow description
A.6.2.3 Device is temporarily unavailable <\/td>\n<\/tr>\n
46<\/td>\nA.7 Update of a single Resource
A.7.1 Summary
A.7.2 Flows
A.7.2.1 Success path
A.7.2.2 Success path flow description <\/td>\n<\/tr>\n
47<\/td>\nA.7.2.3 Device is temporarily unavailable
A.8 Establishment of new subscription request
A.8.1 Summary
A.8.2 Flows <\/td>\n<\/tr>\n
48<\/td>\nA.9 Event generated for a subscription
A.9.1 Summary
A.9.2 Flows <\/td>\n<\/tr>\n
49<\/td>\nA.10 Addition of new registration
A.10.1 Summary
A.10.2 Flows
A.11 Removal of existing device registration
A.11.1 Summary
A.11.2 Flows <\/td>\n<\/tr>\n
51<\/td>\nAnnex B Open API Definition
B.1 OCF Cloud API for Cloud Services
B.1.1 Supported APIs
B.1.1.1 \/api\/v1\/devices?content=base
B.1.1.2 \/api\/v1\/devices?content=all
B.1.1.3 \/api\/v1\/devices\/subscriptions
B.1.1.4 \/api\/v1\/devices\/subscriptions\/{subscriptionId}
B.1.1.5 \/api\/v1\/devices\/{deviceId}?content=base
B.1.1.6 \/api\/v1\/devices\/{deviceId}?content=all
B.1.1.7 \/api\/v1\/devices\/{deviceId}\/subscriptions <\/td>\n<\/tr>\n
52<\/td>\nB.1.1.8 \/api\/v1\/devices\/{deviceId}\/subscriptions\/{subscriptionId}
B.1.1.9 \/api\/v1\/devices\/{deviceId}\/{resourceLinkHref}
B.1.1.10 \/api\/v1\/devices\/{deviceId}\/{resourceLinkHref}\/subscriptions
B.1.1.11 \/api\/v1\/devices\/{deviceId}\/{resourceLinkHref}\/subscriptions\/{subscriptionId}
B.1.1.12 \/{eventsUrl}
B.1.2 OpenAPI 2.0 definition <\/td>\n<\/tr>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

Information technology. Open Connectivity Foundation (OCF) Specification – Cloud API for cloud services specification<\/b><\/p>\n\n\n\n\n
Published By<\/td>\nPublication Date<\/td>\nNumber of Pages<\/td>\n<\/tr>\n
BSI<\/b><\/a><\/td>\n2021<\/td>\n74<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"featured_media":386076,"template":"","meta":{"rank_math_lock_modified_date":false,"ep_exclude_from_search":false},"product_cat":[2641],"product_tag":[],"class_list":{"0":"post-386066","1":"product","2":"type-product","3":"status-publish","4":"has-post-thumbnail","6":"product_cat-bsi","8":"first","9":"instock","10":"sold-individually","11":"shipping-taxable","12":"purchasable","13":"product-type-simple"},"_links":{"self":[{"href":"https:\/\/pdfstandards.shop\/wp-json\/wp\/v2\/product\/386066","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/pdfstandards.shop\/wp-json\/wp\/v2\/product"}],"about":[{"href":"https:\/\/pdfstandards.shop\/wp-json\/wp\/v2\/types\/product"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/pdfstandards.shop\/wp-json\/wp\/v2\/media\/386076"}],"wp:attachment":[{"href":"https:\/\/pdfstandards.shop\/wp-json\/wp\/v2\/media?parent=386066"}],"wp:term":[{"taxonomy":"product_cat","embeddable":true,"href":"https:\/\/pdfstandards.shop\/wp-json\/wp\/v2\/product_cat?post=386066"},{"taxonomy":"product_tag","embeddable":true,"href":"https:\/\/pdfstandards.shop\/wp-json\/wp\/v2\/product_tag?post=386066"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}