🔥🔥 Don’t Miss Out on Our End of Autumn Sale. If you have any questions, feel free to click the bottom right corner to contact our customer service..

Concat us[email protected]
Shopping Cart

No products in the cart.

🔍
BS ISO/IEC 30118-10:2021

BS ISO/IEC 30118-10:2021

$215.11

Information technology. Open Connectivity Foundation (OCF) Specification – Cloud API for cloud services specification

Published By Publication Date Number of Pages
BSI 2021 74
PDF Format Searchable Printable Preview Now
Guaranteed Safe Checkout
Category:

If you have any questions, feel free to reach out to our online customer service team by clicking on the bottom right corner. We’re here to assist you 24/7.
Email:[email protected]

This document defines functional requirements for the OCF Cloud to Cloud Application Programming Interface (API).

PDF Catalog

PDF Pages PDF Title
2 undefined
7 Foreword
8 Introduction
10 1 Scope
2 Normative references
11 3 Terms, definitions and abbreviated terms
3.1 Terms and definitions
3.2 Symbols and abbreviated terms
12 4 Document conventions and organization
4.1 Conventions
4.2 Notation
13 5 Overview
5.1 Introduction
14 5.2 OCF Cloud architecture alignment with ISO IEC 17789
5.3 General OCF Cloud API for Cloud Services elements
15 5.4 Cloud to Cloud operational overview
5.4.1 Introduction
5.4.2 Conceptual architecture
5.4.3 Authorizing OCF Cloud connectivity
16 5.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
17 7 Account linking API
7.1 General
18 7.2 OAuth2.0 access token scopes
19 8 Devices API
8.1 Introduction
8.2 Parameters supported in Requests
20 8.3 Retrieve all Devices
8.3.1 Summary
21 8.3.2 Request and response payload
22 8.3.3 Responses
8.4 Retrieve one Device
8.4.1 Summary
23 8.4.2 Request and response payload
8.4.3 Responses
24 8.5 Retrieve specific Resource
8.5.1 Summary
8.5.2 Request and response payload
25 8.5.3 Responses
8.6 Update a Resource on a Device
8.6.1 Summary
26 8.6.2 Request and response payload
8.6.3 Responses
27 9 Events API
9.1 Introduction
28 9.2 Events authentication
9.2.1 Introduction
9.2.2 Create event signature
9.2.1 Verify the event signature
29 9.3 Parameters supported
9.4 Events API subscription and notification payload definitions
9.4.1 Subscription request
30 9.4.2 Subscription response
31 9.4.3 Notification request
33 9.4.4 Notification response
9.5 Subscribe and unsubscribe to devices level event types
9.5.1 Summary
34 9.5.2 Request and response payload
9.5.3 Responses
9.6 Subscribe and unsubscribe to device level events
9.6.1 Summary
35 9.6.2 Request and response payload
9.6.3 Responses
36 9.7 Subscribe and unsubscribe to resource level events
9.7.1 Summary
9.7.2 Request and response payload
37 9.7.3 Responses
9.8 Notification of devices level events
9.8.1 Summary
38 9.8.2 Request and response payload
9.8.3 Responses
9.9 Notification of Device level events
9.9.1 Summary
39 9.9.2 Request and response payload
9.9.3 Responses
9.10 Notification of Resource level events
9.10.1 Summary
40 9.10.2 Request and response payload
9.10.3 Responses
41 Annex A Representative flows
A.1 Introduction
A.2 OAuth2.0 application registration
A.3 Account linking
42 A.4 Retrieval of all Devices
A.4.1 Summary
A.4.2 Flow
43 A.4.3 Flow description
A.5 Retrieval of a single Device
A.5.1 Summary
A.5.2 Flow
44 A.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
45 A.6.2.2 Success path flow description
A.6.2.3 Device is temporarily unavailable
46 A.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
47 A.7.2.3 Device is temporarily unavailable
A.8 Establishment of new subscription request
A.8.1 Summary
A.8.2 Flows
48 A.9 Event generated for a subscription
A.9.1 Summary
A.9.2 Flows
49 A.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
51 Annex 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
52 B.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

Related products

BS ISO/IEC 30118-10:2021
$215.11