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

Commit 86f5fae

Browse files
Bimdata-ioBimdata-io
committed
PATCH: add filters to getRawElements and getSimpleElements
1 parent 0cdfcf5 commit 86f5fae

File tree

4 files changed

+53
-13
lines changed

4 files changed

+53
-13
lines changed

‎docs/CollaborationApi.md‎

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

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

960960
### Example
961961

‎docs/ModelApi.md‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6687,7 +6687,7 @@ Name | Type | Description | Notes
66876687

66886688
## getRawElements
66896689

6690-
> RawElements getRawElements(cloudPk, modelPk, projectPk)
6690+
> RawElements getRawElements(cloudPk, modelPk, projectPk, opts)
66916691
66926692
Retrieve all elements in a optimized format
66936693

@@ -6719,7 +6719,12 @@ let apiInstance = new bimdata.ModelApi();
67196719
let cloudPk = 56; // Number | A unique integer value identifying this cloud.
67206720
let modelPk = 56; // Number | A unique integer value identifying this model.
67216721
let projectPk = 56; // Number | A unique integer value identifying this project.
6722-
apiInstance.getRawElements(cloudPk, modelPk, projectPk).then((data) => {
6722+
let opts = {
6723+
'classification': "classification_example", // String |
6724+
'classificationNotation': "classificationNotation_example", // String |
6725+
'type': "type_example" // String |
6726+
};
6727+
apiInstance.getRawElements(cloudPk, modelPk, projectPk, opts).then((data) => {
67236728
console.log('API called successfully. Returned data: ' + data);
67246729
}, (error) => {
67256730
console.error(error);
@@ -6735,6 +6740,9 @@ Name | Type | Description | Notes
67356740
**cloudPk** | **Number**| A unique integer value identifying this cloud. |
67366741
**modelPk** | **Number**| A unique integer value identifying this model. |
67376742
**projectPk** | **Number**| A unique integer value identifying this project. |
6743+
**classification** | **String**| | [optional]
6744+
**classificationNotation** | **String**| | [optional]
6745+
**type** | **String**| | [optional]
67386746

67396747
### Return type
67406748

@@ -6819,7 +6827,7 @@ Name | Type | Description | Notes
68196827

68206828
## getSimpleElements
68216829

6822-
> SimpleElement getSimpleElements(cloudPk, modelPk, projectPk)
6830+
> SimpleElement getSimpleElements(cloudPk, modelPk, projectPk, opts)
68236831
68246832
Retrieve all elements of a model with a simple value representation
68256833

@@ -6851,7 +6859,12 @@ let apiInstance = new bimdata.ModelApi();
68516859
let cloudPk = 56; // Number | A unique integer value identifying this cloud.
68526860
let modelPk = 56; // Number | A unique integer value identifying this model.
68536861
let projectPk = 56; // Number | A unique integer value identifying this project.
6854-
apiInstance.getSimpleElements(cloudPk, modelPk, projectPk).then((data) => {
6862+
let opts = {
6863+
'classification': "classification_example", // String |
6864+
'classificationNotation': "classificationNotation_example", // String |
6865+
'type': "type_example" // String |
6866+
};
6867+
apiInstance.getSimpleElements(cloudPk, modelPk, projectPk, opts).then((data) => {
68556868
console.log('API called successfully. Returned data: ' + data);
68566869
}, (error) => {
68576870
console.error(error);
@@ -6867,6 +6880,9 @@ Name | Type | Description | Notes
68676880
**cloudPk** | **Number**| A unique integer value identifying this cloud. |
68686881
**modelPk** | **Number**| A unique integer value identifying this model. |
68696882
**projectPk** | **Number**| A unique integer value identifying this project. |
6883+
**classification** | **String**| | [optional]
6884+
**classificationNotation** | **String**| | [optional]
6885+
**type** | **String**| | [optional]
68706886

68716887
### Return type
68726888

‎src/api/CollaborationApi.js‎

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

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

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

‎src/api/ModelApi.js‎

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6895,9 +6895,14 @@ export default class ModelApi {
68956895
* @param {Number} cloudPk A unique integer value identifying this cloud.
68966896
* @param {Number} modelPk A unique integer value identifying this model.
68976897
* @param {Number} projectPk A unique integer value identifying this project.
6898+
* @param {Object} opts Optional parameters
6899+
* @param {String} opts.classification
6900+
* @param {String} opts.classificationNotation
6901+
* @param {String} opts.type
68986902
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RawElements} and HTTP response
68996903
*/
6900-
getRawElementsWithHttpInfo(cloudPk, modelPk, projectPk) {
6904+
getRawElementsWithHttpInfo(cloudPk, modelPk, projectPk, opts) {
6905+
opts = opts || {};
69016906
let postBody = null;
69026907
// verify the required parameter 'cloudPk' is set
69036908
if (cloudPk === undefined || cloudPk === null) {
@@ -6918,6 +6923,9 @@ export default class ModelApi {
69186923
'project_pk': projectPk
69196924
};
69206925
let queryParams = {
6926+
'classification': opts['classification'],
6927+
'classification__notation': opts['classificationNotation'],
6928+
'type': opts['type']
69216929
};
69226930
let headerParams = {
69236931
};
@@ -6941,10 +6949,14 @@ export default class ModelApi {
69416949
* @param {Number} cloudPk A unique integer value identifying this cloud.
69426950
* @param {Number} modelPk A unique integer value identifying this model.
69436951
* @param {Number} projectPk A unique integer value identifying this project.
6952+
* @param {Object} opts Optional parameters
6953+
* @param {String} opts.classification
6954+
* @param {String} opts.classificationNotation
6955+
* @param {String} opts.type
69446956
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RawElements}
69456957
*/
6946-
getRawElements(cloudPk, modelPk, projectPk) {
6947-
return this.getRawElementsWithHttpInfo(cloudPk, modelPk, projectPk)
6958+
getRawElements(cloudPk, modelPk, projectPk, opts) {
6959+
return this.getRawElementsWithHttpInfo(cloudPk, modelPk, projectPk, opts)
69486960
.then(function(response_and_data) {
69496961
return response_and_data.data;
69506962
});
@@ -7026,9 +7038,14 @@ export default class ModelApi {
70267038
* @param {Number} cloudPk A unique integer value identifying this cloud.
70277039
* @param {Number} modelPk A unique integer value identifying this model.
70287040
* @param {Number} projectPk A unique integer value identifying this project.
7041+
* @param {Object} opts Optional parameters
7042+
* @param {String} opts.classification
7043+
* @param {String} opts.classificationNotation
7044+
* @param {String} opts.type
70297045
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SimpleElement} and HTTP response
70307046
*/
7031-
getSimpleElementsWithHttpInfo(cloudPk, modelPk, projectPk) {
7047+
getSimpleElementsWithHttpInfo(cloudPk, modelPk, projectPk, opts) {
7048+
opts = opts || {};
70327049
let postBody = null;
70337050
// verify the required parameter 'cloudPk' is set
70347051
if (cloudPk === undefined || cloudPk === null) {
@@ -7049,6 +7066,9 @@ export default class ModelApi {
70497066
'project_pk': projectPk
70507067
};
70517068
let queryParams = {
7069+
'classification': opts['classification'],
7070+
'classification__notation': opts['classificationNotation'],
7071+
'type': opts['type']
70527072
};
70537073
let headerParams = {
70547074
};
@@ -7072,10 +7092,14 @@ export default class ModelApi {
70727092
* @param {Number} cloudPk A unique integer value identifying this cloud.
70737093
* @param {Number} modelPk A unique integer value identifying this model.
70747094
* @param {Number} projectPk A unique integer value identifying this project.
7095+
* @param {Object} opts Optional parameters
7096+
* @param {String} opts.classification
7097+
* @param {String} opts.classificationNotation
7098+
* @param {String} opts.type
70757099
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SimpleElement}
70767100
*/
7077-
getSimpleElements(cloudPk, modelPk, projectPk) {
7078-
return this.getSimpleElementsWithHttpInfo(cloudPk, modelPk, projectPk)
7101+
getSimpleElements(cloudPk, modelPk, projectPk, opts) {
7102+
return this.getSimpleElementsWithHttpInfo(cloudPk, modelPk, projectPk, opts)
70797103
.then(function(response_and_data) {
70807104
return response_and_data.data;
70817105
});

0 commit comments

Comments
 (0)