Newer
Older
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
title: World Storage API
description: API ensuring interoperability between an authoring tool and a World Storage service
license:
name: BSD-3-clause
url: https://opensource.org/licenses/BSD-3-Clause
servers:
- url: http://localhost:8080
paths:
/ping:
get:
summary: Test the server availability
responses:
'200':
description: OK
/admin:
get:
summary: Get the version of the API
operationId: getVersion
responses:
'200':
description: OK world storage.
content:
text/plain:
schema:
type: string
/trackables:
post:
summary: Create a trackable
operationId: addTrackable
tags:
- trackables
requestBody:
description: the trackable to be added to the world storage
required: true
content:
application/json:
schema:
responses:
'200':
description: OK returns the UUID of the Trackable defined by the world storage.
content:
text/plain:
schema:
type: string
'201':
description: Null response
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
get:
summary: returns the list of all trackables defined by the world storage.
operationId: getTrackables
tags:
- trackables
responses:
200:
description: OK returns all the Trackables defined by the world storage.
content:
application/json:
schema:
type : array
items :
201:
description: Null response
default:
description: unexpected error
content:
application/json:
schema:
/trackables/{trackableId}:
get:
summary: Find a trackable by his ID
operationId: getTrackableById
tags:
- trackables
parameters:
- name: trackableId
in: path
description: ID of the trackable to retrieve
required: true
schema:
type: string
responses:
'200':
delete:
summary: Deletes a trackable
operationId: deleteTrackable
tags:
- trackables
parameters:
- name: trackableId
in: path
description: trackable id to delete
required: true
schema:
type: string
responses:
'200':
description: OK
'400':
description: Invalid ID supplied
'404':
description: trackable not found
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
/worldAnchors:
post:
summary: Create a world anchor
operationId: addWorldAnchor
tags:
- world anchors
requestBody:
description: the world anchor to be added to the world storage
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WorldAnchor'
application/xml:
schema:
$ref: '#/components/schemas/WorldAnchor'
responses:
'200':
description: OK returns the UUID of the World Anchor defined by the world storage.
content:
text/plain:
schema:
type: string
'201':
description: Null response
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
get:
summary: returns the list of all world anchors defined by the world storage.
operationId: getWorldAnchors
tags:
- world anchors
responses:
200:
description: OK returns all the world anchors defined by the world storage.
content:
application/json:
schema:
type : array
items :
$ref: "#/components/schemas/WorldAnchor"
201:
description: Null response
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/worldAnchors/{worldAnchorId}:
get:
summary: Find a world anchor by his ID
operationId: getWorldAnchorById
tags:
- world anchors
parameters:
- name: worldAnchorId
in: path
description: ID of the world anchor to retrieve
required: true
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorldAnchor'
'400':
description: Invalid ID supplied
'404':
description: World Anchor not found
delete:
summary: Deletes a world anchor
operationId: deleteWorldAnchor
tags:
- world anchors
parameters:
- name: worldAnchorId
in: path
description: world anchor id to delete
required: true
schema:
type: string
responses:
'200':
description: OK
'400':
description: Invalid ID supplied
'404':
description: World anchor not found
/worldLinks:
post:
summary: Create a link between world anchors and trackables
operationId: addWorldLink
tags:
- world links
requestBody:
description: the link to be added to the world storage
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WorldLink'
application/xml:
schema:
$ref: '#/components/schemas/WorldLink'
responses:
'200':
description: OK returns the UUID of the link defined by the world storage.
content:
text/plain:
schema:
type: string
'201':
description: Null response
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
get:
summary: returns the list of all links defined by the world storage.
operationId: getWorldLinks
tags:
- world links
responses:
200:
description: OK returns all the worldLinks defined by the world storage.
content:
application/json:
schema:
type : array
items :
$ref: "#/components/schemas/WorldLink"
201:
description: Null response
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/worldLinks/{linkId}:
get:
summary: Find a link by his ID
operationId: getWorldLinkById
tags:
- world links
parameters:
- name: worldLinkId
in: path
description: ID of the link to retrieve
required: true
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorldLink'
'400':
description: Invalid ID supplied
'404':
description: World Link not found
delete:
summary: Deletes a worldLink
operationId: deleteWorldLink
tags:
- world links
parameters:
- name: linkId
in: path
description: link id to delete
required: true
schema:
type: string
responses:
'200':
description: OK
'400':
description: Invalid ID supplied
'404':
description: link not found
type: object
required:
- creatorUID
- trackableType
- trackableEncodingInformation
- trackablePayload
- trackableDimension
- keyvalueTagList
properties:
description: A Universally Unique IDentifier identifying the trackable
type: string
format: uuid
example: fa8bbe40-8052-11ec-a8a3-0242ac120002
creatorUID:
description: A Universally Unique IDentifier identifying the creator of the trackable
type: string
format: uuid
example: c75f6324-77a0-11ec-90d6-0242ac120003
trackableType:
description: Extensible list of trackable types possibly handled by complient World Storage implementation
type: string
enum: [FIDUCIAL_MARKER, IMAGE_MARKER, MAP, OTHER]
example: FIDUCIAL_MARKER
trackableEncodingInformation:
description: Identifies targeted framework and version of the format.
$ref: '#/components/schemas/EncodingInformationStructure'
trackablePayload:
description: The data provided to create the trackable in a specific format handled by the World Storage service.
type: string
format: byte
example: "10110101"
localCRS:
description: Coordinate reference system
$ref: '#/components/schemas/CRS'
example: [-2, 1, -3, 4,
4, 4, 4, 2,
1, 0, -2, 1,
-1, -2, 0, 0]
unit:
description: Unit of length
$ref: '#/components/schemas/UnitSystem'
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
description: Bounding box of the Trackable, {width, length, 0} for 2D trackables, {width, length, depth} for 3D trackables
$ref: '#/components/schemas/Dimension'
example: [1,5,0]
keyvalueTags:
description: List of additional parameters to be stored
$ref: '#/components/schemas/KeyvalueTagList'
example: { "author" : ["james","donovan"], "image" : ["skater"]}
WorldAnchor:
type: object
required:
- creatorUID
- localCRS
- unit
- worldAnchorDimension
- keyvalueTagList
properties:
UID:
description: A Universally Unique IDentifier identifying the world anchor
type: string
format: uuid
example: ce8ccd80-56ee-2a5c-a8a3-0242ac150d002
creatorUID:
description: A Universally Unique IDentifier identifying the creator of the world anchor
type: string
format: uuid
example: c75f6324-77a0-11ec-90d6-0242ac120003
localCRS:
description: Coordinate reference system
$ref: '#/components/schemas/CRS'
example: [-2, 1, -3, 4,
4, 4, 4, 2,
1, 0, -2, 1,
-1, -2, 0, 0]
unit:
description: Unit of length
$ref: '#/components/schemas/UnitSystem'
worldAnchorDimension:
description: Bounding box {width, length, depth}
$ref: '#/components/schemas/Dimension'
example: [1,5,0]
keyvalueTags:
description: List of additional parameters to be stored
$ref: '#/components/schemas/KeyvalueTagList'
example: { "Place" : ["Museum 1"], "room" : ["B4"]}
WorldLink:
type: object
required:
- creatorUID
- UIDA
- UIDB
- localCRS
- unit
- linkDimension
- keyvalueTags
properties:
UID:
description: A Universally Unique IDentifier identifying the link
type: string
format: uuid
example: ce8ccd80-56ee-2a5c-a8a3-0242ac150d002
creatorUID:
description: A Universally Unique IDentifier identifying the creator of the link
type: string
format: uuid
example: c75f6324-77a0-11ec-90d6-0242ac120003
UIDA:
description: A Universally Unique IDentifier identifying a world anchor or trackable
type: string
format: uuid
example: ce8ccd80-56ee-2a5c-a8a3-0242ac150d002
UIDB:
description: A Universally Unique IDentifier identifying a world anchor or trackable
type: string
format: uuid
example: ce8ccd80-56ee-2a5c-a8a3-0242ac150d002
localCRS:
description: Coordinate reference system
$ref: '#/components/schemas/CRS'
example: [-2, 1, -3, 4,
4, 4, 4, 2,
1, 0, -2, 1,
-1, -2, 0, 0]
unit:
description: Unit of length
$ref: '#/components/schemas/UnitSystem'
example: M
linkDimension:
description: Bounding box
$ref: '#/components/schemas/Dimension'
example: [1,5,0]
keyvalueTags:
description: List of additional parameters to be stored
$ref: '#/components/schemas/KeyvalueTagList'
example: { "LinkType" : ["Hierarchy"]}
EncodingInformationStructure:
required:
- dataFormat
- version
properties:
dataFormat:
description: Identifier of the target framework
type: string
enum: [HOLOLENS, ARKIT, ARCORE]
example : "HOLOLENS"
version:
description: The version of the format
type: string
example : "1.01"
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
CRS:
description: Coordinate reference system of the world anchor, a 4*4 matrix (rowmajor) represented by a float vector
type: array
minItems: 16
maxItems: 16
items:
type: number
format: float
UnitSystem:
description: Unit of length
type: string
enum: [MM, CM, DM, M, DAM, HM, KM, INCH, FOOT, YARD, MILE]
Dimension:
description: Bounding box {width, length, depth}
type: array
items:
type: number
format: double
minItems: 3
maxItems: 3
example: [1,5,0]
KeyvalueTagList:
description: List of additional parameters to be stored with the trackable.
type: object
additionalProperties:
type: array
items:
type: string
minItems: 1
example: { "Place" : ["Museum 1"], "room" : ["B4"]}
Error:
required:
- code
- message
properties:
code:
type: integer
format: int32
message: