bimdata - JavaScript client for @bimdata/bimdata-api-client BIMData API is a tool to interact with your models stored on BIMData’s servers. Through the API, you can manage your projects, the clouds, upload your IFC files and manage them through endpoints. This SDK is automatically generated by the OpenAPI Generator project:

• API version: v1
• Package version: 0.0.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

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

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.

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

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.

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
      }
    }
  ]
}

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['Authorization'] = "Token"

var api = new bimdata.ApplicationApi()
var cloudPk = "cloudPk_example"; // {String} 
var id = "id_example"; // {String} 
var webHook = new bimdata.WebHook(); // {WebHook} 
api.cloudWebhookPing(cloudPk, id, webHook).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

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

• bimdata.BcfProject
• bimdata.BcfUser
• bimdata.CheckPlan
• bimdata.CheckerResult
• bimdata.Classification
• bimdata.ClippingPlane
• bimdata.Cloud
• bimdata.CloudInvitation
• bimdata.CloudRole
• bimdata.Coloring
• bimdata.Comment
• bimdata.Component
• bimdata.ComponentsParent
• bimdata.Direction
• bimdata.Document
• bimdata.Element
• bimdata.ElementClassificationRelation
• bimdata.ElementPropertySetRelation
• bimdata.Extensions
• bimdata.Feature
• bimdata.Folder
• bimdata.Ifc
• bimdata.IfcChecker
• bimdata.IfcCheckerCheckplan
• bimdata.IfcCheckerResults
• bimdata.IfcFiles
• bimdata.Label
• bimdata.LineSeriaizer
• bimdata.OrthogonalCamera
• bimdata.PerspectiveCamera
• bimdata.Point
• bimdata.Priority
• bimdata.Project
• bimdata.ProjectInvitation
• bimdata.ProjectRole
• bimdata.Property
• bimdata.PropertyDefinition
• bimdata.PropertySet
• bimdata.RawDefinition
• bimdata.RawElement
• bimdata.RawElements
• bimdata.RawProperty
• bimdata.RawPropertySet
• bimdata.RawUnit
• bimdata.Rule
• bimdata.RuleComponent
• bimdata.Ruleset
• bimdata.SelfBcfUser
• bimdata.SelfUser
• bimdata.SingleJsonTopic
• bimdata.Snapshot
• bimdata.Space
• bimdata.Stage
• bimdata.Topic
• bimdata.TopicStatus
• bimdata.TopicType
• bimdata.Unit
• bimdata.User
• bimdata.UserCloudUpdate
• bimdata.UserProjectUpdate
• bimdata.ViewSetupHints
• bimdata.Viewpoint
• bimdata.Visibility
• bimdata.WebHook
• bimdata.Zone
• bimdata.ZoneSpace

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