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

Commit 4b802f7

Browse files
committed
MINOR: add routes to manage zone_space relations (#690)
1 parent caa04a9 commit 4b802f7

File tree

14 files changed

+506
-19
lines changed

14 files changed

+506
-19
lines changed

.openapi-generator/FILES

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,7 @@ docs/XktFile.md
243243
docs/Zone.md
244244
docs/ZoneRequest.md
245245
docs/ZoneSpace.md
246+
docs/ZoneSpaceRelationRequest.md
246247
docs/ZoneSpaceRequest.md
247248
git_push.sh
248249
mocha.opts
@@ -489,6 +490,7 @@ src/model/XktFile.js
489490
src/model/Zone.js
490491
src/model/ZoneRequest.js
491492
src/model/ZoneSpace.js
493+
src/model/ZoneSpaceRelationRequest.js
492494
src/model/ZoneSpaceRequest.js
493495
test/api/BcfApi.spec.js
494496
test/api/CollaborationApi.spec.js
@@ -731,4 +733,5 @@ test/model/XktFile.spec.js
731733
test/model/Zone.spec.js
732734
test/model/ZoneRequest.spec.js
733735
test/model/ZoneSpace.spec.js
736+
test/model/ZoneSpaceRelationRequest.spec.js
734737
test/model/ZoneSpaceRequest.spec.js

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,7 @@ Class | Method | HTTP request | Description
312312
*bimdata.CollaborationApi* | [**updateVisa**](docs/CollaborationApi.md#updateVisa) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id} | Update some fields of a visa
313313
*bimdata.CollaborationApi* | [**updateVisaComment**](docs/CollaborationApi.md#updateVisaComment) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment/{id} | Update some fields of a comment
314314
*bimdata.IfcApi* | [**addIfcErrorsDeprecated**](docs/IfcApi.md#addIfcErrorsDeprecated) | **POST** /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/errors | Add errors to model
315+
*bimdata.IfcApi* | [**addZoneSpaceDeprecated**](docs/IfcApi.md#addZoneSpaceDeprecated) | **POST** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/add | Add a space to a zone
315316
*bimdata.IfcApi* | [**bulkDeleteIfcClassificationsDeprecated**](docs/IfcApi.md#bulkDeleteIfcClassificationsDeprecated) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/list_destroy | Remove all classifications from model's elements
316317
*bimdata.IfcApi* | [**bulkDeleteIfcPropertiesDeprecated**](docs/IfcApi.md#bulkDeleteIfcPropertiesDeprecated) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/bulk_destroy | Delete many Property of a model
317318
*bimdata.IfcApi* | [**bulkDeleteIfcPropertyDefinitionsDeprecated**](docs/IfcApi.md#bulkDeleteIfcPropertyDefinitionsDeprecated) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/bulk_destroy | Delete many PropertyDefinitions of a model
@@ -367,7 +368,7 @@ Class | Method | HTTP request | Description
367368
*bimdata.IfcApi* | [**deleteStoreyPlanDeprecated**](docs/IfcApi.md#deleteStoreyPlanDeprecated) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/storey/{storey_uuid}/plan/{id} | Delete the relation between a 2d model and a storey
368369
*bimdata.IfcApi* | [**deleteSystemDeprecated**](docs/IfcApi.md#deleteSystemDeprecated) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/system/{uuid} | Delete a system of a model
369370
*bimdata.IfcApi* | [**deleteZoneDeprecated**](docs/IfcApi.md#deleteZoneDeprecated) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id} | Delete a zone of a model
370-
*bimdata.IfcApi* | [**deleteZoneSpaceDeprecated**](docs/IfcApi.md#deleteZoneSpaceDeprecated) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id} | Delete a space of a zone
371+
*bimdata.IfcApi* | [**deleteZoneSpaceDeprecated**](docs/IfcApi.md#deleteZoneSpaceDeprecated) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id} | Delete the relation between a space and a zone
371372
*bimdata.IfcApi* | [**exportIfcDeprecated**](docs/IfcApi.md#exportIfcDeprecated) | **POST** /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/export | Export IFC
372373
*bimdata.IfcApi* | [**fullUpdateElementDeprecated**](docs/IfcApi.md#fullUpdateElementDeprecated) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid} | Update all fields of an element
373374
*bimdata.IfcApi* | [**getAccessTokenDeprecated**](docs/IfcApi.md#getAccessTokenDeprecated) | **GET** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_token/{token} | Retrieve one token created for this model
@@ -459,6 +460,7 @@ Class | Method | HTTP request | Description
459460
*bimdata.IfcApi* | [**updateZoneDeprecated**](docs/IfcApi.md#updateZoneDeprecated) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id} | Update some fields of a zone
460461
*bimdata.IfcApi* | [**updateZoneSpaceDeprecated**](docs/IfcApi.md#updateZoneSpaceDeprecated) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id} | Update some fields of a space
461462
*bimdata.ModelApi* | [**addModelErrors**](docs/ModelApi.md#addModelErrors) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/errors | Add errors to model
463+
*bimdata.ModelApi* | [**addZoneSpace**](docs/ModelApi.md#addZoneSpace) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/add | Add a space to a zone
462464
*bimdata.ModelApi* | [**bulkDeleteModelClassifications**](docs/ModelApi.md#bulkDeleteModelClassifications) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/list_destroy | Remove all classifications from model's elements
463465
*bimdata.ModelApi* | [**bulkDeleteModelProperties**](docs/ModelApi.md#bulkDeleteModelProperties) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/bulk_destroy | Delete many Property of a model
464466
*bimdata.ModelApi* | [**bulkDeleteModelPropertyDefinitions**](docs/ModelApi.md#bulkDeleteModelPropertyDefinitions) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/bulk_destroy | Delete many PropertyDefinitions of a model
@@ -514,7 +516,7 @@ Class | Method | HTTP request | Description
514516
*bimdata.ModelApi* | [**deleteStoreyPlan**](docs/ModelApi.md#deleteStoreyPlan) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/{id} | Delete the relation between a 2d model and a storey
515517
*bimdata.ModelApi* | [**deleteSystem**](docs/ModelApi.md#deleteSystem) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system/{uuid} | Delete a system of a model
516518
*bimdata.ModelApi* | [**deleteZone**](docs/ModelApi.md#deleteZone) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{id} | Delete a zone of a model
517-
*bimdata.ModelApi* | [**deleteZoneSpace**](docs/ModelApi.md#deleteZoneSpace) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/{id} | Delete a space of a zone
519+
*bimdata.ModelApi* | [**deleteZoneSpace**](docs/ModelApi.md#deleteZoneSpace) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/{id} | Delete the relation between a space and a zone
518520
*bimdata.ModelApi* | [**exportIfc**](docs/ModelApi.md#exportIfc) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/export | Export IFC
519521
*bimdata.ModelApi* | [**fullUpdateElement**](docs/ModelApi.md#fullUpdateElement) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} | Update all fields of an element
520522
*bimdata.ModelApi* | [**getAccessToken**](docs/ModelApi.md#getAccessToken) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token/{token} | Retrieve one token created for this model
@@ -856,6 +858,7 @@ Class | Method | HTTP request | Description
856858
- [bimdata.Zone](docs/Zone.md)
857859
- [bimdata.ZoneRequest](docs/ZoneRequest.md)
858860
- [bimdata.ZoneSpace](docs/ZoneSpace.md)
861+
- [bimdata.ZoneSpaceRelationRequest](docs/ZoneSpaceRelationRequest.md)
859862
- [bimdata.ZoneSpaceRequest](docs/ZoneSpaceRequest.md)
860863

861864

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

960960
### Example
961961

docs/IfcApi.md

Lines changed: 73 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ All URIs are relative to *http://localhost*
55
Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**addIfcErrorsDeprecated**](IfcApi.md#addIfcErrorsDeprecated) | **POST** /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/errors | Add errors to model
8+
[**addZoneSpaceDeprecated**](IfcApi.md#addZoneSpaceDeprecated) | **POST** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/add | Add a space to a zone
89
[**bulkDeleteIfcClassificationsDeprecated**](IfcApi.md#bulkDeleteIfcClassificationsDeprecated) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/list_destroy | Remove all classifications from model's elements
910
[**bulkDeleteIfcPropertiesDeprecated**](IfcApi.md#bulkDeleteIfcPropertiesDeprecated) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/bulk_destroy | Delete many Property of a model
1011
[**bulkDeleteIfcPropertyDefinitionsDeprecated**](IfcApi.md#bulkDeleteIfcPropertyDefinitionsDeprecated) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/bulk_destroy | Delete many PropertyDefinitions of a model
@@ -60,7 +61,7 @@ Method | HTTP request | Description
6061
[**deleteStoreyPlanDeprecated**](IfcApi.md#deleteStoreyPlanDeprecated) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/storey/{storey_uuid}/plan/{id} | Delete the relation between a 2d model and a storey
6162
[**deleteSystemDeprecated**](IfcApi.md#deleteSystemDeprecated) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/system/{uuid} | Delete a system of a model
6263
[**deleteZoneDeprecated**](IfcApi.md#deleteZoneDeprecated) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id} | Delete a zone of a model
63-
[**deleteZoneSpaceDeprecated**](IfcApi.md#deleteZoneSpaceDeprecated) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id} | Delete a space of a zone
64+
[**deleteZoneSpaceDeprecated**](IfcApi.md#deleteZoneSpaceDeprecated) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id} | Delete the relation between a space and a zone
6465
[**exportIfcDeprecated**](IfcApi.md#exportIfcDeprecated) | **POST** /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/export | Export IFC
6566
[**fullUpdateElementDeprecated**](IfcApi.md#fullUpdateElementDeprecated) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid} | Update all fields of an element
6667
[**getAccessTokenDeprecated**](IfcApi.md#getAccessTokenDeprecated) | **GET** /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_token/{token} | Retrieve one token created for this model
@@ -223,6 +224,75 @@ Name | Type | Description | Notes
223224
- **Accept**: application/json
224225

225226

227+
## addZoneSpaceDeprecated
228+
229+
> ZoneSpace addZoneSpaceDeprecated(cloudPk, ifcPk, projectPk, zonePk, zoneSpaceRelationRequest)
230+
231+
Add a space to a zone
232+
233+
Add a space to a zone. The IFC file will not be updated. The created space will be accessible over the API and when exporting an IFC file Required scopes: ifc:write, model:write
234+
235+
### Example
236+
237+
```javascript
238+
import bimdata from '@bimdata/bimdata-api-client';
239+
let defaultClient = bimdata.ApiClient.instance;
240+
// Configure API key authorization: ApiKey
241+
let ApiKey = defaultClient.authentications['ApiKey'];
242+
ApiKey.apiKey = 'YOUR API KEY';
243+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
244+
//ApiKey.apiKeyPrefix = 'Token';
245+
// Configure OAuth2 access token for authorization: BIMData_Connect
246+
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
247+
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
248+
// Configure OAuth2 access token for authorization: BIMData_Connect
249+
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
250+
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
251+
// Configure API key authorization: Bearer
252+
let Bearer = defaultClient.authentications['Bearer'];
253+
Bearer.apiKey = 'YOUR API KEY';
254+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
255+
//Bearer.apiKeyPrefix = 'Token';
256+
257+
let apiInstance = new bimdata.IfcApi();
258+
let cloudPk = 56; // Number | A unique integer value identifying this cloud.
259+
let ifcPk = 56; // Number | A unique integer value identifying this model.
260+
let projectPk = 56; // Number | A unique integer value identifying this project.
261+
let zonePk = 56; // Number | A unique integer value identifying this zone.
262+
let zoneSpaceRelationRequest = new bimdata.ZoneSpaceRelationRequest(); // ZoneSpaceRelationRequest |
263+
apiInstance.addZoneSpaceDeprecated(cloudPk, ifcPk, projectPk, zonePk, zoneSpaceRelationRequest).then((data) => {
264+
console.log('API called successfully. Returned data: ' + data);
265+
}, (error) => {
266+
console.error(error);
267+
});
268+
269+
```
270+
271+
### Parameters
272+
273+
274+
Name | Type | Description | Notes
275+
------------- | ------------- | ------------- | -------------
276+
**cloudPk** | **Number**| A unique integer value identifying this cloud. |
277+
**ifcPk** | **Number**| A unique integer value identifying this model. |
278+
**projectPk** | **Number**| A unique integer value identifying this project. |
279+
**zonePk** | **Number**| A unique integer value identifying this zone. |
280+
**zoneSpaceRelationRequest** | [**ZoneSpaceRelationRequest**](ZoneSpaceRelationRequest.md)| |
281+
282+
### Return type
283+
284+
[**ZoneSpace**](ZoneSpace.md)
285+
286+
### Authorization
287+
288+
[ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer)
289+
290+
### HTTP request headers
291+
292+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
293+
- **Accept**: application/json
294+
295+
226296
## bulkDeleteIfcClassificationsDeprecated
227297

228298
> bulkDeleteIfcClassificationsDeprecated(cloudPk, ifcPk, projectPk, opts)
@@ -3978,9 +4048,9 @@ null (empty response body)
39784048

39794049
> deleteZoneSpaceDeprecated(cloudPk, id, ifcPk, projectPk, zonePk)
39804050
3981-
Delete a space of a zone
4051+
Delete the relation between a space and a zone
39824052

3983-
The IFC file will not be updated. The remaining spaces are available in API and will be available when exporting an IFC file Required scopes: ifc:write, model:write
4053+
Delete the relation between a space and a zone. The IFC file will not be updated. The remaining spaces are available in API and will be available when exporting an IFC file Required scopes: ifc:write, model:write
39844054

39854055
### Example
39864056

0 commit comments

Comments
 (0)