alblez/bimdata-php-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

Maintainers

Package info

github.com/alblez/bimdata-php-api-client

pkg:composer/alblez/bimdata-php-api-client

Statistics

Installs: 1 324

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

dev-main 2021-10-25 03:34 UTC

This package is auto-updated.

Last update: 2026-02-25 12:49:48 UTC


README

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.

Installation & Usage

Requirements

PHP 7.4 or PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\BcfApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$projects_pk = 'projects_pk_example'; // string
$topics_guid = 'topics_guid_example'; // string
$data = new \OpenAPI\Client\Model\Comment(); // \OpenAPI\Client\Model\Comment

try {
    $result = $apiInstance->createComment($projects_pk, $topics_guid, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BcfApi->createComment: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

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

Class Method HTTP request Description
BcfApi createComment POST /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments Create a comment
BcfApi createFullTopic POST /bcf/2.1/projects/{projects_pk}/full-topic Create a Topic with viewpoints and comments
BcfApi createTopic POST /bcf/2.1/projects/{projects_pk}/topics Create a topic
BcfApi createViewpoint POST /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints Create a Viewpoint
BcfApi deleteComment DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} Delete a comment
BcfApi deleteTopic DELETE /bcf/2.1/projects/{projects_pk}/topics/{guid} Delete a topic
BcfApi deleteViewpoint DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} Delete a Viewpoint
BcfApi downloadBcfExport GET /bcf/2.1/projects/{id}/export Export project's topics in bcf-xml format
BcfApi fullUpdateBcfProject PUT /bcf/2.1/projects/{id} Update all fields of a BCF project
BcfApi fullUpdateComment PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} Update all fields of a comment
BcfApi fullUpdateFullTopic PUT /bcf/2.1/projects/{projects_pk}/full-topic/{guid} Update all fields of a topic
BcfApi fullUpdateTopic PUT /bcf/2.1/projects/{projects_pk}/topics/{guid} Update all fields of a topic
BcfApi fullUpdateViewpoint PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} Update all fields of a Viewpoint
BcfApi getBcfProject GET /bcf/2.1/projects/{id} Retrieve a BCF project
BcfApi getBcfProjects GET /bcf/2.1/projects Retrieve all BCF projects
BcfApi getColorings GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/coloring Retrieve all colorings of a viewpoint
BcfApi getComment GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} Retrieve a comment
BcfApi getComments GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments Retrieve all comments
BcfApi getExtensions GET /bcf/2.1/projects/{projects_pk}/extensions Retrieve project extensions
BcfApi getFullTopic GET /bcf/2.1/projects/{projects_pk}/full-topic/{guid} Retrieve a full topic
BcfApi getFullTopics GET /bcf/2.1/projects/{projects_pk}/full-topic Retrieve all full topics
BcfApi getSelections GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/selection Retrieve all selections of a viewpoint
BcfApi getSnapshot GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/snapshot Retrieve the viewpoint' snapshot
BcfApi getTopic GET /bcf/2.1/projects/{projects_pk}/topics/{guid} Retrieve a topic
BcfApi getTopicViewpoints GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/topic-viewpoints Retrieve all viewpoints attached to the topic
BcfApi getTopics GET /bcf/2.1/projects/{projects_pk}/topics Retrieve all topics
BcfApi getUser GET /bcf/2.1/current-user Get current user info
BcfApi getViewpoint GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} Retrieve a Viewpoint
BcfApi getViewpoints GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints Retrieve all Viewpoints of a topic
BcfApi getVisibilities GET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/visibility Retrieve all visibilities of a viewpoint
BcfApi importBcf POST /bcf/2.1/projects/{id}/import Import bcf-xml format into this project
BcfApi updateBcfProject PATCH /bcf/2.1/projects/{id} Update some fields of a BCF project
BcfApi updateComment PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} Update some fields of a comment
BcfApi updateExtensions PATCH /bcf/2.1/projects/{projects_pk}/extensions Update project extensions
BcfApi updateFullTopic PATCH /bcf/2.1/projects/{projects_pk}/full-topic/{guid} Update some fields of a topic
BcfApi updateTopic PATCH /bcf/2.1/projects/{projects_pk}/topics/{guid} Update some fields of a topic
BcfApi updateViewpoint PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} Update some fields of a Viewpoint
CheckerApi createChecker POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker Create a checker to a model
CheckerApi createCheckerResult POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result Create a CheckerResult
CheckerApi createCheckplan POST /cloud/{cloud_pk}/project/{project_pk}/checkplan Create a Checkplan
CheckerApi createRule POST /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule Create a Rule
CheckerApi createRuleComponent POST /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent Create a RuleComponent
CheckerApi createRuleset POST /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset Create a Ruleset
CheckerApi deleteChecker DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id} Delete a checker of a model
CheckerApi deleteCheckerResult DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id} Delete a CheckerResult
CheckerApi deleteCheckplan DELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id} Delete a Checkplan
CheckerApi deleteRule DELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id} Delete a Rule
CheckerApi deleteRuleComponent DELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id} Delete a RuleComponent
CheckerApi deleteRuleset DELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id} Delete a Ruleset
CheckerApi fullUpdateChecker PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id} Update all fields of a checker of a model
CheckerApi fullUpdateCheckerResult PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id} Update all fields of a CheckerResult
CheckerApi fullUpdateCheckplan PUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id} Update all fields of a Checkplan
CheckerApi fullUpdateRule PUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id} Update all fields of a Rule
CheckerApi fullUpdateRuleComponent 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
CheckerApi fullUpdateRuleset PUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id} Update all fields of a Ruleset
CheckerApi getChecker GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id} Retrieve a checker of a model
CheckerApi getCheckerResult GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id} Retrieve one CheckerResult
CheckerApi getCheckerResults GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result Retrieve all CheckerResults
CheckerApi getCheckers GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker Retrieve all checkers of a model
CheckerApi getCheckplan GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id} Retrieve one Checkplan
CheckerApi getCheckplans GET /cloud/{cloud_pk}/project/{project_pk}/checkplan Retrieve all Checkplans
CheckerApi getRule GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id} Retrieve one Rule
CheckerApi getRuleComponent GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id} Retrieve one RuleComponent
CheckerApi getRuleComponents GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent Retrieve all RuleComponents
CheckerApi getRules GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule Retrieve all Rules
CheckerApi getRuleset GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id} Retrieve one Ruleset
CheckerApi getRulesets GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset Retrieve all Rulesets
CheckerApi launchNewCheck POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id}/launch-check Launch a new check on the model
CheckerApi updateChecker PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id} Update some fields of a checker of a model
CheckerApi updateCheckerResult PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id} Update some fields of a CheckerResult
CheckerApi updateCheckplan PATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id} Update some fields of a Checkplan
CheckerApi updateRule PATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id} Update some fields of a Rule
CheckerApi updateRuleComponent 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
CheckerApi updateRuleset PATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id} Update some fields of a Ruleset
CollaborationApi addGroupMember POST /cloud/{cloud_pk}/project/{project_pk}/group/{group_pk}/member Add a user to a group
CollaborationApi cancelCloudUserInvitation DELETE /cloud/{cloud_pk}/invitation/{id} Cancel a pending invitation
CollaborationApi cancelProjectUserInvitation DELETE /cloud/{cloud_pk}/project/{project_pk}/invitation/{id} Cancel a pending invitation
CollaborationApi checkAccess GET /cloud/{id}/check-access Check app access from cloud
CollaborationApi createClassification POST /cloud/{cloud_pk}/project/{project_pk}/classification Create a classification
CollaborationApi createCloud POST /cloud Create a cloud
CollaborationApi createDMSTree POST /cloud/{cloud_pk}/project/{id}/dms-tree Create a complete DMS tree
CollaborationApi createDemo POST /cloud/{id}/create-demo Create a Demo project in a cloud
CollaborationApi createDocument POST /cloud/{cloud_pk}/project/{project_pk}/document Create a document
CollaborationApi createFolder POST /cloud/{cloud_pk}/project/{project_pk}/folder Create a folder
CollaborationApi createManageGroup POST /cloud/{cloud_pk}/project/{project_pk}/group Create a group
CollaborationApi createProject POST /cloud/{cloud_pk}/project Create a project
CollaborationApi createProjectAccessToken POST /cloud/{cloud_pk}/project/{project_pk}/access-token Create a token for this project
CollaborationApi deleteClassification DELETE /cloud/{cloud_pk}/project/{project_pk}/classification/{id} Delete a classification
CollaborationApi deleteCloud DELETE /cloud/{id} Delete a cloud
CollaborationApi deleteCloudUser DELETE /cloud/{cloud_pk}/user/{id} Remove a user from a cloud
CollaborationApi deleteDocument DELETE /cloud/{cloud_pk}/project/{project_pk}/document/{id} Delete the document
CollaborationApi deleteFolder DELETE /cloud/{cloud_pk}/project/{project_pk}/folder/{id} Delete a folder
CollaborationApi deleteGroupMember DELETE /cloud/{cloud_pk}/project/{project_pk}/group/{group_pk}/member/{id} Delete a user from a group
CollaborationApi deleteManageGroup DELETE /cloud/{cloud_pk}/project/{project_pk}/group/{id} Delete a group
CollaborationApi deleteProject DELETE /cloud/{cloud_pk}/project/{id} Delete a project
CollaborationApi deleteProjectAccessToken DELETE /cloud/{cloud_pk}/project/{project_pk}/access-token/{token} Delete a token
CollaborationApi deleteProjectUser DELETE /cloud/{cloud_pk}/project/{project_pk}/user/{id} Remove a user from a project
CollaborationApi fullUpdateClassification PUT /cloud/{cloud_pk}/project/{project_pk}/classification/{id} Update all fields of a classification
CollaborationApi fullUpdateCloud PUT /cloud/{id} Update all fields of a cloud
CollaborationApi fullUpdateCloudUser PUT /cloud/{cloud_pk}/user/{id} Update all fields of a cloud user
CollaborationApi fullUpdateDocument PUT /cloud/{cloud_pk}/project/{project_pk}/document/{id} Update all fields of the document
CollaborationApi fullUpdateFolder PUT /cloud/{cloud_pk}/project/{project_pk}/folder/{id} Update all fields of a folder
CollaborationApi fullUpdateGroupFolder PUT /cloud/{cloud_pk}/project/{project_pk}/folder/{folder_pk}/group/{id} Update the permission of a group on a folder
CollaborationApi fullUpdateManageGroup PUT /cloud/{cloud_pk}/project/{project_pk}/group/{id} Update all fields of a group
CollaborationApi fullUpdateProject PUT /cloud/{cloud_pk}/project/{id} Update all fields of a project
CollaborationApi fullUpdateProjectAccessToken PUT /cloud/{cloud_pk}/project/{project_pk}/access-token/{token} Update all fields of a token
CollaborationApi fullUpdateProjectUser PUT /cloud/{cloud_pk}/project/{project_pk}/user/{id} Update all fields of a project user
CollaborationApi getClassification GET /cloud/{cloud_pk}/project/{project_pk}/classification/{id} Retrieve a classification
CollaborationApi getClassifications GET /cloud/{cloud_pk}/project/{project_pk}/classification Retrieve all classifications
CollaborationApi getCloud GET /cloud/{id} Retrieve one cloud
CollaborationApi getCloudInvitations GET /cloud/{cloud_pk}/invitation Retrieve all pending invitations in the cloud
CollaborationApi getCloudSize GET /cloud/{id}/size Get size of all ifc files in the cloud
CollaborationApi getCloudUser GET /cloud/{cloud_pk}/user/{id} Retrieve a user in a cloud
CollaborationApi getCloudUsers GET /cloud/{cloud_pk}/user Retrieve all users in a cloud, or a list with a filter by email
CollaborationApi getClouds GET /cloud Retrieve all clouds
CollaborationApi getDocument GET /cloud/{cloud_pk}/project/{project_pk}/document/{id} Retrieve a document
CollaborationApi getDocuments GET /cloud/{cloud_pk}/project/{project_pk}/document Retrieve all documents
CollaborationApi getFolder GET /cloud/{cloud_pk}/project/{project_pk}/folder/{id} Retrieve a folder
CollaborationApi getFolders GET /cloud/{cloud_pk}/project/{project_pk}/folder Retrieve all folders
CollaborationApi getGroup GET /cloud/{cloud_pk}/project/{project_pk}/me/group/{id} Retrieve a group
CollaborationApi getGroups GET /cloud/{cloud_pk}/project/{project_pk}/me/group Retrieve all groups
CollaborationApi getManageGroup GET /cloud/{cloud_pk}/project/{project_pk}/group/{id} Retrieve a group
CollaborationApi getManageGroups GET /cloud/{cloud_pk}/project/{project_pk}/group Retrieve all groups
CollaborationApi getProject GET /cloud/{cloud_pk}/project/{id} Retrieve a project
CollaborationApi getProjectAccessToken GET /cloud/{cloud_pk}/project/{project_pk}/access-token/{token} Retrieve one token created for this project
CollaborationApi getProjectAccessTokens GET /cloud/{cloud_pk}/project/{project_pk}/access-token Retrieve all tokens created for this project
CollaborationApi getProjectDMSTree GET /cloud/{cloud_pk}/project/{id}/dms-tree Retrieve the complete DMS tree
CollaborationApi getProjectInvitations GET /cloud/{cloud_pk}/project/{project_pk}/invitation Retrieve all pending invitations in the project
CollaborationApi getProjectSubTree GET /cloud/{cloud_pk}/project/subtree Retrieve the complete projects tree of the cloud
CollaborationApi getProjectUser GET /cloud/{cloud_pk}/project/{project_pk}/user/{id} Retrieve a user in a project
CollaborationApi getProjectUsers GET /cloud/{cloud_pk}/project/{project_pk}/user Retrieve all users in a project, or a list with a filter by email
CollaborationApi getProject_0 GET /cloud/{cloud_pk}/project/{id}/tree Retrieve a project
CollaborationApi getProjects GET /cloud/{cloud_pk}/project Retrieve all projects
CollaborationApi getSelfProjects GET /user/projects List current user's projects
CollaborationApi getSelfUser GET /user Get info about the current user
CollaborationApi inviteCloudUser POST /cloud/{cloud_pk}/invitation Invite a cloud administrator
CollaborationApi inviteProjectUser POST /cloud/{cloud_pk}/project/{project_pk}/invitation Invite a project member
CollaborationApi updateClassification PATCH /cloud/{cloud_pk}/project/{project_pk}/classification/{id} Update some fields of a classification
CollaborationApi updateCloud PATCH /cloud/{id} Update some fields of a cloud
CollaborationApi updateCloudUser PATCH /cloud/{cloud_pk}/user/{id} Update some fields of a cloud user
CollaborationApi updateDocument PATCH /cloud/{cloud_pk}/project/{project_pk}/document/{id} Update some fields of the document
CollaborationApi updateFolder PATCH /cloud/{cloud_pk}/project/{project_pk}/folder/{id} Update some fields of a folder
CollaborationApi updateGroupFolder PATCH /cloud/{cloud_pk}/project/{project_pk}/folder/{folder_pk}/group/{id} Update the permission of a group on a folder
CollaborationApi updateManageGroup PATCH /cloud/{cloud_pk}/project/{project_pk}/group/{id} Update some fields of a group
CollaborationApi updateProject PATCH /cloud/{cloud_pk}/project/{id} Update some fields of a project
CollaborationApi updateProjectAccessToken PATCH /cloud/{cloud_pk}/project/{project_pk}/access-token/{token} Update some fields of a token
CollaborationApi updateProjectUser PATCH /cloud/{cloud_pk}/project/{project_pk}/user/{id} Update some fields of a project user
CollaborationApi updateSelfUser PATCH /user Update info of the current user
IfcApi addIfcErrors POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/errors Add errors to IFC
IfcApi bulkDeleteIfcClassifications DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/list_destroy Remove all classifications from model's elements
IfcApi bulkDeleteIfcProperties DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/bulk_destroy Delete many Property of a model
IfcApi bulkDeleteIfcPropertyDefinitions DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/bulk_destroy Delete many PropertyDefinitions of a model
IfcApi bulkDeleteIfcUnits DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/bulk_destroy Delete many Units of a model
IfcApi bulkDeletePropertySet DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/bulk_destroy Delete many PropertySet of a model
IfcApi bulkFullUpdateElements 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 bulkFullUpdateIfcProperty PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/bulk_update Update some fields of many properties of a model
IfcApi bulkRemoveClassificationsOfElement DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/classification/bulk_destroy Remove many classifications from an element
IfcApi bulkRemoveElementsFromClassification DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/{ifc_classification_pk}/element/bulk_destroy Remove the classifications from all elements
IfcApi bulkUpdateElements PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/bulk_update Update many elements at once (all field must be defined)
IfcApi bulkUpdateIfcProperty PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/bulk_update Update all fields of many properties of a model
IfcApi createAccessToken POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_token Create a token for this model
IfcApi createClassificationElementRelations POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification-element Create association between existing classification and existing element
IfcApi createClassificationsOfElement POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/classification Create one or many classifications to an element
IfcApi createElement POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element Create an element in the model
IfcApi createElementPropertySet POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset Create a PropertySets to an element
IfcApi createElementPropertySetProperty POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property Create a property to a PropertySet
IfcApi createElementPropertySetPropertyDefinition 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 createElementPropertySetPropertyDefinitionUnit 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 createIfcPropertyDefinition POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition Create a PropertyDefinition on the model
IfcApi createIfcUnit POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit Create a Unit on a model
IfcApi createLayer POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/layer Create a layer in the model
IfcApi createPropertySet POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset Create a PropertySet
IfcApi createPropertySetElementRelations POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset-element Create association between PropertySet and element
IfcApi createRawElements POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/raw Create elements in an optimized format
IfcApi createSpace POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space Create a space in the model
IfcApi createSystem POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/system Create a system in the model
IfcApi createZone POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone Create a zone in the model
IfcApi createZoneSpace POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space Create a space in a zone
IfcApi deleteAccessToken DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_token/{token} Delete a token
IfcApi deleteElement DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid} Delete an element of a model
IfcApi deleteIfc DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{id} Delete a model
IfcApi deleteIfcProperty DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id} Delete a Property of a model
IfcApi deleteIfcPropertyDefinition DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id} Delete a PropertyDefinitions of a model
IfcApi deleteIfcUnit DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/{id} Delete a Unit of a model
IfcApi deleteLayer DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/layer/{id} Delete a layer of a model
IfcApi deletePropertySet DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/{id} Delete a PropertySet of a model
IfcApi deleteSpace DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space/{id} Delete a space
IfcApi deleteSystem DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/system/{uuid} Delete a system of a model
IfcApi deleteZone DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id} Delete a zone of a model
IfcApi deleteZoneSpace DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id} Delete a space of a zone
IfcApi exportIfc POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/export Export IFC
IfcApi fullUpdateAccessToken PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_token/{token} Update all fields of a token
IfcApi fullUpdateElement PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid} Update all fields of an element
IfcApi fullUpdateElementPropertySetProperty PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} Update a property from an element
IfcApi fullUpdateIfc PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{id} Update all fields of a model
IfcApi fullUpdateIfcProperty PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id} Update some fields of a Property
IfcApi fullUpdateIfcPropertyDefinition PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id} Update all fields of many PropertyDefinitions of a model
IfcApi fullUpdateIfcUnit PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/{id} Update all fields of a Unit of a model
IfcApi fullUpdateLayer PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/layer/{id} Update all fields of a layer
IfcApi fullUpdateProcessorHandler PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/processorhandler/{id} Update the status of a processor handler
IfcApi fullUpdatePropertySet PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/{id} Update all fields of a PropertySet
IfcApi fullUpdateSpace PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space/{id} Update all fields of a space
IfcApi fullUpdateSystem PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/system/{uuid} Update all fields of a system
IfcApi fullUpdateZone PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id} Update all fields of a zone
IfcApi fullUpdateZoneSpace PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id} Update all fields of a space
IfcApi getAccessToken GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_token/{token} Retrieve one token created for this model
IfcApi getAccessTokens GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_token Retrieve all tokens created for this model
IfcApi getClassificationsOfElement GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/classification Retrieve all classifications of an element
IfcApi getElement GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid} Retrieve an element of a model
IfcApi getElementPropertySet GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{id} Retrieve a PropertySet of an element
IfcApi getElementPropertySetProperties GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property Retrieve all Properties of a PropertySet
IfcApi getElementPropertySetProperty 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 getElementPropertySetPropertyDefinition 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 getElementPropertySetPropertyDefinitionUnit 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 getElementPropertySetPropertyDefinitionUnits 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 getElementPropertySetPropertyDefinitions 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 getElementPropertySets GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset Retrieve all PropertySets of an element
IfcApi getElements GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element Retrieve all elements of a model
IfcApi getElementsFromClassification GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/{ifc_classification_pk}/element Retrieve all elements with the classification
IfcApi getIfc GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id} Retrieve one model
IfcApi getIfcBVH GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/map Get svg file
IfcApi getIfcClassifications GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification Retrieve all classifications in a model
IfcApi getIfcGLTF GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/gltf Get gltf file
IfcApi getIfcMap GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/bvh Get bvh file
IfcApi getIfcMaterial GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/material/{id} Retrieve a material of a model
IfcApi getIfcMaterials GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/material Retrieve all materials of a model
IfcApi getIfcProperties GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property Retrieve all Properties of a model
IfcApi getIfcProperty GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id} Retrieve a Property of a model
IfcApi getIfcPropertyDefinition GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id} Retrieve a PropertyDefinition of a model
IfcApi getIfcPropertyDefinitions GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition Retrieve all PropertyDefinitions of a model
IfcApi getIfcStructure GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/structure Get structure file
IfcApi getIfcSystems GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/systems Get systems file
IfcApi getIfcUnit GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/{id} Retrieve a Unit of a model
IfcApi getIfcUnits GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit Retrieve all Units of a model
IfcApi getIfcs GET /cloud/{cloud_pk}/project/{project_pk}/ifc Retrieve all models
IfcApi getLayer GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/layer/{id} Retrieve a layer of a model
IfcApi getLayers GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/layer Retrieve all layers of a model
IfcApi getMaterial GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/material/{id} Retrieve a material of a model
IfcApi getMaterials GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/material Retrieve all materials of a model
IfcApi getProcessorHandler GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/processorhandler/{id} Retrieve a processor handler
IfcApi getProcessorHandlers GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/processorhandler Get all processor handlers
IfcApi getPropertySet GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/{id} Retrieve a PropertySet of a model
IfcApi getPropertySets GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset Retrieve all PropertySets of a model
IfcApi getRawElements GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/raw Retrieve all elements in a optimized format
IfcApi getSimpleElement GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid}/simple Retrieve an element of a model with a simple value representation
IfcApi getSimpleElements GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/simple Retrieve all elements of a model with a simple value representation
IfcApi getSpace GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space/{id} Retrieve one space of the model
IfcApi getSpaces GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space Retrieve all spaces of the model
IfcApi getSystem GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/system/{uuid} Retrieve a system of a model
IfcApi getSystems GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/system Retrieve all systems of a model
IfcApi getZone GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id} Retrieve one zone of a model
IfcApi getZoneSpace GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id} Retrieve one space of a zone
IfcApi getZoneSpaces GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space Retrieve all spaces of a zone
IfcApi getZones GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone Retrieve zones of a model
IfcApi listClassificationElementRelations GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification-element List all associations between classifications and elements
IfcApi mergeIfcs POST /cloud/{cloud_pk}/project/{project_pk}/ifc/merge Merge IFC files
IfcApi optimizeIfc POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/optimize Optimize the IFC
IfcApi removeAllElementPropertySet DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/all Remove all property sets from element
IfcApi removeClassificationOfElement DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/classification/{id} Remove a classification from an element
IfcApi removeElementPropertySet DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{id} Remove a PropertySet from an element
IfcApi removeElementPropertySetProperty 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 removeElementPropertySetPropertyDefinition 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 removeElementPropertySetPropertyDefinitionUnit 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 removeElementsFromClassification DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/{ifc_classification_pk}/element/{uuid} Remove the classification from all elements
IfcApi reprocessIfc POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/reprocess Reprocess IFC file
IfcApi updateAccessToken PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_token/{token} Update some fields of a token
IfcApi updateElement PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid} Update some fields of an element
IfcApi updateElementPropertySetProperty PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id} Update a property from an element
IfcApi updateIfc PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{id} Update some fields of a model
IfcApi updateIfcFiles PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/files Update models file (gltf, svg, structure, etc)
IfcApi updateIfcProperty PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id} Update some fields of a Property
IfcApi updateIfcPropertyDefinition PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id} Update some fields of many PropertyDefinitions of a model
IfcApi updateIfcUnit PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/{id} Update some fields of a Unit of a model
IfcApi updateLayer PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/layer/{id} Update some fields of a layer
IfcApi updateProcessorHandler PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/processorhandler/{id} Update the status of a processor handler
IfcApi updatePropertySet PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/{id} Update some fields of a PropertySet
IfcApi updateSpace PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space/{id} Update some fields of a space
IfcApi updateSystem PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/system/{uuid} Update some fields of a system
IfcApi updateZone PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id} Update some fields of a zone
IfcApi updateZoneSpace PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id} Update some fields of a space
SsoApi acceptInvitation POST /identity-provider/invitation/{id}/accept Accept an invitation
SsoApi deleteUser DELETE /identity-provider/user Delete user from BIMData
SsoApi denyInvitation POST /identity-provider/invitation/{id}/deny Deny an invitation
SsoApi getInvitation GET /identity-provider/invitation/{id} Retrieve an invitation
SsoApi getInvitations GET /identity-provider/invitation Retrieve all invitations
WebhookApi createWebHook POST /cloud/{cloud_pk}/webhook Create a new Webhook
WebhookApi deleteWebHook DELETE /cloud/{cloud_pk}/webhook/{id} Delete a webhook
WebhookApi fullUpdateWebHook PUT /cloud/{cloud_pk}/webhook/{id} Update all field of a webhook
WebhookApi getWebHook GET /cloud/{cloud_pk}/webhook/{id} Retrieve one configured webhook
WebhookApi getWebHooks GET /cloud/{cloud_pk}/webhook Retrieve all configured webhooks
WebhookApi pingWebHook POST /cloud/{cloud_pk}/webhook/{id}/ping Test a webhook
WebhookApi updateWebHook PATCH /cloud/{cloud_pk}/webhook/{id} Update some field of a webhook

Models

Authorization

Bearer

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

bimdata_connect

  • Type: OAuth
  • Flow: implicit
  • Authorization URL: https://iam.bimdata.io/auth/realms/bimdata/protocol/openid-connect/auth
  • Scopes: N/A

client_credentials

  • Type: OAuth
  • Flow: application
  • Authorization URL: https://iam.bimdata.io/auth/realms/bimdata/protocol/openid-connect/token
  • Scopes: N/A

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

support@bimdata.io

About this package

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

  • API version: v1
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen