You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 18, 2025. It is now read-only.
MINOR: labeling API on JPEG, PNG & PDF model (#870)
* Add basic labels.
* WIP: label route for worker.
* Add label retrieving at the org level.
* Rename BCF Label view to avoid swagger warning about conflict
* Add test for malicious requests on label routes.
* Rename Model Label view & serialiser.
* Rework color formating for label.
* Compile the color regex.
* Fix typo in help text describing color format.
*bimdata.ModelApi* | [**createElementPropertySetProperty**](docs/ModelApi.md#createElementPropertySetProperty) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property | Create a property to a PropertySet
332
332
*bimdata.ModelApi* | [**createElementPropertySetPropertyDefinition**](docs/ModelApi.md#createElementPropertySetPropertyDefinition) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition | Create a Definition to a Property
333
333
*bimdata.ModelApi* | [**createElementPropertySetPropertyDefinitionUnit**](docs/ModelApi.md#createElementPropertySetPropertyDefinitionUnit) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit | Create a Unit to a Definition
334
+
*bimdata.ModelApi* | [**createLabel**](docs/ModelApi.md#createLabel) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/label | Create a label in the model
334
335
*bimdata.ModelApi* | [**createLayer**](docs/ModelApi.md#createLayer) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer | Create a layer in the model
335
336
*bimdata.ModelApi* | [**createMask2D**](docs/ModelApi.md#createMask2D) | **PUT** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/mask-2d | Create or update a 2D mask for the model
336
337
*bimdata.ModelApi* | [**createMetaBuilding**](docs/ModelApi.md#createMetaBuilding) | **POST** /cloud/{cloud_pk}/project/{project_pk}/model/create-metabuilding | Create an empty 3D Model
*bimdata.ModelApi* | [**deleteBuildingPlan**](docs/ModelApi.md#deleteBuildingPlan) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/{id} | Delete the relation between a 2d model and a building
357
358
*bimdata.ModelApi* | [**deleteDrawing**](docs/ModelApi.md#deleteDrawing) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing/{id} | Delete a drawing of a model
358
359
*bimdata.ModelApi* | [**deleteElement**](docs/ModelApi.md#deleteElement) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} | Delete an element of a model
360
+
*bimdata.ModelApi* | [**deleteLabel**](docs/ModelApi.md#deleteLabel) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/label/{id} | Delete a label
359
361
*bimdata.ModelApi* | [**deleteLayer**](docs/ModelApi.md#deleteLayer) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id} | Delete a layer of a model
360
362
*bimdata.ModelApi* | [**deleteMask2D**](docs/ModelApi.md#deleteMask2D) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/mask-2d | Delete the 2D mask for the model
361
363
*bimdata.ModelApi* | [**deleteModel**](docs/ModelApi.md#deleteModel) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/model/{id} | Delete a model
*bimdata.ModelApi* | [**getElementPropertySets**](docs/ModelApi.md#getElementPropertySets) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset | Retrieve all PropertySets of an element
394
396
*bimdata.ModelApi* | [**getElements**](docs/ModelApi.md#getElements) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element | Retrieve all elements of a model
395
397
*bimdata.ModelApi* | [**getElementsFromClassification**](docs/ModelApi.md#getElementsFromClassification) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/{model_classification_pk}/element | Retrieve all elements with the classification
398
+
*bimdata.ModelApi* | [**getLabel**](docs/ModelApi.md#getLabel) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/label/{id} | Retrieve one label of the model
399
+
*bimdata.ModelApi* | [**getLabels**](docs/ModelApi.md#getLabels) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/label | Retrieve all labels of the model
396
400
*bimdata.ModelApi* | [**getLayer**](docs/ModelApi.md#getLayer) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id} | Retrieve a layer of a model
397
401
*bimdata.ModelApi* | [**getLayers**](docs/ModelApi.md#getLayers) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer | Retrieve all layers of a model
398
402
*bimdata.ModelApi* | [**getMaterial**](docs/ModelApi.md#getMaterial) | **GET** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/material/{id} | Retrieve a material of a model
*bimdata.ModelApi* | [**updateDrawing**](docs/ModelApi.md#updateDrawing) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing/{id} | Update some fields of a drawing
447
451
*bimdata.ModelApi* | [**updateElement**](docs/ModelApi.md#updateElement) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} | Update some fields of an element
448
452
*bimdata.ModelApi* | [**updateElementPropertySetProperty**](docs/ModelApi.md#updateElementPropertySetProperty) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} | Update a property from an element
453
+
*bimdata.ModelApi* | [**updateLabel**](docs/ModelApi.md#updateLabel) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/label/{id} | Update some fields of a label
449
454
*bimdata.ModelApi* | [**updateLayer**](docs/ModelApi.md#updateLayer) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id} | Update some fields of a layer
450
455
*bimdata.ModelApi* | [**updateMask2D**](docs/ModelApi.md#updateMask2D) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{id}/mask-2d | Partial update of a 2D mask for the model
451
456
*bimdata.ModelApi* | [**updateModel**](docs/ModelApi.md#updateModel) | **PATCH** /cloud/{cloud_pk}/project/{project_pk}/model/{id} | Update some fields of a model
Copy file name to clipboardExpand all lines: docs/CollaborationApi.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -882,7 +882,7 @@ Name | Type | Description | Notes
882
882
883
883
Create a document
884
884
885
-
Create a document. If the document is one of {'GLTF', 'POINT_CLOUD', 'IFC', 'DXF', 'OBJ', 'DWG'}, a model will be created and attached to this document Required scopes: document:write
885
+
Create a document. If the document is one of {'POINT_CLOUD', 'OBJ', 'DXF', 'DWG', 'GLTF', 'IFC'}, a model will be created and attached to this document Required scopes: document:write
0 commit comments