Package Health Score

55 / 100

security
Security review needed
popularity
Small
maintenance
Healthy
community
Limited

Explore Similar Packages

dynamo
42

Popularity

Small

GitHub Stars: 0
Forks: 4
Contributors: 4

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package bimdata-api-client, we found that it has been starred ? times.

Security

Security review needed

Security and license risk for latest version

Release Date: Jun 20, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
1
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Unknown

Unable to detect license

We couldn’t find an appropriate license for this project. It is highly advised to make sure the project license is compatible with your business needs before including it as a dependency, to keep yourself protected from infringement suits or loss of your own code.

Security Policy

We found a way for you to contribute to the project! Looks like bimdata-api-client is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 4 days ago
Last Commit: 25 days ago

Further analysis of the maintenance status of bimdata-api-client based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that bimdata-api-client demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Limited

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 4
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like bimdata-api-client is missing a Code of Conduct.

How about a good first contribution to this project? It seems that bimdata-api-client is missing a LICENSE file.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: Unspecified

Age: 6 years
Latest Release: 4 days ago
Dependencies: N/A
Versions: 213
Maintainers: 1
Wheels: No

Readme

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

Class	Method	HTTP request	Description
BcfApi	create_comment	POST /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments	Create a comment
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	Export project's topics in bcf-xml format
BcfApi	download_bcf_export_xlsx	GET /bcf/2.1/projects/{id}/export-xlsx	Export project's topics in excel format
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_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_detailed_extensions	GET /bcf/2.1/projects/{id}/detailed-extensions	Retrieve project detailed extensions
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_document_references	GET /bcf/2.1/projects/{projects_pk}/topics/{guid}/document_references	Get all related documents
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_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	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_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_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_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_user	GET /cloud/{cloud_pk}/user/{id}	Retrieve a user in a 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_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_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_sub_tree	GET /cloud/{cloud_pk}/project/subtree	Retrieve the complete projects tree of the cloud
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	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_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_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_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_layer	POST /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer	Create a layer in 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_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_layer	DELETE /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id}	Delete a layer of a 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_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_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_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_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_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	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_layer	PATCH /cloud/{cloud_pk}/project/{project_pk}/model/{model_pk}/layer/{id}	Update some fields of a layer
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_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_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_web_hook	POST /cloud/{cloud_pk}/webhook	Create a new Webhook
WebhookApi	delete_web_hook	DELETE /cloud/{cloud_pk}/webhook/{id}	Delete a webhook
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_web_hook	POST /cloud/{cloud_pk}/webhook/{id}/ping	Test a webhook
WebhookApi	update_web_hook	PATCH /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

Type: OAuth
Flow: implicit
Authorization URL: http://fakeurl.bimdata.example/realms/bimdata/protocol/openid-connect/auth
Scopes: N/A

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 *

FAQs

What is bimdata-api-client?

BIMData API. Visit Snyk Advisor to see a full health score report for bimdata-api-client, including popularity, security, maintenance & community analysis.

Is bimdata-api-client popular?

The python package bimdata-api-client receives a total of 3,045 weekly downloads. As such, bimdata-api-client popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is bimdata-api-client well maintained?

We found that bimdata-api-client demonstrated a healthy version release cadence and project activity. It has a community of 4 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is bimdata-api-client safe to use?

While scanning the latest version of bimdata-api-client, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 22 June-2024, at 15:53 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

bimdata-api-client

Requirements.

Installation & Usage

pip install

Setuptools

Getting Started

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

ApiKey

BIMData_Connect

BIMData_Connect

Bearer

Author

Notes for Large OpenAPI documents

FAQs

What is bimdata-api-client?

Is bimdata-api-client popular?

Is bimdata-api-client well maintained?

Is bimdata-api-client safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues