Skip to content
This repository was archived by the owner on Nov 18, 2025. It is now read-only.

Commit 68daa30

Browse files
Bimdata-ioBimdata-io
committed
MINOR: add img_format=url in BCF routes (#472)
1 parent 27506a8 commit 68daa30

2 files changed

Lines changed: 172 additions & 57 deletions

File tree

‎docs/BcfApi.md‎

Lines changed: 69 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Name | Type | Description | Notes
106106

107107
## createFullTopic
108108

109-
> FullTopic createFullTopic(projectsPk, data)
109+
> FullTopic createFullTopic(projectsPk, data, opts)
110110
111111
Create a Topic with viewpoints and comments
112112

@@ -132,7 +132,10 @@ client_credentials.accessToken = 'YOUR ACCESS TOKEN';
132132
let apiInstance = new bimdata.BcfApi();
133133
let projectsPk = "projectsPk_example"; // String |
134134
let data = new bimdata.FullTopic(); // FullTopic |
135-
apiInstance.createFullTopic(projectsPk, data).then((data) => {
135+
let opts = {
136+
'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64
137+
};
138+
apiInstance.createFullTopic(projectsPk, data, opts).then((data) => {
136139
console.log('API called successfully. Returned data: ' + data);
137140
}, (error) => {
138141
console.error(error);
@@ -147,6 +150,7 @@ Name | Type | Description | Notes
147150
------------- | ------------- | ------------- | -------------
148151
**projectsPk** | **String**| |
149152
**data** | [**FullTopic**](FullTopic.md)| |
153+
**imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional]
150154

151155
### Return type
152156

@@ -222,7 +226,7 @@ Name | Type | Description | Notes
222226

223227
## createViewpoint
224228

225-
> Viewpoint createViewpoint(projectsPk, topicsGuid, data)
229+
> Viewpoint createViewpoint(projectsPk, topicsGuid, data, opts)
226230
227231
Create a Viewpoint
228232

@@ -249,7 +253,10 @@ let apiInstance = new bimdata.BcfApi();
249253
let projectsPk = "projectsPk_example"; // String |
250254
let topicsGuid = "topicsGuid_example"; // String |
251255
let data = new bimdata.Viewpoint(); // Viewpoint |
252-
apiInstance.createViewpoint(projectsPk, topicsGuid, data).then((data) => {
256+
let opts = {
257+
'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64
258+
};
259+
apiInstance.createViewpoint(projectsPk, topicsGuid, data, opts).then((data) => {
253260
console.log('API called successfully. Returned data: ' + data);
254261
}, (error) => {
255262
console.error(error);
@@ -265,6 +272,7 @@ Name | Type | Description | Notes
265272
**projectsPk** | **String**| |
266273
**topicsGuid** | **String**| |
267274
**data** | [**Viewpoint**](Viewpoint.md)| |
275+
**imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional]
268276

269277
### Return type
270278

@@ -400,7 +408,7 @@ null (empty response body)
400408

401409
## deleteViewpoint
402410

403-
> deleteViewpoint(guid, projectsPk, topicsGuid)
411+
> deleteViewpoint(guid, projectsPk, topicsGuid, opts)
404412
405413
Delete a Viewpoint
406414

@@ -427,7 +435,10 @@ let apiInstance = new bimdata.BcfApi();
427435
let guid = null; // String |
428436
let projectsPk = "projectsPk_example"; // String |
429437
let topicsGuid = "topicsGuid_example"; // String |
430-
apiInstance.deleteViewpoint(guid, projectsPk, topicsGuid).then(() => {
438+
let opts = {
439+
'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64
440+
};
441+
apiInstance.deleteViewpoint(guid, projectsPk, topicsGuid, opts).then(() => {
431442
console.log('API called successfully.');
432443
}, (error) => {
433444
console.error(error);
@@ -443,6 +454,7 @@ Name | Type | Description | Notes
443454
**guid** | [**String**](.md)| |
444455
**projectsPk** | **String**| |
445456
**topicsGuid** | **String**| |
457+
**imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional]
446458

447459
### Return type
448460

@@ -642,7 +654,7 @@ Name | Type | Description | Notes
642654

643655
## fullUpdateFullTopic
644656

645-
> FullTopic fullUpdateFullTopic(guid, projectsPk, data)
657+
> FullTopic fullUpdateFullTopic(guid, projectsPk, data, opts)
646658
647659
Update all fields of a topic
648660

@@ -669,7 +681,10 @@ let apiInstance = new bimdata.BcfApi();
669681
let guid = null; // String |
670682
let projectsPk = "projectsPk_example"; // String |
671683
let data = new bimdata.FullTopic(); // FullTopic |
672-
apiInstance.fullUpdateFullTopic(guid, projectsPk, data).then((data) => {
684+
let opts = {
685+
'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64
686+
};
687+
apiInstance.fullUpdateFullTopic(guid, projectsPk, data, opts).then((data) => {
673688
console.log('API called successfully. Returned data: ' + data);
674689
}, (error) => {
675690
console.error(error);
@@ -685,6 +700,7 @@ Name | Type | Description | Notes
685700
**guid** | [**String**](.md)| |
686701
**projectsPk** | **String**| |
687702
**data** | [**FullTopic**](FullTopic.md)| |
703+
**imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional]
688704

689705
### Return type
690706

@@ -762,7 +778,7 @@ Name | Type | Description | Notes
762778

763779
## fullUpdateViewpoint
764780

765-
> Viewpoint fullUpdateViewpoint(guid, projectsPk, topicsGuid, data)
781+
> Viewpoint fullUpdateViewpoint(guid, projectsPk, topicsGuid, data, opts)
766782
767783
Update all fields of a Viewpoint
768784

@@ -790,7 +806,10 @@ let guid = null; // String |
790806
let projectsPk = "projectsPk_example"; // String |
791807
let topicsGuid = "topicsGuid_example"; // String |
792808
let data = new bimdata.Viewpoint(); // Viewpoint |
793-
apiInstance.fullUpdateViewpoint(guid, projectsPk, topicsGuid, data).then((data) => {
809+
let opts = {
810+
'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64
811+
};
812+
apiInstance.fullUpdateViewpoint(guid, projectsPk, topicsGuid, data, opts).then((data) => {
794813
console.log('API called successfully. Returned data: ' + data);
795814
}, (error) => {
796815
console.error(error);
@@ -807,6 +826,7 @@ Name | Type | Description | Notes
807826
**projectsPk** | **String**| |
808827
**topicsGuid** | **String**| |
809828
**data** | [**Viewpoint**](Viewpoint.md)| |
829+
**imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional]
810830

811831
### Return type
812832

@@ -1166,7 +1186,7 @@ Name | Type | Description | Notes
11661186

11671187
## getFullTopic
11681188

1169-
> FullTopic getFullTopic(guid, projectsPk)
1189+
> FullTopic getFullTopic(guid, projectsPk, opts)
11701190
11711191
Retrieve a full topic
11721192

@@ -1192,7 +1212,10 @@ client_credentials.accessToken = 'YOUR ACCESS TOKEN';
11921212
let apiInstance = new bimdata.BcfApi();
11931213
let guid = null; // String |
11941214
let projectsPk = "projectsPk_example"; // String |
1195-
apiInstance.getFullTopic(guid, projectsPk).then((data) => {
1215+
let opts = {
1216+
'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64
1217+
};
1218+
apiInstance.getFullTopic(guid, projectsPk, opts).then((data) => {
11961219
console.log('API called successfully. Returned data: ' + data);
11971220
}, (error) => {
11981221
console.error(error);
@@ -1207,6 +1230,7 @@ Name | Type | Description | Notes
12071230
------------- | ------------- | ------------- | -------------
12081231
**guid** | [**String**](.md)| |
12091232
**projectsPk** | **String**| |
1233+
**imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional]
12101234

12111235
### Return type
12121236

@@ -1251,7 +1275,8 @@ let apiInstance = new bimdata.BcfApi();
12511275
let projectsPk = "projectsPk_example"; // String |
12521276
let opts = {
12531277
'ifcs': "ifcs_example", // String | Filter the returned list by ifcs
1254-
'format': "format_example" // String | Filter the returned list by format
1278+
'format': "format_example", // String | Filter the returned list by format
1279+
'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64
12551280
};
12561281
apiInstance.getFullTopics(projectsPk, opts).then((data) => {
12571282
console.log('API called successfully. Returned data: ' + data);
@@ -1269,6 +1294,7 @@ Name | Type | Description | Notes
12691294
**projectsPk** | **String**| |
12701295
**ifcs** | **String**| Filter the returned list by ifcs | [optional]
12711296
**format** | **String**| Filter the returned list by format | [optional]
1297+
**imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional]
12721298

12731299
### Return type
12741300

@@ -1464,7 +1490,7 @@ Name | Type | Description | Notes
14641490

14651491
## getTopicViewpoints
14661492

1467-
> [Viewpoint] getTopicViewpoints(projectsPk, topicsGuid)
1493+
> [Viewpoint] getTopicViewpoints(projectsPk, topicsGuid, opts)
14681494
14691495
Retrieve all viewpoints attached to the topic
14701496

@@ -1490,7 +1516,10 @@ client_credentials.accessToken = 'YOUR ACCESS TOKEN';
14901516
let apiInstance = new bimdata.BcfApi();
14911517
let projectsPk = "projectsPk_example"; // String |
14921518
let topicsGuid = "topicsGuid_example"; // String |
1493-
apiInstance.getTopicViewpoints(projectsPk, topicsGuid).then((data) => {
1519+
let opts = {
1520+
'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64
1521+
};
1522+
apiInstance.getTopicViewpoints(projectsPk, topicsGuid, opts).then((data) => {
14941523
console.log('API called successfully. Returned data: ' + data);
14951524
}, (error) => {
14961525
console.error(error);
@@ -1505,6 +1534,7 @@ Name | Type | Description | Notes
15051534
------------- | ------------- | ------------- | -------------
15061535
**projectsPk** | **String**| |
15071536
**topicsGuid** | **String**| |
1537+
**imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional]
15081538

15091539
### Return type
15101540

@@ -1636,7 +1666,7 @@ This endpoint does not need any parameter.
16361666

16371667
## getViewpoint
16381668

1639-
> Viewpoint getViewpoint(guid, projectsPk, topicsGuid)
1669+
> Viewpoint getViewpoint(guid, projectsPk, topicsGuid, opts)
16401670
16411671
Retrieve a Viewpoint
16421672

@@ -1663,7 +1693,10 @@ let apiInstance = new bimdata.BcfApi();
16631693
let guid = null; // String |
16641694
let projectsPk = "projectsPk_example"; // String |
16651695
let topicsGuid = "topicsGuid_example"; // String |
1666-
apiInstance.getViewpoint(guid, projectsPk, topicsGuid).then((data) => {
1696+
let opts = {
1697+
'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64
1698+
};
1699+
apiInstance.getViewpoint(guid, projectsPk, topicsGuid, opts).then((data) => {
16671700
console.log('API called successfully. Returned data: ' + data);
16681701
}, (error) => {
16691702
console.error(error);
@@ -1679,6 +1712,7 @@ Name | Type | Description | Notes
16791712
**guid** | [**String**](.md)| |
16801713
**projectsPk** | **String**| |
16811714
**topicsGuid** | **String**| |
1715+
**imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional]
16821716

16831717
### Return type
16841718

@@ -1696,7 +1730,7 @@ Name | Type | Description | Notes
16961730

16971731
## getViewpoints
16981732

1699-
> [Viewpoint] getViewpoints(projectsPk, topicsGuid)
1733+
> [Viewpoint] getViewpoints(projectsPk, topicsGuid, opts)
17001734
17011735
Retrieve all Viewpoints of a topic
17021736

@@ -1722,7 +1756,10 @@ client_credentials.accessToken = 'YOUR ACCESS TOKEN';
17221756
let apiInstance = new bimdata.BcfApi();
17231757
let projectsPk = "projectsPk_example"; // String |
17241758
let topicsGuid = "topicsGuid_example"; // String |
1725-
apiInstance.getViewpoints(projectsPk, topicsGuid).then((data) => {
1759+
let opts = {
1760+
'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64
1761+
};
1762+
apiInstance.getViewpoints(projectsPk, topicsGuid, opts).then((data) => {
17261763
console.log('API called successfully. Returned data: ' + data);
17271764
}, (error) => {
17281765
console.error(error);
@@ -1737,6 +1774,7 @@ Name | Type | Description | Notes
17371774
------------- | ------------- | ------------- | -------------
17381775
**projectsPk** | **String**| |
17391776
**topicsGuid** | **String**| |
1777+
**imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional]
17401778

17411779
### Return type
17421780

@@ -2050,7 +2088,7 @@ Name | Type | Description | Notes
20502088

20512089
## updateFullTopic
20522090

2053-
> FullTopic updateFullTopic(guid, projectsPk, data)
2091+
> FullTopic updateFullTopic(guid, projectsPk, data, opts)
20542092
20552093
Update some fields of a topic
20562094

@@ -2077,7 +2115,10 @@ let apiInstance = new bimdata.BcfApi();
20772115
let guid = null; // String |
20782116
let projectsPk = "projectsPk_example"; // String |
20792117
let data = new bimdata.FullTopic(); // FullTopic |
2080-
apiInstance.updateFullTopic(guid, projectsPk, data).then((data) => {
2118+
let opts = {
2119+
'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64
2120+
};
2121+
apiInstance.updateFullTopic(guid, projectsPk, data, opts).then((data) => {
20812122
console.log('API called successfully. Returned data: ' + data);
20822123
}, (error) => {
20832124
console.error(error);
@@ -2093,6 +2134,7 @@ Name | Type | Description | Notes
20932134
**guid** | [**String**](.md)| |
20942135
**projectsPk** | **String**| |
20952136
**data** | [**FullTopic**](FullTopic.md)| |
2137+
**imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional]
20962138

20972139
### Return type
20982140

@@ -2170,7 +2212,7 @@ Name | Type | Description | Notes
21702212

21712213
## updateViewpoint
21722214

2173-
> Viewpoint updateViewpoint(guid, projectsPk, topicsGuid, data)
2215+
> Viewpoint updateViewpoint(guid, projectsPk, topicsGuid, data, opts)
21742216
21752217
Update some fields of a Viewpoint
21762218

@@ -2198,7 +2240,10 @@ let guid = null; // String |
21982240
let projectsPk = "projectsPk_example"; // String |
21992241
let topicsGuid = "topicsGuid_example"; // String |
22002242
let data = new bimdata.Viewpoint(); // Viewpoint |
2201-
apiInstance.updateViewpoint(guid, projectsPk, topicsGuid, data).then((data) => {
2243+
let opts = {
2244+
'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64
2245+
};
2246+
apiInstance.updateViewpoint(guid, projectsPk, topicsGuid, data, opts).then((data) => {
22022247
console.log('API called successfully. Returned data: ' + data);
22032248
}, (error) => {
22042249
console.error(error);
@@ -2215,6 +2260,7 @@ Name | Type | Description | Notes
22152260
**projectsPk** | **String**| |
22162261
**topicsGuid** | **String**| |
22172262
**data** | [**Viewpoint**](Viewpoint.md)| |
2263+
**imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional]
22182264

22192265
### Return type
22202266

0 commit comments

Comments
 (0)