Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

bimdata-api-client

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

bimdata-api-client

BIMData API

  • 10.9.3
  • PyPI
  • Socket score
Maintainers
1

bimdata-api-client

BIMData API is a tool to interact with your models stored on BIMData’s servers. Through the API, you can manage your projects, the clouds, upload your IFC files and manage them through endpoints.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v1 (v1)
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://bimdata.io/

Requirements.

Python >=3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import bimdata_api_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import bimdata_api_client

Getting Started

Please follow the installation procedure and then run the following:


import time
import bimdata_api_client
from pprint import pprint
from bimdata_api_client.api import bcf_api
from bimdata_api_client.model.auth import Auth
from bimdata_api_client.model.bcf_project import BcfProject
from bimdata_api_client.model.bcf_project_request import BcfProjectRequest
from bimdata_api_client.model.coloring import Coloring
from bimdata_api_client.model.comment import Comment
from bimdata_api_client.model.comment_request import CommentRequest
from bimdata_api_client.model.component import Component
from bimdata_api_client.model.detailed_extensions import DetailedExtensions
from bimdata_api_client.model.extensions import Extensions
from bimdata_api_client.model.full_topic import FullTopic
from bimdata_api_client.model.full_topic_request import FullTopicRequest
from bimdata_api_client.model.label import Label
from bimdata_api_client.model.label_request import LabelRequest
from bimdata_api_client.model.patched_bcf_project_request import PatchedBcfProjectRequest
from bimdata_api_client.model.patched_comment_request import PatchedCommentRequest
from bimdata_api_client.model.patched_full_topic_request import PatchedFullTopicRequest
from bimdata_api_client.model.patched_label_request import PatchedLabelRequest
from bimdata_api_client.model.patched_pin_request import PatchedPinRequest
from bimdata_api_client.model.patched_priority_request import PatchedPriorityRequest
from bimdata_api_client.model.patched_stage_request import PatchedStageRequest
from bimdata_api_client.model.patched_topic_request import PatchedTopicRequest
from bimdata_api_client.model.patched_topic_status_request import PatchedTopicStatusRequest
from bimdata_api_client.model.patched_topic_type_request import PatchedTopicTypeRequest
from bimdata_api_client.model.patched_viewpoint_request import PatchedViewpointRequest
from bimdata_api_client.model.pin import Pin
from bimdata_api_client.model.pin_request import PinRequest
from bimdata_api_client.model.priority import Priority
from bimdata_api_client.model.priority_request import PriorityRequest
from bimdata_api_client.model.self_bcf_user import SelfBcfUser
from bimdata_api_client.model.stage import Stage
from bimdata_api_client.model.stage_request import StageRequest
from bimdata_api_client.model.topic import Topic
from bimdata_api_client.model.topic_request import TopicRequest
from bimdata_api_client.model.topic_status import TopicStatus
from bimdata_api_client.model.topic_status_request import TopicStatusRequest
from bimdata_api_client.model.topic_type import TopicType
from bimdata_api_client.model.topic_type_request import TopicTypeRequest
from bimdata_api_client.model.version import Version
from bimdata_api_client.model.viewpoint import Viewpoint
from bimdata_api_client.model.viewpoint_request import ViewpointRequest
from bimdata_api_client.model.visibility import Visibility
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = bimdata_api_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Configure OAuth2 access token for authorization: BIMData_Connect
configuration = bimdata_api_client.Configuration(
    host = "http://localhost"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Configure OAuth2 access token for authorization: BIMData_Connect
configuration = bimdata_api_client.Configuration(
    host = "http://localhost"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Configure API key authorization: Bearer
configuration.api_key['Bearer'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer'] = 'Bearer'


# Enter a context with an instance of the API client
with bimdata_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = bcf_api.BcfApi(api_client)
    projects_pk = 1 # int | A unique integer value identifying this project.
topics_guid = "topics_guid_example" # str | 
comment_request = CommentRequest(
        guid="guid_example",
        date=dateutil_parser('1970-01-01T00:00:00.00Z'),
        author="author_example",
        comment="comment_example",
        viewpoint_guid="viewpoint_guid_example",
        reply_to_comment_guid="reply_to_comment_guid_example",
        modified_author="modified_author_example",
        viewpoint_temp_id=1,
    ) # CommentRequest |  (optional)

    try:
        # Create a comment
        api_response = api_instance.create_comment(projects_pk, topics_guid, comment_request=comment_request)
        pprint(api_response)
    except bimdata_api_client.ApiException as e:
        print("Exception when calling BcfApi->create_comment: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
BcfApicreate_commentPOST /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/commentsCreate a comment
BcfApicreate_extension_labelPOST /bcf/2.1/projects/{projects_pk}/extension/labelCreate a Label
BcfApicreate_extension_priorityPOST /bcf/2.1/projects/{projects_pk}/extension/priorityCreate a Priority
BcfApicreate_extension_stagePOST /bcf/2.1/projects/{projects_pk}/extension/stageCreate a Stage
BcfApicreate_extension_statusPOST /bcf/2.1/projects/{projects_pk}/extension/statusCreate a TopicStatus
BcfApicreate_extension_typePOST /bcf/2.1/projects/{projects_pk}/extension/typeCreate a TopicType
BcfApicreate_full_topicPOST /bcf/2.1/projects/{projects_pk}/full-topicCreate a Topic with viewpoints and comments
BcfApicreate_pinPOST /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pinCreate a Pin
BcfApicreate_topicPOST /bcf/2.1/projects/{projects_pk}/topicsCreate a topic
BcfApicreate_viewpointPOST /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpointsCreate a Viewpoint
BcfApidelete_commentDELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid}Delete a comment
BcfApidelete_extension_labelDELETE /bcf/2.1/projects/{projects_pk}/extension/label/{id}Delete a Label
BcfApidelete_extension_priorityDELETE /bcf/2.1/projects/{projects_pk}/extension/priority/{id}Delete a Priority
BcfApidelete_extension_stageDELETE /bcf/2.1/projects/{projects_pk}/extension/stage/{id}Delete a Stage
BcfApidelete_extension_statusDELETE /bcf/2.1/projects/{projects_pk}/extension/status/{id}Delete a TopicStatus
BcfApidelete_extension_typeDELETE /bcf/2.1/projects/{projects_pk}/extension/type/{id}Delete a TopicType
BcfApidelete_pinDELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid}Delete a Pin
BcfApidelete_topicDELETE /bcf/2.1/projects/{projects_pk}/topics/{guid}Delete a topic
BcfApidelete_viewpointDELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}Delete a Viewpoint
BcfApidownload_bcf_exportGET /bcf/2.1/projects/{id}/exportExport project's topics in bcf-xml format
BcfApidownload_bcf_export_xlsxGET /bcf/2.1/projects/{id}/export-xlsxExport project's topics in excel format
BcfApifull_update_bcf_projectPUT /bcf/2.1/projects/{id}Update all fields of a BCF project
BcfApifull_update_commentPUT /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid}Update all fields of a comment
BcfApifull_update_full_topicPUT /bcf/2.1/projects/{projects_pk}/full-topic/{guid}Update all fields of a topic
BcfApifull_update_pinPUT /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid}Update all fields of a Pin
BcfApifull_update_topicPUT /bcf/2.1/projects/{projects_pk}/topics/{guid}Update all fields of a topic
BcfApiget_authGET /bcf/2.1/authRetrieve Authentication Information
BcfApiget_bcf_projectGET /bcf/2.1/projects/{id}Retrieve a BCF project
BcfApiget_bcf_projectsGET /bcf/2.1/projectsRetrieve all BCF projects
BcfApiget_coloringsGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/coloringRetrieve all colorings of a viewpoint
BcfApiget_commentGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid}Retrieve a comment
BcfApiget_commentsGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/commentsRetrieve all comments
BcfApiget_detailed_extensionsGET /bcf/2.1/projects/{id}/detailed-extensionsRetrieve project detailed extensions
BcfApiget_extensionsGET /bcf/2.1/projects/{id}/extensionsRetrieve project extensions
BcfApiget_full_topicGET /bcf/2.1/projects/{projects_pk}/full-topic/{guid}Retrieve a full topic
BcfApiget_full_topicsGET /bcf/2.1/projects/{projects_pk}/full-topicRetrieve all full topics
BcfApiget_pinsGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pinRetrieve all Pins of a viewpoint
BcfApiget_related_topicsGET /bcf/2.1/projects/{projects_pk}/topics/{guid}/related_topicsGet all related topics
BcfApiget_selectionsGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/selectionRetrieve all selections of a viewpoint
BcfApiget_snapshotGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/snapshotRetrieve the viewpoint' snapshot
BcfApiget_topicGET /bcf/2.1/projects/{projects_pk}/topics/{guid}Retrieve a topic
BcfApiget_topic_document_referencesGET /bcf/2.1/projects/{projects_pk}/topics/{guid}/document_referencesGet all related documents
BcfApiget_topic_viewpointsGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/topic-viewpointsRetrieve all viewpoints attached to the topic
BcfApiget_topicsGET /bcf/2.1/projects/{projects_pk}/topicsRetrieve all topics
BcfApiget_userGET /bcf/2.1/current-userGet current user info
BcfApiget_versionsGET /bcf/versionsRetrieve all supported BCF versions by this API
BcfApiget_viewpoin_pinGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid}Retrieve a Pin
BcfApiget_viewpointGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}Retrieve a Viewpoint
BcfApiget_viewpointsGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpointsRetrieve all Viewpoints of a topic
BcfApiget_visibilitiesGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/visibilityRetrieve all visibilities of a viewpoint
BcfApiimport_bcfPOST /bcf/2.1/projects/{id}/importImport bcf-xml format into this project
BcfApiupdate_bcf_projectPATCH /bcf/2.1/projects/{id}Update some fields of a BCF project
BcfApiupdate_commentPATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid}Update some fields of a comment
BcfApiupdate_extension_labelPATCH /bcf/2.1/projects/{projects_pk}/extension/label/{id}Update a Label
BcfApiupdate_extension_priorityPATCH /bcf/2.1/projects/{projects_pk}/extension/priority/{id}Update a Priority
BcfApiupdate_extension_stagePATCH /bcf/2.1/projects/{projects_pk}/extension/stage/{id}Update a Stage
BcfApiupdate_extension_statusPATCH /bcf/2.1/projects/{projects_pk}/extension/status/{id}Update a TopicStatus
BcfApiupdate_extension_typePATCH /bcf/2.1/projects/{projects_pk}/extension/type/{id}Update a TopicType
BcfApiupdate_full_topicPATCH /bcf/2.1/projects/{projects_pk}/full-topic/{guid}Update some fields of a topic
BcfApiupdate_pinPATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid}Update some fields of a Pin
BcfApiupdate_topicPATCH /bcf/2.1/projects/{projects_pk}/topics/{guid}Update some fields of a topic
BcfApiupdate_viewpointPATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}Update some fields of a Viewpoint
CollaborationApiaccept_user_invitationPOST /user/invitations/{id}/acceptAccept an invitation
CollaborationApiaccept_validationPOST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id}/acceptAccept a validation
CollaborationApiadd_document_tagPOST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/tagAdd a tag to a document
CollaborationApiadd_group_memberPOST /cloud/{cloud_pk}/project/{project_pk}/group/{group_pk}/memberAdd a user to a group
CollaborationApicancel_cloud_user_invitationDELETE /cloud/{cloud_pk}/invitation/{id}Cancel a pending invitation
CollaborationApicancel_project_user_invitationDELETE /cloud/{cloud_pk}/project/{project_pk}/invitation/{id}Cancel a pending invitation
CollaborationApicheck_accessGET /cloud/{id}/check-accessCheck app access from cloud
CollaborationApicheck_project_accessGET /cloud/{cloud_pk}/project/{id}/check-accessCheck if the current token has access to the requested project
CollaborationApiclose_visaPOST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id}/closeClose a visa of a document
CollaborationApicreate_classificationPOST /cloud/{cloud_pk}/project/{project_pk}/classificationCreate a classification
CollaborationApicreate_cloudPOST /cloudCreate a cloud
CollaborationApicreate_demoPOST /cloud/{id}/create-demoCreate a Demo project in a cloud
CollaborationApicreate_dms_treePOST /cloud/{cloud_pk}/project/{id}/dms-treeCreate a complete DMS tree
CollaborationApicreate_documentPOST /cloud/{cloud_pk}/project/{project_pk}/documentCreate a document
CollaborationApicreate_folderPOST /cloud/{cloud_pk}/project/{project_pk}/folderCreate a folder
CollaborationApicreate_manage_groupPOST /cloud/{cloud_pk}/project/{project_pk}/groupCreate a group
CollaborationApicreate_projectPOST /cloud/{cloud_pk}/projectCreate a project
CollaborationApicreate_project_access_tokenPOST /cloud/{cloud_pk}/project/{project_pk}/access-tokenCreate a token for this project
CollaborationApicreate_tagPOST /cloud/{cloud_pk}/project/{project_pk}/tagCreate a tag
CollaborationApicreate_validationPOST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validationAdd a validation to a visa
CollaborationApicreate_visaPOST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visaCreate a visa
CollaborationApicreate_visa_commentPOST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/commentAdd a comment
CollaborationApidelete_all_document_historyDELETE /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history/deleteDelete all document history
CollaborationApidelete_classificationDELETE /cloud/{cloud_pk}/project/{project_pk}/classification/{id}Delete a classification
CollaborationApidelete_cloudDELETE /cloud/{id}Delete a cloud
CollaborationApidelete_cloud_userDELETE /cloud/{cloud_pk}/user/{id}Remove a user from a cloud
CollaborationApidelete_documentDELETE /cloud/{cloud_pk}/project/{project_pk}/document/{id}Delete the document
CollaborationApidelete_document_tagDELETE /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/tag/{id}Delete a tag from a document
CollaborationApidelete_folderDELETE /cloud/{cloud_pk}/project/{project_pk}/folder/{id}Delete a folder
CollaborationApidelete_group_memberDELETE /cloud/{cloud_pk}/project/{project_pk}/group/{group_pk}/member/{id}Delete a user from a group
CollaborationApidelete_manage_groupDELETE /cloud/{cloud_pk}/project/{project_pk}/group/{id}Delete a group
CollaborationApidelete_projectDELETE /cloud/{cloud_pk}/project/{id}Delete a project
CollaborationApidelete_project_access_tokenDELETE /cloud/{cloud_pk}/project/{project_pk}/access-token/{token}Delete a token
CollaborationApidelete_project_userDELETE /cloud/{cloud_pk}/project/{project_pk}/user/{id}Remove a user from a project
CollaborationApidelete_tagDELETE /cloud/{cloud_pk}/project/{project_pk}/tag/{id}Delete the tag
CollaborationApidelete_validationDELETE /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id}Remove a validation
CollaborationApidelete_visaDELETE /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id}Remove a visa
CollaborationApidelete_visa_commentDELETE /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment/{id}Remove a comment
CollaborationApideny_user_invitationPOST /user/invitations/{id}/denyDeny an invitation
CollaborationApideny_validationPOST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id}/denyDeny a validation
CollaborationApiget_classificationGET /cloud/{cloud_pk}/project/{project_pk}/classification/{id}Retrieve a classification
CollaborationApiget_classificationsGET /cloud/{cloud_pk}/project/{project_pk}/classificationRetrieve all classifications
CollaborationApiget_cloudGET /cloud/{id}Retrieve one cloud
CollaborationApiget_cloud_invitationsGET /cloud/{cloud_pk}/invitationRetrieve all pending invitations in the cloud
CollaborationApiget_cloud_sizeGET /cloud/{id}/sizeGet size of the cloud
CollaborationApiget_cloud_userGET /cloud/{cloud_pk}/user/{id}Retrieve a user in a cloud
CollaborationApiget_cloud_usersGET /cloud/{cloud_pk}/userRetrieve all users in a cloud, or a list with a filter by email
CollaborationApiget_cloudsGET /cloudRetrieve all clouds
CollaborationApiget_documentGET /cloud/{cloud_pk}/project/{project_pk}/document/{id}Retrieve a document
CollaborationApiget_document_historiesGET /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/historyRetrieve all document histories
CollaborationApiget_documentsGET /cloud/{cloud_pk}/project/{project_pk}/documentRetrieve all documents
CollaborationApiget_folderGET /cloud/{cloud_pk}/project/{project_pk}/folder/{id}Retrieve a folder
CollaborationApiget_folder_documentsGET /cloud/{cloud_pk}/project/{project_pk}/folder/{folder_pk}/documentGet all documents of a folder
CollaborationApiget_folder_project_usersGET /cloud/{cloud_pk}/project/{project_pk}/folder/{folder_pk}/userRetrieve all users in a project with the permission on the folder
CollaborationApiget_foldersGET /cloud/{cloud_pk}/project/{project_pk}/folderRetrieve all folders
CollaborationApiget_groupGET /cloud/{cloud_pk}/project/{project_pk}/me/group/{id}Retrieve a group
CollaborationApiget_groupsGET /cloud/{cloud_pk}/project/{project_pk}/me/groupRetrieve all groups
CollaborationApiget_logsGET /cloud/{cloud_pk}/project/{project_pk}/logsRetrieve all logs of the project
CollaborationApiget_manage_groupGET /cloud/{cloud_pk}/project/{project_pk}/group/{id}Retrieve a group
CollaborationApiget_manage_groupsGET /cloud/{cloud_pk}/project/{project_pk}/groupRetrieve all groups
CollaborationApiget_projectGET /cloud/{cloud_pk}/project/{id}Retrieve a project
CollaborationApiget_project_access_tokenGET /cloud/{cloud_pk}/project/{project_pk}/access-token/{token}Retrieve one token created for this project
CollaborationApiget_project_access_tokensGET /cloud/{cloud_pk}/project/{project_pk}/access-tokenRetrieve all tokens created for this project
CollaborationApiget_project_creator_visasGET /cloud/{cloud_pk}/project/{project_pk}/me/visa/creatorList visas created by user
CollaborationApiget_project_dms_treeGET /cloud/{cloud_pk}/project/{id}/dms-treeRetrieve the complete DMS tree
CollaborationApiget_project_folder_treeGET /cloud/{cloud_pk}/project/{id}/folder-treeRetrieve folder tree of the project
CollaborationApiget_project_invitationsGET /cloud/{cloud_pk}/project/{project_pk}/invitationRetrieve all pending invitations in the project
CollaborationApiget_project_sizeGET /cloud/{cloud_pk}/project/{id}/sizeGet size of all model files in the project
CollaborationApiget_project_treeGET /cloud/{cloud_pk}/project/{id}/treeRetrieve the complete DMS tree
CollaborationApiget_project_usersGET /cloud/{cloud_pk}/project/{project_pk}/userRetrieve all users in a project, or a list with a filter by email
CollaborationApiget_project_validator_visasGET /cloud/{cloud_pk}/project/{project_pk}/me/visa/validatorList visas where user is a validator
CollaborationApiget_projectsGET /cloud/{cloud_pk}/projectRetrieve all projects
CollaborationApiget_self_projectsGET /user/projectsList current user's projects
CollaborationApiget_self_userGET /userGet info about the current user
CollaborationApiget_tagGET /cloud/{cloud_pk}/project/{project_pk}/tag/{id}Retrieve a tag
CollaborationApiget_tagsGET /cloud/{cloud_pk}/project/{project_pk}/tagRetrieve all tags
CollaborationApiget_user_invitationGET /user/invitations/{id}Retrieve an invitation
CollaborationApiget_user_invitationsGET /user/invitationsList user's invitations
CollaborationApiget_validationGET /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id}Retrieve a validation to a visa
CollaborationApiget_validationsGET /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validationList all validations to a visa
CollaborationApiget_visaGET /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id}Retrieve a visa of a document
CollaborationApiget_visa_commentGET /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment/{id}Retrieve a comment
CollaborationApiget_visa_commentsGET /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/commentList all comment of a visa
CollaborationApiget_visasGET /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visaList all visas of a document
CollaborationApiimport_from_projectPOST /cloud/{cloud_pk}/project/{id}/import_fromImport data from a project
CollaborationApiimport_manage_groupPOST /cloud/{cloud_pk}/project/{project_pk}/group/importImport a group from another project
CollaborationApiinvite_cloud_userPOST /cloud/{cloud_pk}/invitationInvite a cloud member
CollaborationApiinvite_project_userPOST /cloud/{cloud_pk}/project/{project_pk}/invitationInvite a project member
CollaborationApileave_projectPOST /cloud/{cloud_pk}/project/{id}/leaveLeave the project
CollaborationApileave_version_document_historyPOST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history/{id}/leaveLeave the history version
CollaborationApimake_head_version_document_historyPOST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history/{id}/head-versionMake the head of the version
CollaborationApipause_visaPOST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id}/pausePause a visa of a document
CollaborationApireset_validationPOST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id}/resetReset a validation
CollaborationApiresume_visaPOST /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id}/resumeResume a visa of a document
CollaborationApiupdate_classificationPATCH /cloud/{cloud_pk}/project/{project_pk}/classification/{id}Update some fields of a classification
CollaborationApiupdate_cloudPATCH /cloud/{id}Update some fields of a cloud
CollaborationApiupdate_cloud_userPATCH /cloud/{cloud_pk}/user/{id}Change the user role in the cloud
CollaborationApiupdate_documentPATCH /cloud/{cloud_pk}/project/{project_pk}/document/{id}Update some fields of the document
CollaborationApiupdate_folderPATCH /cloud/{cloud_pk}/project/{project_pk}/folder/{id}Update some fields of a folder
CollaborationApiupdate_group_folderPATCH /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.
CollaborationApiupdate_manage_groupPATCH /cloud/{cloud_pk}/project/{project_pk}/group/{id}Update some fields of a group
CollaborationApiupdate_preview_filePATCH /cloud/{cloud_pk}/project/{project_pk}/document/{id}/preview-fileUpdate preview of the document
CollaborationApiupdate_projectPATCH /cloud/{cloud_pk}/project/{id}Update some fields of a project
CollaborationApiupdate_project_userPATCH /cloud/{cloud_pk}/project/{project_pk}/user/{id}Change the user role in the cloud
CollaborationApiupdate_tagPATCH /cloud/{cloud_pk}/project/{project_pk}/tag/{id}Update some fields of the tag
CollaborationApiupdate_validationPATCH /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation/{id}Update the validator of validation
CollaborationApiupdate_visaPATCH /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{id}Update some fields of a visa
CollaborationApiupdate_visa_commentPATCH /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment/{id}Update some fields of a comment
ModelApiadd_model_errorsPOST /cloud/{cloud_pk}/project/{project_pk}/model/{id}/errorsAdd errors to model
ModelApiadd_zone_spacePOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/addAdd a space to a zone
ModelApibulk_delete_model_classificationsDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/list_destroyRemove all classifications from model's elements
ModelApibulk_delete_model_propertiesDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/bulk_destroyDelete many Property of a model
ModelApibulk_delete_model_property_definitionsDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/bulk_destroyDelete many PropertyDefinitions of a model
ModelApibulk_delete_model_unitsDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit/bulk_destroyDelete many Units of a model
ModelApibulk_delete_property_setDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/bulk_destroyDelete many PropertySet of a model
ModelApibulk_full_update_elementsPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/bulk_updateUpdate many elements at once (only changing fields may be defined)
ModelApibulk_full_update_model_propertyPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/bulk_updateUpdate some fields of many properties of a model
ModelApibulk_remove_classifications_of_elementDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/classification/bulk_destroyRemove many classifications from an element
ModelApibulk_remove_documents_of_elementDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/documents/bulk_destroyRemove many documents from an element
ModelApibulk_remove_elements_from_classificationDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/{model_classification_pk}/element/bulk_destroyRemove the classifications from all elements
ModelApibulk_update_elementsPUT /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/bulk_updateUpdate many elements at once (all field must be defined)
ModelApibulk_update_model_propertyPUT /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/bulk_updateUpdate all fields of many properties of a model
ModelApicreate_access_tokenPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_tokenCreate a token for this model
ModelApicreate_buildingPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/buildingCreate a building of a model
ModelApicreate_building_planPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/addCreate a relation between a 2d model and a building
ModelApicreate_classification_element_relationsPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification-elementCreate association between existing classification and existing element
ModelApicreate_classifications_of_elementPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/classificationCreate one or many classifications to an element
ModelApicreate_drawingPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawingCreate a drawing in the model
ModelApicreate_elementPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/elementCreate an element in the model
ModelApicreate_element_property_setPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertysetCreate a PropertySets to an element
ModelApicreate_element_property_set_propertyPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/propertyCreate a property to a PropertySet
ModelApicreate_element_property_set_property_definitionPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinitionCreate a Definition to a Property
ModelApicreate_element_property_set_property_definition_unitPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unitCreate a Unit to a Definition
ModelApicreate_layerPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layerCreate a layer in the model
ModelApicreate_meta_buildingPOST /cloud/{cloud_pk}/project/{project_pk}/model/create-metabuildingCreate an empty 3D Model
ModelApicreate_modelPOST /cloud/{cloud_pk}/project/{project_pk}/model/create-modelMake a PDF or Image file a Model
ModelApicreate_model_property_definitionPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinitionCreate a PropertyDefinition on the model
ModelApicreate_model_unitPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unitCreate a Unit on a model
ModelApicreate_multi_page_modelPOST /cloud/{cloud_pk}/project/{project_pk}/model/{id}/create-multipage-modelCreate a multi page model
ModelApicreate_photospherePOST /cloud/{cloud_pk}/project/{project_pk}/model/create-photosphereCreate a photopshere model from an image file
ModelApicreate_photosphere_buildingPOST /cloud/{cloud_pk}/project/{project_pk}/model/create-photosphere-buildingCreate an empty Photosphere Building Model
ModelApicreate_property_setPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertysetCreate one or many PropertySet
ModelApicreate_property_set_element_relationsPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset-elementCreate association between PropertySet and element
ModelApicreate_raw_elementsPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/rawCreate elements in an optimized format
ModelApicreate_spacePOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/spaceCreate a space in the model
ModelApicreate_storeyPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storeyCreate a storey of a model
ModelApicreate_storey_planPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/addCreate a relation between a 2d model and a storey
ModelApicreate_systemPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/systemCreate a system in the model
ModelApicreate_tilesetPOST /cloud/{cloud_pk}/project/{project_pk}/model/{id}/tilesetCreate the tileset of the model and upload all files
ModelApicreate_xkt_filePOST /cloud/{cloud_pk}/project/{project_pk}/model/{id}/xkt-fileCreate an xkt file for the model. Overrides existing file with same version
ModelApicreate_zonePOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zoneCreate a zone in the model
ModelApicreate_zone_spacePOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/spaceCreate a space in a zone
ModelApidelete_access_tokenDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token/{token}Delete a token
ModelApidelete_buildingDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{uuid}Delete a building of a model
ModelApidelete_building_planDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/{id}Delete the relation between a 2d model and a building
ModelApidelete_drawingDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing/{id}Delete a drawing of a model
ModelApidelete_elementDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid}Delete an element of a model
ModelApidelete_layerDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id}Delete a layer of a model
ModelApidelete_modelDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{id}Delete a model
ModelApidelete_model_propertyDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/{id}Delete a Property of a model
ModelApidelete_model_property_definitionDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/{id}Delete a PropertyDefinitions of a model
ModelApidelete_model_unitDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit/{id}Delete a Unit of a model
ModelApidelete_model_without_docDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{id}/delete-modelDelete the Model without deleting the related document
ModelApidelete_property_setDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/{id}Delete a PropertySet of a model
ModelApidelete_spaceDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space/{id}Delete a space
ModelApidelete_storeyDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{uuid}Delete a storey of a model
ModelApidelete_storey_planDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/{id}Delete the relation between a 2d model and a storey
ModelApidelete_systemDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system/{uuid}Delete a system of a model
ModelApidelete_zoneDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{id}Delete a zone of a model
ModelApidelete_zone_spaceDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/{id}Delete the relation between a space and a zone
ModelApiexport_ifcPOST /cloud/{cloud_pk}/project/{project_pk}/model/{id}/exportExport IFC
ModelApifull_update_elementPUT /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid}Update all fields of an element
ModelApiget_access_tokenGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token/{token}Retrieve one token created for this model
ModelApiget_access_tokensGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_tokenRetrieve all tokens created for this model
ModelApiget_buildingGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{uuid}Retrieve a building of a model
ModelApiget_building_plan_positioningGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/{id}/positioningRetrieve the postioning of the plan in the building
ModelApiget_buildingsGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/buildingRetrieve all buildings of a model
ModelApiget_classifications_of_elementGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/classificationRetrieve all classifications of an element
ModelApiget_documents_of_elementGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/documentsRetrieve all documents of an element
ModelApiget_drawingGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing/{id}Retrieve a drawing of a model
ModelApiget_drawingsGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawingRetrieve all drawings of a model
ModelApiget_elementGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid}Retrieve an element of a model
ModelApiget_element_linked_documentsGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/documentsRetrieve all documents linked to any element
ModelApiget_element_property_setGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{id}Retrieve a PropertySet of an element
ModelApiget_element_property_set_propertiesGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/propertyRetrieve all Properties of a PropertySet
ModelApiget_element_property_set_propertyGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id}Retrieve a Property of a PropertySet
ModelApiget_element_property_set_property_definitionGET /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
ModelApiget_element_property_set_property_definition_unitGET /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
ModelApiget_element_property_set_property_definition_unitsGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unitRetrieve all Units of a Definition
ModelApiget_element_property_set_property_definitionsGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinitionRetrieve all Definitions of a PropertySet
ModelApiget_element_property_setsGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertysetRetrieve all PropertySets of an element
ModelApiget_elementsGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/elementRetrieve all elements of a model
ModelApiget_elements_from_classificationGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/{model_classification_pk}/elementRetrieve all elements with the classification
ModelApiget_layerGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id}Retrieve a layer of a model
ModelApiget_layersGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layerRetrieve all layers of a model
ModelApiget_materialGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/material/{id}Retrieve a material of a model
ModelApiget_materialsGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/materialRetrieve all materials of a model
ModelApiget_modelGET /cloud/{cloud_pk}/project/{project_pk}/model/{id}Retrieve one model
ModelApiget_model_classificationsGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classificationRetrieve all classifications in a model
ModelApiget_model_materialGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/material/{id}Retrieve a material of a model
ModelApiget_model_materialsGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/materialRetrieve all materials of a model
ModelApiget_model_propertiesGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyRetrieve all Properties of a model
ModelApiget_model_propertyGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/{id}Retrieve a Property of a model
ModelApiget_model_property_definitionGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/{id}Retrieve a PropertyDefinition of a model
ModelApiget_model_property_definitionsGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinitionRetrieve all PropertyDefinitions of a model
ModelApiget_model_unitGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit/{id}Retrieve a Unit of a model
ModelApiget_model_unitsGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unitRetrieve all Units of a model
ModelApiget_modelsGET /cloud/{cloud_pk}/project/{project_pk}/modelRetrieve all models
ModelApiget_processor_handlerGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/processorhandler/{id}Retrieve a processor handler
ModelApiget_processor_handlersGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/processorhandlerGet all processor handlers
ModelApiget_property_setGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/{id}Retrieve a PropertySet of a model
ModelApiget_property_setsGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertysetRetrieve all PropertySets of a model
ModelApiget_raw_elementsGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/rawRetrieve all elements in a optimized format
ModelApiget_simple_elementGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid}/simpleRetrieve an element of a model with a simple value representation
ModelApiget_simple_elementsGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/simpleRetrieve all elements of a model with a simple value representation
ModelApiget_spaceGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space/{id}Retrieve one space of the model
ModelApiget_spacesGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/spaceRetrieve all spaces of the model
ModelApiget_storeyGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{uuid}Retrieve a storey of a model
ModelApiget_storey_plan_positioningGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/{id}/positioningRetrieve the postioning of the plan in the storey
ModelApiget_storeysGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storeyRetrieve all storeys of a model
ModelApiget_systemGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system/{uuid}Retrieve a system of a model
ModelApiget_systemsGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/systemRetrieve all systems of a model
ModelApiget_tilesetGET /cloud/{cloud_pk}/project/{project_pk}/model/{id}/tilesetRetrieve the tileset of the model
ModelApiget_zoneGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{id}Retrieve one zone of a model
ModelApiget_zone_spaceGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/{id}Retrieve one space of a zone
ModelApiget_zone_spacesGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/spaceRetrieve all spaces of a zone
ModelApiget_zonesGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zoneRetrieve zones of a model
ModelApilink_documents_of_elementPOST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/documentsLink one or many documents to an element
ModelApilist_classification_element_relationsGET /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification-elementList all associations between classifications and elements
ModelApimerge_ifcsPOST /cloud/{cloud_pk}/project/{project_pk}/model/mergeMerge IFC files
ModelApioptimize_ifcPOST /cloud/{cloud_pk}/project/{project_pk}/model/{id}/optimizeOptimize the IFC
ModelApiremove_all_element_property_setDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/allRemove all property sets from element
ModelApiremove_classification_of_elementDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/classification/{id}Remove a classification from an element
ModelApiremove_document_of_elementDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/documents/{id}Remove a documents from an element
ModelApiremove_element_property_setDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{id}Remove a PropertySet from an element
ModelApiremove_element_property_set_propertyDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id}Remove a property from a PropertySet
ModelApiremove_element_property_set_property_definitionDELETE /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
ModelApiremove_element_property_set_property_definition_unitDELETE /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
ModelApiremove_elements_from_classificationDELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/classification/{model_classification_pk}/element/{uuid}Remove the classification from all elements
ModelApireprocess_modelPOST /cloud/{cloud_pk}/project/{project_pk}/model/{id}/reprocessReprocess Model file
ModelApiupdate_access_tokenPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/access_token/{token}Update some fields of a token
ModelApiupdate_buildingPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{uuid}Update some fields of a building
ModelApiupdate_building_plan_positioningPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/{id}/positioningUpdate the postioning of the plan in the building
ModelApiupdate_drawingPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/drawing/{id}Update some fields of a drawing
ModelApiupdate_elementPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{uuid}Update some fields of an element
ModelApiupdate_element_property_set_propertyPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id}Update a property from an element
ModelApiupdate_layerPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id}Update some fields of a layer
ModelApiupdate_modelPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{id}Update some fields of a model
ModelApiupdate_model_filesPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{id}/filesUpdate models file (gltf, svg, structure, etc)
ModelApiupdate_model_propertyPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/property/{id}Update some fields of a Property
ModelApiupdate_model_property_definitionPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertydefinition/{id}Update some fields of many PropertyDefinitions of a model
ModelApiupdate_model_unitPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/unit/{id}Update some fields of a Unit of a model
ModelApiupdate_order_building_planPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/building/{building_uuid}/plan/orderUpdate order of all plan of a building
ModelApiupdate_order_storey_planPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/orderUpdate order of all plan of a storey
ModelApiupdate_order_storeysPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/orderUpdate order of all storey of a model
ModelApiupdate_processor_handlerPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/processorhandler/{id}Update the status of a processor handler
ModelApiupdate_property_setPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/propertyset/{id}Update some fields of a PropertySet
ModelApiupdate_spacePATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/space/{id}Update some fields of a space
ModelApiupdate_storeyPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{uuid}Update some fields of a storey
ModelApiupdate_storey_plan_positioningPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/storey/{storey_uuid}/plan/{id}/positioningUpdate the postioning of the plan in the storey
ModelApiupdate_systemPATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/system/{uuid}Update some fields of a system
ModelApiupdate_zonePATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{id}Update some fields of a zone
ModelApiupdate_zone_spacePATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/zone/{zone_pk}/space/{id}Update some fields of a space
SsoApiaccept_invitationPOST /identity-provider/invitation/{id}/acceptAccept an invitation
SsoApicreate_userPOST /identity-provider/userCreate a user
SsoApidelete_userDELETE /identity-provider/userDelete user from BIMData
SsoApideny_invitationPOST /identity-provider/invitation/{id}/denyDeny an invitation
SsoApiget_invitationGET /identity-provider/invitation/{id}Retrieve an invitation
SsoApiget_invitationsGET /identity-provider/invitationRetrieve all invitations
WebhookApicreate_web_hookPOST /cloud/{cloud_pk}/webhookCreate a new Webhook
WebhookApidelete_web_hookDELETE /cloud/{cloud_pk}/webhook/{id}Delete a webhook
WebhookApiget_web_hookGET /cloud/{cloud_pk}/webhook/{id}Retrieve one configured webhook
WebhookApiget_web_hooksGET /cloud/{cloud_pk}/webhookRetrieve all configured webhooks
WebhookApiping_web_hookPOST /cloud/{cloud_pk}/webhook/{id}/pingTest a webhook
WebhookApiupdate_web_hookPATCH /cloud/{cloud_pk}/webhook/{id}Update some field of a webhook

Documentation For Models

Documentation For Authorization

ApiKey

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

BIMData_Connect

BIMData_Connect

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

support@bimdata.io

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in bimdata_api_client.apis and bimdata_api_client.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from bimdata_api_client.api.default_api import DefaultApi
  • from bimdata_api_client.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import bimdata_api_client
from bimdata_api_client.apis import *
from bimdata_api_client.models import *

Keywords

FAQs

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

Data Theft Repackaged: A Case Study in Malicious Wrapper Packages on npm

Security News

Research

Data Theft Repackaged: A Case Study in Malicious Wrapper Packages on npm

The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.

By Kush Pandya  -  Dec 11, 2024
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc