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

Commit bc19220

Browse files
Bimdata-ioBimdata-io
committed
MINOR: add property update route
1 parent 6e17b18 commit bc19220

4 files changed

Lines changed: 472 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,7 @@ Class | Method | HTTP request | Description
305305
*bimdata.IfcApi* | [**exportIfc**](docs/IfcApi.md#exportIfc) | **POST** /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/export | Export IFC
306306
*bimdata.IfcApi* | [**fullUpdateAccessToken**](docs/IfcApi.md#fullUpdateAccessToken) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_token/{token} | Update all fields of a token
307307
*bimdata.IfcApi* | [**fullUpdateElement**](docs/IfcApi.md#fullUpdateElement) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid} | Update all fields of an element
308+
*bimdata.IfcApi* | [**fullUpdateElementPropertySetProperty**](docs/IfcApi.md#fullUpdateElementPropertySetProperty) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} | Update a property from an element
308309
*bimdata.IfcApi* | [**fullUpdateIfc**](docs/IfcApi.md#fullUpdateIfc) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/ifc/{id} | Update all fields of a model
309310
*bimdata.IfcApi* | [**fullUpdateIfcProperty**](docs/IfcApi.md#fullUpdateIfcProperty) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id} | Update some fields of a Property
310311
*bimdata.IfcApi* | [**fullUpdateIfcPropertyDefinition**](docs/IfcApi.md#fullUpdateIfcPropertyDefinition) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id} | Update all fields of many PropertyDefinitions of a model
@@ -368,8 +369,10 @@ Class | Method | HTTP request | Description
368369
*bimdata.IfcApi* | [**removeElementPropertySetPropertyDefinition**](docs/IfcApi.md#removeElementPropertySetPropertyDefinition) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{id} | Remove a Definition from a Property
369370
*bimdata.IfcApi* | [**removeElementPropertySetPropertyDefinitionUnit**](docs/IfcApi.md#removeElementPropertySetPropertyDefinitionUnit) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit/{id} | Remove a Unit from a Definition
370371
*bimdata.IfcApi* | [**removeElementsFromClassification**](docs/IfcApi.md#removeElementsFromClassification) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/{ifc_classification_pk}/element/{uuid} | Remove the classification from all elements
372+
*bimdata.IfcApi* | [**reprocessIfc**](docs/IfcApi.md#reprocessIfc) | **POST** /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/reprocess | reprocess IFC file
371373
*bimdata.IfcApi* | [**updateAccessToken**](docs/IfcApi.md#updateAccessToken) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_token/{token} | Update some fields of a token
372374
*bimdata.IfcApi* | [**updateElement**](docs/IfcApi.md#updateElement) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid} | Update some fields of a zone
375+
*bimdata.IfcApi* | [**updateElementPropertySetProperty**](docs/IfcApi.md#updateElementPropertySetProperty) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} | Update a property from an element
373376
*bimdata.IfcApi* | [**updateIfc**](docs/IfcApi.md#updateIfc) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/ifc/{id} | Update some fields of a model
374377
*bimdata.IfcApi* | [**updateIfcFiles**](docs/IfcApi.md#updateIfcFiles) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/files | Update models file (gltf, svg, structure, etc)
375378
*bimdata.IfcApi* | [**updateIfcProperty**](docs/IfcApi.md#updateIfcProperty) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id} | Update some fields of a Property

‎docs/IfcApi.md‎

Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ Method | HTTP request | Description
4949
[**exportIfc**](IfcApi.md#exportIfc) | **POST** /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/export | Export IFC
5050
[**fullUpdateAccessToken**](IfcApi.md#fullUpdateAccessToken) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_token/{token} | Update all fields of a token
5151
[**fullUpdateElement**](IfcApi.md#fullUpdateElement) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid} | Update all fields of an element
52+
[**fullUpdateElementPropertySetProperty**](IfcApi.md#fullUpdateElementPropertySetProperty) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} | Update a property from an element
5253
[**fullUpdateIfc**](IfcApi.md#fullUpdateIfc) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/ifc/{id} | Update all fields of a model
5354
[**fullUpdateIfcProperty**](IfcApi.md#fullUpdateIfcProperty) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id} | Update some fields of a Property
5455
[**fullUpdateIfcPropertyDefinition**](IfcApi.md#fullUpdateIfcPropertyDefinition) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id} | Update all fields of many PropertyDefinitions of a model
@@ -112,8 +113,10 @@ Method | HTTP request | Description
112113
[**removeElementPropertySetPropertyDefinition**](IfcApi.md#removeElementPropertySetPropertyDefinition) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{id} | Remove a Definition from a Property
113114
[**removeElementPropertySetPropertyDefinitionUnit**](IfcApi.md#removeElementPropertySetPropertyDefinitionUnit) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit/{id} | Remove a Unit from a Definition
114115
[**removeElementsFromClassification**](IfcApi.md#removeElementsFromClassification) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/{ifc_classification_pk}/element/{uuid} | Remove the classification from all elements
116+
[**reprocessIfc**](IfcApi.md#reprocessIfc) | **POST** /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/reprocess | reprocess IFC file
115117
[**updateAccessToken**](IfcApi.md#updateAccessToken) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_token/{token} | Update some fields of a token
116118
[**updateElement**](IfcApi.md#updateElement) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid} | Update some fields of a zone
119+
[**updateElementPropertySetProperty**](IfcApi.md#updateElementPropertySetProperty) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} | Update a property from an element
117120
[**updateIfc**](IfcApi.md#updateIfc) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/ifc/{id} | Update some fields of a model
118121
[**updateIfcFiles**](IfcApi.md#updateIfcFiles) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/files | Update models file (gltf, svg, structure, etc)
119122
[**updateIfcProperty**](IfcApi.md#updateIfcProperty) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id} | Update some fields of a Property
@@ -2937,6 +2940,74 @@ Name | Type | Description | Notes
29372940
- **Accept**: application/json
29382941

29392942

2943+
## fullUpdateElementPropertySetProperty
2944+
2945+
> Property fullUpdateElementPropertySetProperty(cloudPk, elementUuid, id, ifcPk, projectPk, propertysetPk, data)
2946+
2947+
Update a property from an element
2948+
2949+
Update a property value from an element. If the element is the only one to have this property, the property will be update in place. If many elements share this property, a new propertySet will be created to replace the propertyset for this element. Keeping the property for all other elements. If you want to update the property of all elements, see updateIfcProperty
2950+
2951+
### Example
2952+
2953+
```javascript
2954+
import bimdata from '@bimdata/bimdata-api-client';
2955+
let defaultClient = bimdata.ApiClient.instance;
2956+
// Configure API key authorization: Bearer
2957+
let Bearer = defaultClient.authentications['Bearer'];
2958+
Bearer.apiKey = 'YOUR API KEY';
2959+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2960+
//Bearer.apiKeyPrefix = 'Token';
2961+
// Configure OAuth2 access token for authorization: bimdata_connect
2962+
let bimdata_connect = defaultClient.authentications['bimdata_connect'];
2963+
bimdata_connect.accessToken = 'YOUR ACCESS TOKEN';
2964+
// Configure OAuth2 access token for authorization: client_credentials
2965+
let client_credentials = defaultClient.authentications['client_credentials'];
2966+
client_credentials.accessToken = 'YOUR ACCESS TOKEN';
2967+
2968+
let apiInstance = new bimdata.IfcApi();
2969+
let cloudPk = "cloudPk_example"; // String |
2970+
let elementUuid = "elementUuid_example"; // String |
2971+
let id = 56; // Number | A unique integer value identifying this property.
2972+
let ifcPk = "ifcPk_example"; // String |
2973+
let projectPk = "projectPk_example"; // String |
2974+
let propertysetPk = "propertysetPk_example"; // String |
2975+
let data = new bimdata.Property(); // Property |
2976+
apiInstance.fullUpdateElementPropertySetProperty(cloudPk, elementUuid, id, ifcPk, projectPk, propertysetPk, data).then((data) => {
2977+
console.log('API called successfully. Returned data: ' + data);
2978+
}, (error) => {
2979+
console.error(error);
2980+
});
2981+
2982+
```
2983+
2984+
### Parameters
2985+
2986+
2987+
Name | Type | Description | Notes
2988+
------------- | ------------- | ------------- | -------------
2989+
**cloudPk** | **String**| |
2990+
**elementUuid** | **String**| |
2991+
**id** | **Number**| A unique integer value identifying this property. |
2992+
**ifcPk** | **String**| |
2993+
**projectPk** | **String**| |
2994+
**propertysetPk** | **String**| |
2995+
**data** | [**Property**](Property.md)| |
2996+
2997+
### Return type
2998+
2999+
[**Property**](Property.md)
3000+
3001+
### Authorization
3002+
3003+
[Bearer](../README.md#Bearer), [bimdata_connect](../README.md#bimdata_connect), [client_credentials](../README.md#client_credentials)
3004+
3005+
### HTTP request headers
3006+
3007+
- **Content-Type**: application/json
3008+
- **Accept**: application/json
3009+
3010+
29403011
## fullUpdateIfc
29413012

29423013
> Ifc fullUpdateIfc(cloudPk, id, projectPk, data)
@@ -6911,6 +6982,66 @@ null (empty response body)
69116982
- **Accept**: Not defined
69126983

69136984

6985+
## reprocessIfc
6986+
6987+
> reprocessIfc(cloudPk, id, projectPk)
6988+
6989+
reprocess IFC file
6990+
6991+
Reprocess the IFC. All data that are not in the original IFC files will be lost Required scopes: ifc:write
6992+
6993+
### Example
6994+
6995+
```javascript
6996+
import bimdata from '@bimdata/bimdata-api-client';
6997+
let defaultClient = bimdata.ApiClient.instance;
6998+
// Configure API key authorization: Bearer
6999+
let Bearer = defaultClient.authentications['Bearer'];
7000+
Bearer.apiKey = 'YOUR API KEY';
7001+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
7002+
//Bearer.apiKeyPrefix = 'Token';
7003+
// Configure OAuth2 access token for authorization: bimdata_connect
7004+
let bimdata_connect = defaultClient.authentications['bimdata_connect'];
7005+
bimdata_connect.accessToken = 'YOUR ACCESS TOKEN';
7006+
// Configure OAuth2 access token for authorization: client_credentials
7007+
let client_credentials = defaultClient.authentications['client_credentials'];
7008+
client_credentials.accessToken = 'YOUR ACCESS TOKEN';
7009+
7010+
let apiInstance = new bimdata.IfcApi();
7011+
let cloudPk = "cloudPk_example"; // String |
7012+
let id = 56; // Number | A unique integer value identifying this ifc.
7013+
let projectPk = "projectPk_example"; // String |
7014+
apiInstance.reprocessIfc(cloudPk, id, projectPk).then(() => {
7015+
console.log('API called successfully.');
7016+
}, (error) => {
7017+
console.error(error);
7018+
});
7019+
7020+
```
7021+
7022+
### Parameters
7023+
7024+
7025+
Name | Type | Description | Notes
7026+
------------- | ------------- | ------------- | -------------
7027+
**cloudPk** | **String**| |
7028+
**id** | **Number**| A unique integer value identifying this ifc. |
7029+
**projectPk** | **String**| |
7030+
7031+
### Return type
7032+
7033+
null (empty response body)
7034+
7035+
### Authorization
7036+
7037+
[Bearer](../README.md#Bearer), [bimdata_connect](../README.md#bimdata_connect), [client_credentials](../README.md#client_credentials)
7038+
7039+
### HTTP request headers
7040+
7041+
- **Content-Type**: Not defined
7042+
- **Accept**: Not defined
7043+
7044+
69147045
## updateAccessToken
69157046

69167047
> IfcAccessToken updateAccessToken(cloudPk, ifcPk, projectPk, token, data)
@@ -7039,6 +7170,74 @@ Name | Type | Description | Notes
70397170
- **Accept**: application/json
70407171

70417172

7173+
## updateElementPropertySetProperty
7174+
7175+
> Property updateElementPropertySetProperty(cloudPk, elementUuid, id, ifcPk, projectPk, propertysetPk, data)
7176+
7177+
Update a property from an element
7178+
7179+
Update a property value from an element. If the element is the only one to have this property, the property will be update in place. If many elements share this property, a new property will be created to replace the property for this element. Keeping the property for all other elements. If you want to update the property of all elements, see updateIfcProperty Required scopes: ifc:write
7180+
7181+
### Example
7182+
7183+
```javascript
7184+
import bimdata from '@bimdata/bimdata-api-client';
7185+
let defaultClient = bimdata.ApiClient.instance;
7186+
// Configure API key authorization: Bearer
7187+
let Bearer = defaultClient.authentications['Bearer'];
7188+
Bearer.apiKey = 'YOUR API KEY';
7189+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
7190+
//Bearer.apiKeyPrefix = 'Token';
7191+
// Configure OAuth2 access token for authorization: bimdata_connect
7192+
let bimdata_connect = defaultClient.authentications['bimdata_connect'];
7193+
bimdata_connect.accessToken = 'YOUR ACCESS TOKEN';
7194+
// Configure OAuth2 access token for authorization: client_credentials
7195+
let client_credentials = defaultClient.authentications['client_credentials'];
7196+
client_credentials.accessToken = 'YOUR ACCESS TOKEN';
7197+
7198+
let apiInstance = new bimdata.IfcApi();
7199+
let cloudPk = "cloudPk_example"; // String |
7200+
let elementUuid = "elementUuid_example"; // String |
7201+
let id = 56; // Number | A unique integer value identifying this property.
7202+
let ifcPk = "ifcPk_example"; // String |
7203+
let projectPk = "projectPk_example"; // String |
7204+
let propertysetPk = "propertysetPk_example"; // String |
7205+
let data = new bimdata.Property(); // Property |
7206+
apiInstance.updateElementPropertySetProperty(cloudPk, elementUuid, id, ifcPk, projectPk, propertysetPk, data).then((data) => {
7207+
console.log('API called successfully. Returned data: ' + data);
7208+
}, (error) => {
7209+
console.error(error);
7210+
});
7211+
7212+
```
7213+
7214+
### Parameters
7215+
7216+
7217+
Name | Type | Description | Notes
7218+
------------- | ------------- | ------------- | -------------
7219+
**cloudPk** | **String**| |
7220+
**elementUuid** | **String**| |
7221+
**id** | **Number**| A unique integer value identifying this property. |
7222+
**ifcPk** | **String**| |
7223+
**projectPk** | **String**| |
7224+
**propertysetPk** | **String**| |
7225+
**data** | [**Property**](Property.md)| |
7226+
7227+
### Return type
7228+
7229+
[**Property**](Property.md)
7230+
7231+
### Authorization
7232+
7233+
[Bearer](../README.md#Bearer), [bimdata_connect](../README.md#bimdata_connect), [client_credentials](../README.md#client_credentials)
7234+
7235+
### HTTP request headers
7236+
7237+
- **Content-Type**: application/json
7238+
- **Accept**: application/json
7239+
7240+
70427241
## updateIfc
70437242

70447243
> Ifc updateIfc(cloudPk, id, projectPk, data)

0 commit comments

Comments
 (0)