Skip to content

Commit 5e940de

Browse files
Bimdata-ioBimdata-io
committed
PATCH: add meta routes for model elements (#881)
1 parent 1d9589d commit 5e940de

17 files changed

+606
-103
lines changed

‎.openapi-generator/FILES

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,7 @@ docs/ProjectSize.md
172172
docs/Property.md
173173
docs/PropertyDefinition.md
174174
docs/PropertyDefinitionRequest.md
175+
docs/PropertyList.md
175176
docs/PropertyRequest.md
176177
docs/PropertySet.md
177178
docs/PropertySetRequest.md
@@ -448,6 +449,7 @@ src/model/ProjectSize.js
448449
src/model/Property.js
449450
src/model/PropertyDefinition.js
450451
src/model/PropertyDefinitionRequest.js
452+
src/model/PropertyList.js
451453
src/model/PropertyRequest.js
452454
src/model/PropertySet.js
453455
src/model/PropertySetRequest.js
@@ -718,6 +720,7 @@ test/model/ProjectSize.spec.js
718720
test/model/Property.spec.js
719721
test/model/PropertyDefinition.spec.js
720722
test/model/PropertyDefinitionRequest.spec.js
723+
test/model/PropertyList.spec.js
721724
test/model/PropertyRequest.spec.js
722725
test/model/PropertySet.spec.js
723726
test/model/PropertySetRequest.spec.js

‎README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -414,6 +414,7 @@ Class | Method | HTTP request | Description
414414
*bimdata.ModelApi* | [**getModels**](docs/ModelApi.md#getModels) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model | Retrieve all models
415415
*bimdata.ModelApi* | [**getProcessorHandler**](docs/ModelApi.md#getProcessorHandler) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/processorhandler/{id} | Retrieve a processor handler
416416
*bimdata.ModelApi* | [**getProcessorHandlers**](docs/ModelApi.md#getProcessorHandlers) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/processorhandler | Get all processor handlers
417+
*bimdata.ModelApi* | [**getPropertiesTypes**](docs/ModelApi.md#getPropertiesTypes) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/properties | Retrieve all property types and their value type used in this model
417418
*bimdata.ModelApi* | [**getPropertySet**](docs/ModelApi.md#getPropertySet) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/{id} | Retrieve a PropertySet of a model
418419
*bimdata.ModelApi* | [**getPropertySets**](docs/ModelApi.md#getPropertySets) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset | Retrieve all PropertySets of a model
419420
*bimdata.ModelApi* | [**getRawElements**](docs/ModelApi.md#getRawElements) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/raw | Retrieve all elements in a optimized format
@@ -427,6 +428,7 @@ Class | Method | HTTP request | Description
427428
*bimdata.ModelApi* | [**getSystem**](docs/ModelApi.md#getSystem) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system/{uuid} | Retrieve a system of a model
428429
*bimdata.ModelApi* | [**getSystems**](docs/ModelApi.md#getSystems) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system | Retrieve all systems of a model
429430
*bimdata.ModelApi* | [**getTileset**](docs/ModelApi.md#getTileset) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/tileset | Retrieve the tileset of the model
431+
*bimdata.ModelApi* | [**getTypes**](docs/ModelApi.md#getTypes) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/types | Retrieve all IFC Types used in this model
430432
*bimdata.ModelApi* | [**getZone**](docs/ModelApi.md#getZone) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{id} | Retrieve one zone of a model
431433
*bimdata.ModelApi* | [**getZoneSpace**](docs/ModelApi.md#getZoneSpace) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/{id} | Retrieve one space of a zone
432434
*bimdata.ModelApi* | [**getZoneSpaces**](docs/ModelApi.md#getZoneSpaces) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space | Retrieve all spaces of a zone
@@ -659,6 +661,7 @@ Class | Method | HTTP request | Description
659661
- [bimdata.Property](docs/Property.md)
660662
- [bimdata.PropertyDefinition](docs/PropertyDefinition.md)
661663
- [bimdata.PropertyDefinitionRequest](docs/PropertyDefinitionRequest.md)
664+
- [bimdata.PropertyList](docs/PropertyList.md)
662665
- [bimdata.PropertyRequest](docs/PropertyRequest.md)
663666
- [bimdata.PropertySet](docs/PropertySet.md)
664667
- [bimdata.PropertySetRequest](docs/PropertySetRequest.md)

‎docs/CollaborationApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -882,7 +882,7 @@ Name | Type | Description | Notes
882882
883883
Create a document
884884

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

887887
### Example
888888

‎docs/ModelApi.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ Method | HTTP request | Description
112112
[**getModels**](ModelApi.md#getModels) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model | Retrieve all models
113113
[**getProcessorHandler**](ModelApi.md#getProcessorHandler) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/processorhandler/{id} | Retrieve a processor handler
114114
[**getProcessorHandlers**](ModelApi.md#getProcessorHandlers) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/processorhandler | Get all processor handlers
115+
[**getPropertiesTypes**](ModelApi.md#getPropertiesTypes) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/properties | Retrieve all property types and their value type used in this model
115116
[**getPropertySet**](ModelApi.md#getPropertySet) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/{id} | Retrieve a PropertySet of a model
116117
[**getPropertySets**](ModelApi.md#getPropertySets) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset | Retrieve all PropertySets of a model
117118
[**getRawElements**](ModelApi.md#getRawElements) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/raw | Retrieve all elements in a optimized format
@@ -125,6 +126,7 @@ Method | HTTP request | Description
125126
[**getSystem**](ModelApi.md#getSystem) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system/{uuid} | Retrieve a system of a model
126127
[**getSystems**](ModelApi.md#getSystems) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system | Retrieve all systems of a model
127128
[**getTileset**](ModelApi.md#getTileset) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/tileset | Retrieve the tileset of the model
129+
[**getTypes**](ModelApi.md#getTypes) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/types | Retrieve all IFC Types used in this model
128130
[**getZone**](ModelApi.md#getZone) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{id} | Retrieve one zone of a model
129131
[**getZoneSpace**](ModelApi.md#getZoneSpace) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/{id} | Retrieve one space of a zone
130132
[**getZoneSpaces**](ModelApi.md#getZoneSpaces) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space | Retrieve all spaces of a zone
@@ -6865,6 +6867,73 @@ Name | Type | Description | Notes
68656867
- **Accept**: application/json
68666868

68676869

6870+
## getPropertiesTypes
6871+
6872+
> [PropertyList] getPropertiesTypes(cloudPk, modelPk, projectPk, opts)
6873+
6874+
Retrieve all property types and their value type used in this model
6875+
6876+
Retrieve all property types and their value type used in this model Required scopes: ifc:read, model:read
6877+
6878+
### Example
6879+
6880+
```javascript
6881+
import bimdata from '@bimdata/bimdata-api-client';
6882+
let defaultClient = bimdata.ApiClient.instance;
6883+
// Configure API key authorization: ApiKey
6884+
let ApiKey = defaultClient.authentications['ApiKey'];
6885+
ApiKey.apiKey = 'YOUR API KEY';
6886+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
6887+
//ApiKey.apiKeyPrefix = 'Token';
6888+
// Configure API key authorization: Bearer
6889+
let Bearer = defaultClient.authentications['Bearer'];
6890+
Bearer.apiKey = 'YOUR API KEY';
6891+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
6892+
//Bearer.apiKeyPrefix = 'Token';
6893+
6894+
let apiInstance = new bimdata.ModelApi();
6895+
let cloudPk = 56; // Number | A unique integer value identifying this cloud.
6896+
let modelPk = 56; // Number | A unique integer value identifying this model.
6897+
let projectPk = 56; // Number | A unique integer value identifying this project.
6898+
let opts = {
6899+
'classification': "classification_example", // String |
6900+
'classificationNotation': "classificationNotation_example", // String |
6901+
'type': "type_example" // String |
6902+
};
6903+
apiInstance.getPropertiesTypes(cloudPk, modelPk, projectPk, opts).then((data) => {
6904+
console.log('API called successfully. Returned data: ' + data);
6905+
}, (error) => {
6906+
console.error(error);
6907+
});
6908+
6909+
```
6910+
6911+
### Parameters
6912+
6913+
6914+
Name | Type | Description | Notes
6915+
------------- | ------------- | ------------- | -------------
6916+
**cloudPk** | **Number**| A unique integer value identifying this cloud. |
6917+
**modelPk** | **Number**| A unique integer value identifying this model. |
6918+
**projectPk** | **Number**| A unique integer value identifying this project. |
6919+
**classification** | **String**| | [optional]
6920+
**classificationNotation** | **String**| | [optional]
6921+
**type** | **String**| | [optional]
6922+
6923+
### Return type
6924+
6925+
[**[PropertyList]**](PropertyList.md)
6926+
6927+
### Authorization
6928+
6929+
[ApiKey](../README.md#ApiKey), [Bearer](../README.md#Bearer)
6930+
6931+
### HTTP request headers
6932+
6933+
- **Content-Type**: Not defined
6934+
- **Accept**: application/json
6935+
6936+
68686937
## getPropertySet
68696938

68706939
> PropertySet getPropertySet(cloudPk, id, modelPk, projectPk)
@@ -7666,6 +7735,65 @@ null (empty response body)
76667735
- **Accept**: Not defined
76677736

76687737

7738+
## getTypes
7739+
7740+
> [String] getTypes(cloudPk, modelPk, projectPk)
7741+
7742+
Retrieve all IFC Types used in this model
7743+
7744+
Retrieve all IFC Types used in this model Required scopes: ifc:read, model:read
7745+
7746+
### Example
7747+
7748+
```javascript
7749+
import bimdata from '@bimdata/bimdata-api-client';
7750+
let defaultClient = bimdata.ApiClient.instance;
7751+
// Configure API key authorization: ApiKey
7752+
let ApiKey = defaultClient.authentications['ApiKey'];
7753+
ApiKey.apiKey = 'YOUR API KEY';
7754+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
7755+
//ApiKey.apiKeyPrefix = 'Token';
7756+
// Configure API key authorization: Bearer
7757+
let Bearer = defaultClient.authentications['Bearer'];
7758+
Bearer.apiKey = 'YOUR API KEY';
7759+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
7760+
//Bearer.apiKeyPrefix = 'Token';
7761+
7762+
let apiInstance = new bimdata.ModelApi();
7763+
let cloudPk = 56; // Number | A unique integer value identifying this cloud.
7764+
let modelPk = 56; // Number | A unique integer value identifying this model.
7765+
let projectPk = 56; // Number | A unique integer value identifying this project.
7766+
apiInstance.getTypes(cloudPk, modelPk, projectPk).then((data) => {
7767+
console.log('API called successfully. Returned data: ' + data);
7768+
}, (error) => {
7769+
console.error(error);
7770+
});
7771+
7772+
```
7773+
7774+
### Parameters
7775+
7776+
7777+
Name | Type | Description | Notes
7778+
------------- | ------------- | ------------- | -------------
7779+
**cloudPk** | **Number**| A unique integer value identifying this cloud. |
7780+
**modelPk** | **Number**| A unique integer value identifying this model. |
7781+
**projectPk** | **Number**| A unique integer value identifying this project. |
7782+
7783+
### Return type
7784+
7785+
**[String]**
7786+
7787+
### Authorization
7788+
7789+
[ApiKey](../README.md#ApiKey), [Bearer](../README.md#Bearer)
7790+
7791+
### HTTP request headers
7792+
7793+
- **Content-Type**: Not defined
7794+
- **Accept**: application/json
7795+
7796+
76697797
## getZone
76707798

76717799
> Zone getZone(cloudPk, id, modelPk, projectPk)

‎docs/PropertyList.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# bimdata.PropertyList
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**name** | **String** | |
8+
**valueType** | **String** | * `string` - string * `number` - number * `boolean` - boolean |
9+
10+
11+
12+
## Enum: ValueTypeEnum
13+
14+
15+
* `string` (value: `"string"`)
16+
17+
* `number` (value: `"number"`)
18+
19+
* `boolean` (value: `"boolean"`)
20+
21+
22+
23+

‎docs/WriteFolder.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**updatedAt** | **Date** | Date of the last update | [readonly]
8-
**defaultPermission** | **Number** | Permission for a Folder * `1` - denied * `50` - read_only * `100` - read_write | [optional]
7+
**id** | **Number** | | [readonly]
98
**parentId** | **Number** | | [optional]
10-
**groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly]
11-
**nature** | **String** | Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly]
9+
**createdAt** | **Date** | Creation date | [readonly]
1210
**name** | **String** | Name of the folder |
13-
**id** | **Number** | | [readonly]
14-
**type** | **String** | DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly]
11+
**updatedAt** | **Date** | Date of the last update | [readonly]
12+
**defaultPermission** | **Number** | Permission for a Folder * `1` - denied * `50` - read_only * `100` - read_write | [optional]
1513
**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly]
16-
**createdAt** | **Date** | Creation date | [readonly]
14+
**type** | **String** | DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly]
15+
**nature** | **String** | Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly]
1716
**createdBy** | [**ShortUser**](ShortUser.md) | | [readonly]
17+
**groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly]
1818
**children** | [**[WriteFolder]**](WriteFolder.md) | | [optional]
1919

2020

‎docs/WriteFolderRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**defaultPermission** | **Number** | Permission for a Folder * `1` - denied * `50` - read_only * `100` - read_write | [optional]
87
**parentId** | **Number** | | [optional]
98
**name** | **String** | Name of the folder |
9+
**defaultPermission** | **Number** | Permission for a Folder * `1` - denied * `50` - read_only * `100` - read_write | [optional]
1010
**children** | [**[WriteFolder]**](WriteFolder.md) | | [optional]
1111

1212

‎src/api/CollaborationApi.js

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

867867
/**
868868
* Create a document
869-
* Create a document. If the document is one of {'OBJ', 'DWG', 'IFC', 'GLTF', 'POINT_CLOUD', 'DXF'}, a model will be created and attached to this document Required scopes: document:write
869+
* Create a document. If the document is one of {'DWG', 'POINT_CLOUD', 'GLTF', 'DXF', 'OBJ', 'IFC'}, a model will be created and attached to this document Required scopes: document:write
870870
* @param {Number} cloudPk A unique integer value identifying this cloud.
871871
* @param {Number} projectPk A unique integer value identifying this project.
872872
* @param {String} name Shown name of the file
@@ -934,7 +934,7 @@ export default class CollaborationApi {
934934

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

0 commit comments

Comments
 (0)