Skip to content

Commit a9ad097

Browse files
committed
PATCH: fix bcf excel export documentation
1 parent 967f8c5 commit a9ad097

File tree

4 files changed

+27
-12
lines changed

4 files changed

+27
-12
lines changed

docs/BcfApi.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1366,7 +1366,7 @@ Name | Type | Description | Notes
13661366

13671367
## downloadBcfExportXlsx
13681368

1369-
> BcfProject downloadBcfExportXlsx(id)
1369+
> File downloadBcfExportXlsx(id, opts)
13701370
13711371
Export project's topics in excel format
13721372

@@ -1396,7 +1396,11 @@ Bearer.apiKey = 'YOUR API KEY';
13961396

13971397
let apiInstance = new bimdata.BcfApi();
13981398
let id = 56; // Number | A unique integer value identifying this project.
1399-
apiInstance.downloadBcfExportXlsx(id).then((data) => {
1399+
let opts = {
1400+
'format': "format_example", // String | topic format to export, comma separated. Default = standard
1401+
'topics': "topics_example" // String | topic guids to export, comma separated. Default = all
1402+
};
1403+
apiInstance.downloadBcfExportXlsx(id, opts).then((data) => {
14001404
console.log('API called successfully. Returned data: ' + data);
14011405
}, (error) => {
14021406
console.error(error);
@@ -1410,10 +1414,12 @@ apiInstance.downloadBcfExportXlsx(id).then((data) => {
14101414
Name | Type | Description | Notes
14111415
------------- | ------------- | ------------- | -------------
14121416
**id** | **Number**| A unique integer value identifying this project. |
1417+
**format** | **String**| topic format to export, comma separated. Default = standard | [optional]
1418+
**topics** | **String**| topic guids to export, comma separated. Default = all | [optional]
14131419

14141420
### Return type
14151421

1416-
[**BcfProject**](BcfProject.md)
1422+
**File**
14171423

14181424
### Authorization
14191425

docs/CollaborationApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -956,7 +956,7 @@ Name | Type | Description | Notes
956956
957957
Create a document
958958

959-
Create a document. If the document is one of {'OBJ', 'DXF', 'IFC', 'GLTF', 'POINT_CLOUD', 'DWG'}, a model will be created and attached to this document Required scopes: document:write
959+
Create a document. If the document is one of {'POINT_CLOUD', 'IFC', 'GLTF', 'DWG', 'OBJ', 'DXF'}, a model will be created and attached to this document Required scopes: document:write
960960

961961
### Example
962962

src/api/BcfApi.js

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1240,9 +1240,13 @@ export default class BcfApi {
12401240
* Export project's topics in excel format
12411241
* This is not a standard route. Export project's topics in excel format Required scopes: bcf:read
12421242
* @param {Number} id A unique integer value identifying this project.
1243-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BcfProject} and HTTP response
1243+
* @param {Object} opts Optional parameters
1244+
* @param {String} opts.format topic format to export, comma separated. Default = standard
1245+
* @param {String} opts.topics topic guids to export, comma separated. Default = all
1246+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link File} and HTTP response
12441247
*/
1245-
downloadBcfExportXlsxWithHttpInfo(id) {
1248+
downloadBcfExportXlsxWithHttpInfo(id, opts) {
1249+
opts = opts || {};
12461250
let postBody = null;
12471251
// verify the required parameter 'id' is set
12481252
if (id === undefined || id === null) {
@@ -1253,6 +1257,8 @@ export default class BcfApi {
12531257
'id': id
12541258
};
12551259
let queryParams = {
1260+
'format': opts['format'],
1261+
'topics': opts['topics']
12561262
};
12571263
let headerParams = {
12581264
};
@@ -1262,7 +1268,7 @@ export default class BcfApi {
12621268
let authNames = ['ApiKey', 'BIMData_Connect', 'BIMData_Connect', 'Bearer'];
12631269
let contentTypes = [];
12641270
let accepts = ['application/json'];
1265-
let returnType = BcfProject;
1271+
let returnType = File;
12661272
return this.apiClient.callApi(
12671273
'/bcf/2.1/projects/{id}/export-xlsx', 'GET',
12681274
pathParams, queryParams, headerParams, formParams, postBody,
@@ -1274,10 +1280,13 @@ export default class BcfApi {
12741280
* Export project's topics in excel format
12751281
* This is not a standard route. Export project's topics in excel format Required scopes: bcf:read
12761282
* @param {Number} id A unique integer value identifying this project.
1277-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BcfProject}
1283+
* @param {Object} opts Optional parameters
1284+
* @param {String} opts.format topic format to export, comma separated. Default = standard
1285+
* @param {String} opts.topics topic guids to export, comma separated. Default = all
1286+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link File}
12781287
*/
1279-
downloadBcfExportXlsx(id) {
1280-
return this.downloadBcfExportXlsxWithHttpInfo(id)
1288+
downloadBcfExportXlsx(id, opts) {
1289+
return this.downloadBcfExportXlsxWithHttpInfo(id, opts)
12811290
.then(function(response_and_data) {
12821291
return response_and_data.data;
12831292
});

src/api/CollaborationApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -859,7 +859,7 @@ export default class CollaborationApi {
859859

860860
/**
861861
* Create a document
862-
* Create a document. If the document is one of {'OBJ', 'DXF', 'IFC', 'GLTF', 'POINT_CLOUD', 'DWG'}, a model will be created and attached to this document Required scopes: document:write
862+
* Create a document. If the document is one of {'POINT_CLOUD', 'IFC', 'GLTF', 'DWG', 'OBJ', 'DXF'}, a model will be created and attached to this document Required scopes: document:write
863863
* @param {Number} cloudPk A unique integer value identifying this cloud.
864864
* @param {Number} projectPk A unique integer value identifying this project.
865865
* @param {String} name Shown name of the file
@@ -925,7 +925,7 @@ export default class CollaborationApi {
925925

926926
/**
927927
* Create a document
928-
* Create a document. If the document is one of {'OBJ', 'DXF', 'IFC', 'GLTF', 'POINT_CLOUD', 'DWG'}, a model will be created and attached to this document Required scopes: document:write
928+
* Create a document. If the document is one of {'POINT_CLOUD', 'IFC', 'GLTF', 'DWG', 'OBJ', 'DXF'}, a model will be created and attached to this document Required scopes: document:write
929929
* @param {Number} cloudPk A unique integer value identifying this cloud.
930930
* @param {Number} projectPk A unique integer value identifying this project.
931931
* @param {String} name Shown name of the file

0 commit comments

Comments
 (0)