| BcfApi |
create_comment |
POST /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments |
Create a comment |
| BcfApi |
create_document_reference |
POST /bcf/2.1/projects/{projects_pk}/topics/{guid}/document_references |
Create a reference to a document |
| BcfApi |
create_extension_label |
POST /bcf/2.1/projects/{projects_pk}/extension/label |
Create a Label |
| BcfApi |
create_extension_priority |
POST /bcf/2.1/projects/{projects_pk}/extension/priority |
Create a Priority |
| BcfApi |
create_extension_stage |
POST /bcf/2.1/projects/{projects_pk}/extension/stage |
Create a Stage |
| BcfApi |
create_extension_status |
POST /bcf/2.1/projects/{projects_pk}/extension/status |
Create a TopicStatus |
| BcfApi |
create_extension_type |
POST /bcf/2.1/projects/{projects_pk}/extension/type |
Create a TopicType |
| BcfApi |
create_full_topic |
POST /bcf/2.1/projects/{projects_pk}/full-topic |
Create a Topic with viewpoints and comments |
| BcfApi |
create_pin |
POST /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin |
Create a Pin |
| BcfApi |
create_topic |
POST /bcf/2.1/projects/{projects_pk}/topics |
Create a topic |
| BcfApi |
create_viewpoint |
POST /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints |
Create a Viewpoint |
| BcfApi |
delete_comment |
DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} |
Delete a comment |
| BcfApi |
delete_extension_label |
DELETE /bcf/2.1/projects/{projects_pk}/extension/label/{id} |
Delete a Label |
| BcfApi |
delete_extension_priority |
DELETE /bcf/2.1/projects/{projects_pk}/extension/priority/{id} |
Delete a Priority |
| BcfApi |
delete_extension_stage |
DELETE /bcf/2.1/projects/{projects_pk}/extension/stage/{id} |
Delete a Stage |
| BcfApi |
delete_extension_status |
DELETE /bcf/2.1/projects/{projects_pk}/extension/status/{id} |
Delete a TopicStatus |
| BcfApi |
delete_extension_type |
DELETE /bcf/2.1/projects/{projects_pk}/extension/type/{id} |
Delete a TopicType |
| BcfApi |
delete_pin |
DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} |
Delete a Pin |
| BcfApi |
delete_topic |
DELETE /bcf/2.1/projects/{projects_pk}/topics/{guid} |
Delete a topic |
| BcfApi |
delete_viewpoint |
DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} |
Delete a Viewpoint |
| BcfApi |
download_bcf_export |
GET /bcf/2.1/projects/{id}/export |
|
| BcfApi |
download_bcf_export_post |
POST /bcf/2.1/projects/{id}/export |
|
| BcfApi |
download_bcf_export_xlsx |
GET /bcf/2.1/projects/{id}/export-xlsx |
|
| BcfApi |
download_bcf_export_xlsx_post |
POST /bcf/2.1/projects/{id}/export-xlsx |
|
| BcfApi |
full_update_bcf_project |
PUT /bcf/2.1/projects/{id} |
Update all fields of a BCF project |
| BcfApi |
full_update_comment |
PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} |
Update all fields of a comment |
| BcfApi |
full_update_document_reference |
PUT /bcf/2.1/projects/{projects_pk}/topics/{guid}/document_references |
Add or update document references to a topic |
| BcfApi |
full_update_full_topic |
PUT /bcf/2.1/projects/{projects_pk}/full-topic/{guid} |
Update all fields of a topic |
| BcfApi |
full_update_pin |
PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} |
Update all fields of a Pin |
| BcfApi |
full_update_topic |
PUT /bcf/2.1/projects/{projects_pk}/topics/{guid} |
Update all fields of a topic |
| BcfApi |
get_auth |
GET /bcf/2.1/auth |
Retrieve Authentication Information |
| BcfApi |
get_bcf_project |
GET /bcf/2.1/projects/{id} |
Retrieve a BCF project |
| BcfApi |
get_bcf_projects |
GET /bcf/2.1/projects |
Retrieve all BCF projects |
| BcfApi |
get_colorings |
GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/coloring |
Retrieve all colorings of a viewpoint |
| BcfApi |
get_comment |
GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} |
Retrieve a comment |
| BcfApi |
get_comments |
GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments |
Retrieve all comments |
| BcfApi |
get_comments_events |
GET /bcf/2.1/projects/{projects_pk}/topics/comments/events |
Get comments events |
| BcfApi |
get_detailed_extensions |
GET /bcf/2.1/projects/{id}/detailed-extensions |
Retrieve project detailed extensions |
| BcfApi |
get_document_references |
GET /bcf/2.1/projects/{projects_pk}/topics/{guid}/document_references |
Retrieve all documents referenced by the topic |
| BcfApi |
get_extensions |
GET /bcf/2.1/projects/{id}/extensions |
Retrieve project extensions |
| BcfApi |
get_full_topic |
GET /bcf/2.1/projects/{projects_pk}/full-topic/{guid} |
Retrieve a full topic |
| BcfApi |
get_full_topics |
GET /bcf/2.1/projects/{projects_pk}/full-topic |
Retrieve all full topics |
| BcfApi |
get_pins |
GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin |
Retrieve all Pins of a viewpoint |
| BcfApi |
get_related_topics |
GET /bcf/2.1/projects/{projects_pk}/topics/{guid}/related_topics |
Get all related topics |
| BcfApi |
get_selections |
GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/selection |
Retrieve all selections of a viewpoint |
| BcfApi |
get_snapshot |
GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/snapshot |
Retrieve the viewpoint' snapshot |
| BcfApi |
get_topic |
GET /bcf/2.1/projects/{projects_pk}/topics/{guid} |
Retrieve a topic |
| BcfApi |
get_topic_viewpoints |
GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/topic-viewpoints |
Retrieve all viewpoints attached to the topic |
| BcfApi |
get_topics |
GET /bcf/2.1/projects/{projects_pk}/topics |
Retrieve all topics |
| BcfApi |
get_topics_events |
GET /bcf/2.1/projects/{projects_pk}/topics/events |
Get topics events |
| BcfApi |
get_topics_pins |
GET /bcf/2.1/projects/{projects_pk}/topics/pins |
Get pins of all or many topics |
| BcfApi |
get_user |
GET /bcf/2.1/current-user |
Get current user info |
| BcfApi |
get_versions |
GET /bcf/versions |
Retrieve all supported BCF versions by this API |
| BcfApi |
get_viewpoin_pin |
GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} |
Retrieve a Pin |
| BcfApi |
get_viewpoint |
GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} |
Retrieve a Viewpoint |
| BcfApi |
get_viewpoints |
GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints |
Retrieve all Viewpoints of a topic |
| BcfApi |
get_visibilities |
GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/visibility |
Retrieve all visibilities of a viewpoint |
| BcfApi |
import_bcf |
POST /bcf/2.1/projects/{id}/import |
Import bcf-xml format into this project |
| BcfApi |
update_bcf_project |
PATCH /bcf/2.1/projects/{id} |
Update some fields of a BCF project |
| BcfApi |
update_comment |
PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} |
Update some fields of a comment |
| BcfApi |
update_extension_label |
PATCH /bcf/2.1/projects/{projects_pk}/extension/label/{id} |
Update a Label |
| BcfApi |
update_extension_priority |
PATCH /bcf/2.1/projects/{projects_pk}/extension/priority/{id} |
Update a Priority |
| BcfApi |
update_extension_stage |
PATCH /bcf/2.1/projects/{projects_pk}/extension/stage/{id} |
Update a Stage |
| BcfApi |
update_extension_status |
PATCH /bcf/2.1/projects/{projects_pk}/extension/status/{id} |
Update a TopicStatus |
| BcfApi |
update_extension_type |
PATCH /bcf/2.1/projects/{projects_pk}/extension/type/{id} |
Update a TopicType |
| BcfApi |
update_full_topic |
PATCH /bcf/2.1/projects/{projects_pk}/full-topic/{guid} |
Update some fields of a topic |
| BcfApi |
update_pin |
PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} |
Update some fields of a Pin |
| BcfApi |
update_topic |
PATCH /bcf/2.1/projects/{projects_pk}/topics/{guid} |
Update some fields of a topic |
| BcfApi |
update_viewpoint |
PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} |
Update some fields of a Viewpoint |
| CollaborationApi |
accept_user_invitation |
POST /user/invitations/{id}/accept |
Accept an invitation |
| CollaborationApi |
accept_validation |
POST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id}/accept |
Accept a validation |
| CollaborationApi |
add_document_tag |
POST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/tag |
Add a tag to a document |
| CollaborationApi |
add_group_member |
POST /cloud/{cloud_pk}/project/{project_pk}/group/{group_pk}/member |
Add a user to a group |
| CollaborationApi |
bulk_delete_document_history |
DELETE /cloud/{cloud_pk}/project/{project_pk}/document/bulk_destroy_history |
Bulk delete document history |
| CollaborationApi |
bulk_delete_documents |
DELETE /cloud/{cloud_pk}/project/{project_pk}/document/bulk_destroy |
Bulk delete documents |
| CollaborationApi |
bulk_delete_folders |
DELETE /cloud/{cloud_pk}/project/{project_pk}/folder/bulk_destroy |
Bulk delete folders |
| CollaborationApi |
cancel_cloud_user_invitation |
DELETE /cloud/{cloud_pk}/invitation/{id} |
Cancel a pending invitation |
| CollaborationApi |
cancel_project_user_invitation |
DELETE /cloud/{cloud_pk}/project/{project_pk}/invitation/{id} |
Cancel a pending invitation |
| CollaborationApi |
check_access |
GET /cloud/{id}/check-access |
Check app access from cloud |
| CollaborationApi |
check_project_access |
GET /cloud/{cloud_pk}/project/{id}/check-access |
Check if the current token has access to the requested project |
| CollaborationApi |
close_visa |
POST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id}/close |
Close a visa of a document |
| CollaborationApi |
create_classification |
POST /cloud/{cloud_pk}/project/{project_pk}/classification |
Create a classification |
| CollaborationApi |
create_cloud |
POST /cloud |
Create a cloud |
| CollaborationApi |
create_demo |
POST /cloud/{id}/create-demo |
Create a Demo project in a cloud |
| CollaborationApi |
create_dms_tree |
POST /cloud/{cloud_pk}/project/{id}/dms-tree |
Create a complete DMS tree |
| CollaborationApi |
create_document |
POST /cloud/{cloud_pk}/project/{project_pk}/document |
Create a document |
| CollaborationApi |
create_folder |
POST /cloud/{cloud_pk}/project/{project_pk}/folder |
Create a folder |
| CollaborationApi |
create_manage_group |
POST /cloud/{cloud_pk}/project/{project_pk}/group |
Create a group |
| CollaborationApi |
create_naming_constraint |
POST /cloud/{cloud_pk}/project/{project_pk}/naming-constraint |
Create a naming constraint |
| CollaborationApi |
create_naming_parts_template |
POST /cloud/{cloud_pk}/project/{project_pk}/naming-parts-template |
Create a naming rule list |
| CollaborationApi |
create_project |
POST /cloud/{cloud_pk}/project |
Create a project |
| CollaborationApi |
create_project_access_token |
POST /cloud/{cloud_pk}/project/{project_pk}/access-token |
Create a token for this project |
| CollaborationApi |
create_tag |
POST /cloud/{cloud_pk}/project/{project_pk}/tag |
Create a tag |
| CollaborationApi |
create_validation |
POST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation |
Add a validation to a visa |
| CollaborationApi |
create_visa |
POST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa |
Create a visa |
| CollaborationApi |
create_visa_comment |
POST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment |
Add a comment |
| CollaborationApi |
delete_all_document_history |
DELETE /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history/delete |
Delete all document history |
| CollaborationApi |
delete_classification |
DELETE /cloud/{cloud_pk}/project/{project_pk}/classification/{id} |
Delete a classification |
| CollaborationApi |
delete_cloud |
DELETE /cloud/{id} |
Delete a cloud |
| CollaborationApi |
delete_cloud_user |
DELETE /cloud/{cloud_pk}/user/{id} |
Remove a user from a cloud |
| CollaborationApi |
delete_document |
DELETE /cloud/{cloud_pk}/project/{project_pk}/document/{id} |
Delete the document |
| CollaborationApi |
delete_document_tag |
DELETE /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/tag/{id} |
Delete a tag from a document |
| CollaborationApi |
delete_folder |
DELETE /cloud/{cloud_pk}/project/{project_pk}/folder/{id} |
Delete a folder |
| CollaborationApi |
delete_folder_naming_constraint |
DELETE /cloud/{cloud_pk}/project/{project_pk}/folder/{id}/naming-constraint |
Remove a naming constraint from a folder |
| CollaborationApi |
delete_group_member |
DELETE /cloud/{cloud_pk}/project/{project_pk}/group/{group_pk}/member/{id} |
Delete a user from a group |
| CollaborationApi |
delete_manage_group |
DELETE /cloud/{cloud_pk}/project/{project_pk}/group/{id} |
Delete a group |
| CollaborationApi |
delete_naming_constraint |
DELETE /cloud/{cloud_pk}/project/{project_pk}/naming-constraint/{id} |
Delete a naming constraint |
| CollaborationApi |
delete_naming_parts_template |
DELETE /cloud/{cloud_pk}/project/{project_pk}/naming-parts-template/{id} |
Delete a naming rule list |
| CollaborationApi |
delete_project |
DELETE /cloud/{cloud_pk}/project/{id} |
Delete a project |
| CollaborationApi |
delete_project_access_token |
DELETE /cloud/{cloud_pk}/project/{project_pk}/access-token/{token} |
Delete a token |
| CollaborationApi |
delete_project_user |
DELETE /cloud/{cloud_pk}/project/{project_pk}/user/{id} |
Remove a user from a project |
| CollaborationApi |
delete_tag |
DELETE /cloud/{cloud_pk}/project/{project_pk}/tag/{id} |
Delete the tag |
| CollaborationApi |
delete_validation |
DELETE /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id} |
Remove a validation |
| CollaborationApi |
delete_visa |
DELETE /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id} |
Remove a visa |
| CollaborationApi |
delete_visa_comment |
DELETE /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment/{id} |
Remove a comment |
| CollaborationApi |
deny_user_invitation |
POST /user/invitations/{id}/deny |
Deny an invitation |
| CollaborationApi |
deny_validation |
POST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id}/deny |
Deny a validation |
| CollaborationApi |
get_classification |
GET /cloud/{cloud_pk}/project/{project_pk}/classification/{id} |
Retrieve a classification |
| CollaborationApi |
get_classifications |
GET /cloud/{cloud_pk}/project/{project_pk}/classification |
Retrieve all classifications |
| CollaborationApi |
get_cloud |
GET /cloud/{id} |
Retrieve one cloud |
| CollaborationApi |
get_cloud_invitations |
GET /cloud/{cloud_pk}/invitation |
Retrieve all pending invitations in the cloud |
| CollaborationApi |
get_cloud_size |
GET /cloud/{id}/size |
Get size of the cloud |
| CollaborationApi |
get_cloud_users |
GET /cloud/{cloud_pk}/user |
Retrieve all users in a cloud, or a list with a filter by email |
| CollaborationApi |
get_clouds |
GET /cloud |
Retrieve all clouds |
| CollaborationApi |
get_document |
GET /cloud/{cloud_pk}/project/{project_pk}/document/{id} |
Retrieve a document |
| CollaborationApi |
get_document_histories |
GET /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history |
Retrieve all document histories |
| CollaborationApi |
get_documents |
GET /cloud/{cloud_pk}/project/{project_pk}/document |
Retrieve all documents |
| CollaborationApi |
get_folder |
GET /cloud/{cloud_pk}/project/{project_pk}/folder/{id} |
Retrieve a folder |
| CollaborationApi |
get_folder_documents |
GET /cloud/{cloud_pk}/project/{project_pk}/folder/{folder_pk}/document |
Get all documents of a folder |
| CollaborationApi |
get_folder_naming_constraint |
GET /cloud/{cloud_pk}/project/{project_pk}/folder/{id}/naming-constraint |
Get the naming constraint of a folder |
| CollaborationApi |
get_folder_project_users |
GET /cloud/{cloud_pk}/project/{project_pk}/folder/{folder_pk}/user |
Retrieve all users in a project with the permission on the folder |
| CollaborationApi |
get_folders |
GET /cloud/{cloud_pk}/project/{project_pk}/folder |
Retrieve all folders |
| CollaborationApi |
get_group |
GET /cloud/{cloud_pk}/project/{project_pk}/me/group/{id} |
Retrieve a group |
| CollaborationApi |
get_groups |
GET /cloud/{cloud_pk}/project/{project_pk}/me/group |
Retrieve all groups |
| CollaborationApi |
get_logs |
GET /cloud/{cloud_pk}/project/{project_pk}/logs |
Retrieve all logs of the project |
| CollaborationApi |
get_manage_group |
GET /cloud/{cloud_pk}/project/{project_pk}/group/{id} |
Retrieve a group |
| CollaborationApi |
get_manage_groups |
GET /cloud/{cloud_pk}/project/{project_pk}/group |
Retrieve all groups |
| CollaborationApi |
get_naming_constraint |
GET /cloud/{cloud_pk}/project/{project_pk}/naming-constraint/{id} |
Retrieve a naming constraint |
| CollaborationApi |
get_naming_constraints |
GET /cloud/{cloud_pk}/project/{project_pk}/naming-constraint |
Retrieve all naming constraints |
| CollaborationApi |
get_naming_parts_template |
GET /cloud/{cloud_pk}/project/{project_pk}/naming-parts-template/{id} |
Retrieve a naming rule list |
| CollaborationApi |
get_naming_parts_templates |
GET /cloud/{cloud_pk}/project/{project_pk}/naming-parts-template |
Retrieve all naming rule lists |
| CollaborationApi |
get_project |
GET /cloud/{cloud_pk}/project/{id} |
Retrieve a project |
| CollaborationApi |
get_project_access_token |
GET /cloud/{cloud_pk}/project/{project_pk}/access-token/{token} |
Retrieve one token created for this project |
| CollaborationApi |
get_project_access_tokens |
GET /cloud/{cloud_pk}/project/{project_pk}/access-token |
Retrieve all tokens created for this project |
| CollaborationApi |
get_project_creator_visas |
GET /cloud/{cloud_pk}/project/{project_pk}/me/visa/creator |
List visas created by user |
| CollaborationApi |
get_project_dms_tree |
GET /cloud/{cloud_pk}/project/{id}/dms-tree |
Retrieve the complete DMS tree |
| CollaborationApi |
get_project_folder_tree |
GET /cloud/{cloud_pk}/project/{id}/folder-tree |
Retrieve folder tree of the project |
| CollaborationApi |
get_project_invitations |
GET /cloud/{cloud_pk}/project/{project_pk}/invitation |
Retrieve all pending invitations in the project |
| CollaborationApi |
get_project_size |
GET /cloud/{cloud_pk}/project/{id}/size |
Get size of all model files in the project |
| CollaborationApi |
get_project_tree |
GET /cloud/{cloud_pk}/project/{id}/tree |
Retrieve the complete DMS tree |
| CollaborationApi |
get_project_users |
GET /cloud/{cloud_pk}/project/{project_pk}/user |
Retrieve all users in a project, or a list with a filter by email |
| CollaborationApi |
get_project_validator_visas |
GET /cloud/{cloud_pk}/project/{project_pk}/me/visa/validator |
List visas where user is a validator |
| CollaborationApi |
get_projects |
GET /cloud/{cloud_pk}/project |
Retrieve all projects |
| CollaborationApi |
get_self_projects |
GET /user/projects |
List current user's projects |
| CollaborationApi |
get_self_user |
GET /user |
Get info about the current user |
| CollaborationApi |
get_tag |
GET /cloud/{cloud_pk}/project/{project_pk}/tag/{id} |
Retrieve a tag |
| CollaborationApi |
get_tags |
GET /cloud/{cloud_pk}/project/{project_pk}/tag |
Retrieve all tags |
| CollaborationApi |
get_user_invitation |
GET /user/invitations/{id} |
Retrieve an invitation |
| CollaborationApi |
get_user_invitations |
GET /user/invitations |
List user's invitations |
| CollaborationApi |
get_validation |
GET /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id} |
Retrieve a validation to a visa |
| CollaborationApi |
get_validations |
GET /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation |
List all validations to a visa |
| CollaborationApi |
get_visa |
GET /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id} |
Retrieve a visa of a document |
| CollaborationApi |
get_visa_comment |
GET /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment/{id} |
Retrieve a comment |
| CollaborationApi |
get_visa_comments |
GET /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment |
List all comment of a visa |
| CollaborationApi |
get_visas |
GET /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa |
List all visas of a document |
| CollaborationApi |
import_from_project |
POST /cloud/{cloud_pk}/project/{id}/import_from |
Import data from a project |
| CollaborationApi |
import_manage_group |
POST /cloud/{cloud_pk}/project/{project_pk}/group/import |
Import a group from another project |
| CollaborationApi |
invite_cloud_user |
POST /cloud/{cloud_pk}/invitation |
Invite a cloud member |
| CollaborationApi |
invite_project_user |
POST /cloud/{cloud_pk}/project/{project_pk}/invitation |
Invite a project member |
| CollaborationApi |
leave_project |
POST /cloud/{cloud_pk}/project/{id}/leave |
Leave the project |
| CollaborationApi |
leave_version_document_history |
POST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history/{id}/leave |
Leave the history version |
| CollaborationApi |
make_head_version_document_history |
POST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history/{id}/head-version |
Make the head of the version |
| CollaborationApi |
pause_visa |
POST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id}/pause |
Pause a visa of a document |
| CollaborationApi |
reset_validation |
POST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id}/reset |
Reset a validation |
| CollaborationApi |
resume_visa |
POST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id}/resume |
Resume a visa of a document |
| CollaborationApi |
set_folder_naming_constraint |
POST /cloud/{cloud_pk}/project/{project_pk}/folder/{id}/naming-constraint |
Set or replace a naming constraint on a folder |
| CollaborationApi |
update_classification |
PATCH /cloud/{cloud_pk}/project/{project_pk}/classification/{id} |
Update some fields of a classification |
| CollaborationApi |
update_cloud |
PATCH /cloud/{id} |
Update some fields of a cloud |
| CollaborationApi |
update_cloud_user |
PATCH /cloud/{cloud_pk}/user/{id} |
Change the user role in the cloud |
| CollaborationApi |
update_document |
PATCH /cloud/{cloud_pk}/project/{project_pk}/document/{id} |
Update some fields of the document |
| CollaborationApi |
update_document_text |
PATCH /cloud/{cloud_pk}/project/{project_pk}/document/{id}/text |
Update the text representation of a document |
| CollaborationApi |
update_folder |
PATCH /cloud/{cloud_pk}/project/{project_pk}/folder/{id} |
Update some fields of a folder |
| CollaborationApi |
update_group_folder |
PATCH /cloud/{cloud_pk}/project/{project_pk}/folder/{folder_pk}/group/{id} |
Update the permission of a group on a folder. When propagate is set to True, the permission of all children in the folder will be updated. |
| CollaborationApi |
update_manage_group |
PATCH /cloud/{cloud_pk}/project/{project_pk}/group/{id} |
Update some fields of a group |
| CollaborationApi |
update_naming_constraint |
PATCH /cloud/{cloud_pk}/project/{project_pk}/naming-constraint/{id} |
Update some fields of a naming constraint |
| CollaborationApi |
update_naming_parts_template |
PATCH /cloud/{cloud_pk}/project/{project_pk}/naming-parts-template/{id} |
Update some fields of a naming rule list |
| CollaborationApi |
update_preview_file |
PATCH /cloud/{cloud_pk}/project/{project_pk}/document/{id}/preview-file |
Update preview of the document |
| CollaborationApi |
update_project |
PATCH /cloud/{cloud_pk}/project/{id} |
Update some fields of a project |
| CollaborationApi |
update_project_user |
PATCH /cloud/{cloud_pk}/project/{project_pk}/user/{id} |
Change the user role in the cloud |
| CollaborationApi |
update_tag |
PATCH /cloud/{cloud_pk}/project/{project_pk}/tag/{id} |
Update some fields of the tag |
| CollaborationApi |
update_validation |
PATCH /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id} |
Update the validator of validation |
| CollaborationApi |
update_visa |
PATCH /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id} |
Update some fields of a visa |
| CollaborationApi |
update_visa_comment |
PATCH /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment/{id} |
Update some fields of a comment |
| ModelApi |
add_equipment_image |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/equipment/{equipment_pk}/image |
Add a new image to the equipment |
| ModelApi |
add_model_errors |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{id}/errors |
Add errors to model |
| ModelApi |
add_zone_space |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/add |
Add a space to a zone |
| ModelApi |
bulk_delete_model_classifications |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/list_destroy |
Remove all classifications from model's elements |
| ModelApi |
bulk_delete_model_properties |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/bulk_destroy |
Delete many Property of a model |
| ModelApi |
bulk_delete_model_property_definitions |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/bulk_destroy |
Delete many PropertyDefinitions of a model |
| ModelApi |
bulk_delete_model_units |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit/bulk_destroy |
Delete many Units of a model |
| ModelApi |
bulk_delete_property_set |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/bulk_destroy |
Delete many PropertySet of a model |
| ModelApi |
bulk_full_update_elements |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/bulk_update |
Update many elements at once (only changing fields may be defined) |
| ModelApi |
bulk_full_update_model_property |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/bulk_update |
Update some fields of many properties of a model |
| ModelApi |
bulk_remove_classifications_of_element |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/classification/bulk_destroy |
Remove many classifications from an element |
| ModelApi |
bulk_remove_documents_of_element |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/documents/bulk_destroy |
Remove many documents from an element |
| ModelApi |
bulk_remove_elements_from_classification |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/{model_classification_pk}/element/bulk_destroy |
Remove the classifications from all elements |
| ModelApi |
bulk_update_elements |
PUT /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/bulk_update |
Update many elements at once (all field must be defined) |
| ModelApi |
bulk_update_model_property |
PUT /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/bulk_update |
Update all fields of many properties of a model |
| ModelApi |
create_access_token |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token |
Create a token for this model |
| ModelApi |
create_building |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building |
Create a building of a model |
| ModelApi |
create_building_plan |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/add |
Create a relation between a 2d model and a building |
| ModelApi |
create_classification_element_relations |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification-element |
Create association between existing classification and existing element |
| ModelApi |
create_classifications_of_element |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/classification |
Create one or many classifications to an element |
| ModelApi |
create_drawing |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing |
Create a drawing in the model |
| ModelApi |
create_element |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element |
Create an element in the model |
| ModelApi |
create_element_property_set |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset |
Create a PropertySets to an element |
| ModelApi |
create_element_property_set_property |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property |
Create a property to a PropertySet |
| ModelApi |
create_element_property_set_property_definition |
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 |
| ModelApi |
create_element_property_set_property_definition_unit |
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 |
| ModelApi |
create_equipment |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/equipment |
Create an equipment on the model |
| ModelApi |
create_label |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/label |
Create a label in the model |
| ModelApi |
create_layer |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer |
Create a layer in the model |
| ModelApi |
create_mask2_d |
PUT /cloud/{cloud_pk}/project/{project_pk}/model/{id}/mask-2d |
Create or update a 2D mask for the model |
| ModelApi |
create_meta_building |
POST /cloud/{cloud_pk}/project/{project_pk}/model/create-metabuilding |
Create an empty 3D Model |
| ModelApi |
create_model |
POST /cloud/{cloud_pk}/project/{project_pk}/model/create-model |
Make a PDF or Image file a Model |
| ModelApi |
create_model_property_definition |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition |
Create a PropertyDefinition on the model |
| ModelApi |
create_model_unit |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit |
Create a Unit on a model |
| ModelApi |
create_multi_page_model |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{id}/create-multipage-model |
Create a multi page model |
| ModelApi |
create_photosphere |
POST /cloud/{cloud_pk}/project/{project_pk}/model/create-photosphere |
Create a photopshere model from an image file |
| ModelApi |
create_photosphere_building |
POST /cloud/{cloud_pk}/project/{project_pk}/model/create-photosphere-building |
Create an empty Photosphere Building Model |
| ModelApi |
create_positioned_model |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/positioned-model |
Add a child model and it's position on the model |
| ModelApi |
create_property_set |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset |
Create one or many PropertySet |
| ModelApi |
create_property_set_element_relations |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset-element |
Create association between PropertySet and element |
| ModelApi |
create_raw_elements |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/raw |
Create elements in an optimized format |
| ModelApi |
create_space |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space |
Create a space in the model |
| ModelApi |
create_storey |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey |
Create a storey of a model |
| ModelApi |
create_storey_plan |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/add |
Create a relation between a 2d model and a storey |
| ModelApi |
create_system |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system |
Create a system in the model |
| ModelApi |
create_tileset |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{id}/tileset |
Create the tileset of the model and upload all files |
| ModelApi |
create_xkt_file |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{id}/xkt-file |
Create an xkt file for the model. Overrides existing file with same version |
| ModelApi |
create_zone |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone |
Create a zone in the model |
| ModelApi |
create_zone_space |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space |
Create a space in a zone |
| ModelApi |
delete_access_token |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token/{token} |
Delete a token |
| ModelApi |
delete_building |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{uuid} |
Delete a building of a model |
| ModelApi |
delete_building_plan |
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 |
| ModelApi |
delete_drawing |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing/{id} |
Delete a drawing of a model |
| ModelApi |
delete_element |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} |
Delete an element of a model |
| ModelApi |
delete_equipment |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/equipment/{id} |
Delete an equipment |
| ModelApi |
delete_equipment_image |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/equipment/{equipment_pk}/image/{id} |
Remove an equipment image |
| ModelApi |
delete_label |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/label/{id} |
Delete a label |
| ModelApi |
delete_layer |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id} |
Delete a layer of a model |
| ModelApi |
delete_mask2_d |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{id}/mask-2d |
Delete the 2D mask for the model |
| ModelApi |
delete_model |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{id} |
Delete a model |
| ModelApi |
delete_model_property |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/{id} |
Delete a Property of a model |
| ModelApi |
delete_model_property_definition |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/{id} |
Delete a PropertyDefinitions of a model |
| ModelApi |
delete_model_unit |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit/{id} |
Delete a Unit of a model |
| ModelApi |
delete_model_without_doc |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{id}/delete-model |
Delete the Model without deleting the related document |
| ModelApi |
delete_positioned_model |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/positioned-model/{id} |
Remove a child model and its position from the model |
| ModelApi |
delete_property_set |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/{id} |
Delete a PropertySet of a model |
| ModelApi |
delete_space |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space/{id} |
Delete a space |
| ModelApi |
delete_storey |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{uuid} |
Delete a storey of a model |
| ModelApi |
delete_storey_plan |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/{id} |
Delete the relation between a 2d model and a storey |
| ModelApi |
delete_system |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system/{uuid} |
Delete a system of a model |
| ModelApi |
delete_zone |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{id} |
Delete a zone of a model |
| ModelApi |
delete_zone_space |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/{id} |
Delete the relation between a space and a zone |
| ModelApi |
export_ifc |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{id}/export |
Export IFC |
| ModelApi |
full_update_element |
PUT /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} |
Update all fields of an element |
| ModelApi |
get_access_token |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token/{token} |
Retrieve one token created for this model |
| ModelApi |
get_access_tokens |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token |
Retrieve all tokens created for this model |
| ModelApi |
get_building |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{uuid} |
Retrieve a building of a model |
| ModelApi |
get_building_plan_positioning |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/{id}/positioning |
Retrieve the postioning of the plan in the building |
| ModelApi |
get_buildings |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building |
Retrieve all buildings of a model |
| ModelApi |
get_classifications_of_element |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/classification |
Retrieve all classifications of an element |
| ModelApi |
get_documents_of_element |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/documents |
Retrieve all documents of an element |
| ModelApi |
get_drawing |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing/{id} |
Retrieve a drawing of a model |
| ModelApi |
get_drawings |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing |
Retrieve all drawings of a model |
| ModelApi |
get_element |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} |
Retrieve an element of a model |
| ModelApi |
get_element_linked_documents |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/documents |
Retrieve all documents linked to any element |
| ModelApi |
get_element_property_set |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{id} |
Retrieve a PropertySet of an element |
| ModelApi |
get_element_property_set_properties |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property |
Retrieve all Properties of a PropertySet |
| ModelApi |
get_element_property_set_property |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} |
Retrieve a Property of a PropertySet |
| ModelApi |
get_element_property_set_property_definition |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{id} |
Retrieve a Definition of a Property |
| ModelApi |
get_element_property_set_property_definition_unit |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit/{id} |
Retrieve a Unit of a Definition |
| ModelApi |
get_element_property_set_property_definition_units |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit |
Retrieve all Units of a Definition |
| ModelApi |
get_element_property_set_property_definitions |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition |
Retrieve all Definitions of a PropertySet |
| ModelApi |
get_element_property_sets |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset |
Retrieve all PropertySets of an element |
| ModelApi |
get_elements |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element |
Retrieve all elements of a model |
| ModelApi |
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 |
| ModelApi |
get_equipment |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/equipment/{id} |
Retrieve one equipment of the model |
| ModelApi |
get_equipment_images |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/equipment/{equipment_pk}/image |
Retrieve all images attached to the equipment |
| ModelApi |
get_equipments |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/equipment |
Retrieve all equipments of the model |
| ModelApi |
get_label |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/label/{id} |
Retrieve one label of the model |
| ModelApi |
get_labels |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/label |
Retrieve all labels of the model |
| ModelApi |
get_layer |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id} |
Retrieve a layer of a model |
| ModelApi |
get_layers |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer |
Retrieve all layers of a model |
| ModelApi |
get_material |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/material/{id} |
Retrieve a material of a model |
| ModelApi |
get_materials |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/material |
Retrieve all materials of a model |
| ModelApi |
get_model |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{id} |
Retrieve one model |
| ModelApi |
get_model_classifications |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification |
Retrieve all classifications in a model |
| ModelApi |
get_model_material |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/material/{id} |
Retrieve a material of a model |
| ModelApi |
get_model_materials |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/material |
Retrieve all materials of a model |
| ModelApi |
get_model_properties |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property |
Retrieve all Properties of a model |
| ModelApi |
get_model_property |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/{id} |
Retrieve a Property of a model |
| ModelApi |
get_model_property_definition |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/{id} |
Retrieve a PropertyDefinition of a model |
| ModelApi |
get_model_property_definitions |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition |
Retrieve all PropertyDefinitions of a model |
| ModelApi |
get_model_unit |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit/{id} |
Retrieve a Unit of a model |
| ModelApi |
get_model_units |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit |
Retrieve all Units of a model |
| ModelApi |
get_models |
GET /cloud/{cloud_pk}/project/{project_pk}/model |
Retrieve all models |
| ModelApi |
get_models_summary |
GET /cloud/{cloud_pk}/project/{project_pk}/model/summary |
Retrieve all models summary |
| ModelApi |
get_positioned_model |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/positioned-model/{id} |
Retrieve one specific child model & position on the model |
| ModelApi |
get_positioned_models |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/positioned-model |
Retrieve all positioned child model & positions on the model |
| ModelApi |
get_processor_handler |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/processorhandler/{id} |
Retrieve a processor handler |
| ModelApi |
get_processor_handlers |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/processorhandler |
Get all processor handlers |
| ModelApi |
get_properties_types |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/properties |
Retrieve all property types and their value type used in this model |
| ModelApi |
get_property_set |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/{id} |
Retrieve a PropertySet of a model |
| ModelApi |
get_property_sets |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset |
Retrieve all PropertySets of a model |
| ModelApi |
get_raw_elements |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/raw |
Retrieve all elements in a optimized format |
| ModelApi |
get_simple_element |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid}/simple |
Retrieve an element of a model with a simple value representation |
| ModelApi |
get_simple_elements |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/simple |
Retrieve all elements of a model with a simple value representation |
| ModelApi |
get_space |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space/{id} |
Retrieve one space of the model |
| ModelApi |
get_spaces |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space |
Retrieve all spaces of the model |
| ModelApi |
get_storey |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{uuid} |
Retrieve a storey of a model |
| ModelApi |
get_storey_plan_positioning |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/{id}/positioning |
Retrieve the postioning of the plan in the storey |
| ModelApi |
get_storeys |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey |
Retrieve all storeys of a model |
| ModelApi |
get_system |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system/{uuid} |
Retrieve a system of a model |
| ModelApi |
get_systems |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system |
Retrieve all systems of a model |
| ModelApi |
get_tileset |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{id}/tileset |
Retrieve the tileset of the model |
| ModelApi |
get_types |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/types |
Retrieve all IFC Types used in this model |
| ModelApi |
get_zone |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{id} |
Retrieve one zone of a model |
| ModelApi |
get_zone_space |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/{id} |
Retrieve one space of a zone |
| ModelApi |
get_zone_spaces |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space |
Retrieve all spaces of a zone |
| ModelApi |
get_zones |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone |
Retrieve zones of a model |
| ModelApi |
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 |
| ModelApi |
list_classification_element_relations |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification-element |
List all associations between classifications and elements |
| ModelApi |
list_models_positioned_in |
GET /cloud/{cloud_pk}/project/{project_pk}/model/{id}/positioned-in |
List all models where the model is positioned in |
| ModelApi |
merge_ifcs |
POST /cloud/{cloud_pk}/project/{project_pk}/model/merge |
Merge IFC files |
| ModelApi |
optimize_ifc |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{id}/optimize |
Optimize the IFC |
| ModelApi |
remove_all_element_property_set |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/all |
Remove all property sets from element |
| ModelApi |
remove_classification_of_element |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/classification/{id} |
Remove a classification from an element |
| ModelApi |
remove_document_of_element |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/documents/{id} |
Remove a documents from an element |
| ModelApi |
remove_element_property_set |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{id} |
Remove a PropertySet from an element |
| ModelApi |
remove_element_property_set_property |
DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} |
Remove a property from a PropertySet |
| ModelApi |
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 |
| ModelApi |
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 |
| ModelApi |
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 |
| ModelApi |
reprocess_model |
POST /cloud/{cloud_pk}/project/{project_pk}/model/{id}/reprocess |
Reprocess Model file |
| ModelApi |
update_access_token |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token/{token} |
Update some fields of a token |
| ModelApi |
update_building |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{uuid} |
Update some fields of a building |
| ModelApi |
update_building_plan_positioning |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/{id}/positioning |
Update the postioning of the plan in the building |
| ModelApi |
update_drawing |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing/{id} |
Update some fields of a drawing |
| ModelApi |
update_element |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid} |
Update some fields of an element |
| ModelApi |
update_element_property_set_property |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} |
Update a property from an element |
| ModelApi |
update_equipment |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/equipment/{id} |
Update some fields of an equipment |
| ModelApi |
update_label |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/label/{id} |
Update some fields of a label |
| ModelApi |
update_layer |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id} |
Update some fields of a layer |
| ModelApi |
update_mask2_d |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{id}/mask-2d |
Partial update of a 2D mask for the model |
| ModelApi |
update_model |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{id} |
Update some fields of a model |
| ModelApi |
update_model_files |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{id}/files |
Update models file (gltf, svg, structure, etc) |
| ModelApi |
update_model_property |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/{id} |
Update some fields of a Property |
| ModelApi |
update_model_property_definition |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/{id} |
Update some fields of many PropertyDefinitions of a model |
| ModelApi |
update_model_transform |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{id}/transform |
Update model transform |
| ModelApi |
update_model_unit |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit/{id} |
Update some fields of a Unit of a model |
| ModelApi |
update_order_building_plan |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/order |
Update order of all plan of a building |
| ModelApi |
update_order_storey_plan |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/order |
Update order of all plan of a storey |
| ModelApi |
update_order_storeys |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/order |
Update order of all storey of a model |
| ModelApi |
update_positioned_model |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/positioned-model/{id} |
Update the position of a child model on the model |
| ModelApi |
update_processor_handler |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/processorhandler/{id} |
Update the status of a processor handler |
| ModelApi |
update_property_set |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/{id} |
Update some fields of a PropertySet |
| ModelApi |
update_space |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space/{id} |
Update some fields of a space |
| ModelApi |
update_storey |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{uuid} |
Update some fields of a storey |
| ModelApi |
update_storey_plan_positioning |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/{id}/positioning |
Update the postioning of the plan in the storey |
| ModelApi |
update_system |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system/{uuid} |
Update some fields of a system |
| ModelApi |
update_zone |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{id} |
Update some fields of a zone |
| ModelApi |
update_zone_space |
PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/{id} |
Update some fields of a space |
| SsoApi |
accept_invitation |
POST /identity-provider/invitation/{id}/accept |
Accept an invitation |
| SsoApi |
create_user |
POST /identity-provider/user |
Create a user |
| SsoApi |
delete_user |
DELETE /identity-provider/user |
Delete user from BIMData |
| SsoApi |
deny_invitation |
POST /identity-provider/invitation/{id}/deny |
Deny an invitation |
| SsoApi |
get_invitation |
GET /identity-provider/invitation/{id} |
Retrieve an invitation |
| SsoApi |
get_invitations |
GET /identity-provider/invitation |
Retrieve all invitations |
| WebhookApi |
create_project_web_hook |
POST /cloud/{cloud_pk}/project/{project_pk}/webhook |
Create a new project Webhook |
| WebhookApi |
create_web_hook |
POST /cloud/{cloud_pk}/webhook |
Create a new Webhook |
| WebhookApi |
delete_project_web_hook |
DELETE /cloud/{cloud_pk}/project/{project_pk}/webhook/{id} |
Delete a webhook |
| WebhookApi |
delete_web_hook |
DELETE /cloud/{cloud_pk}/webhook/{id} |
Delete a webhook |
| WebhookApi |
get_project_web_hook |
GET /cloud/{cloud_pk}/project/{project_pk}/webhook/{id} |
Retrieve one configured project webhook |
| WebhookApi |
get_project_web_hooks |
GET /cloud/{cloud_pk}/project/{project_pk}/webhook |
Retrieve all configured project webhooks |
| WebhookApi |
get_web_hook |
GET /cloud/{cloud_pk}/webhook/{id} |
Retrieve one configured webhook |
| WebhookApi |
get_web_hooks |
GET /cloud/{cloud_pk}/webhook |
Retrieve all configured webhooks |
| WebhookApi |
ping_project_web_hook |
POST /cloud/{cloud_pk}/project/{project_pk}/webhook/{id}/ping |
Test a project webhook |
| WebhookApi |
ping_web_hook |
POST /cloud/{cloud_pk}/webhook/{id}/ping |
Test a webhook |
| WebhookApi |
update_project_web_hook |
PATCH /cloud/{cloud_pk}/project/{project_pk}/webhook/{id} |
Update some field of a webhook |
| WebhookApi |
update_web_hook |
PATCH /cloud/{cloud_pk}/webhook/{id} |
Update some field of a webhook |