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

Commit e9ff434

Browse files
committed
MAJOR: rename ifc to model (#477)
* filter storey models with permissions * duplicate ifc routes and update tags ViewSet * add deprecated ifc views and filter by type * rename ifc operations * rename Ifc table * rename some Ifc classes * duplicate ifc test and change reverse url name * update foreignkeys * rename ifc_pk in model_pk * update route name * update scopes * fix swagger dupplicate * fix test projectAccessToken * actually send keycloak scope create * restore ifc_guid * don't unzip unzipped structure files * fix bad rebase
1 parent 7263bd5 commit e9ff434

57 files changed

Lines changed: 25664 additions & 3661 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 289 additions & 146 deletions
Large diffs are not rendered by default.

docs/BcfApi.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1274,6 +1274,7 @@ client_credentials.accessToken = 'YOUR ACCESS TOKEN';
12741274
let apiInstance = new bimdata.BcfApi();
12751275
let projectsPk = "projectsPk_example"; // String |
12761276
let opts = {
1277+
'models': "models_example", // String | Filter the returned list by models
12771278
'ifcs': "ifcs_example", // String | Filter the returned list by ifcs
12781279
'format': "format_example", // String | Filter the returned list by format
12791280
'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64
@@ -1292,6 +1293,7 @@ apiInstance.getFullTopics(projectsPk, opts).then((data) => {
12921293
Name | Type | Description | Notes
12931294
------------- | ------------- | ------------- | -------------
12941295
**projectsPk** | **String**| |
1296+
**models** | **String**| Filter the returned list by models | [optional]
12951297
**ifcs** | **String**| Filter the returned list by ifcs | [optional]
12961298
**format** | **String**| Filter the returned list by format | [optional]
12971299
**imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional]
@@ -1578,6 +1580,7 @@ client_credentials.accessToken = 'YOUR ACCESS TOKEN';
15781580
let apiInstance = new bimdata.BcfApi();
15791581
let projectsPk = "projectsPk_example"; // String |
15801582
let opts = {
1583+
'models': "models_example", // String | Filter the returned list by models
15811584
'ifcs': "ifcs_example", // String | Filter the returned list by ifcs
15821585
'format': "format_example" // String | Filter the returned list by format
15831586
};
@@ -1595,6 +1598,7 @@ apiInstance.getTopics(projectsPk, opts).then((data) => {
15951598
Name | Type | Description | Notes
15961599
------------- | ------------- | ------------- | -------------
15971600
**projectsPk** | **String**| |
1601+
**models** | **String**| Filter the returned list by models | [optional]
15981602
**ifcs** | **String**| Filter the returned list by ifcs | [optional]
15991603
**format** | **String**| Filter the returned list by format | [optional]
16001604

docs/CheckerApi.md

Lines changed: 55 additions & 55 deletions
Large diffs are not rendered by default.

docs/CollaborationApi.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Method | HTTP request | Description
5959
[**getProjectCreatorVisas**](CollaborationApi.md#getProjectCreatorVisas) | **GET** /cloud/{cloud_pk}/project/{project_pk}/me/visa/creator | List visas created by user
6060
[**getProjectDMSTree**](CollaborationApi.md#getProjectDMSTree) | **GET** /cloud/{cloud_pk}/project/{id}/dms-tree | Retrieve the complete DMS tree
6161
[**getProjectInvitations**](CollaborationApi.md#getProjectInvitations) | **GET** /cloud/{cloud_pk}/project/{project_pk}/invitation | Retrieve all pending invitations in the project
62-
[**getProjectSize**](CollaborationApi.md#getProjectSize) | **GET** /cloud/{cloud_pk}/project/{id}/size | Get size of all ifc files in the project
62+
[**getProjectSize**](CollaborationApi.md#getProjectSize) | **GET** /cloud/{cloud_pk}/project/{id}/size | Get size of all model files in the project
6363
[**getProjectSubTree**](CollaborationApi.md#getProjectSubTree) | **GET** /cloud/{cloud_pk}/project/subtree | Retrieve the complete projects tree of the cloud
6464
[**getProjectTree**](CollaborationApi.md#getProjectTree) | **GET** /cloud/{cloud_pk}/project/{id}/tree | Retrieve the complete DMS tree
6565
[**getProjectUsers**](CollaborationApi.md#getProjectUsers) | **GET** /cloud/{cloud_pk}/project/{project_pk}/user | Retrieve all users in a project, or a list with a filter by email
@@ -463,7 +463,7 @@ null (empty response body)
463463
464464
Create a classification
465465

466-
Bulk create available. You can either post an object or a list of objects. Is you post a list, the response will be a list (in the same order) of created objects or of errors if any If at least one create succeeded, the status code will be 201. If every create failed, the status code we'll be 400 with the list of errors If created classification already exists, it will not be duplicated and the previous one will be returned. You also can add a 'classification' filter on this endpoint. By ex: /classification?name='untec'. The name is case sensitive Required scopes: ifc:write
466+
Bulk create available. You can either post an object or a list of objects. Is you post a list, the response will be a list (in the same order) of created objects or of errors if any If at least one create succeeded, the status code will be 201. If every create failed, the status code we'll be 400 with the list of errors If created classification already exists, it will not be duplicated and the previous one will be returned. You also can add a 'classification' filter on this endpoint. By ex: /classification?name='untec'. The name is case sensitive Required scopes: ifc:write, model:write
467467

468468
### Example
469469

@@ -726,7 +726,8 @@ let opts = {
726726
'fileName': "fileName_example", // String | Full name of the file
727727
'description': "description_example", // String | Description of the file
728728
'size': 56, // Number | Size of the file.
729-
'ifcSource': "ifcSource_example" // String | Define the ifc.source field if the upload is an IFC
729+
'modelSource': "modelSource_example", // String | Define the model.source field if the upload is a Model (IFC, PDF, DWG...)
730+
'ifcSource': "ifcSource_example" // String | DEPRECATED: Use 'model_source' instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...)
730731
};
731732
apiInstance.createDocument(cloudPk, projectPk, name, file, opts).then((data) => {
732733
console.log('API called successfully. Returned data: ' + data);
@@ -751,7 +752,8 @@ Name | Type | Description | Notes
751752
**fileName** | **String**| Full name of the file | [optional]
752753
**description** | **String**| Description of the file | [optional]
753754
**size** | **Number**| Size of the file. | [optional]
754-
**ifcSource** | **String**| Define the ifc.source field if the upload is an IFC | [optional]
755+
**modelSource** | **String**| Define the model.source field if the upload is a Model (IFC, PDF, DWG...) | [optional]
756+
**ifcSource** | **String**| DEPRECATED: Use 'model_source' instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...) | [optional]
755757

756758
### Return type
757759

@@ -1201,7 +1203,7 @@ Name | Type | Description | Notes
12011203
12021204
Delete a classification
12031205

1204-
All elements having this classification will lose it Required scopes: ifc:write
1206+
All elements having this classification will lose it Required scopes: ifc:write, model:write
12051207

12061208
### Example
12071209

@@ -2049,7 +2051,7 @@ null (empty response body)
20492051
20502052
Retrieve a classification
20512053

2052-
Retrieve a classification Required scopes: ifc:read
2054+
Retrieve a classification Required scopes: ifc:read, model:read
20532055

20542056
### Example
20552057

@@ -2109,7 +2111,7 @@ Name | Type | Description | Notes
21092111
21102112
Retrieve all classifications
21112113

2112-
Retrieve all classifications of all models in the project Required scopes: ifc:read
2114+
Retrieve all classifications of all models in the project Required scopes: ifc:read, model:read
21132115

21142116
### Example
21152117

@@ -3389,7 +3391,7 @@ Name | Type | Description | Notes
33893391

33903392
> ProjectSize getProjectSize(cloudPk, id)
33913393
3392-
Get size of all ifc files in the project
3394+
Get size of all model files in the project
33933395

33943396
Returns the size of the project in Bytes
33953397

@@ -4587,7 +4589,7 @@ null (empty response body)
45874589
45884590
Update some fields of a classification
45894591

4590-
Update some fields of a classification Required scopes: ifc:write
4592+
Update some fields of a classification Required scopes: ifc:write, model:write
45914593

45924594
### Example
45934595

docs/Document.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,31 @@ Name | Type | Description | Notes
1616
**size** | **Number** | Size of the file. | [optional]
1717
**createdAt** | **Date** | Creation date | [optional] [readonly]
1818
**updatedAt** | **Date** | Date of the last update | [optional] [readonly]
19-
**ifcSource** | **String** | Define the ifc.source field if the upload is an IFC | [optional]
20-
**ifcId** | **String** | | [optional] [readonly]
19+
**modelSource** | **String** | Define the model.source field if the upload is a Model (IFC, PDF, DWG...) | [optional]
20+
**modelId** | **String** | | [optional] [readonly]
21+
**ifcSource** | **String** | DEPRECATED: Use 'model_source' instead. Define the model.source field if the upload is a Model (IFC, PDF, DWG...) | [optional]
22+
**ifcId** | **String** | DEPRECATED: Use 'model_id' instead. | [optional] [readonly]
2123
**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [optional] [readonly]
2224

2325

2426

27+
## Enum: ModelSourceEnum
28+
29+
30+
* `UPLOAD` (value: `"UPLOAD"`)
31+
32+
* `SPLIT` (value: `"SPLIT"`)
33+
34+
* `MERGE` (value: `"MERGE"`)
35+
36+
* `EXPORT` (value: `"EXPORT"`)
37+
38+
* `OPTIMIZED` (value: `"OPTIMIZED"`)
39+
40+
41+
42+
43+
2544
## Enum: IfcSourceEnum
2645

2746

docs/Folder.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**id** | **Number** | | [optional] [readonly]
88
**parentId** | **Number** | | [optional]
9-
**type** | **String** | Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [optional] [readonly]
9+
**type** | **String** | DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [optional] [readonly]
10+
**nature** | **String** | Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [optional] [readonly]
1011
**name** | **String** | Name of the folder |
1112
**createdAt** | **Date** | Creation date | [optional] [readonly]
1213
**updatedAt** | **Date** | Date of the last update | [optional] [readonly]

docs/FullTopic.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ Name | Type | Description | Notes
1212
**title** | **String** | |
1313
**description** | **String** | | [optional]
1414
**referenceLinks** | **[String]** | | [optional]
15-
**ifcs** | **[Number]** | | [optional]
15+
**ifcs** | **[Number]** | DEPRECATED: Use 'models' instead | [optional]
16+
**models** | **[Number]** | | [optional]
1617
**labels** | **[String]** | | [optional]
1718
**topicType** | **String** | | [optional]
1819
**topicStatus** | **String** | | [optional]

0 commit comments

Comments
 (0)