GitHub - bimdata/python-api-client at a48e7b5f7de673d8249e1b9fd0b2327396dcd292 · GitHub
Skip to content

bimdata/python-api-client

BranchesTags

Repository files navigation

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
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

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:

from __future__ import print_function
import time
import bimdata_api_client
from bimdata_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
configuration = bimdata_api_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = bimdata_api_client.ApplicationApi(bimdata_api_client.ApiClient(configuration))
cloud_pk = 'cloud_pk_example' # str | 
web_hook = bimdata_api_client.WebHook() # WebHook | 

try:
    # Create a new Webhook
    api_response = api_instance.create_web_hook(cloud_pk, web_hook)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationApi->create_web_hook: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api-beta.bimdata.io

Class Method HTTP request Description
ApplicationApi create_web_hook POST /cloud/{cloud_pk}/webhook Create a new Webhook
ApplicationApi delete_web_hook DELETE /cloud/{cloud_pk}/webhook/{id} Delete a webhook
ApplicationApi full_update_web_hook PUT /cloud/{cloud_pk}/webhook/{id} Update all field of a webhook
ApplicationApi get_web_hook GET /cloud/{cloud_pk}/webhook/{id} Retrieve one configured webhook
ApplicationApi get_web_hooks GET /cloud/{cloud_pk}/webhook Retrieve all configured webhooks
ApplicationApi ping_web_hook POST /cloud/{cloud_pk}/webhook/{id}/ping Test a webhook
ApplicationApi update_web_hook PATCH /cloud/{cloud_pk}/webhook/{id} Update some field of a webhook
BcfApi create_comment POST /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments Create a comment
BcfApi create_full_topic POST /bcf/2.1/projects/{projects_pk}/full-topic Create a Topic with viewpoints and comments
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_pk}/viewpoints Create a Viewpoint
BcfApi delete_comment DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/{guid} Delete a comment
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_pk}/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 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_pk}/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_topic PUT /bcf/2.1/projects/{projects_pk}/topics/{guid} Update all fields of a topic
BcfApi full_update_viewpoint PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{guid} Update all fields of a Viewpoint
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_pk}/viewpoints/{viewpoints_pk}/coloring Retrieve all colorings of a viewpoint
BcfApi get_comment GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/{guid} Retrieve a comment
BcfApi get_comments GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments Retrieve all comments
BcfApi get_extensions GET /bcf/2.1/projects/{projects_pk}/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_selections GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/selection Retrieve all selections of a viewpoint
BcfApi get_snapshot GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/snapshot Retrieve the viewpoint' snapshot
BcfApi get_topic GET /bcf/2.1/projects/{projects_pk}/topics/{guid} Retrieve a topic
BcfApi get_topic_viewpoints GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/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_viewpoint GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{guid} Retrieve a Viewpoint
BcfApi get_viewpoints GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints Retrieve all Viewpoints of a topic
BcfApi get_visibilities GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/visibility Retrieve all visibilities of a viewpoint
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_pk}/comments/{guid} Update some fields of a comment
BcfApi update_extensions PATCH /bcf/2.1/projects/{projects_pk}/extensions Update project extensions
BcfApi update_full_topic PATCH /bcf/2.1/projects/{projects_pk}/full-topic/{guid} Update some fields of a topic
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_pk}/viewpoints/{guid} Update some fields of a Viewpoint
CheckplanApi create_checker POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker Create a checker to a model
CheckplanApi create_checker_result POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result Create a CheckerResult
CheckplanApi create_checkplan POST /cloud/{cloud_pk}/project/{project_pk}/checkplan Create a Checkplan
CheckplanApi create_rule POST /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule Create a Rule
CheckplanApi create_rule_component POST /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent Create a RuleComponent
CheckplanApi create_ruleset POST /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset Create a Ruleset
CheckplanApi delete_checker DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id} Delete a checker of a model
CheckplanApi delete_checker_result DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id} Delete a CheckerResult
CheckplanApi delete_checkplan DELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id} Delete a Checkplan
CheckplanApi delete_rule DELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id} Delete a Rule
CheckplanApi delete_rule_component DELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id} Delete a RuleComponent
CheckplanApi delete_ruleset DELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id} Delete a Ruleset
CheckplanApi full_update_checker PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id} Update all fields of a checker of a model
CheckplanApi full_update_checker_result PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id} Update all fields of a CheckerResult
CheckplanApi full_update_checkplan PUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id} Update all fields of a Checkplan
CheckplanApi full_update_rule PUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id} Update all fields of a Rule
CheckplanApi full_update_rule_component PUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id} Update all fields of a RuleComponent
CheckplanApi full_update_ruleset PUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id} Update all fields of a Ruleset
CheckplanApi get_checker GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id} Retrieve a checker of a model
CheckplanApi get_checker_result GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id} Retrieve one CheckerResult
CheckplanApi get_checker_results GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result Retrieve all CheckerResults
CheckplanApi get_checkers GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker Retrieve all checkers of a model
CheckplanApi get_checkplan GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id} Retrieve one Checkplan
CheckplanApi get_checkplans GET /cloud/{cloud_pk}/project/{project_pk}/checkplan Retrieve all Checkplans
CheckplanApi get_rule GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id} Retrieve one Rule
CheckplanApi get_rule_component GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id} Retrieve one RuleComponent
CheckplanApi get_rule_components GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent Retrieve all RuleComponents
CheckplanApi get_rules GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule Retrieve all Rules
CheckplanApi get_ruleset GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id} Retrieve one Ruleset
CheckplanApi get_rulesets GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset Retrieve all Rulesets
CheckplanApi launch_new_check POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id}/launch-check Launch a new check on the model
CheckplanApi update_checker PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id} Update some fields of a checker of a model
CheckplanApi update_checker_result PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id} Update some fields of a CheckerResult
CheckplanApi update_checkplan PATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id} Update some fields of a Checkplan
CheckplanApi update_rule PATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id} Update some fields of a Rule
CheckplanApi update_rule_component PATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id} Update some fields of a RuleComponent
CheckplanApi update_ruleset PATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id} Update some fields of a Ruleset
CloudApi cancel_cloud_user_invitation DELETE /cloud/{cloud_pk}/invitation/{id} Cancel a pending invitation
CloudApi create_cloud POST /cloud Create a cloud
CloudApi create_demo POST /cloud/{id}/create-demo Create a Demo project in a cloud
CloudApi delete_cloud DELETE /cloud/{id} Delete a cloud
CloudApi delete_cloud_user DELETE /cloud/{cloud_pk}/user/{id} Remove a user from a cloud
CloudApi full_update_cloud PUT /cloud/{id} Update all fields of a cloud
CloudApi full_update_cloud_user PUT /cloud/{cloud_pk}/user/{id} Update all fields of a cloud user
CloudApi get_cloud GET /cloud/{id} Retrieve one cloud
CloudApi get_cloud_invitations GET /cloud/{cloud_pk}/invitation Retrieve all pending invitations in the cloud
CloudApi get_cloud_size GET /cloud/{id}/size Get size of all files in the cloud
CloudApi get_cloud_user GET /cloud/{cloud_pk}/user/{id} Retrieve a user in a cloud
CloudApi get_cloud_users GET /cloud/{cloud_pk}/user Retrieve all users in a cloud
CloudApi get_clouds GET /cloud Retrieve all clouds
CloudApi invite_cloud_user POST /cloud/{cloud_pk}/invitation Invite a cloud administrator
CloudApi update_cloud PATCH /cloud/{id} Update some fields of a cloud
CloudApi update_cloud_user PATCH /cloud/{cloud_pk}/user/{id} Update some fields of a cloud user
IfcApi bulk_delete_ifc_classifications DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/list_destroy Remove all classifications from model's elements
IfcApi bulk_delete_ifc_properties DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/bulk_destroy Delete many Property of a model
IfcApi bulk_delete_ifc_property_definitions DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/bulk_destroy Delete many PropertyDefinitions of a model
IfcApi bulk_delete_ifc_units DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/bulk_destroy Delete many Units of a model
IfcApi bulk_delete_property_set DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/bulk_destroy Delete many PropertySet of a model
IfcApi bulk_full_update_elements PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/bulk_update Update many elements at once (only changing fields may be defined)
IfcApi bulk_full_update_ifc_property PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/bulk_update Update some fields of many properties of a model
IfcApi bulk_remove_classifications_of_element DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/classification/bulk_destroy Remove many classifications from an element
IfcApi bulk_remove_elements_from_classification DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/{ifc_classification_pk}/element/bulk_destroy Remove the classifications from all elements
IfcApi bulk_update_elements PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/bulk_update Update many elements at once (all field must be defined)
IfcApi bulk_update_ifc_property PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/bulk_update Update all fields of many properties of a model
IfcApi create_classification_element_relations POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification-element Create association between existing classification and existing element
IfcApi create_classifications_of_element POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/classification Create one or many classifications to an element
IfcApi create_element POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element Create an element in the model
IfcApi create_element_property_set POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset Create a PropertySets to an element
IfcApi create_element_property_set_property POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property Create a property to a PropertySet
IfcApi create_element_property_set_property_definition POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition Create a Definition to a Property
IfcApi create_element_property_set_property_definition_unit POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit Create a Unit to a Definition
IfcApi create_ifc_property_definition POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition Create a PropertyDefinition on the model
IfcApi create_ifc_unit POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit Create a Unit on a model
IfcApi create_property_set POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset Create a PropertySet
IfcApi create_property_set_element_relations POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset-element Create association between PropertySet and element
IfcApi create_raw_elements POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/raw Create elements in an optimized format
IfcApi create_space POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space Create a space in the model
IfcApi create_zone POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone Create a zone in the model
IfcApi create_zone_space POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space Create a space in a zone
IfcApi delete_element DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid} Delete a zone of a model
IfcApi delete_ifc DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{id} Delete a model
IfcApi delete_ifc_property DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id} Delete a Property of a model
IfcApi delete_ifc_property_definition DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id} Delete a PropertyDefinitions of a model
IfcApi delete_ifc_unit DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/{id} Delete a Unit of a model
IfcApi delete_property_set DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/{id} Delete a PropertySet of a model
IfcApi delete_space DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space/{id} Delete a space
IfcApi delete_zone DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id} Delete a zone of a model
IfcApi delete_zone_space DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id} Delete a space of a zone
IfcApi full_update_element PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid} Update all fields of an element
IfcApi full_update_ifc PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{id} Update all fields of a model
IfcApi full_update_ifc_property PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id} Update some fields of a Property
IfcApi full_update_ifc_property_definition PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id} Update all fields of many PropertyDefinitions of a model
IfcApi full_update_ifc_unit PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/{id} Update all fields of a Unit of a model
IfcApi full_update_property_set PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/{id} Update all fields of a PropertySet
IfcApi full_update_space PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space/{id} Update all fields of a space
IfcApi full_update_zone PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id} Update all fields of a zone
IfcApi full_update_zone_space PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id} Update all fields of a space
IfcApi get_classifications_of_element GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/classification Retrieve all classifications of an element
IfcApi get_element GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid} Retrieve an element of a model
IfcApi get_element_property_set GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{id} Retrieve a PropertySet of an element
IfcApi get_element_property_set_properties GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property Retrieve all Properties of a PropertySet
IfcApi get_element_property_set_property GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} Retrieve a Property of a PropertySet
IfcApi get_element_property_set_property_definition GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{id} Retrieve a Definition of a Property
IfcApi get_element_property_set_property_definition_unit GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit/{id} Retrieve a Unit of a Definition
IfcApi get_element_property_set_property_definition_units GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit Retrieve all Units of a Definition
IfcApi get_element_property_set_property_definitions GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition Retrieve all Definitions of a PropertySet
IfcApi get_element_property_sets GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset Retrieve all PropertySets of an element
IfcApi get_elements GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element Retrieve all elements of a model
IfcApi get_elements_from_classification GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/{ifc_classification_pk}/element Retrieve all elements with the classification
IfcApi get_ifc GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id} Retrieve one model
IfcApi get_ifc_bvh GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/map Get svg file
IfcApi get_ifc_classifications GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification Retrieve all classifications in a model
IfcApi get_ifc_gltf GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/gltf Get gltf file
IfcApi get_ifc_map GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/bvh Get bvh file
IfcApi get_ifc_properties GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property Retrieve all Properties of a model
IfcApi get_ifc_property GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id} Retrieve a Property of a model
IfcApi get_ifc_property_definition GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id} Retrieve a PropertyDefinition of a model
IfcApi get_ifc_property_definitions GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition Retrieve all PropertyDefinitions of a model
IfcApi get_ifc_structure GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/structure Get structure file
IfcApi get_ifc_systems GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/systems Get systems file
IfcApi get_ifc_unit GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/{id} Retrieve a Unit of a model
IfcApi get_ifc_units GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit Retrieve all Units of a model
IfcApi get_ifcs GET /cloud/{cloud_pk}/project/{project_pk}/ifc Retrieve all models
IfcApi get_property_set GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/{id} Retrieve a PropertySet of a model
IfcApi get_property_sets GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset Retrieve all PropertySets of a model
IfcApi get_raw_elements GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/raw Retrieve all elements in a optimized format
IfcApi get_space GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space/{id} Retrieve one space of the model
IfcApi get_spaces GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space Retrieve all spaces of the model
IfcApi get_zone GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id} Retrieve one zone of a model
IfcApi get_zone_space GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id} Retrieve one space of a zone
IfcApi get_zone_spaces GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space Retrieve all spaces of a zone
IfcApi get_zones GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone Retrieve all zones of a model
IfcApi list_classification_element_relations GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification-element List all associations between classifications and elements
IfcApi remove_classification_of_element DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/classification/{id} Remove a classification from an element
IfcApi remove_element_property_set DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{id} Remove a PropertySet from an element
IfcApi remove_element_property_set_property DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} Remove a property from a PropertySet
IfcApi remove_element_property_set_property_definition DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{id} Remove a Definition from a Property
IfcApi remove_element_property_set_property_definition_unit DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unit/{id} Remove a Unit from a Definition
IfcApi remove_elements_from_classification DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/{ifc_classification_pk}/element/{uuid} Remove the classification from all elements
IfcApi update_element PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid} Update some fields of a zone
IfcApi update_ifc PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{id} Update some fields of a model
IfcApi update_ifc_files PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/files Update models file (gltf, svg, structure, etc)
IfcApi update_ifc_property PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id} Update some fields of a Property
IfcApi update_ifc_property_definition PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id} Update some fields of many PropertyDefinitions of a model
IfcApi update_ifc_unit PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/{id} Update some fields of a Unit of a model
IfcApi update_property_set PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/{id} Update some fields of a PropertySet
IfcApi update_space PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space/{id} Update some fields of a space
IfcApi update_zone PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id} Update some fields of a zone
IfcApi update_zone_space PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id} Update some fields of a space
ProjectApi cancel_project_user_invitation DELETE /cloud/{cloud_pk}/project/{project_pk}/invitation/{id} Cancel a pending invitation
ProjectApi create_classification POST /cloud/{cloud_pk}/project/{project_pk}/classification Create a classification
ProjectApi create_classification_0 POST /cloud/{cloud_pk}/project/{project_pk}/document Create a classification
ProjectApi create_folder POST /cloud/{cloud_pk}/project/{project_pk}/folder Create a folder
ProjectApi create_project POST /cloud/{cloud_pk}/project Create a project
ProjectApi delete_classification DELETE /cloud/{cloud_pk}/project/{project_pk}/classification/{id} Delete a classification
ProjectApi delete_classification_0 DELETE /cloud/{cloud_pk}/project/{project_pk}/document/{id} Delete a classification
ProjectApi delete_folder DELETE /cloud/{cloud_pk}/project/{project_pk}/folder/{id} Delete a folder
ProjectApi delete_project DELETE /cloud/{cloud_pk}/project/{id} Delete a project
ProjectApi delete_project_user DELETE /cloud/{cloud_pk}/project/{project_pk}/user/{id} Remove a user from a project
ProjectApi full_update_classification PUT /cloud/{cloud_pk}/project/{project_pk}/classification/{id} Update all fields of a classification
ProjectApi full_update_classification_0 PUT /cloud/{cloud_pk}/project/{project_pk}/document/{id} Update all fields of a classification
ProjectApi full_update_folder PUT /cloud/{cloud_pk}/project/{project_pk}/folder/{id} Update all fields of a folder
ProjectApi full_update_project PUT /cloud/{cloud_pk}/project/{id} Update all fields of a project
ProjectApi full_update_project_user PUT /cloud/{cloud_pk}/project/{project_pk}/user/{id} Update all fields of a project user
ProjectApi get_classification GET /cloud/{cloud_pk}/project/{project_pk}/classification/{id} Retrieve a classification
ProjectApi get_classification_0 GET /cloud/{cloud_pk}/project/{project_pk}/document/{id} Retrieve a classification
ProjectApi get_classifications GET /cloud/{cloud_pk}/project/{project_pk}/classification Retrieve all classifications
ProjectApi get_classifications_0 GET /cloud/{cloud_pk}/project/{project_pk}/document Retrieve all classifications
ProjectApi get_folder GET /cloud/{cloud_pk}/project/{project_pk}/folder/{id} Retrieve a folder
ProjectApi get_folders GET /cloud/{cloud_pk}/project/{project_pk}/folder Retrieve all folders
ProjectApi get_project GET /cloud/{cloud_pk}/project/{id} Retrieve a project
ProjectApi get_project_invitations GET /cloud/{cloud_pk}/project/{project_pk}/invitation Retrieve all pending invitations in the project
ProjectApi get_project_tree GET /cloud/{cloud_pk}/project/{id}/tree Retrieve the complete DMS tree
ProjectApi get_project_user GET /cloud/{cloud_pk}/project/{project_pk}/user/{id} Retrieve a user in a project
ProjectApi get_project_users GET /cloud/{cloud_pk}/project/{project_pk}/user Retrieve all users in a project
ProjectApi get_projects GET /cloud/{cloud_pk}/project Retrieve all projects
ProjectApi invite_project_user POST /cloud/{cloud_pk}/project/{project_pk}/invitation Invite a project member
ProjectApi update_classification PATCH /cloud/{cloud_pk}/project/{project_pk}/classification/{id} Update some fields of a classification
ProjectApi update_classification_0 PATCH /cloud/{cloud_pk}/project/{project_pk}/document/{id} Update some fields of a classification
ProjectApi update_folder PATCH /cloud/{cloud_pk}/project/{project_pk}/folder/{id} Update some fields of a folder
ProjectApi update_project PATCH /cloud/{cloud_pk}/project/{id} Update some fields of a project
ProjectApi update_project_user PATCH /cloud/{cloud_pk}/project/{project_pk}/user/{id} Update some fields of a project user
UserApi get_self_user GET /user
UserApi update_self_user PATCH /user
UserApi user_projects_list GET /user/projects

Documentation For Models

Documentation For Authorization

Bearer

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

Author

contact@bimdata.io

About

BIMData.io api client in python

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

4 forks
Report repository

Releases 183

v10.37.2 Latest
Jul 2, 2026
+ 182 releases

Packages

 
 
 

Contributors

Languages