autodesk.forge.designautomation v3.0.5

autodesk.forge.designautomation

Overview

AutodeskForgeDesignAutomation - Asynchronous Node.js library for the Autodesk Forge Design Automation v3 implementation.

• Package version: 3.0.3
• API version: v3
• API documentation: For more information, please visit https://forge.autodesk.com/en/docs/design-automation/v3/developers_guide/overview/

Requirements

• Node.js 6.3.1 or later
• A registered app on the Forge Developer Portal.

Contributions

Contributions are welcome! Please open a Pull Request.

Support

Please ask questions on StackOverflow with tag autodesk-designautomation tag. If it turns out that you may have found a bug, please open an issue

Tutorials

Please visit Learn Forge tutorial.

Installation

For Node.js

npm

npm package is published on npm. Install this package using following command

npm install autodesk.forge.designautomation --save

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

Configuring ApiClient

User can use default settings or change following properties of ApiClient. 1. CircuitBreaker : Configure the threshold failure count and failure interval of circuit breaker.

Default : Failure Count : 10 Failure interval : 10000 ms

```javascript
    let AutodeskForgeDesignAutomation = require('autodesk.forge.designautomation');
    let config = {
      "circuitBreaker": {
          "threshold": 11,
          "interval": 1200
      }
    };
    let apiClient = new AutodeskForgeDesignAutomation.AutodeskForgeDesignAutomationClient(config);
    let api = new AutodeskForgeDesignAutomation.AutodeskForgeDesignAutomationApi(apiClient)
```

2. Retry : Autodesk resiliency library provides 3 types of retry policies.

   * WAIT : Retry after fixed delay interval.
   * EXPONENTIAL : Retry after exponential delay interval.
   * JITTER : Retry after exponential delay with jitter interval.
   
   User can specify number of retry count and retry policy.
   ```javascript
     let AutodeskForgeDesignAutomation = require('autodesk.forge.designautomation');
     let config = {
         "retry" : {
             "maxNumberOfRetries" :  7,
             "backoffDelay" : 4000,
             "backoffPolicy" : "exponentialBackoffWithJitter"
         }
     };
     let apiClient = new AutodeskForgeDesignAutomation.AutodeskForgeDesignAutomationClient(config);
     let api = new AutodeskForgeDesignAutomation.AutodeskForgeDesignAutomationApi(apiClient)
   ```

3. Timeout : Set request timeout.

   	  let AutodeskForgeDesignAutomation = require('autodesk.forge.designautomation');
   	
       let config = {
           "requestTimeout" : 13000
       };
       let apiClient = new AutodeskForgeDesignAutomation.AutodeskForgeDesignAutomationClient(config);
       let api = new AutodeskForgeDesignAutomation.AutodeskForgeDesignAutomationApi(apiClient)

Getting Started

Please follow the installation instruction and execute the following code:

1. Default api client

let AutodeskForgeDesignAutomation = require('autodesk.forge.designautomation');

let defaultClient = AutodeskForgeDesignAutomation.AutodeskForgeDesignAutomationClient.instance;

// Configure OAuth2 access token for authorization: 2-legged
let oauth = defaultClient.authManager.authentications['2-legged'];
oauth.accessToken = "YOUR ACCESS TOKEN";

// And/Or you can pass fetchToken and refreshToken to manage the token
oauth.fetchToken = function() { return Promise.resolve({accessToken: "token", expiresIn: 300000}) }
oauth.refreshToken = function() { return Promise.resolve({accessToken: "token", expiresIn: 300000}) }

let api = new AutodeskForgeDesignAutomation.AutodeskForgeDesignAutomationApi()

let item = new AutodeskForgeDesignAutomation.Activity(); // {Activity} 

api.createActivity(item).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

2. ApiClient configuration

let AutodeskForgeDesignAutomation = require('autodesk.forge.designautomation');

let config = {
		        "retry" : {
		            "maxNumberOfRetries" :  7,
		            "backoffDelay" : 4000,
		            "backoffPolicy" : "exponentialBackoffWithJitter"
		        },
		        "circuitBreaker": {
		            "threshold": 11,
		            "interval": 1200
		        },
		        "requestTimeout" : 13000
		    };
    
let client = new AutodeskForgeDesignAutomation.AutodeskForgeDesignAutomationClient(config); 


// Configure OAuth2 access token for authorization: 2-legged
let oauth = client.authManager.authentications['2-legged'];
oauth.accessToken = "YOUR ACCESS TOKEN";

// And/Or you can pass fetchToken and refreshToken to manage the token
oauth.fetchToken = function() { return Promise.resolve({accessToken: "token", expiresIn: 300000}) }
oauth.refreshToken = function() { return Promise.resolve({accessToken: "token", expiresIn: 300000}) }


let api = new AutodeskForgeDesignAutomation.AutodeskForgeDesignAutomationApi(client)

let item = new AutodeskForgeDesignAutomation.Activity(); // {Activity} 

api.createActivity(item).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://developer.api.autodesk.com/da/us-east

Documentation for Models

• AutodeskForgeDesignAutomation.Activity
• AutodeskForgeDesignAutomation.Alias
• AutodeskForgeDesignAutomation.AliasPatch
• AutodeskForgeDesignAutomation.AppBundle
• AutodeskForgeDesignAutomation.BackendLimits
• AutodeskForgeDesignAutomation.Engine
• AutodeskForgeDesignAutomation.FrontendLimits
• AutodeskForgeDesignAutomation.IArgument
• AutodeskForgeDesignAutomation.ISetting
• AutodeskForgeDesignAutomation.NicknameRecord
• AutodeskForgeDesignAutomation.PageAlias
• AutodeskForgeDesignAutomation.PageInt32
• AutodeskForgeDesignAutomation.PageShare
• AutodeskForgeDesignAutomation.PageString
• AutodeskForgeDesignAutomation.Parameter
• AutodeskForgeDesignAutomation.PublicKey
• AutodeskForgeDesignAutomation.ServiceLimit
• AutodeskForgeDesignAutomation.Share
• AutodeskForgeDesignAutomation.ShareType
• AutodeskForgeDesignAutomation.SignedUrl
• AutodeskForgeDesignAutomation.Statistics
• AutodeskForgeDesignAutomation.Status
• AutodeskForgeDesignAutomation.UploadAppBundleParameters
• AutodeskForgeDesignAutomation.Verb
• AutodeskForgeDesignAutomation.WorkItem
• AutodeskForgeDesignAutomation.WorkItemSignatures
• AutodeskForgeDesignAutomation.WorkItemStatus
• AutodeskForgeDesignAutomation.StringArgument
• AutodeskForgeDesignAutomation.StringSetting
• AutodeskForgeDesignAutomation.UrlSetting
• AutodeskForgeDesignAutomation.XrefTreeArgument

Documentation for Authorization

2-legged

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
  • code:all: Author or execute your codes

3-legged

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://developer.api.autodesk.com/authentication/v1/authorize
• Scopes:
  • code:all: Author or execute your codes

License

This sample is licensed under the terms of the Apache License 2.0. Please see the LICENSE file for full details.