Skip to content

Commit d3dd08e

Browse files
committed
MINOR: feat(equipment): add equipment documents (#1042)
* MINOR: feat(equipment): add equipment documents * PATCH: fix(equipment): use LightDocumentSerializer for equipment documents
1 parent 6f30e6a commit d3dd08e

25 files changed

Lines changed: 1036 additions & 186 deletions

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -144,13 +144,13 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
144144
projects_pk = 1 # int | A unique integer value identifying this project.
145145
topics_guid = "topics_guid_example" # str |
146146
comment_request = CommentRequest(
147-
author="author_example",
148-
reply_to_comment_guid="reply_to_comment_guid_example",
149-
viewpoint_guid="viewpoint_guid_example",
150-
modified_author="modified_author_example",
151147
date=dateutil_parser('1970-01-01T00:00:00.00Z'),
152-
viewpoint_temp_id=1,
148+
viewpoint_guid="viewpoint_guid_example",
149+
reply_to_comment_guid="reply_to_comment_guid_example",
153150
comment="comment_example",
151+
author="author_example",
152+
viewpoint_temp_id=1,
153+
modified_author="modified_author_example",
154154
guid="guid_example",
155155
) # CommentRequest | (optional)
156156

@@ -457,6 +457,7 @@ Class | Method | HTTP request | Description
457457
*ModelApi* | [**get_elements**](docs/ModelApi.md#get_elements) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element | Retrieve all elements of a model
458458
*ModelApi* | [**get_elements_from_classification**](docs/ModelApi.md#get_elements_from_classification) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/{model_classification_pk}/element | Retrieve all elements with the classification
459459
*ModelApi* | [**get_equipment**](docs/ModelApi.md#get_equipment) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/equipment/{id} | Retrieve one equipment of the model
460+
*ModelApi* | [**get_equipment_documents**](docs/ModelApi.md#get_equipment_documents) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/equipment/{equipment_pk}/document | Retrieve all documents of an equipment
460461
*ModelApi* | [**get_equipment_images**](docs/ModelApi.md#get_equipment_images) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/equipment/{equipment_pk}/image | Retrieve all images attached to the equipment
461462
*ModelApi* | [**get_equipments**](docs/ModelApi.md#get_equipments) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/equipment | Retrieve all equipments of the model
462463
*ModelApi* | [**get_label**](docs/ModelApi.md#get_label) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/label/{id} | Retrieve one label of the model
@@ -501,6 +502,7 @@ Class | Method | HTTP request | Description
501502
*ModelApi* | [**get_zone_spaces**](docs/ModelApi.md#get_zone_spaces) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space | Retrieve all spaces of a zone
502503
*ModelApi* | [**get_zones**](docs/ModelApi.md#get_zones) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone | Retrieve zones of a model
503504
*ModelApi* | [**link_documents_of_element**](docs/ModelApi.md#link_documents_of_element) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/documents | Link one or many documents to an element
505+
*ModelApi* | [**link_documents_to_equipment**](docs/ModelApi.md#link_documents_to_equipment) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/equipment/{equipment_pk}/document | Link one or many documents to an equipment
504506
*ModelApi* | [**list_classification_element_relations**](docs/ModelApi.md#list_classification_element_relations) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification-element | List all associations between classifications and elements
505507
*ModelApi* | [**list_models_positioned_in**](docs/ModelApi.md#list_models_positioned_in) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/positioned-in | List all models where the model is positioned in
506508
*ModelApi* | [**merge_ifcs**](docs/ModelApi.md#merge_ifcs) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/merge | Merge IFC files
@@ -513,6 +515,7 @@ Class | Method | HTTP request | Description
513515
*ModelApi* | [**remove_element_property_set_property_definition**](docs/ModelApi.md#remove_element_property_set_property_definition) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{id} | Delete a Definition to a Property
514516
*ModelApi* | [**remove_element_property_set_property_definition_unit**](docs/ModelApi.md#remove_element_property_set_property_definition_unit) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit/{id} | Remove a Unit from a Definition
515517
*ModelApi* | [**remove_elements_from_classification**](docs/ModelApi.md#remove_elements_from_classification) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/{model_classification_pk}/element/{uuid} | Remove the classification from all elements
518+
*ModelApi* | [**remove_equipment_document**](docs/ModelApi.md#remove_equipment_document) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/equipment/{equipment_pk}/document/{id} | Remove a document from an equipment
516519
*ModelApi* | [**reprocess_model**](docs/ModelApi.md#reprocess_model) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/reprocess | Reprocess Model file
517520
*ModelApi* | [**update_access_token**](docs/ModelApi.md#update_access_token) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token/{token} | Update some fields of a token
518521
*ModelApi* | [**update_building**](docs/ModelApi.md#update_building) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{uuid} | Update some fields of a building

bimdata_api_client/api/collaboration_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10237,7 +10237,7 @@ def create_document(
1023710237
):
1023810238
"""Create a document # noqa: E501
1023910239

10240-
Create a document. If the document is one of {'OBJ', 'DXF', 'IFC', 'PHOTOSPHERE', 'POINT_CLOUD', 'GLTF', 'DWG'}, a model will be created and attached to this document Required scopes: document:write # noqa: E501
10240+
Create a document. If the document is one of {'POINT_CLOUD', 'DXF', 'PHOTOSPHERE', 'IFC', 'OBJ', 'DWG', 'GLTF'}, a model will be created and attached to this document Required scopes: document:write # noqa: E501
1024110241
This method makes a synchronous HTTP request by default. To make an
1024210242
asynchronous HTTP request, please pass async_req=True
1024310243

0 commit comments

Comments
 (0)