Skip to content

Repository files navigation

OpenAPIClient-php

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:

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

Getting Started

Please follow the installation procedure and then run the following:

<?phprequire_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 = newOpenAPI\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.newGuzzleHttp\Client(),
$config
);
$projects_pk = 'projects_pk_example'; // string$topics_guid = 'topics_guid_example'; // string$data = new \OpenAPI\Client\Model\Comment(); // \OpenAPI\Client\Model\Commenttry {
$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

ClassMethodHTTP requestDescription
BcfApicreateCommentPOST /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/commentsCreate a comment
BcfApicreateFullTopicPOST /bcf/2.1/projects/{projects_pk}/full-topicCreate a Topic with viewpoints and comments
BcfApicreateTopicPOST /bcf/2.1/projects/{projects_pk}/topicsCreate a topic
BcfApicreateViewpointPOST /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpointsCreate a Viewpoint
BcfApideleteCommentDELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid}Delete a comment
BcfApideleteTopicDELETE /bcf/2.1/projects/{projects_pk}/topics/{guid}Delete a topic
BcfApideleteViewpointDELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}Delete a Viewpoint
BcfApidownloadBcfExportGET /bcf/2.1/projects/{id}/exportExport project's topics in bcf-xml format
BcfApifullUpdateBcfProjectPUT /bcf/2.1/projects/{id}Update all fields of a BCF project
BcfApifullUpdateCommentPUT /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid}Update all fields of a comment
BcfApifullUpdateFullTopicPUT /bcf/2.1/projects/{projects_pk}/full-topic/{guid}Update all fields of a topic
BcfApifullUpdateTopicPUT /bcf/2.1/projects/{projects_pk}/topics/{guid}Update all fields of a topic
BcfApifullUpdateViewpointPUT /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}Update all fields of a Viewpoint
BcfApigetBcfProjectGET /bcf/2.1/projects/{id}Retrieve a BCF project
BcfApigetBcfProjectsGET /bcf/2.1/projectsRetrieve all BCF projects
BcfApigetColoringsGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/coloringRetrieve all colorings of a viewpoint
BcfApigetCommentGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid}Retrieve a comment
BcfApigetCommentsGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/commentsRetrieve all comments
BcfApigetExtensionsGET /bcf/2.1/projects/{projects_pk}/extensionsRetrieve project extensions
BcfApigetFullTopicGET /bcf/2.1/projects/{projects_pk}/full-topic/{guid}Retrieve a full topic
BcfApigetFullTopicsGET /bcf/2.1/projects/{projects_pk}/full-topicRetrieve all full topics
BcfApigetSelectionsGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/selectionRetrieve all selections of a viewpoint
BcfApigetSnapshotGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/snapshotRetrieve the viewpoint' snapshot
BcfApigetTopicGET /bcf/2.1/projects/{projects_pk}/topics/{guid}Retrieve a topic
BcfApigetTopicViewpointsGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/topic-viewpointsRetrieve all viewpoints attached to the topic
BcfApigetTopicsGET /bcf/2.1/projects/{projects_pk}/topicsRetrieve all topics
BcfApigetUserGET /bcf/2.1/current-userGet current user info
BcfApigetViewpointGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}Retrieve a Viewpoint
BcfApigetViewpointsGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpointsRetrieve all Viewpoints of a topic
BcfApigetVisibilitiesGET /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/visibilityRetrieve all visibilities of a viewpoint
BcfApiimportBcfPOST /bcf/2.1/projects/{id}/importImport bcf-xml format into this project
BcfApiupdateBcfProjectPATCH /bcf/2.1/projects/{id}Update some fields of a BCF project
BcfApiupdateCommentPATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid}Update some fields of a comment
BcfApiupdateExtensionsPATCH /bcf/2.1/projects/{projects_pk}/extensionsUpdate project extensions
BcfApiupdateFullTopicPATCH /bcf/2.1/projects/{projects_pk}/full-topic/{guid}Update some fields of a topic
BcfApiupdateTopicPATCH /bcf/2.1/projects/{projects_pk}/topics/{guid}Update some fields of a topic
BcfApiupdateViewpointPATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}Update some fields of a Viewpoint
CheckerApicreateCheckerPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checkerCreate a checker to a model
CheckerApicreateCheckerResultPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/resultCreate a CheckerResult
CheckerApicreateCheckplanPOST /cloud/{cloud_pk}/project/{project_pk}/checkplanCreate a Checkplan
CheckerApicreateRulePOST /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/ruleCreate a Rule
CheckerApicreateRuleComponentPOST /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponentCreate a RuleComponent
CheckerApicreateRulesetPOST /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/rulesetCreate a Ruleset
CheckerApideleteCheckerDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id}Delete a checker of a model
CheckerApideleteCheckerResultDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id}Delete a CheckerResult
CheckerApideleteCheckplanDELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id}Delete a Checkplan
CheckerApideleteRuleDELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id}Delete a Rule
CheckerApideleteRuleComponentDELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id}Delete a RuleComponent
CheckerApideleteRulesetDELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id}Delete a Ruleset
CheckerApifullUpdateCheckerPUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id}Update all fields of a checker of a model
CheckerApifullUpdateCheckerResultPUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id}Update all fields of a CheckerResult
CheckerApifullUpdateCheckplanPUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id}Update all fields of a Checkplan
CheckerApifullUpdateRulePUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id}Update all fields of a Rule
CheckerApifullUpdateRuleComponentPUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id}Update all fields of a RuleComponent
CheckerApifullUpdateRulesetPUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id}Update all fields of a Ruleset
CheckerApigetCheckerGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id}Retrieve a checker of a model
CheckerApigetCheckerResultGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id}Retrieve one CheckerResult
CheckerApigetCheckerResultsGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/resultRetrieve all CheckerResults
CheckerApigetCheckersGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checkerRetrieve all checkers of a model
CheckerApigetCheckplanGET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id}Retrieve one Checkplan
CheckerApigetCheckplansGET /cloud/{cloud_pk}/project/{project_pk}/checkplanRetrieve all Checkplans
CheckerApigetRuleGET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id}Retrieve one Rule
CheckerApigetRuleComponentGET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id}Retrieve one RuleComponent
CheckerApigetRuleComponentsGET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponentRetrieve all RuleComponents
CheckerApigetRulesGET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/ruleRetrieve all Rules
CheckerApigetRulesetGET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id}Retrieve one Ruleset
CheckerApigetRulesetsGET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/rulesetRetrieve all Rulesets
CheckerApilaunchNewCheckPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id}/launch-checkLaunch a new check on the model
CheckerApiupdateCheckerPATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id}Update some fields of a checker of a model
CheckerApiupdateCheckerResultPATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id}Update some fields of a CheckerResult
CheckerApiupdateCheckplanPATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id}Update some fields of a Checkplan
CheckerApiupdateRulePATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id}Update some fields of a Rule
CheckerApiupdateRuleComponentPATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id}Update some fields of a RuleComponent
CheckerApiupdateRulesetPATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id}Update some fields of a Ruleset
CollaborationApiaddGroupMemberPOST /cloud/{cloud_pk}/project/{project_pk}/group/{group_pk}/memberAdd a user to a group
CollaborationApicancelCloudUserInvitationDELETE /cloud/{cloud_pk}/invitation/{id}Cancel a pending invitation
CollaborationApicancelProjectUserInvitationDELETE /cloud/{cloud_pk}/project/{project_pk}/invitation/{id}Cancel a pending invitation
CollaborationApicheckAccessGET /cloud/{id}/check-accessCheck app access from cloud
CollaborationApicreateClassificationPOST /cloud/{cloud_pk}/project/{project_pk}/classificationCreate a classification
CollaborationApicreateCloudPOST /cloudCreate a cloud
CollaborationApicreateDMSTreePOST /cloud/{cloud_pk}/project/{id}/dms-treeCreate a complete DMS tree
CollaborationApicreateDemoPOST /cloud/{id}/create-demoCreate a Demo project in a cloud
CollaborationApicreateDocumentPOST /cloud/{cloud_pk}/project/{project_pk}/documentCreate a document
CollaborationApicreateFolderPOST /cloud/{cloud_pk}/project/{project_pk}/folderCreate a folder
CollaborationApicreateManageGroupPOST /cloud/{cloud_pk}/project/{project_pk}/groupCreate a group
CollaborationApicreateProjectPOST /cloud/{cloud_pk}/projectCreate a project
CollaborationApicreateProjectAccessTokenPOST /cloud/{cloud_pk}/project/{project_pk}/access-tokenCreate a token for this project
CollaborationApideleteClassificationDELETE /cloud/{cloud_pk}/project/{project_pk}/classification/{id}Delete a classification
CollaborationApideleteCloudDELETE /cloud/{id}Delete a cloud
CollaborationApideleteCloudUserDELETE /cloud/{cloud_pk}/user/{id}Remove a user from a cloud
CollaborationApideleteDocumentDELETE /cloud/{cloud_pk}/project/{project_pk}/document/{id}Delete the document
CollaborationApideleteFolderDELETE /cloud/{cloud_pk}/project/{project_pk}/folder/{id}Delete a folder
CollaborationApideleteGroupMemberDELETE /cloud/{cloud_pk}/project/{project_pk}/group/{group_pk}/member/{id}Delete a user from a group
CollaborationApideleteManageGroupDELETE /cloud/{cloud_pk}/project/{project_pk}/group/{id}Delete a group
CollaborationApideleteProjectDELETE /cloud/{cloud_pk}/project/{id}Delete a project
CollaborationApideleteProjectAccessTokenDELETE /cloud/{cloud_pk}/project/{project_pk}/access-token/{token}Delete a token
CollaborationApideleteProjectUserDELETE /cloud/{cloud_pk}/project/{project_pk}/user/{id}Remove a user from a project
CollaborationApifullUpdateClassificationPUT /cloud/{cloud_pk}/project/{project_pk}/classification/{id}Update all fields of a classification
CollaborationApifullUpdateCloudPUT /cloud/{id}Update all fields of a cloud
CollaborationApifullUpdateCloudUserPUT /cloud/{cloud_pk}/user/{id}Update all fields of a cloud user
CollaborationApifullUpdateDocumentPUT /cloud/{cloud_pk}/project/{project_pk}/document/{id}Update all fields of the document
CollaborationApifullUpdateFolderPUT /cloud/{cloud_pk}/project/{project_pk}/folder/{id}Update all fields of a folder
CollaborationApifullUpdateGroupFolderPUT /cloud/{cloud_pk}/project/{project_pk}/folder/{folder_pk}/group/{id}Update the permission of a group on a folder
CollaborationApifullUpdateManageGroupPUT /cloud/{cloud_pk}/project/{project_pk}/group/{id}Update all fields of a group
CollaborationApifullUpdateProjectPUT /cloud/{cloud_pk}/project/{id}Update all fields of a project
CollaborationApifullUpdateProjectAccessTokenPUT /cloud/{cloud_pk}/project/{project_pk}/access-token/{token}Update all fields of a token
CollaborationApifullUpdateProjectUserPUT /cloud/{cloud_pk}/project/{project_pk}/user/{id}Update all fields of a project user
CollaborationApigetClassificationGET /cloud/{cloud_pk}/project/{project_pk}/classification/{id}Retrieve a classification
CollaborationApigetClassificationsGET /cloud/{cloud_pk}/project/{project_pk}/classificationRetrieve all classifications
CollaborationApigetCloudGET /cloud/{id}Retrieve one cloud
CollaborationApigetCloudInvitationsGET /cloud/{cloud_pk}/invitationRetrieve all pending invitations in the cloud
CollaborationApigetCloudSizeGET /cloud/{id}/sizeGet size of all ifc files in the cloud
CollaborationApigetCloudUserGET /cloud/{cloud_pk}/user/{id}Retrieve a user in a cloud
CollaborationApigetCloudUsersGET /cloud/{cloud_pk}/userRetrieve all users in a cloud, or a list with a filter by email
CollaborationApigetCloudsGET /cloudRetrieve all clouds
CollaborationApigetDocumentGET /cloud/{cloud_pk}/project/{project_pk}/document/{id}Retrieve a document
CollaborationApigetDocumentsGET /cloud/{cloud_pk}/project/{project_pk}/documentRetrieve all documents
CollaborationApigetFolderGET /cloud/{cloud_pk}/project/{project_pk}/folder/{id}Retrieve a folder
CollaborationApigetFoldersGET /cloud/{cloud_pk}/project/{project_pk}/folderRetrieve all folders
CollaborationApigetGroupGET /cloud/{cloud_pk}/project/{project_pk}/me/group/{id}Retrieve a group
CollaborationApigetGroupsGET /cloud/{cloud_pk}/project/{project_pk}/me/groupRetrieve all groups
CollaborationApigetManageGroupGET /cloud/{cloud_pk}/project/{project_pk}/group/{id}Retrieve a group
CollaborationApigetManageGroupsGET /cloud/{cloud_pk}/project/{project_pk}/groupRetrieve all groups
CollaborationApigetProjectGET /cloud/{cloud_pk}/project/{id}Retrieve a project
CollaborationApigetProjectAccessTokenGET /cloud/{cloud_pk}/project/{project_pk}/access-token/{token}Retrieve one token created for this project
CollaborationApigetProjectAccessTokensGET /cloud/{cloud_pk}/project/{project_pk}/access-tokenRetrieve all tokens created for this project
CollaborationApigetProjectDMSTreeGET /cloud/{cloud_pk}/project/{id}/dms-treeRetrieve the complete DMS tree
CollaborationApigetProjectInvitationsGET /cloud/{cloud_pk}/project/{project_pk}/invitationRetrieve all pending invitations in the project
CollaborationApigetProjectSubTreeGET /cloud/{cloud_pk}/project/subtreeRetrieve the complete projects tree of the cloud
CollaborationApigetProjectUserGET /cloud/{cloud_pk}/project/{project_pk}/user/{id}Retrieve a user in a project
CollaborationApigetProjectUsersGET /cloud/{cloud_pk}/project/{project_pk}/userRetrieve all users in a project, or a list with a filter by email
CollaborationApigetProject_0GET /cloud/{cloud_pk}/project/{id}/treeRetrieve a project
CollaborationApigetProjectsGET /cloud/{cloud_pk}/projectRetrieve all projects
CollaborationApigetSelfProjectsGET /user/projectsList current user's projects
CollaborationApigetSelfUserGET /userGet info about the current user
CollaborationApiinviteCloudUserPOST /cloud/{cloud_pk}/invitationInvite a cloud administrator
CollaborationApiinviteProjectUserPOST /cloud/{cloud_pk}/project/{project_pk}/invitationInvite a project member
CollaborationApiupdateClassificationPATCH /cloud/{cloud_pk}/project/{project_pk}/classification/{id}Update some fields of a classification
CollaborationApiupdateCloudPATCH /cloud/{id}Update some fields of a cloud
CollaborationApiupdateCloudUserPATCH /cloud/{cloud_pk}/user/{id}Update some fields of a cloud user
CollaborationApiupdateDocumentPATCH /cloud/{cloud_pk}/project/{project_pk}/document/{id}Update some fields of the document
CollaborationApiupdateFolderPATCH /cloud/{cloud_pk}/project/{project_pk}/folder/{id}Update some fields of a folder
CollaborationApiupdateGroupFolderPATCH /cloud/{cloud_pk}/project/{project_pk}/folder/{folder_pk}/group/{id}Update the permission of a group on a folder
CollaborationApiupdateManageGroupPATCH /cloud/{cloud_pk}/project/{project_pk}/group/{id}Update some fields of a group
CollaborationApiupdateProjectPATCH /cloud/{cloud_pk}/project/{id}Update some fields of a project
CollaborationApiupdateProjectAccessTokenPATCH /cloud/{cloud_pk}/project/{project_pk}/access-token/{token}Update some fields of a token
CollaborationApiupdateProjectUserPATCH /cloud/{cloud_pk}/project/{project_pk}/user/{id}Update some fields of a project user
CollaborationApiupdateSelfUserPATCH /userUpdate info of the current user
IfcApiaddIfcErrorsPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/errorsAdd errors to IFC
IfcApibulkDeleteIfcClassificationsDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/list_destroyRemove all classifications from model's elements
IfcApibulkDeleteIfcPropertiesDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/bulk_destroyDelete many Property of a model
IfcApibulkDeleteIfcPropertyDefinitionsDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/bulk_destroyDelete many PropertyDefinitions of a model
IfcApibulkDeleteIfcUnitsDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/bulk_destroyDelete many Units of a model
IfcApibulkDeletePropertySetDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/bulk_destroyDelete many PropertySet of a model
IfcApibulkFullUpdateElementsPATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/bulk_updateUpdate many elements at once (only changing fields may be defined)
IfcApibulkFullUpdateIfcPropertyPATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/bulk_updateUpdate some fields of many properties of a model
IfcApibulkRemoveClassificationsOfElementDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/classification/bulk_destroyRemove many classifications from an element
IfcApibulkRemoveElementsFromClassificationDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/{ifc_classification_pk}/element/bulk_destroyRemove the classifications from all elements
IfcApibulkUpdateElementsPUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/bulk_updateUpdate many elements at once (all field must be defined)
IfcApibulkUpdateIfcPropertyPUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/bulk_updateUpdate all fields of many properties of a model
IfcApicreateAccessTokenPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_tokenCreate a token for this model
IfcApicreateClassificationElementRelationsPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification-elementCreate association between existing classification and existing element
IfcApicreateClassificationsOfElementPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/classificationCreate one or many classifications to an element
IfcApicreateElementPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/elementCreate an element in the model
IfcApicreateElementPropertySetPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertysetCreate a PropertySets to an element
IfcApicreateElementPropertySetPropertyPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/propertyCreate a property to a PropertySet
IfcApicreateElementPropertySetPropertyDefinitionPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinitionCreate a Definition to a Property
IfcApicreateElementPropertySetPropertyDefinitionUnitPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unitCreate a Unit to a Definition
IfcApicreateIfcPropertyDefinitionPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinitionCreate a PropertyDefinition on the model
IfcApicreateIfcUnitPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unitCreate a Unit on a model
IfcApicreateLayerPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/layerCreate a layer in the model
IfcApicreatePropertySetPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertysetCreate a PropertySet
IfcApicreatePropertySetElementRelationsPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset-elementCreate association between PropertySet and element
IfcApicreateRawElementsPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/rawCreate elements in an optimized format
IfcApicreateSpacePOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/spaceCreate a space in the model
IfcApicreateSystemPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/systemCreate a system in the model
IfcApicreateZonePOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zoneCreate a zone in the model
IfcApicreateZoneSpacePOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/spaceCreate a space in a zone
IfcApideleteAccessTokenDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_token/{token}Delete a token
IfcApideleteElementDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid}Delete an element of a model
IfcApideleteIfcDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}Delete a model
IfcApideleteIfcPropertyDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id}Delete a Property of a model
IfcApideleteIfcPropertyDefinitionDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id}Delete a PropertyDefinitions of a model
IfcApideleteIfcUnitDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/{id}Delete a Unit of a model
IfcApideleteLayerDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/layer/{id}Delete a layer of a model
IfcApideletePropertySetDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/{id}Delete a PropertySet of a model
IfcApideleteSpaceDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space/{id}Delete a space
IfcApideleteSystemDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/system/{uuid}Delete a system of a model
IfcApideleteZoneDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id}Delete a zone of a model
IfcApideleteZoneSpaceDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id}Delete a space of a zone
IfcApiexportIfcPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/exportExport IFC
IfcApifullUpdateAccessTokenPUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_token/{token}Update all fields of a token
IfcApifullUpdateElementPUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid}Update all fields of an element
IfcApifullUpdateElementPropertySetPropertyPUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id}Update a property from an element
IfcApifullUpdateIfcPUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}Update all fields of a model
IfcApifullUpdateIfcPropertyPUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id}Update some fields of a Property
IfcApifullUpdateIfcPropertyDefinitionPUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id}Update all fields of many PropertyDefinitions of a model
IfcApifullUpdateIfcUnitPUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/{id}Update all fields of a Unit of a model
IfcApifullUpdateLayerPUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/layer/{id}Update all fields of a layer
IfcApifullUpdateProcessorHandlerPATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/processorhandler/{id}Update the status of a processor handler
IfcApifullUpdatePropertySetPUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/{id}Update all fields of a PropertySet
IfcApifullUpdateSpacePUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space/{id}Update all fields of a space
IfcApifullUpdateSystemPUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/system/{uuid}Update all fields of a system
IfcApifullUpdateZonePUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id}Update all fields of a zone
IfcApifullUpdateZoneSpacePUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id}Update all fields of a space
IfcApigetAccessTokenGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_token/{token}Retrieve one token created for this model
IfcApigetAccessTokensGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_tokenRetrieve all tokens created for this model
IfcApigetClassificationsOfElementGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/classificationRetrieve all classifications of an element
IfcApigetElementGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid}Retrieve an element of a model
IfcApigetElementPropertySetGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{id}Retrieve a PropertySet of an element
IfcApigetElementPropertySetPropertiesGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/propertyRetrieve all Properties of a PropertySet
IfcApigetElementPropertySetPropertyGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id}Retrieve a Property of a PropertySet
IfcApigetElementPropertySetPropertyDefinitionGET /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
IfcApigetElementPropertySetPropertyDefinitionUnitGET /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
IfcApigetElementPropertySetPropertyDefinitionUnitsGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{propertydefinition_pk}/unitRetrieve all Units of a Definition
IfcApigetElementPropertySetPropertyDefinitionsGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinitionRetrieve all Definitions of a PropertySet
IfcApigetElementPropertySetsGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertysetRetrieve all PropertySets of an element
IfcApigetElementsGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/elementRetrieve all elements of a model
IfcApigetElementsFromClassificationGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/{ifc_classification_pk}/elementRetrieve all elements with the classification
IfcApigetIfcGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}Retrieve one model
IfcApigetIfcBVHGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/mapGet svg file
IfcApigetIfcClassificationsGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classificationRetrieve all classifications in a model
IfcApigetIfcGLTFGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/gltfGet gltf file
IfcApigetIfcMapGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/bvhGet bvh file
IfcApigetIfcMaterialGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/material/{id}Retrieve a material of a model
IfcApigetIfcMaterialsGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/materialRetrieve all materials of a model
IfcApigetIfcPropertiesGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyRetrieve all Properties of a model
IfcApigetIfcPropertyGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id}Retrieve a Property of a model
IfcApigetIfcPropertyDefinitionGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id}Retrieve a PropertyDefinition of a model
IfcApigetIfcPropertyDefinitionsGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinitionRetrieve all PropertyDefinitions of a model
IfcApigetIfcStructureGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/structureGet structure file
IfcApigetIfcSystemsGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/systemsGet systems file
IfcApigetIfcUnitGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/{id}Retrieve a Unit of a model
IfcApigetIfcUnitsGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unitRetrieve all Units of a model
IfcApigetIfcsGET /cloud/{cloud_pk}/project/{project_pk}/ifcRetrieve all models
IfcApigetLayerGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/layer/{id}Retrieve a layer of a model
IfcApigetLayersGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/layerRetrieve all layers of a model
IfcApigetMaterialGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/material/{id}Retrieve a material of a model
IfcApigetMaterialsGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/materialRetrieve all materials of a model
IfcApigetProcessorHandlerGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/processorhandler/{id}Retrieve a processor handler
IfcApigetProcessorHandlersGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/processorhandlerGet all processor handlers
IfcApigetPropertySetGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/{id}Retrieve a PropertySet of a model
IfcApigetPropertySetsGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertysetRetrieve all PropertySets of a model
IfcApigetRawElementsGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/rawRetrieve all elements in a optimized format
IfcApigetSimpleElementGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid}/simpleRetrieve an element of a model with a simple value representation
IfcApigetSimpleElementsGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/simpleRetrieve all elements of a model with a simple value representation
IfcApigetSpaceGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space/{id}Retrieve one space of the model
IfcApigetSpacesGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/spaceRetrieve all spaces of the model
IfcApigetSystemGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/system/{uuid}Retrieve a system of a model
IfcApigetSystemsGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/systemRetrieve all systems of a model
IfcApigetZoneGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id}Retrieve one zone of a model
IfcApigetZoneSpaceGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id}Retrieve one space of a zone
IfcApigetZoneSpacesGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/spaceRetrieve all spaces of a zone
IfcApigetZonesGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zoneRetrieve zones of a model
IfcApilistClassificationElementRelationsGET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification-elementList all associations between classifications and elements
IfcApimergeIfcsPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/mergeMerge IFC files
IfcApioptimizeIfcPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/optimizeOptimize the IFC
IfcApiremoveAllElementPropertySetDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/allRemove all property sets from element
IfcApiremoveClassificationOfElementDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/classification/{id}Remove a classification from an element
IfcApiremoveElementPropertySetDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{id}Remove a PropertySet from an element
IfcApiremoveElementPropertySetPropertyDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id}Remove a property from a PropertySet
IfcApiremoveElementPropertySetPropertyDefinitionDELETE /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
IfcApiremoveElementPropertySetPropertyDefinitionUnitDELETE /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
IfcApiremoveElementsFromClassificationDELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/{ifc_classification_pk}/element/{uuid}Remove the classification from all elements
IfcApireprocessIfcPOST /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/reprocessReprocess IFC file
IfcApiupdateAccessTokenPATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/access_token/{token}Update some fields of a token
IfcApiupdateElementPATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid}Update some fields of an element
IfcApiupdateElementPropertySetPropertyPATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id}Update a property from an element
IfcApiupdateIfcPATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}Update some fields of a model
IfcApiupdateIfcFilesPATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/filesUpdate models file (gltf, svg, structure, etc)
IfcApiupdateIfcPropertyPATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id}Update some fields of a Property
IfcApiupdateIfcPropertyDefinitionPATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id}Update some fields of many PropertyDefinitions of a model
IfcApiupdateIfcUnitPATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/{id}Update some fields of a Unit of a model
IfcApiupdateLayerPATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/layer/{id}Update some fields of a layer
IfcApiupdateProcessorHandlerPUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/processorhandler/{id}Update the status of a processor handler
IfcApiupdatePropertySetPATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/{id}Update some fields of a PropertySet
IfcApiupdateSpacePATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space/{id}Update some fields of a space
IfcApiupdateSystemPATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/system/{uuid}Update some fields of a system
IfcApiupdateZonePATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id}Update some fields of a zone
IfcApiupdateZoneSpacePATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id}Update some fields of a space
SsoApiacceptInvitationPOST /identity-provider/invitation/{id}/acceptAccept an invitation
SsoApideleteUserDELETE /identity-provider/userDelete user from BIMData
SsoApidenyInvitationPOST /identity-provider/invitation/{id}/denyDeny an invitation
SsoApigetInvitationGET /identity-provider/invitation/{id}Retrieve an invitation
SsoApigetInvitationsGET /identity-provider/invitationRetrieve all invitations
WebhookApicreateWebHookPOST /cloud/{cloud_pk}/webhookCreate a new Webhook
WebhookApideleteWebHookDELETE /cloud/{cloud_pk}/webhook/{id}Delete a webhook
WebhookApifullUpdateWebHookPUT /cloud/{cloud_pk}/webhook/{id}Update all field of a webhook
WebhookApigetWebHookGET /cloud/{cloud_pk}/webhook/{id}Retrieve one configured webhook
WebhookApigetWebHooksGET /cloud/{cloud_pk}/webhookRetrieve all configured webhooks
WebhookApipingWebHookPOST /cloud/{cloud_pk}/webhook/{id}/pingTest a webhook
WebhookApiupdateWebHookPATCH /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

About

PHP API Client for BIMData

Resources

Stars

3 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages