@bimdata/bimdata-api-client

@bimdata/bimdata-api-client

bimdata - JavaScript client for @bimdata/bimdata-api-client BIMData API documentation This SDK is automatically generated by the Swagger Codegen project:

• API version: v1
• Package version: 1.0.12
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @bimdata/bimdata-api-client --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your @bimdata/bimdata-api-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('@bimdata/bimdata-api-client') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var bimdata = require('@bimdata/bimdata-api-client');

var defaultClient = bimdata.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['access_token'] = "Token"

var api = new bimdata.BcfApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.bcf21CurrentUserList(callback);

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
bimdata.BcfApi	bcf21CurrentUserList	GET /bcf/2.1/current-user
bimdata.BcfApi	bcf21ProjectsTopicsCommentsEventsDelete	DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/events/{id}
bimdata.BcfApi	bcf21ProjectsTopicsCommentsEventsDelete_0	DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/{comments_pk}/events/{id}
bimdata.BcfApi	bcf21ProjectsTopicsEventsDelete	DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/events/{id}
bimdata.BcfApi	bcf21ProjectsTopicsViewpointsBitmapDelete	DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/bitmap/{id}
bimdata.BcfApi	bcf21ProjectsTopicsViewpointsColoringDelete	DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/coloring/{id}
bimdata.BcfApi	bcf21ProjectsTopicsViewpointsDelete	DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{id}
bimdata.BcfApi	bcf21ProjectsTopicsViewpointsSelectionDelete	DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/selection/{id}
bimdata.BcfApi	bcf21ProjectsTopicsViewpointsVisibilityDelete	DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/visibility/{id}
bimdata.BcfApi	bcfVersionsDelete	DELETE /bcf/versions/{id}
bimdata.BcfApi	createBcfDocument	POST /bcf/2.1/projects/{projects_pk}/documents
bimdata.BcfApi	createBcfProject	POST /bcf/2.1/projects
bimdata.BcfApi	createBitmap	POST /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/bitmap
bimdata.BcfApi	createColoring	POST /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/coloring
bimdata.BcfApi	createComment	POST /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments
bimdata.BcfApi	createCommentEvent	POST /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/events
bimdata.BcfApi	createCommentEvent_0	POST /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/{comments_pk}/events
bimdata.BcfApi	createDocumentReference	POST /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/document_references
bimdata.BcfApi	createFile	POST /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/file
bimdata.BcfApi	createRelatedTopic	POST /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/related_topics
bimdata.BcfApi	createSelection	POST /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/selection
bimdata.BcfApi	createSnippet	POST /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/snippet
bimdata.BcfApi	createTopic	POST /bcf/2.1/projects/{projects_pk}/topics
bimdata.BcfApi	createTopicEvent	POST /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/events
bimdata.BcfApi	createVersion	POST /bcf/versions
bimdata.BcfApi	createViewpoint	POST /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints
bimdata.BcfApi	createVisibility	POST /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/visibility
bimdata.BcfApi	deleteBcfDocument	DELETE /bcf/2.1/projects/{projects_pk}/documents/{id}
bimdata.BcfApi	deleteBcfProject	DELETE /bcf/2.1/projects/{id}
bimdata.BcfApi	deleteComment	DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/{id}
bimdata.BcfApi	deleteDocumentReference	DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/document_references/{id}
bimdata.BcfApi	deleteFile	DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/file/{id}
bimdata.BcfApi	deleteRelatedTopic	DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/related_topics/{id}
bimdata.BcfApi	deleteSnippet	DELETE /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/snippet/{id}
bimdata.BcfApi	deleteTopic	DELETE /bcf/2.1/projects/{projects_pk}/topics/{id}
bimdata.BcfApi	fullUpdateBcfDocument	PUT /bcf/2.1/projects/{projects_pk}/documents/{id}
bimdata.BcfApi	fullUpdateBcfProject	PUT /bcf/2.1/projects/{id}
bimdata.BcfApi	fullUpdateBitmap	PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/bitmap/{id}
bimdata.BcfApi	fullUpdateColoring	PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/coloring/{id}
bimdata.BcfApi	fullUpdateComment	PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/{id}
bimdata.BcfApi	fullUpdateCommentEvent	PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/events/{id}
bimdata.BcfApi	fullUpdateCommentEvent_0	PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/{comments_pk}/events/{id}
bimdata.BcfApi	fullUpdateDocumentReference	PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/document_references/{id}
bimdata.BcfApi	fullUpdateFile	PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/file/{id}
bimdata.BcfApi	fullUpdateRelatedTopic	PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/related_topics/{id}
bimdata.BcfApi	fullUpdateSelection	PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/selection/{id}
bimdata.BcfApi	fullUpdateSnippet	PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/snippet/{id}
bimdata.BcfApi	fullUpdateTopic	PUT /bcf/2.1/projects/{projects_pk}/topics/{id}
bimdata.BcfApi	fullUpdateTopicEvent	PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/events/{id}
bimdata.BcfApi	fullUpdateVersion	PUT /bcf/versions/{id}
bimdata.BcfApi	fullUpdateViewpoint	PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{id}
bimdata.BcfApi	fullUpdateVisibility	PUT /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/visibility/{id}
bimdata.BcfApi	getAllCommentsEvents	GET /bcf/2.1/projects/{projects_pk}/topics/comments/events
bimdata.BcfApi	getAllTopicsEvents	GET /bcf/2.1/projects/{projects_pk}/topics/events
bimdata.BcfApi	getBcfDocument	GET /bcf/2.1/projects/{projects_pk}/documents/{id}
bimdata.BcfApi	getBcfDocuments	GET /bcf/2.1/projects/{projects_pk}/documents
bimdata.BcfApi	getBcfProject	GET /bcf/2.1/projects/{id}
bimdata.BcfApi	getBcfProjects	GET /bcf/2.1/projects
bimdata.BcfApi	getBitmap	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/bitmap/{id}
bimdata.BcfApi	getBitmaps	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/bitmap
bimdata.BcfApi	getColoring	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/coloring/{id}
bimdata.BcfApi	getColorings	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/coloring
bimdata.BcfApi	getComment	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/{id}
bimdata.BcfApi	getCommentEvent	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/events/{id}
bimdata.BcfApi	getCommentEvent_0	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/{comments_pk}/events/{id}
bimdata.BcfApi	getCommentEvents	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/events
bimdata.BcfApi	getCommentEvents_0	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/{comments_pk}/events
bimdata.BcfApi	getComments	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments
bimdata.BcfApi	getDocumentReference	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/document_references/{id}
bimdata.BcfApi	getDocumentReferences	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/document_references
bimdata.BcfApi	getExtensions	GET /bcf/2.1/projects/{projects_pk}/extensions
bimdata.BcfApi	getFile	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/file/{id}
bimdata.BcfApi	getFiles	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/file
bimdata.BcfApi	getRelatedTopic	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/related_topics/{id}
bimdata.BcfApi	getRelatedTopics	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/related_topics
bimdata.BcfApi	getSelection	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/selection/{id}
bimdata.BcfApi	getSelections	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/selection
bimdata.BcfApi	getSnapshots	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/snapshot
bimdata.BcfApi	getSnippet	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/snippet/{id}
bimdata.BcfApi	getSnippets	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/snippet
bimdata.BcfApi	getTopic	GET /bcf/2.1/projects/{projects_pk}/topics/{id}
bimdata.BcfApi	getTopicEvent	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/events/{id}
bimdata.BcfApi	getTopicEvents	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/events
bimdata.BcfApi	getTopics	GET /bcf/2.1/projects/{projects_pk}/topics
bimdata.BcfApi	getVersion	GET /bcf/versions/{id}
bimdata.BcfApi	getVersions	GET /bcf/versions
bimdata.BcfApi	getViewpoint	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{id}
bimdata.BcfApi	getViewpoints	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints
bimdata.BcfApi	getVisibilities	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/visibility
bimdata.BcfApi	getVisibility	GET /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/visibility/{id}
bimdata.BcfApi	updateBcfDocument	PATCH /bcf/2.1/projects/{projects_pk}/documents/{id}
bimdata.BcfApi	updateBcfProject	PATCH /bcf/2.1/projects/{id}
bimdata.BcfApi	updateBitmap	PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/bitmap/{id}
bimdata.BcfApi	updateColoring	PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/coloring/{id}
bimdata.BcfApi	updateComment	PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/{id}
bimdata.BcfApi	updateCommentEvent	PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/events/{id}
bimdata.BcfApi	updateCommentEvent_0	PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/comments/{comments_pk}/events/{id}
bimdata.BcfApi	updateDocumentReference	PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/document_references/{id}
bimdata.BcfApi	updateFile	PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/file/{id}
bimdata.BcfApi	updateRelatedTopic	PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/related_topics/{id}
bimdata.BcfApi	updateSelection	PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/selection/{id}
bimdata.BcfApi	updateSnippet	PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/snippet/{id}
bimdata.BcfApi	updateTopic	PATCH /bcf/2.1/projects/{projects_pk}/topics/{id}
bimdata.BcfApi	updateTopicEvent	PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/events/{id}
bimdata.BcfApi	updateVersion	PATCH /bcf/versions/{id}
bimdata.BcfApi	updateViewpoint	PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{id}
bimdata.BcfApi	updateVisibility	PATCH /bcf/2.1/projects/{projects_pk}/topics/{topics_pk}/viewpoints/{viewpoints_pk}/visibility/{id}
bimdata.CheckplanApi	createChecker	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker
bimdata.CheckplanApi	createCheckerResult	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result
bimdata.CheckplanApi	createCheckplan	POST /cloud/{cloud_pk}/project/{project_pk}/checkplan
bimdata.CheckplanApi	createRule	POST /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule
bimdata.CheckplanApi	createRuleComponent	POST /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent
bimdata.CheckplanApi	createRuleset	POST /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset
bimdata.CheckplanApi	deleteChecker	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id}
bimdata.CheckplanApi	deleteCheckerResult	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id}
bimdata.CheckplanApi	deleteCheckplan	DELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id}
bimdata.CheckplanApi	deleteRule	DELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id}
bimdata.CheckplanApi	deleteRuleComponent	DELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id}
bimdata.CheckplanApi	deleteRuleset	DELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id}
bimdata.CheckplanApi	fullUpdateChecker	PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id}
bimdata.CheckplanApi	fullUpdateCheckerResult	PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id}
bimdata.CheckplanApi	fullUpdateCheckplan	PUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id}
bimdata.CheckplanApi	fullUpdateRule	PUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id}
bimdata.CheckplanApi	fullUpdateRuleComponent	PUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id}
bimdata.CheckplanApi	fullUpdateRuleset	PUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id}
bimdata.CheckplanApi	getChecker	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id}
bimdata.CheckplanApi	getCheckerResult	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id}
bimdata.CheckplanApi	getCheckerResults	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result
bimdata.CheckplanApi	getCheckers	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker
bimdata.CheckplanApi	getCheckplan	GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id}
bimdata.CheckplanApi	getCheckplans	GET /cloud/{cloud_pk}/project/{project_pk}/checkplan
bimdata.CheckplanApi	getRule	GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id}
bimdata.CheckplanApi	getRuleComponent	GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id}
bimdata.CheckplanApi	getRuleComponents	GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent
bimdata.CheckplanApi	getRules	GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule
bimdata.CheckplanApi	getRuleset	GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id}
bimdata.CheckplanApi	getRulesets	GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset
bimdata.CheckplanApi	launchNewCheck	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id}/launch-check
bimdata.CheckplanApi	updateChecker	PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id}
bimdata.CheckplanApi	updateCheckerResult	PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id}
bimdata.CheckplanApi	updateCheckplan	PATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id}
bimdata.CheckplanApi	updateRule	PATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id}
bimdata.CheckplanApi	updateRuleComponent	PATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id}
bimdata.CheckplanApi	updateRuleset	PATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id}
bimdata.CloudApi	createCloud	POST /cloud
bimdata.CloudApi	createCloudUser	POST /cloud/{cloud_pk}/user
bimdata.CloudApi	deleteCloudUser	DELETE /cloud/{cloud_pk}/user/{id}
bimdata.CloudApi	fullUpdateCloud	PUT /cloud/{id}
bimdata.CloudApi	fullUpdateCloudUser	PUT /cloud/{cloud_pk}/user/{id}
bimdata.CloudApi	getCloud	GET /cloud/{id}
bimdata.CloudApi	getCloudSize	GET /cloud/{id}/size
bimdata.CloudApi	getCloudUser	GET /cloud/{cloud_pk}/user/{id}
bimdata.CloudApi	getCloudUsers	GET /cloud/{cloud_pk}/user
bimdata.CloudApi	getClouds	GET /cloud
bimdata.CloudApi	updateCloud	PATCH /cloud/{id}
bimdata.CloudApi	updateCloudUser	PATCH /cloud/{cloud_pk}/user/{id}
bimdata.IfcApi	bulkDeleteIfcClassifications	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/list_destroy
bimdata.IfcApi	bulkDeleteIfcProperties	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/bulk_destroy
bimdata.IfcApi	bulkDeleteIfcPropertyDefinitions	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/bulk_destroy
bimdata.IfcApi	bulkDeleteIfcUnits	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/bulk_destroy
bimdata.IfcApi	bulkDeletePropertySet	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/bulk_destroy
bimdata.IfcApi	bulkFullUpdateElements	PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/bulk_update
bimdata.IfcApi	bulkFullUpdateIfcProperty	PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/bulk_update
bimdata.IfcApi	bulkRemoveClassificationsOfElement	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/classification/bulk_destroy
bimdata.IfcApi	bulkRemoveElementsFromClassification	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/{ifc_classification_pk}/element/bulk_destroy
bimdata.IfcApi	bulkUpdateElements	PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/bulk_update
bimdata.IfcApi	bulkUpdateIfcProperty	PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/bulk_update
bimdata.IfcApi	createClassificationElementRelations	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification-element
bimdata.IfcApi	createClassificationsOfElement	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/classification
bimdata.IfcApi	createElement	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element
bimdata.IfcApi	createElementPropertySet	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset
bimdata.IfcApi	createElementPropertySetProperty	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property
bimdata.IfcApi	createElementPropertySetPropertyDefinition	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition
bimdata.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
bimdata.IfcApi	createIfcPropertyDefinition	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition
bimdata.IfcApi	createIfcUnit	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit
bimdata.IfcApi	createPropertySet	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset
bimdata.IfcApi	createPropertySetElementRelations	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset-element
bimdata.IfcApi	createRawElements	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/raw
bimdata.IfcApi	createSpace	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space
bimdata.IfcApi	createZone	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone
bimdata.IfcApi	createZoneSpace	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space
bimdata.IfcApi	deleteElement	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid}
bimdata.IfcApi	deleteIfc	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}
bimdata.IfcApi	deleteIfcProperty	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id}
bimdata.IfcApi	deleteIfcPropertyDefinition	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id}
bimdata.IfcApi	deleteIfcUnit	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/{id}
bimdata.IfcApi	deletePropertySet	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/{id}
bimdata.IfcApi	deleteSpace	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space/{id}
bimdata.IfcApi	deleteZone	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id}
bimdata.IfcApi	deleteZoneSpace	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id}
bimdata.IfcApi	fullUpdateElement	PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid}
bimdata.IfcApi	fullUpdateIfc	PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}
bimdata.IfcApi	fullUpdateIfcProperty	PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id}
bimdata.IfcApi	fullUpdateIfcPropertyDefinition	PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id}
bimdata.IfcApi	fullUpdateIfcUnit	PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/{id}
bimdata.IfcApi	fullUpdatePropertySet	PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/{id}
bimdata.IfcApi	fullUpdateSpace	PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space/{id}
bimdata.IfcApi	fullUpdateZone	PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id}
bimdata.IfcApi	fullUpdateZoneSpace	PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id}
bimdata.IfcApi	getClassificationsOfElement	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/classification
bimdata.IfcApi	getElement	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid}
bimdata.IfcApi	getElementPropertySet	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{id}
bimdata.IfcApi	getElementPropertySetProperties	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property
bimdata.IfcApi	getElementPropertySetProperty	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id}
bimdata.IfcApi	getElementPropertySetPropertyDefinition	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{id}
bimdata.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}
bimdata.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
bimdata.IfcApi	getElementPropertySetPropertyDefinitions	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition
bimdata.IfcApi	getElementPropertySets	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset
bimdata.IfcApi	getElements	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element
bimdata.IfcApi	getElementsFromClassification	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/{ifc_classification_pk}/element
bimdata.IfcApi	getIfc	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}
bimdata.IfcApi	getIfcBVH	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/bvh
bimdata.IfcApi	getIfcClassifications	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification
bimdata.IfcApi	getIfcGLTF	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/gltf
bimdata.IfcApi	getIfcMap	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/map
bimdata.IfcApi	getIfcProperties	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property
bimdata.IfcApi	getIfcProperty	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id}
bimdata.IfcApi	getIfcPropertyDefinition	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id}
bimdata.IfcApi	getIfcPropertyDefinitions	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition
bimdata.IfcApi	getIfcStructure	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/structure
bimdata.IfcApi	getIfcSystems	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/systems
bimdata.IfcApi	getIfcUnit	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/{id}
bimdata.IfcApi	getIfcUnits	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit
bimdata.IfcApi	getIfcs	GET /cloud/{cloud_pk}/project/{project_pk}/ifc
bimdata.IfcApi	getPropertySet	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/{id}
bimdata.IfcApi	getPropertySets	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset
bimdata.IfcApi	getRawElements	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/raw
bimdata.IfcApi	getSpace	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space/{id}
bimdata.IfcApi	getSpaces	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space
bimdata.IfcApi	getZone	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id}
bimdata.IfcApi	getZoneSpace	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id}
bimdata.IfcApi	getZoneSpaces	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space
bimdata.IfcApi	getZones	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone
bimdata.IfcApi	removeClassificationOfElement	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/classification/{id}
bimdata.IfcApi	removeElementPropertySet	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{id}
bimdata.IfcApi	removeElementPropertySetProperty	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{id}
bimdata.IfcApi	removeElementPropertySetPropertyDefinition	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{element_uuid}/propertyset/{propertyset_pk}/property/{property_pk}/propertydefinition/{id}
bimdata.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}
bimdata.IfcApi	removeElementsFromClassification	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/classification/{ifc_classification_pk}/element/{uuid}
bimdata.IfcApi	updateElement	PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/element/{uuid}
bimdata.IfcApi	updateIfc	PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}
bimdata.IfcApi	updateIfcFiles	PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{id}/files
bimdata.IfcApi	updateIfcProperty	PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/property/{id}
bimdata.IfcApi	updateIfcPropertyDefinition	PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertydefinition/{id}
bimdata.IfcApi	updateIfcUnit	PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/unit/{id}
bimdata.IfcApi	updatePropertySet	PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/propertyset/{id}
bimdata.IfcApi	updateSpace	PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/space/{id}
bimdata.IfcApi	updateZone	PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{id}
bimdata.IfcApi	updateZoneSpace	PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/zone/{zone_pk}/space/{id}
bimdata.ProjectApi	createClassification	POST /cloud/{cloud_pk}/project/{project_pk}/classification
bimdata.ProjectApi	createDocument	POST /cloud/{cloud_pk}/project/{project_pk}/document
bimdata.ProjectApi	createFolder	POST /cloud/{cloud_pk}/project/{project_pk}/folder
bimdata.ProjectApi	createProject	POST /cloud/{cloud_pk}/project
bimdata.ProjectApi	createProjectUser	POST /cloud/{cloud_pk}/project/{project_pk}/user
bimdata.ProjectApi	deleteClassification	DELETE /cloud/{cloud_pk}/project/{project_pk}/classification/{id}
bimdata.ProjectApi	deleteDocument	DELETE /cloud/{cloud_pk}/project/{project_pk}/document/{id}
bimdata.ProjectApi	deleteFolder	DELETE /cloud/{cloud_pk}/project/{project_pk}/folder/{id}
bimdata.ProjectApi	deleteProject	DELETE /cloud/{cloud_pk}/project/{id}
bimdata.ProjectApi	deleteProjectUser	DELETE /cloud/{cloud_pk}/project/{project_pk}/user/{id}
bimdata.ProjectApi	fullUpdateClassification	PUT /cloud/{cloud_pk}/project/{project_pk}/classification/{id}
bimdata.ProjectApi	fullUpdateDocument	PUT /cloud/{cloud_pk}/project/{project_pk}/document/{id}
bimdata.ProjectApi	fullUpdateFolder	PUT /cloud/{cloud_pk}/project/{project_pk}/folder/{id}
bimdata.ProjectApi	fullUpdateProject	PUT /cloud/{cloud_pk}/project/{id}
bimdata.ProjectApi	fullUpdateProjectUser	PUT /cloud/{cloud_pk}/project/{project_pk}/user/{id}
bimdata.ProjectApi	getClassification	GET /cloud/{cloud_pk}/project/{project_pk}/classification/{id}
bimdata.ProjectApi	getClassifications	GET /cloud/{cloud_pk}/project/{project_pk}/classification
bimdata.ProjectApi	getDocument	GET /cloud/{cloud_pk}/project/{project_pk}/document/{id}
bimdata.ProjectApi	getDocuments	GET /cloud/{cloud_pk}/project/{project_pk}/document
bimdata.ProjectApi	getFolder	GET /cloud/{cloud_pk}/project/{project_pk}/folder/{id}
bimdata.ProjectApi	getFolders	GET /cloud/{cloud_pk}/project/{project_pk}/folder
bimdata.ProjectApi	getProject	GET /cloud/{cloud_pk}/project/{id}
bimdata.ProjectApi	getProjectTree	GET /cloud/{cloud_pk}/project/{id}/tree
bimdata.ProjectApi	getProjectUser	GET /cloud/{cloud_pk}/project/{project_pk}/user/{id}
bimdata.ProjectApi	getProjectUsers	GET /cloud/{cloud_pk}/project/{project_pk}/user
bimdata.ProjectApi	getProjects	GET /cloud/{cloud_pk}/project
bimdata.ProjectApi	updateClassification	PATCH /cloud/{cloud_pk}/project/{project_pk}/classification/{id}
bimdata.ProjectApi	updateDocument	PATCH /cloud/{cloud_pk}/project/{project_pk}/document/{id}
bimdata.ProjectApi	updateFolder	PATCH /cloud/{cloud_pk}/project/{project_pk}/folder/{id}
bimdata.ProjectApi	updateProject	PATCH /cloud/{cloud_pk}/project/{id}
bimdata.ProjectApi	updateProjectUser	PATCH /cloud/{cloud_pk}/project/{project_pk}/user/{id}
bimdata.UserApi	askResetPasswordToken	POST /user/forgot-password
bimdata.UserApi	fullUpdateNotification	PUT /user/notification/{id}
bimdata.UserApi	getNotification	GET /user/notification/{id}
bimdata.UserApi	getSelfNotifications	GET /user/notification
bimdata.UserApi	getSelfProjects	GET /user/projects
bimdata.UserApi	getSelfUser	GET /user
bimdata.UserApi	resetPassword	POST /user/reset-password
bimdata.UserApi	signUp	POST /user/signup
bimdata.UserApi	signUpWithInvitationToken	POST /user/invited-signup
bimdata.UserApi	updateNotification	PATCH /user/notification/{id}
bimdata.UserApi	updateSelfUser	PATCH /user

Documentation for Models

• bimdata.ActionEvent
• bimdata.BcfProject
• bimdata.BimSnippet
• bimdata.Bitmap
• bimdata.CheckPlan
• bimdata.CheckerResult
• bimdata.Classification
• bimdata.ClippingPlane
• bimdata.Cloud
• bimdata.Coloring
• bimdata.Comment
• bimdata.CommentAction
• bimdata.CommentEvent
• bimdata.Component
• bimdata.ComponentsParent
• bimdata.Direction
• bimdata.Document
• bimdata.DocumentReference
• bimdata.Element
• bimdata.ElementClassificationRelation
• bimdata.ElementPropertySetRelation
• bimdata.EventAction
• bimdata.Extensions
• bimdata.Feature
• bimdata.Folder
• bimdata.FosUser
• bimdata.FosUserWrite
• bimdata.Ifc
• bimdata.IfcChecker
• bimdata.IfcCheckerCheckplan
• bimdata.IfcCheckerIfc
• bimdata.IfcCheckerResults
• bimdata.IfcCreator
• bimdata.IfcDocument
• bimdata.IfcFiles
• bimdata.IfcProject
• bimdata.Label
• bimdata.LineSeriaizer
• bimdata.Notification
• bimdata.OrthogonalCamera
• bimdata.PerspectiveCamera
• bimdata.Point
• bimdata.Priority
• bimdata.Project
• bimdata.ProjectAction
• bimdata.ProjectRootFolder
• bimdata.Property
• bimdata.PropertyDefinition
• bimdata.PropertySet
• bimdata.ReferenceLink
• bimdata.RelatedTopic
• bimdata.Rule
• bimdata.RuleComponent
• bimdata.RuleComponentResult
• bimdata.RuleResult
• bimdata.Ruleset
• bimdata.RulesetResult
• bimdata.SelfUser
• bimdata.SignupFosUser
• bimdata.Snapshot
• bimdata.SnippetType
• bimdata.Space
• bimdata.Stage
• bimdata.Topic
• bimdata.TopicAction
• bimdata.TopicEvents
• bimdata.TopicStatus
• bimdata.TopicType
• bimdata.Unit
• bimdata.User
• bimdata.Version
• bimdata.ViewSetupHints
• bimdata.Viewpoint
• bimdata.Visibility
• bimdata.Zone
• bimdata.ZoneSpace

Documentation for Authorization

Bearer

• Type: API key
• API key parameter name: access_token
• Location: URL query string