forge-model-derivative

Asynchronous Javascript/Node.js library for the Autodesk Forge Model Derivative API.


Keywords
framework, lmv, forge, autodesk, rest, restful, api
License
MIT
Install
npm install forge-model-derivative@2.1.1

Documentation

This package is now deprecated, please use the official SDK

This version is using the official SDK in the background

build status Node.js npm Platforms License

Forge API: oAuth2 Data-Management OSS Model-Derivative Viewer

forge-model-derivative

Asynchronous Javascript/Node.js library for the Autodesk Forge Model Derivative API.

This SDK was generated from YAML using a modified version of the Swagger tools. Modified version located here.

Samples using this SDKs available here.

Installation

npm

npm install forge-model-derivative --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):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

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

This libray can either use callbacks or Promises. Do not provide a callback parameter to use Promises.

callback version

var ForgeModelDerivative =require ('forge-model-derivative') ;

var defaultClient =ForgeModelDerivative.ApiClient.instance ;

// Configure OAuth2 access token for authorization: oauth2_access_code
var oauth2_access_code =defaultClient.authentications ['oauth2_access_code'] ;
oauth2_access_code.accessToken ="YOUR ACCESS TOKEN" ;

// Configure OAuth2 access token for authorization: oauth2_application
var oauth2_application =defaultClient.authentications ['oauth2_application'] ;
oauth2_application.accessToken ="YOUR ACCESS TOKEN" ;

var api =new ForgeModelDerivative.DerivativesApi()
 ;
var urn ="urn_example" ; // {String} The Base64 (URL Safe) encoded design URN 


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

Promise version

var ForgeModelDerivative =require ('forge-model-derivative') ;

var defaultClient =ForgeModelDerivative.ApiClient.instance ;

// Configure OAuth2 access token for authorization: oauth2_access_code
var oauth2_access_code =defaultClient.authentications ['oauth2_access_code'] ;
oauth2_access_code.accessToken ="YOUR ACCESS TOKEN" ;

// Configure OAuth2 access token for authorization: oauth2_application
var oauth2_application =defaultClient.authentications ['oauth2_application'] ;
oauth2_application.accessToken ="YOUR ACCESS TOKEN" ;

var api =new ForgeModelDerivative.DerivativesApi()
 ;
var urn ="urn_example" ; // {String} The Base64 (URL Safe) encoded design URN 


api.deleteManifest(urn).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/

Class Method HTTP request Description
ForgeModelDerivative.DerivativesApi deleteManifest DELETE /modelderivative/v2/designdata/{urn}/manifest
ForgeModelDerivative.DerivativesApi getDerivativeManifest GET /modelderivative/v2/designdata/{urn}/manifest/{derivativeUrn}
ForgeModelDerivative.DerivativesApi getFormats GET /modelderivative/v2/designdata/formats
ForgeModelDerivative.DerivativesApi getManifest GET /modelderivative/v2/designdata/{urn}/manifest
ForgeModelDerivative.DerivativesApi getMetadata GET /modelderivative/v2/designdata/{urn}/metadata
ForgeModelDerivative.DerivativesApi getModelviewMetadata GET /modelderivative/v2/designdata/{urn}/metadata/{guid}
ForgeModelDerivative.DerivativesApi getModelviewProperties GET /modelderivative/v2/designdata/{urn}/metadata/{guid}/properties
ForgeModelDerivative.DerivativesApi getThumbnail GET /modelderivative/v2/designdata/{urn}/thumbnail
ForgeModelDerivative.DerivativesApi translate POST /modelderivative/v2/designdata/job

Documentation for Models

Documentation for Authorization

oauth2_access_code

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://developer.api.autodesk.com/authentication/v1/authorize
  • Scopes:
    • data:read: The application will be able to read the end user’s data within the Autodesk ecosystem.
    • data:write: The application will be able to create, update, and delete data on behalf of the end user within the Autodesk ecosystem.
    • data:create: The application will be able to create data on behalf of the end user within the Autodesk ecosystem.
    • data:search: The application will be able to search the end user’s data within the Autodesk ecosystem.
    • bucket:create: The application will be able to create an OSS bucket it will own.
    • bucket:read: The application will be able to read the metadata and list contents for OSS buckets that it has access to.
    • bucket:update: The application will be able to set permissions and entitlements for OSS buckets that it has permission to modify.
    • bucket:delete: The application will be able to delete a bucket that it has permission to delete.
    • code:all: The application will be able to author and execute code on behalf of the end user (e.g., scripts processed by the Design Automation API).
    • account:read: For Product APIs, the application will be able to read the account data the end user has entitlements to.
    • account:write: For Product APIs, the application will be able to update the account data the end user has entitlements to.
    • user-profile:read: The application will be able to read the end user’s profile data.

oauth2_application

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
    • data:read: The application will be able to read the end user’s data within the Autodesk ecosystem.
    • data:write: The application will be able to create, update, and delete data on behalf of the end user within the Autodesk ecosystem.
    • data:create: The application will be able to create data on behalf of the end user within the Autodesk ecosystem.
    • data:search: The application will be able to search the end user’s data within the Autodesk ecosystem.
    • bucket:create: The application will be able to create an OSS bucket it will own.
    • bucket:read: The application will be able to read the metadata and list contents for OSS buckets that it has access to.
    • bucket:update: The application will be able to set permissions and entitlements for OSS buckets that it has permission to modify.
    • bucket:delete: The application will be able to delete a bucket that it has permission to delete.
    • code:all: The application will be able to author and execute code on behalf of the end user (e.g., scripts processed by the Design Automation API).
    • account:read: For Product APIs, the application will be able to read the account data the end user has entitlements to.
    • account:write: For Product APIs, the application will be able to update the account data the end user has entitlements to.
    • user-profile:read: The application will be able to read the end user’s profile data.

Documentation & Support

For more information, please visit https://developer.autodesk.com/en/docs/model-derivative/v2/

For support, please use http://stackoverflow.com/questions/tagged/autodesk-model-derivative


License

This SDK is licensed under the terms of the MIT License. Please see the LICENSE file for full details.