-
Notifications
You must be signed in to change notification settings - Fork 36
/
bSDD OpenAPI.yaml
6702 lines (6702 loc) · 223 KB
/
bSDD OpenAPI.yaml
1
2
3
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
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
460
461
462
463
464
465
466
467
468
469
470
471
472
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
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: Dictionaries API
description: >-
<p>API to access the buildingSMART Data Dictionary.</p><p>For manually
uploading import files, please go to <a
href="https://manage.bsdd.buildingsmart.org">bSDD Management portal</a>.
Version history can be found at <a
href="https://github.com/buildingSMART/bSDD/blob/master/API%20version%20history.md">Version
history</a>.</p><p>Keep an eye on (planned) updates: <a
href="https://forums.buildingsmart.org/t/bsdd-tech-updates/4889">bSDD tech
updates</a></p><h3>For client developers</h3><p>If you're creating a desktop
client that only calls the not secured APIs, you're ready to go.<br/>If you
don't use the secured APIs but want to call the other APIs from your website
or SPA, then we need the URL of your website to allow CORS.</p><p>If you are
going to build a client that is going to use secured APIs, you must request
a Client ID. You can do so by sending us an email and give:</p><ul><li>the
name of the client application</li><li>type of application:<ul><li>Web
application</li><li>Single-page application</li><li>iOS / macOS, Object-C,
Swift, Xamarin</li><li>Adroid - Java, Kotlin,
Xamarin</li><li>Mobile/desktop</li></ul> <li>which development language are
you using? (sometimes the redirectUri to be configured depends on the used
library)</li><li>if it is a website or SPA, specify the return url (the
login page will redirect to this url after user has logged in)</li></ul>
contact:
name: Support
url: https://github.com/buildingSMART/bSDD
email: bsdd_support@buildingsmart.org
license:
name: MIT license
url: >-
https://bsddprototype2020.blob.core.windows.net/public/Copyright_2020_buildingSMART_International.txt
version: v1
servers:
- url: https://api.bsdd.buildingsmart.org/
paths:
/api/Class/v1:
get:
tags:
- Class
summary: "Get Class details - this API replaces api/Classification\r\nChanges:\r\n- now returns Material as well\r\n- \"Classification\" has been renamed to \"Class\"\r\n- \"Domain\" has been renamed to \"Dictionary\"\r\n- \"NamespaceUri\" has been renamed to \"Uri\""
parameters:
- name: Uri
in: query
description: >-
URI of the class, e.g.
https://identifier.buildingsmart.org/uri/bs-agri/fruitvegs/1.1/class/apple
required: true
schema:
type: string
- name: IncludeClassProperties
in: query
description: >-
Use this option to include properties of the class. By default it is
set to false
schema:
type: boolean
- name: IncludeChildClassReferences
in: query
description: >-
Use this option to include references to child classes. By default
it is set to false
schema:
type: boolean
- name: IncludeClassRelations
in: query
description: >-
Use this option to include loading relations of the class. By
default it is set to false
schema:
type: boolean
- name: IncludeReverseRelations
in: query
description: >-
Use this option to include loading reverse relations of the class,
i.e. classes having a relation with this class. By default it is set
to false
schema:
type: boolean
- name: ReverseRelationDictionaryUris
in: query
description: >-
When including reverse relations, you can specify which dictionaries
to include. By default all dictionaries are included
schema:
type: array
items:
type: string
- name: languageCode
in: query
description: >-
Specify language (case sensitive). For those items the text is not
available in the requested language, the text will be returned in
the default language of the dictionary
schema:
type: string
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/ClassContract.v1'
application/json:
schema:
$ref: '#/components/schemas/ClassContract.v1'
text/json:
schema:
$ref: '#/components/schemas/ClassContract.v1'
application/xml:
schema:
$ref: '#/components/schemas/ClassContract.v1'
text/xml:
schema:
$ref: '#/components/schemas/ClassContract.v1'
text/html:
schema:
$ref: '#/components/schemas/ClassContract.v1'
text/turtle:
schema:
$ref: '#/components/schemas/ClassContract.v1'
application/x-turtle:
schema:
$ref: '#/components/schemas/ClassContract.v1'
application/rdf+xml:
schema:
$ref: '#/components/schemas/ClassContract.v1'
/api/Dictionary/v1:
get:
tags:
- Dictionary
summary: "Get list of available Dictionaries. This one replaces /api/Domain. Changes:\r\n- \"Domain\" has been renamed to \"Dictionary\"\r\n- \"NamespaceUri\" has been renamed to \"Uri\""
parameters:
- name: Uri
in: query
description: "Optional parameter to filter by first part of URI. Use this one to get details of just one dictionary version\r\nor, if you leave out the version number at the end, get all the versions of a dictionary.\r\nExample: https://identifier.buildingsmart.org/uri/bs-agri/fruitvegs/"
schema:
type: string
- name: IncludeTestDictionaries
in: query
description: "Should test dictionaries be included in the result? By default it is set to false.\r\nThis option is ignored if you specify a URI."
schema:
type: boolean
- name: Offset
in: query
description: Zero-based offset of the first item to be returned. Default is 0.
schema:
type: integer
format: int32
- name: Limit
in: query
description: >-
Limit number of items to be returned. If you enter an offset then
default limit is 100. The maximum number of items returned is 1000.
schema:
type: integer
format: int32
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/DictionaryResponseContract.v1'
application/json:
schema:
$ref: '#/components/schemas/DictionaryResponseContract.v1'
text/json:
schema:
$ref: '#/components/schemas/DictionaryResponseContract.v1'
application/xml:
schema:
$ref: '#/components/schemas/DictionaryResponseContract.v1'
text/xml:
schema:
$ref: '#/components/schemas/DictionaryResponseContract.v1'
text/html:
schema:
$ref: '#/components/schemas/DictionaryResponseContract.v1'
text/turtle:
schema:
$ref: '#/components/schemas/DictionaryResponseContract.v1'
application/x-turtle:
schema:
$ref: '#/components/schemas/DictionaryResponseContract.v1'
application/rdf+xml:
schema:
$ref: '#/components/schemas/DictionaryResponseContract.v1'
/api/Dictionary/v1/Classes:
get:
tags:
- Dictionary
summary: "Get Dictionary with tree of classes.\r\nThis one replaces /api/Domain. See https://github.com/buildingSMART/bSDD/blob/master/Documentation/API%20version%20history.md for changes."
parameters:
- name: Uri
in: query
description: >-
The URI of the dictionary. The option "latest" is supported, e.g.
https://identifier.buildingsmart.org/uri/bs-agri/fruitvegs/latest
required: true
schema:
type: string
- name: UseNestedClasses
in: query
description: "Set to true to get classes in a nested structure.\r\nYou can't use this option if you are using pagination."
schema:
type: boolean
- name: ClassType
in: query
description: >-
Optional filter on class type. Possible values are "Class",
"GroupOfProperties", "AlternativeUse" and "Material".
schema:
type: string
- name: Offset
in: query
description: Zero-based offset of the first item to be returned. Default is 0.
schema:
type: integer
format: int32
- name: Limit
in: query
description: >-
Limit number of items to be returned. If you enter an offset then
default limit is 100. The maximum number of items returned is 1000.
schema:
type: integer
format: int32
- name: languageCode
in: query
description: >-
Specify language (case sensitive). For those items the text is not
available in the requested language, the text will be returned in
the default language of the dictionary
schema:
type: string
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/DictionaryClassesResponseContract.v1'
application/json:
schema:
$ref: '#/components/schemas/DictionaryClassesResponseContract.v1'
text/json:
schema:
$ref: '#/components/schemas/DictionaryClassesResponseContract.v1'
application/xml:
schema:
$ref: '#/components/schemas/DictionaryClassesResponseContract.v1'
text/xml:
schema:
$ref: '#/components/schemas/DictionaryClassesResponseContract.v1'
text/html:
schema:
$ref: '#/components/schemas/DictionaryClassesResponseContract.v1'
text/turtle:
schema:
$ref: '#/components/schemas/DictionaryClassesResponseContract.v1'
application/x-turtle:
schema:
$ref: '#/components/schemas/DictionaryClassesResponseContract.v1'
application/rdf+xml:
schema:
$ref: '#/components/schemas/DictionaryClassesResponseContract.v1'
/api/Dictionary/v1/Properties:
get:
tags:
- Dictionary
summary: Get Dictionary with its properties
parameters:
- name: Uri
in: query
description: >-
The URI of the dictionary. The option "latest" is supported, e.g.
https://identifier.buildingsmart.org/uri/bs-agri/fruitvegs/latest
required: true
schema:
type: string
- name: Offset
in: query
description: Zero-based offset of the first item to be returned. Default is 0.
schema:
type: integer
format: int32
- name: Limit
in: query
description: >-
Limit number of items to be returned. If you enter an offset then
default limit is 100. The maximum number of items returned is 1000.
schema:
type: integer
format: int32
- name: languageCode
in: query
description: >-
Specify language (case sensitive). For those items the text is not
available in the requested language, the text will be returned in
the default language of the dictionary
schema:
type: string
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/DictionaryPropertiesResponseContract.v1'
application/json:
schema:
$ref: '#/components/schemas/DictionaryPropertiesResponseContract.v1'
text/json:
schema:
$ref: '#/components/schemas/DictionaryPropertiesResponseContract.v1'
application/xml:
schema:
$ref: '#/components/schemas/DictionaryPropertiesResponseContract.v1'
text/xml:
schema:
$ref: '#/components/schemas/DictionaryPropertiesResponseContract.v1'
text/html:
schema:
$ref: '#/components/schemas/DictionaryPropertiesResponseContract.v1'
text/turtle:
schema:
$ref: '#/components/schemas/DictionaryPropertiesResponseContract.v1'
application/x-turtle:
schema:
$ref: '#/components/schemas/DictionaryPropertiesResponseContract.v1'
application/rdf+xml:
schema:
$ref: '#/components/schemas/DictionaryPropertiesResponseContract.v1'
/api/DictionaryDownload/sketchup/v1:
post:
tags:
- Dictionary
summary: "Download a file with an export of a dictionary in format supported by Sketchup.\r\nThis API replaces /api/RequestExportFile/preview"
parameters:
- name: DictionaryUri
in: query
description: >-
The uri of the dictionary to be downloaded, including version
number, e.g.
https://identifier.buildingsmart.org/uri/bs-agri/fruitvegs/1.1. You
can replace the version number by "latest" to automatically get the
latest (active) version of the dictionary
required: true
schema:
type: string
responses:
'200':
description: Success
content:
text/plain:
schema:
type: string
format: binary
application/json:
schema:
type: string
format: binary
text/json:
schema:
type: string
format: binary
text/html:
schema:
type: string
format: binary
text/turtle:
schema:
type: string
format: binary
application/x-turtle:
schema:
type: string
format: binary
application/rdf+xml:
schema:
type: string
format: binary
'400':
description: Bad Request
content:
text/plain:
schema:
$ref: '#/components/schemas/ProblemDetails'
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
application/xml:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/xml:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/html:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/turtle:
schema:
$ref: '#/components/schemas/ProblemDetails'
application/x-turtle:
schema:
$ref: '#/components/schemas/ProblemDetails'
application/rdf+xml:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
content:
text/plain:
schema:
$ref: '#/components/schemas/ProblemDetails'
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
application/xml:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/xml:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/html:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/turtle:
schema:
$ref: '#/components/schemas/ProblemDetails'
application/x-turtle:
schema:
$ref: '#/components/schemas/ProblemDetails'
application/rdf+xml:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
text/plain:
schema:
$ref: '#/components/schemas/ProblemDetails'
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
application/xml:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/xml:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/html:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/turtle:
schema:
$ref: '#/components/schemas/ProblemDetails'
application/x-turtle:
schema:
$ref: '#/components/schemas/ProblemDetails'
application/rdf+xml:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Server Error
security:
- aad-jwt:
- /read
/api/UploadImportFile/v1:
post:
tags:
- Dictionary Update
summary: >-
Upload a bSDD import model json file, see
https://github.com/buildingSMART/bSDD/tree/master/Model/Import%20Model
for more information
requestBody:
content:
multipart/form-data:
schema:
required:
- FormFile
- OrganizationCode
type: object
properties:
OrganizationCode:
type: string
description: "Code of the organization owning the dictionary.\r\nIf you do not know the code, contact us (see e-mail address on top of this page)"
FormFile:
type: string
description: The bsdd import file in json format
format: binary
ValidateOnly:
type: boolean
description: "Set to true if you only want to validate the file. Even when there are no validation errors the file wil not be imported.\r\nThe validation result will not be send via e-mail."
IsTest:
type: boolean
description: "Set to true if you are just testing your file. Data will be stored in the database, you can retrieve it via the API, but you can't set status to Active.\r\nDictionary will be deleted after 60 days of last upload."
encoding:
OrganizationCode:
style: form
FormFile:
style: form
ValidateOnly:
style: form
IsTest:
style: form
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/UploadImportFileResult.v1'
application/json:
schema:
$ref: '#/components/schemas/UploadImportFileResult.v1'
text/json:
schema:
$ref: '#/components/schemas/UploadImportFileResult.v1'
application/xml:
schema:
$ref: '#/components/schemas/UploadImportFileResult.v1'
text/xml:
schema:
$ref: '#/components/schemas/UploadImportFileResult.v1'
text/html:
schema:
$ref: '#/components/schemas/UploadImportFileResult.v1'
text/turtle:
schema:
$ref: '#/components/schemas/UploadImportFileResult.v1'
application/x-turtle:
schema:
$ref: '#/components/schemas/UploadImportFileResult.v1'
application/rdf+xml:
schema:
$ref: '#/components/schemas/UploadImportFileResult.v1'
security:
- aad-jwt:
- /read
/api/Dictionary/v1/{organizationCode}/{code}/{version}:
put:
tags:
- Dictionary Update
summary: Update the status of a Dictionary
parameters:
- name: organizationCode
in: path
required: true
schema:
type: string
- name: code
in: path
required: true
schema:
type: string
- name: version
in: path
required: true
schema:
type: string
requestBody:
description: >-
The new status of the dictionary. Only transitions allowed are:
Preview --> Active, Active --> Inactive and Inactive --> Active
content:
application/json:
schema:
type: string
text/json:
schema:
type: string
application/*+json:
schema:
type: string
responses:
'200':
description: Success
security:
- aad-jwt:
- /manage
delete:
tags:
- Dictionary Update
summary: Delete a dictionary version
parameters:
- name: organizationCode
in: path
required: true
schema:
type: string
- name: code
in: path
required: true
schema:
type: string
- name: version
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
security:
- aad-jwt:
- /manage
/api/Dictionary/v1/{organizationCode}/{code}:
delete:
tags:
- Dictionary Update
summary: Delete all versions of a dictionary
parameters:
- name: organizationCode
in: path
required: true
schema:
type: string
- name: code
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
security:
- aad-jwt:
- /manage
/api/Property/v4:
get:
tags:
- Property
summary: Get Property details
parameters:
- name: uri
in: query
description: >-
URI of the property, e.g.
https://identifier.buildingsmart.org/uri/bs-agri/fruitvegs/1.1/prop/color
required: true
schema:
type: string
- name: includeClasses
in: query
description: >-
Set to true to get list of classes where property is used (only
classes of the same dictionary as the property). Maximum number of
class properties returned is 2000
schema:
type: boolean
- name: languageCode
in: query
description: >-
Specify language (case sensitive). For those items the text is not
available in the requested language, the text will be returned in
the default language of the dictionary
schema:
type: string
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/PropertyContract.v4'
application/json:
schema:
$ref: '#/components/schemas/PropertyContract.v4'
text/json:
schema:
$ref: '#/components/schemas/PropertyContract.v4'
application/xml:
schema:
$ref: '#/components/schemas/PropertyContract.v4'
text/xml:
schema:
$ref: '#/components/schemas/PropertyContract.v4'
text/html:
schema:
$ref: '#/components/schemas/PropertyContract.v4'
text/turtle:
schema:
$ref: '#/components/schemas/PropertyContract.v4'
application/x-turtle:
schema:
$ref: '#/components/schemas/PropertyContract.v4'
application/rdf+xml:
schema:
$ref: '#/components/schemas/PropertyContract.v4'
/api/PropertyValue/v2:
get:
tags:
- Property
summary: Get Property Value details
parameters:
- name: uri
in: query
description: >-
URI of the property value, e.g.
https://identifier.buildingsmart.org/uri/bs-agri/fruitvegs/1.1/prop/color/value/red
required: true
schema:
type: string
- name: languageCode
in: query
description: Language Code
schema:
type: string
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/PropertyValueContract.v4'
application/json:
schema:
$ref: '#/components/schemas/PropertyValueContract.v4'
text/json:
schema:
$ref: '#/components/schemas/PropertyValueContract.v4'
application/xml:
schema:
$ref: '#/components/schemas/PropertyValueContract.v4'
text/xml:
schema:
$ref: '#/components/schemas/PropertyValueContract.v4'
text/html:
schema:
$ref: '#/components/schemas/PropertyValueContract.v4'
text/turtle:
schema:
$ref: '#/components/schemas/PropertyValueContract.v4'
application/x-turtle:
schema:
$ref: '#/components/schemas/PropertyValueContract.v4'
application/rdf+xml:
schema:
$ref: '#/components/schemas/PropertyValueContract.v4'
/api/TextSearch/v1:
get:
tags:
- Search
summary: "Search the bSDD database using free text, get list of Classes and/or Properties matching the text.\r\nPagination options are for Classes and Properties combined. So if result consists of 10 classes and 5 properties, TotalCount will be 15. Classes will be listed first, so if you then use Offset=10 and Limit=5, you will get the 5 properties."
description: The details can be requested per Class via the Class API
parameters:
- name: SearchText
in: query
description: >-
The text to search for, minimum 2 characters (case and accent
insensitive)
required: true
schema:
type: string
- name: TypeFilter
in: query
description: 'Type filter: must be "All", "Classes" or "Properties"'
schema:
type: string
- name: DictionaryUris
in: query
description: List of dictionaries to filter on
schema:
type: array
items:
type: string
- name: Offset
in: query
description: Zero-based offset of the first item to be returned. Default is 0.
schema:
type: integer
format: int32
- name: Limit
in: query
description: >-
Limit number of items to be returned. If you enter an offset then
default limit is 100. The maximum number of items returned is 1000.
schema:
type: integer
format: int32
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/TextSearchResponseContract.v1'
application/json:
schema:
$ref: '#/components/schemas/TextSearchResponseContract.v1'
text/json:
schema:
$ref: '#/components/schemas/TextSearchResponseContract.v1'
application/xml:
schema:
$ref: '#/components/schemas/TextSearchResponseContract.v1'
text/xml:
schema:
$ref: '#/components/schemas/TextSearchResponseContract.v1'
text/html:
schema:
$ref: '#/components/schemas/TextSearchResponseContract.v1'
text/turtle:
schema:
$ref: '#/components/schemas/TextSearchResponseContract.v1'
application/x-turtle:
schema:
$ref: '#/components/schemas/TextSearchResponseContract.v1'
application/rdf+xml:
schema:
$ref: '#/components/schemas/TextSearchResponseContract.v1'
/api/SearchInDictionary/v1:
get:
tags:
- Search
summary: "Search the bSDD database, get list of Classes without details.\r\nThis version uses new naming and returns one Dictionary instead of a list with always one Dictionary.\r\nThis API replaces /api/SearchList."
description: The details can be requested per Class via the Class API
parameters:
- name: DictionaryUri
in: query
description: >-
The uri of the Dictionary to filter on (required). The "latest"
option is supported, e.g.
https://identifier.buildingsmart.org/uri/bs-agri/fruitvegs/latest
required: true
schema:
type: string
- name: SearchText
in: query
description: The text to search for (case and accent insensitive)
schema:
type: string
- name: LanguageCode
in: query
description: "The ISO language code to search in and to return the text in (case sensitive)\r\nIf no language code specified or the text is not available in the requested language, the text will be returned in the default language of the dictionary.\r\nIf a language code has been given, the search takes place in texts of that language, otherwise searches will be done in the default language of the dictionary.\r\nIf an invalid or not supported language code is given, a Bad Request will be returned."
schema:
type: string
- name: RelatedIfcEntity
in: query
description: The official IFC entity name to filter on (case sensitive)
schema:
type: string
- name: Offset
in: query
description: Zero-based offset of the first item to be returned. Default is 0.
schema:
type: integer
format: int32
- name: Limit
in: query
description: >-
Limit number of items to be returned. If you enter an offset then
default limit is 100. The maximum number of items returned is 1000.
schema:
type: integer
format: int32
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/SearchInDictionaryResponseContract.v1'
application/json:
schema:
$ref: '#/components/schemas/SearchInDictionaryResponseContract.v1'
text/json:
schema:
$ref: '#/components/schemas/SearchInDictionaryResponseContract.v1'
application/xml:
schema:
$ref: '#/components/schemas/SearchInDictionaryResponseContract.v1'
text/xml:
schema:
$ref: '#/components/schemas/SearchInDictionaryResponseContract.v1'
text/html:
schema:
$ref: '#/components/schemas/SearchInDictionaryResponseContract.v1'
text/turtle:
schema:
$ref: '#/components/schemas/SearchInDictionaryResponseContract.v1'
application/x-turtle:
schema:
$ref: '#/components/schemas/SearchInDictionaryResponseContract.v1'
application/rdf+xml:
schema:
$ref: '#/components/schemas/SearchInDictionaryResponseContract.v1'
/api/Class/Search/v1:
get:
tags:
- Search
summary: "Search the bSDD database using free text, get list of Classes matching the text and optional additional filters.\r\nChanges with obsolete api/ClassificationSearch:\r\n- \"Classification\" has been renamed to \"Class\"\r\n- \"Domain\" has been renamed to \"Dictionary\"\r\n- \"NamespaceUri\" has been renamed to \"Uri\""
parameters:
- name: SearchText
in: query
description: >-
The text to search for, minimum 3 characters (case and accent
insensitive)
required: true
schema:
type: string
- name: DictionaryUris
in: query
description: "List of dictionaries to filter on.\r\nFor a class to be found it must be part of one of the given dictionaries"
schema:
type: array
items:
type: string
- name: RelatedIfcEntities
in: query
description: "List of related IFC entities to filter on.\r\nFor a class to be found it must have at least one of the given Related Ifc Entities"
schema:
type: array
items:
type: string
- name: Offset
in: query
description: Zero-based offset of the first item to be returned. Default is 0.
schema:
type: integer
format: int32
- name: Limit
in: query
description: >-
Limit number of items to be returned. If you enter an offset then
default limit is 100. The maximum number of items returned is 1000.
schema:
type: integer
format: int32
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/ClassSearchResponseContract.v1'
application/json:
schema:
$ref: '#/components/schemas/ClassSearchResponseContract.v1'
text/json:
schema:
$ref: '#/components/schemas/ClassSearchResponseContract.v1'
application/xml:
schema:
$ref: '#/components/schemas/ClassSearchResponseContract.v1'
text/xml:
schema:
$ref: '#/components/schemas/ClassSearchResponseContract.v1'
text/html:
schema:
$ref: '#/components/schemas/ClassSearchResponseContract.v1'
text/turtle:
schema:
$ref: '#/components/schemas/ClassSearchResponseContract.v1'
application/x-turtle:
schema:
$ref: '#/components/schemas/ClassSearchResponseContract.v1'
application/rdf+xml:
schema:
$ref: '#/components/schemas/ClassSearchResponseContract.v1'
/api/Unit/v1:
get:
tags:
- z Lookup data
summary: Get list of all units
responses:
'200':
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/UnitContract.v1'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UnitContract.v1'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/UnitContract.v1'
application/xml:
schema:
type: array
items: