BSI 23/30469606 DC 2023
$45.21
BS EN 14908-10. Open Data Communication in Building Automation, Controls and Building Management. Control Network Protocol – Part 10. Web Services for Control Networking Protocol Specification
Published By | Publication Date | Number of Pages |
BSI | 2023 | 454 |
PDF Catalog
PDF Pages | PDF Title |
---|---|
1 | 30469606-NC.pdf |
3 | 41_e_stf.pdf |
14 | 1 Scope 2 Normative references 3 Terms and definitions |
15 | 4 IAP API FUNDAMENTALS 4.1 IAP API Overview |
16 | 4.2 IAP/MQ Fundamentals 4.2.1 IAP/MQ Overview 4.2.2 MQTT in IAP 4.2.3 Supported MQTT Version |
17 | 4.2.4 IAP/MQ Topics 4.2.5 Persistent Clients vs Transient Clients 4.2.6 Client Expiration 4.2.7 Message Payload |
18 | 4.2.8 CMS Connectivity 4.2.9 An IAP Site 4.3 Partial Object Assignment 4.3.1 Definition |
19 | 4.3.2 Edge Servers and Partial Object Assignment 4.3.3 Timestamps in IAP |
20 | 4.3.4 Most Recently Used (MRU) Timestamp 4.4 IAP/MQ Topic Syntax 4.4.1 Syntax elements |
25 | 4.4.2 Device Syntax |
27 | 4.4.3 Wildcards 4.5 IAP/REST Fundamentals 4.5.1 REST Overview |
28 | 4.5.2 REST in IAP 4.5.3 Making IAP/REST Calls 4.6 IAP/REST Syntax |
30 | 4.7 Queries and Parameters |
32 | 4.8 Path Parameters |
33 | 4.9 Query Parameters |
34 | 4.10 IAP/WS Fundamentals |
35 | 4.11 Data Log Websocket Queries and Parameters 4.11.1 Data Log Websocket Overview 4.11.2 Key 4.11.3 Operator 4.11.4 Value 4.11.5 Regular Expression Encoding |
36 | 5 IAP/MQ API 5.1 Overview |
37 | 5.2 About 5.2.1 Definition 5.2.2 Example |
38 | 5.2.3 Properties |
42 | 5.3 Alarm 5.3.1 Definition |
43 | 5.3.2 Example |
44 | 5.3.3 Alarm Configuration 5.3.4 Alarm Status |
45 | 5.3.5 Examples 5.3.6 Alarm PropertiesĀ |
46 | 5.3.7 Alarm Actions |
48 | 5.3.8 Alarm Conditions 5.3.8.1 Definition 5.3.8.2 Comparison FunctionsĀ |
49 | 5.3.8.3 Updated and Changed Functions |
50 | 5.3.8.4 Recent Function 5.3.8.5 Executing Alarm Conditions 5.3.8.6 System Alarm Conditions 5.3.9 Manage Alarms |
51 | 5.4 Connections 5.4.1 Definition 5.4.2 Connection Implementation |
52 | 5.4.3 Connection with Datapoint Presets 5.4.4 Connection Objects 5.4.4.1 Object definition 5.4.4.2 Connection Status Properties |
53 | 5.4.4.3 Connection Configuration Properties |
58 | 5.4.5 Connection Do Actions 5.4.5.1 Object definition |
59 | 5.4.5.2 Do Action Arguments |
60 | 5.4.5.3 Example: Create and Deploy a Connection |
61 | 5.4.6 Connection Types 5.4.6.1 Connection Type Definition 5.4.6.2 Peer-to-Peer |
62 | 5.4.6.3 Simple Point-to-Point 5.4.7 Type Translation 5.4.7.1 Type Translation Overview |
64 | 5.4.7.2 Numeric Functions 5.4.7.3 String Functions |
65 | 5.4.7.4 The Constant Transformation Type 5.4.7.5 TheĀ Enumeration Transformation Type |
66 | 5.5 Data Type Definitions 5.5.1 Definition 5.5.2 Data Type References |
67 | 5.5.3 About IAP Data Types 5.5.3.1 Comprehensive and Unambiguous 5.5.3.2 JSON Schema 5.5.3.3 Type Attributes 5.5.3.4 Flat Data Type DefinitionĀ |
68 | 5.5.3.5 Profiles 5.5.4 Data Type General Information 5.5.4.1 Datapoint and Property Types 5.5.4.2 Profiles 5.5.4.3 Enumerations |
69 | 5.5.4.4 Applications 5.5.4.5 Type Names and Sets 5.5.4.6 Type References 5.5.5 Data Type Presentation and Formatting 5.5.5.1 Presentation and Formatting Overview 5.5.5.2 Invalid Values |
70 | 5.5.5.3 Out-of-Range Values 5.5.5.4 Rounding 5.5.5.5 Unknown Types 5.6 Device 5.6.1 Definition |
71 | 5.6.2 DeviceĀ Objects |
72 | 5.6.3 Device Configuration 5.6.3.1 Definition 5.6.3.2 Example 5.6.3.3 Parameters |
73 | 5.6.4 Device Do Action 5.6.4.1 Definition 5.6.4.2 Device Do ActionĀ Properties |
77 | 5.6.4.3 Add Action Properties |
78 | 5.6.4.4 Create Action Properties |
80 | 5.6.4.5 Message Action Properties |
82 | 5.6.4.6 Provision Action Properties |
83 | 5.6.4.7 Remove Action Properties 5.6.4.8 Replace Action Properties |
84 | 5.6.5 Device Interface 5.6.6 Device Status |
86 | 5.6.7 Dynamic Interfaces 5.6.7.1 Dynamic Interfaces Overview 5.6.7.2 Adding a Block |
87 | 5.6.7.3 Adding a Datapoint or Property |
88 | 5.6.7.4 Removing a Block 5.6.8 Implementation Detail Object 5.6.8.1 Definition |
89 | 5.6.8.2 During a Segment Replacement |
90 | 5.6.8.3 Edge Server Replacement 5.7 Discovery |
92 | 5.8 Discovery and Provisioning Details 5.8.1 Device Discovery 5.8.1.1 Definition |
93 | 5.8.1.2 Discovery Capability 5.8.1.3 Discovery Methods |
95 | 5.8.1.4 Device Discovery Event Properties |
96 | 5.8.2 Segment Discovery 5.8.2.1 Definition 5.8.2.2 Edge Server MACID |
97 | 5.8.2.3 Discovery Process 5.8.3 Segment Provisioning 5.8.3.1 Definition 5.8.3.2 Segment Provision Properties |
99 | 5.8.3.3 Referral Message 5.8.4 Segment Discovery Message 5.8.4.1 Definition |
100 | 5.8.4.2 Properties |
102 | 5.9 Events 5.9.1 Definition |
103 | 5.9.2 Data Events 5.9.3 Join Events |
104 | 5.9.4 Tracing 5.9.5 Event Object Properties |
107 | 5.9.6 Created Event |
109 | 5.9.7 Deleted Event |
110 | 5.9.8 Updated Event |
111 | 5.10 Group 5.10.1 Definition |
112 | 5.10.2 Group Characteristics 5.10.3 Group Examples |
114 | 5.10.4 IAP Groups 5.10.4.1 IAP Groups Overview |
115 | 5.10.4.2 Group Object Properties |
116 | 5.10.5 self.add 5.10.5.1 self.add Overview 5.10.5.2 Group Add Actions |
117 | 5.10.5.3 Example 5.10.6 self.create 5.10.6.1 Group Create Action |
118 | 5.10.6.2 Example 5.10.7 self.delete 5.10.7.1 self.delete Overview 5.10.7.2 Group Delete Action |
119 | 5.10.7.3 Example 5.10.8 self.provision 5.10.8.1 self.provision Overview 5.10.8.2 Group Provision Action |
120 | 5.10.8.3 Example 5.10.9 self.remove 5.10.9.1 self.remove Overview 5.10.9.2 Group Remove Actions 5.11 Handle Allocation 5.11.1 Definition |
121 | 5.11.2 Handle Allocation Service |
122 | 5.11.3 Handle Request 5.11.4 Handle Response |
123 | 5.11.5 Example 5.12 Interface Blocks 5.12.1 Definition |
124 | 5.12.2 Interface Topics 5.12.3 Block Object Properties |
125 | 5.12.4 Datapoint Objects |
132 | 5.12.5 Datapoint Presets 5.12.5.1 Datapoint Presets Overview 5.12.5.2 Using Presets andĀ Localization Together 5.12.5.3 The Presets Object |
135 | 5.12.5.4 The Presets Property |
136 | 5.12.5.5 Examples |
140 | 5.12.6 Datapoint Localization 5.12.6.1 Datapoint Localization Overview 5.12.6.2 Using Localization and Presets Together |
141 | 5.12.6.3 The Localization Object |
143 | 5.12.6.4 Transformations |
144 | 5.12.6.5 Examples |
145 | 5.12.7 Monitor Preference Object |
149 | 5.12.8 Working with Datapoint Values 5.12.8.1 Regular Datapoints and Configuration Datapoints 5.12.8.2 Actual Value 5.12.8.3 Present Value |
150 | 5.12.8.4 Normal Value 5.12.8.5 Default Value 5.12.8.6 Override Values and Priorities 5.12.8.7 Creating an Override Value |
152 | 5.12.8.8 Values are Atomic 5.12.8.9 Property Datapoints |
153 | 5.12.9 Working with Unions 5.12.9.1 Background 5.12.9.2 Presenting Unions 5.12.9.3 Writing Unions |
154 | 5.12.9.4 Unions in Datapoint Connections 5.13 License Services 5.13.1 License Service Overview 5.13.2 Actions |
155 | 5.13.2.1 set Action |
157 | 5.13.2.2 refresh Action |
158 | 5.13.2.3 revoke Action |
159 | 5.13.2.4 download Action |
160 | 5.13.3 Capacity 5.13.3.1 Definition |
161 | 5.13.3.2 Managing Licensing for Individual Devices |
162 | 5.13.4 Cloud |
164 | 5.13.5 Configuration |
165 | 5.13.6 License Management 5.13.6.1 General Information 5.13.6.2 Online Activation |
166 | 5.13.6.3 Offline Activation |
167 | 5.13.6.4 Transfer License 5.13.7 Status |
169 | 5.14 Load Do Action 5.14.1 Definition 5.14.2 Outer Image File |
170 | 5.14.3 Load Procedure 5.14.3.1 Load Procedure Overview 5.14.3.2 Load a Single Edge Device 5.14.3.3 Load Multiple Edge Devices 5.14.3.4 Load Many Edge Devices 5.14.3.5 Load an Edge Server |
171 | 5.14.3.6 Schedule a Load 5.14.4 The Load Object 5.14.5 Inner Image File Example |
172 | 5.14.6 Load Action and Manifest Properties |
178 | 5.15 On-Demand Monitoring 5.15.1 Definition |
179 | 5.15.2 On-Demand Datapoint Monitoring Request |
180 | 5.15.3 On-Demand Datapoint Monitoring Response 5.15.4 On-Demand Monitoring Service Collaboration |
181 | 5.15.5 Item Poll Request 5.15.6 Item Poll Response |
182 | 5.16 Query 5.16.1 Definition 5.16.2 Query Request Properties |
184 | 5.16.3 Query Response 5.16.3.1 Query Response Overview 5.16.3.2 Query Response Properties |
185 | 5.16.4 Filtering 5.16.4.1 Filtering Overview |
186 | 5.16.4.2 Filtering Operators 5.17 Schedule Services 5.17.1 Schedule Services Overview |
187 | 5.17.2 Schedule Algorithm |
188 | 5.17.3 Schedule Object 5.17.3.1 Definition 5.17.3.2 Schedule Actions 5.17.3.3 Schedule Status Object 5.17.3.4 Properties |
189 | 5.17.3.5 Schedule Configuration Object 5.17.3.6 Properties |
191 | 5.17.4 Calendar Object 5.17.4.1 Definition 5.17.4.2 Calendar Actions |
192 | 5.17.5 Calendar Status Object 5.17.5.1 Definition 5.17.5.2 Calendar Status Object Properties |
193 | 5.17.5.3 Calendar Configuration Object 5.17.5.4 Calendar Configuration Object Properties 5.17.5.5 Calendar Configuration Object Example: Holidays |
194 | 5.17.6 Dates in Schedules and Calendars 5.17.7 Specifying Dates 5.17.7.1 Specifying Dates Overview 5.17.7.2 Single Date Object |
195 | 5.17.7.3 Date Range Object |
196 | 5.17.7.4 Week-and-Day Date Object |
198 | 5.17.7.5 Date Reference Object 5.17.8 Weekly Schedule 5.17.8.1 Weekly Schedule Overview |
199 | 5.17.8.2 Time 5.17.9 Exception Schedule 5.17.9.1 Exception Schedule Overview |
200 | 5.17.9.2 Special Event Object |
201 | 5.18 Segment Configuration 5.18.1 Definition |
202 | 5.18.2 Segment Configuration PropertiesĀ |
207 | 5.18.3 Location Object 5.18.3.1 Location Object Overview 5.18.3.2 Example 5.18.3.3 Properties |
208 | 5.19 Segment Do Actions 5.19.1 Definition 5.19.2 Action Objects 5.19.2.1 Action Objects Overview |
209 | 5.19.2.2 Import Action |
210 | 5.19.2.3 Import Open |
211 | 5.19.2.4 Import Close |
212 | 5.19.2.5 Import Begin |
213 | 5.19.2.6 Import End |
214 | 5.19.2.7 Import Cancel |
215 | 5.19.2.8 Import Ping 5.20 Segment Status 5.20.1 Definition 5.20.2 Example |
216 | 5.20.3 Properties 6 IAP/REST API 6.1 IAP/REST Overview 6.2 Access 6.2.1 URI Definition |
218 | 6.2.2 Query Parameters 6.3 Alarms 6.3.1 URI Definition |
233 | 6.3.2 Query Parameters 6.4 Authentication (Login/Logout) 6.4.1 URI Definition |
235 | 6.4.2 Query Parameters 6.4.3 Example |
236 | 6.5 Capabilities 6.5.1 URI Definition |
239 | 6.5.2 Query Parameters 6.6 Connection 6.6.1 URI Definition 6.6.2 Parameters 6.6.3 Query Parameters |
240 | 6.6.4 Examples 6.7 Context 6.7.1 Context Overview 6.7.2 Context – Contextual Entity Relationship |
241 | 6.7.3 Device Assignment 6.7.4 URI Definition |
247 | 6.8 Customers 6.8.1 URI Definition |
251 | 6.8.2 Query Parameters 6.8.3 Examples |
252 | 6.9 Datapoint Categories 6.9.1 URI Definition 6.9.2 Queries |
254 | 6.10 Datapoint Default Values 6.10.1 URI Definition |
256 | 6.10.2 Queries |
258 | 6.10.3 Example |
259 | 6.11 Datapoint Favorites 6.11.1 URI Definition |
261 | 6.11.2 Query Parameters 6.12 Datapoint Logs 6.12.1 Overview |
262 | 6.12.2 URI Definition |
266 | 6.12.3 Queries |
267 | 6.12.4 Logging Configuration 6.12.5 Datapoint Log Value |
269 | 6.13 Datapoint Monitor 6.13.1 Overview |
270 | 6.13.2 URI Definition |
273 | 6.13.3 Queries |
275 | 6.14 Datapoint Overrides 6.14.1 Overview 6.14.2 URI Definition |
277 | 6.14.3 Queries |
279 | 6.15 Datapoint Override State 6.15.1 URI Definition |
280 | 6.15.2 Queries |
281 | 6.16 Datapoint Override Value 6.16.1 Overview |
282 | 6.16.2 IAP/MQ Mapping 6.16.3 URI Definition |
283 | 6.16.4 Queries |
284 | 6.16.5 Example |
285 | 6.17 Datapoint Properties 6.17.1 URI Definition |
286 | 6.17.2 Queries |
287 | 6.17.3 Examples |
289 | 6.18 Datapoint Tags 6.18.1 Overview 6.18.2 URI Definition |
290 | 6.18.3 Queries |
292 | 6.19 Datapoint Type 6.19.1 Overview 6.19.2 IAP/MQ Mapping 6.19.3 URI Definition |
295 | 6.19.4 Queries |
297 | 6.20 Datapoint Value 6.20.1 URI Definition |
298 | 6.20.2 Queries |
300 | 6.20.3 Examples |
302 | 6.21 Device Capabilities 6.21.1 URI Definition |
306 | 6.21.2 Query Parameters |
307 | 6.22 Device Types 6.22.1 URI Definition |
320 | 6.23 Devices 6.23.1 URI Definition |
349 | 6.23.2 Query Parameters |
351 | 6.23.3 Example |
353 | 6.24 Diagnostics 6.24.1 URI Definition |
354 | 6.24.2 Query Parameters 6.25 DLA Files 6.25.1 URI Definition |
357 | 6.25.2 Queries |
360 | 6.26 Drivers 6.26.1 URI Definition |
364 | 6.27 Floorplans 6.27.1 URI Definition |
369 | 6.27.2 Query Parameters 6.28 Geozone 6.28.1 URI Definition |
378 | 6.28.2 Query Parameters 6.29 Groups 6.29.1 URI Definition |
387 | 6.29.2 Group Queries |
390 | 6.30 Log Destination 6.30.1 URI Definition 6.30.2 Query Parameters |
391 | 6.31 Log Events 6.31.1 Log Events Overview 6.31.2 URI Definition |
394 | 6.31.3 Query Parameters 6.31.4 Event Log Path Parameters |
396 | 6.31.5 Examples |
398 | 6.32 Log State 6.32.1 URI Definition |
399 | 6.32.2 Query Parameters 6.33 Log Status 6.33.1 URI Definition |
400 | 6.33.2 Query Parameters 6.33.3 Example 6.34 On-Demand 6.34.1 URIĀ Definition |
401 | 6.35 Permissions 6.35.1 URIĀ Definition |
402 | 6.35.2 Query Parameters 6.35.3 Example Response 6.36 Presets 6.36.1 URIĀ Definition |
404 | 6.36.2 QueryĀ Parameters 6.37 Protocols 6.37.1 URIĀ Definition |
408 | 6.38 Reports 6.38.1 URIĀ Definition |
418 | 6.38.2 Query Parameters |
419 | 6.39 Roles 6.39.1 URIĀ Definition |
420 | 6.39.2 Query Parameters 6.40 Schedule Service 6.40.1 URI Definition |
426 | 6.40.2 Schedule Service Query and Path Parameters 6.40.3 Schedule Path Parameters |
427 | 6.40.4 Schedule Service Examples |
431 | 6.41 SMTP Configuration 6.41.1 URI Definition |
432 | 6.41.2 Query Parameters |
433 | 6.42 Transformation Service 6.42.1 URI Definition |
434 | 6.43 Trend Log 6.43.1 URI Definition |
437 | 6.44 Users 6.44.1 URI Definition |
442 | 6.44.2 Query Parameters 6.44.3 Examples |
443 | 6.45 Version 6.45.1 URI Definition |
444 | 6.45.2 Query Parameters 6.45.3 Example |
445 | 6.46 Zones 6.46.1 URI Definition |
450 | 6.46.2 Query Parameters 6.46.3 Zone Path Parameters |
451 | 7 IAP/WS API 7.1 IAP/WS Overview 7.2 General Purpose WebSocket 7.3 Data Log WebSocket |
452 | 7.4 Examples 7.4.1 Example 1 |
453 | 7.4.2 Example 2 |