Skip to content

Commit 3647bea

Browse files
Bimdata-ioBimdata-io
committed
PATCH: better element filter (#889)
* better element filter * remove prints * limit max depth to 4
1 parent b6ce30f commit 3647bea

File tree

10 files changed

+123
-123
lines changed

10 files changed

+123
-123
lines changed

‎docs/CollaborationApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -960,7 +960,7 @@ Name | Type | Description | Notes
960960
961961
Create a document
962962

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

965965
### Example
966966

‎docs/ModelApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5414,7 +5414,7 @@ Name | Type | Description | Notes
54145414
54155415
Retrieve an element of a model
54165416

5417-
Retrieve an element of a model `property_filter` simple syntax: { \"name\": \"property_name\", \"comparator\": \"contains\" | \"icontains\" | \"exact\" | \"gt\" | \"gte\" | \"lt\" | \"lte\" | \"startswith\" | \"istartswith\" | \"endswith\" | \"iendswith\", \"value\": \"property_value\" } `property_filter` combinatory syntax: { \"operande\": \"AND\" | \"OR\", \"conditions\": [ { \"operande\": \"AND\" | \"OR\", \"conditions\": [...], } // OR { \"name\": \"property_name\", \"comparator\": \"contains\" | \"icontains\" | \"exact\" | \"gt\" | \"gte\" | \"lt\" | \"lte\" | \"startswith\" | \"istartswith\" | \"endswith\" | \"iendswith\", \"value\": \"property_value\" }, ... ] } Required scopes: ifc:read, model:read
5417+
Retrieve an element of a model `property_filter` simple syntax: { \"name\": \"property_name\", \"comparator\": \"contains\" | \"icontains\" | \"exact\" | \"gt\" | \"gte\" | \"lt\" | \"lte\" | \"startswith\" | \"istartswith\" | \"endswith\" | \"iendswith\", \"value\": \"property_value\" } `property_filter` combinatory syntax: { \"operator\": \"AND\" | \"OR\", \"conditions\": [ { \"operator\": \"AND\" | \"OR\", \"conditions\": [...], } // OR { \"name\": \"property_name\", \"comparator\": \"contains\" | \"icontains\" | \"exact\" | \"gt\" | \"gte\" | \"lt\" | \"lte\" | \"startswith\" | \"istartswith\" | \"endswith\" | \"iendswith\", \"value\": \"property_value\" }, ... ] } Required scopes: ifc:read, model:read
54185418

54195419
### Example
54205420

@@ -6124,7 +6124,7 @@ Name | Type | Description | Notes
61246124
61256125
Retrieve all elements of a model
61266126

6127-
Retrieve all elements of a model. If not filtered, the json may be very large. To efficently retrieve all elements and their data, see `getRawElements` or `getSimpleElements` `property_filter` simple syntax: { \"name\": \"property_name\", \"comparator\": \"contains\" | \"icontains\" | \"exact\" | \"gt\" | \"gte\" | \"lt\" | \"lte\" | \"startswith\" | \"istartswith\" | \"endswith\" | \"iendswith\", \"value\": \"property_value\" } `property_filter` combinatory syntax: { \"operande\": \"AND\" | \"OR\", \"conditions\": [ { \"operande\": \"AND\" | \"OR\", \"conditions\": [...], } // OR { \"name\": \"property_name\", \"comparator\": \"contains\" | \"icontains\" | \"exact\" | \"gt\" | \"gte\" | \"lt\" | \"lte\" | \"startswith\" | \"istartswith\" | \"endswith\" | \"iendswith\", \"value\": \"property_value\" }, ... ] } Required scopes: ifc:read, model:read
6127+
Retrieve all elements of a model. If not filtered, the json may be very large. To efficently retrieve all elements and their data, see `getRawElements` or `getSimpleElements` `property_filter` simple syntax: { \"name\": \"property_name\", \"comparator\": \"contains\" | \"icontains\" | \"exact\" | \"gt\" | \"gte\" | \"lt\" | \"lte\" | \"startswith\" | \"istartswith\" | \"endswith\" | \"iendswith\", \"value\": \"property_value\" } `property_filter` combinatory syntax: { \"operator\": \"AND\" | \"OR\", \"conditions\": [ { \"operator\": \"AND\" | \"OR\", \"conditions\": [...], } // OR { \"name\": \"property_name\", \"comparator\": \"contains\" | \"icontains\" | \"exact\" | \"gt\" | \"gte\" | \"lt\" | \"lte\" | \"startswith\" | \"istartswith\" | \"endswith\" | \"iendswith\", \"value\": \"property_value\" }, ... ] } Required scopes: ifc:read, model:read
61286128

61296129
### Example
61306130

@@ -7563,7 +7563,7 @@ let opts = {
75637563
'classification': "classification_example", // String |
75647564
'classificationNotation': "classificationNotation_example", // String |
75657565
'propertyFilter': "propertyFilter_example", // String |
7566-
'type': "type_example" // String |
7566+
'type': "type_example" // String | Filter by IfcType
75677567
};
75687568
apiInstance.getPropertiesTypes(cloudPk, modelPk, projectPk, opts).then((data) => {
75697569
console.log('API called successfully. Returned data: ' + data);
@@ -7584,7 +7584,7 @@ Name | Type | Description | Notes
75847584
**classification** | **String**| | [optional]
75857585
**classificationNotation** | **String**| | [optional]
75867586
**propertyFilter** | **String**| | [optional]
7587-
**type** | **String**| | [optional]
7587+
**type** | **String**| Filter by IfcType | [optional]
75887588

75897589
### Return type
75907590

@@ -7738,7 +7738,7 @@ Name | Type | Description | Notes
77387738
77397739
Retrieve all elements in a optimized format
77407740

7741-
Instead of a nested representation, this route respond with a flat structure and indices pointing to related object. The IFC file will not be updated. The created elements will be accessible over the API and when exporting an IFC file. Returns elements, property_sets, properties, definitions and units in a JSON optimized structure `property_filter` simple syntax: { \"name\": \"property_name\", \"comparator\": \"contains\" | \"icontains\" | \"exact\" | \"gt\" | \"gte\" | \"lt\" | \"lte\" | \"startswith\" | \"istartswith\" | \"endswith\" | \"iendswith\", \"value\": \"property_value\" } `property_filter` combinatory syntax: { \"operande\": \"AND\" | \"OR\", \"conditions\": [ { \"operande\": \"AND\" | \"OR\", \"conditions\": [...], } // OR { \"name\": \"property_name\", \"comparator\": \"contains\" | \"icontains\" | \"exact\" | \"gt\" | \"gte\" | \"lt\" | \"lte\" | \"startswith\" | \"istartswith\" | \"endswith\" | \"iendswith\", \"value\": \"property_value\" }, ... ] } Required scopes: ifc:read, model:read
7741+
Instead of a nested representation, this route respond with a flat structure and indices pointing to related object. The IFC file will not be updated. The created elements will be accessible over the API and when exporting an IFC file. Returns elements, property_sets, properties, definitions and units in a JSON optimized structure `property_filter` simple syntax: { \"name\": \"property_name\", \"comparator\": \"contains\" | \"icontains\" | \"exact\" | \"gt\" | \"gte\" | \"lt\" | \"lte\" | \"startswith\" | \"istartswith\" | \"endswith\" | \"iendswith\", \"value\": \"property_value\" } `property_filter` combinatory syntax: { \"operator\": \"AND\" | \"OR\", \"conditions\": [ { \"operator\": \"AND\" | \"OR\", \"conditions\": [...], } // OR { \"name\": \"property_name\", \"comparator\": \"contains\" | \"icontains\" | \"exact\" | \"gt\" | \"gte\" | \"lt\" | \"lte\" | \"startswith\" | \"istartswith\" | \"endswith\" | \"iendswith\", \"value\": \"property_value\" }, ... ] } Required scopes: ifc:read, model:read
77427742

77437743
### Example
77447744

@@ -7880,7 +7880,7 @@ Name | Type | Description | Notes
78807880
78817881
Retrieve all elements of a model with a simple value representation
78827882

7883-
Retrieve all elements of a model with a simple value representation `property_filter` simple syntax: { \"name\": \"property_name\", \"comparator\": \"contains\" | \"icontains\" | \"exact\" | \"gt\" | \"gte\" | \"lt\" | \"lte\" | \"startswith\" | \"istartswith\" | \"endswith\" | \"iendswith\", \"value\": \"property_value\" } `property_filter` combinatory syntax: { \"operande\": \"AND\" | \"OR\", \"conditions\": [ { \"operande\": \"AND\" | \"OR\", \"conditions\": [...], } // OR { \"name\": \"property_name\", \"comparator\": \"contains\" | \"icontains\" | \"exact\" | \"gt\" | \"gte\" | \"lt\" | \"lte\" | \"startswith\" | \"istartswith\" | \"endswith\" | \"iendswith\", \"value\": \"property_value\" }, ... ] } Required scopes: ifc:read, model:read
7883+
Retrieve all elements of a model with a simple value representation `property_filter` simple syntax: { \"name\": \"property_name\", \"comparator\": \"contains\" | \"icontains\" | \"exact\" | \"gt\" | \"gte\" | \"lt\" | \"lte\" | \"startswith\" | \"istartswith\" | \"endswith\" | \"iendswith\", \"value\": \"property_value\" } `property_filter` combinatory syntax: { \"operator\": \"AND\" | \"OR\", \"conditions\": [ { \"operator\": \"AND\" | \"OR\", \"conditions\": [...], } // OR { \"name\": \"property_name\", \"comparator\": \"contains\" | \"icontains\" | \"exact\" | \"gt\" | \"gte\" | \"lt\" | \"lte\" | \"startswith\" | \"istartswith\" | \"endswith\" | \"iendswith\", \"value\": \"property_value\" }, ... ] } Required scopes: ifc:read, model:read
78847884

78857885
### Example
78867886

‎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-
**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly]
8-
**groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly]
9-
**defaultPermission** | **Number** | Permission for a Folder * `1` - denied * `50` - read_only * `100` - read_write | [optional]
10-
**id** | **Number** | | [readonly]
7+
**updatedAt** | **Date** | Date of the last update | [readonly]
118
**name** | **String** | Name of the folder |
9+
**nature** | **String** | Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly]
10+
**createdAt** | **Date** | Creation date | [readonly]
1211
**type** | **String** | DEPRECATED: Use 'nature' instead. Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly]
12+
**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly]
1313
**createdBy** | [**ShortUser**](ShortUser.md) | | [readonly]
14-
**nature** | **String** | Value is \"Folder\". It is usefull to parse the tree and discriminate folders and files | [readonly]
1514
**parentId** | **Number** | | [optional]
16-
**updatedAt** | **Date** | Date of the last update | [readonly]
17-
**createdAt** | **Date** | Creation date | [readonly]
15+
**groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly]
16+
**defaultPermission** | **Number** | Permission for a Folder * `1` - denied * `50` - read_only * `100` - read_write | [optional]
17+
**id** | **Number** | | [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
**name** | **String** | Name of the folder |
98
**parentId** | **Number** | | [optional]
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 {'POINT_CLOUD', 'OBJ', 'DWG', 'IFC', 'DXF', 'GLTF'}, a model will be created and attached to this document Required scopes: document:write
869+
* Create a document. If the document is one of {'POINT_CLOUD', 'DWG', 'OBJ', 'DXF', 'GLTF', '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 {'POINT_CLOUD', 'OBJ', 'DWG', 'IFC', 'DXF', 'GLTF'}, a model will be created and attached to this document Required scopes: document:write
937+
* Create a document. If the document is one of {'POINT_CLOUD', 'DWG', 'OBJ', 'DXF', 'GLTF', '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)