This package has been deprecated

Author message:

WARNING: The 'forge-oss' npm package is deprecated in favor of the 'forge-apis' npm package, please upgrade.

forge-oss

This package is now deprecated, please use the official SDK

Forge API:

forge-oss

Asynchronous Javascript/Node.js library for the Autodesk Forge OSS 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-oss --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 ot Promises. Do not provide a callback parameter to use Promises.

callback version

var ForgeOss =require ('forge-oss') ;
 
var defaultClient =ForgeOss.ApiClient.instance ;
 
// Configure OAuth2 access token for authorization: oauth2_application
var oauth2_application =defaultClient.authentications ['oauth2_application'] ;
oauth2_application.accessToken ="YOUR ACCESS TOKEN" ;
 
var api =new ForgeOss.BucketsApi()
 ;
var postBuckets =new ForgeOss.PostBucketsPayload() ; // {PostBucketsPayload} Body Structure
 ;
var opts ={ 
  'xAdsRegion': "US" // {String} The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US` 
};
 
var callback =function (error, data, response) {
  if ( error ) {
    console.error (error) ;
  } else {
    console.log ('API called successfully. Returned data: ' + data) ;
  }
};
api.createBucket(postBuckets, opts, callback) ;
 

Promise version

var ForgeOss =require ('forge-oss') ;
 
var defaultClient =ForgeOss.ApiClient.instance ;
 
// Configure OAuth2 access token for authorization: oauth2_application
var oauth2_application =defaultClient.authentications ['oauth2_application'] ;
oauth2_application.accessToken ="YOUR ACCESS TOKEN" ;
 
var api =new ForgeOss.BucketsApi()
 ;
var postBuckets =new ForgeOss.PostBucketsPayload() ; // {PostBucketsPayload} Body Structure
 ;
var opts ={ 
  'xAdsRegion': "US" // {String} The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US` 
};
 
api.createBucket(postBuckets, opts).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
ForgeOss.BucketsApi	createBucket	POST /oss/v2/buckets
ForgeOss.BucketsApi	deleteBucket	DELETE /oss/v2/buckets/{bucketKey}
ForgeOss.BucketsApi	getBucketDetails	GET /oss/v2/buckets/{bucketKey}/details
ForgeOss.BucketsApi	getBuckets	GET /oss/v2/buckets
ForgeOss.ObjectsApi	copyTo	PUT /oss/v2/buckets/{bucketKey}/objects/{objectName}/copyTo/{newObjName}
ForgeOss.ObjectsApi	createSignedResource	POST /oss/v2/buckets/{bucketKey}/objects/{objectName}/signed
ForgeOss.ObjectsApi	deleteObject	DELETE /oss/v2/buckets/{bucketKey}/objects/{objectName}
ForgeOss.ObjectsApi	deleteSignedResource	DELETE /oss/v2/signedresources/{id}
ForgeOss.ObjectsApi	getObject	GET /oss/v2/buckets/{bucketKey}/objects/{objectName}
ForgeOss.ObjectsApi	getObjectDetails	GET /oss/v2/buckets/{bucketKey}/objects/{objectName}/details
ForgeOss.ObjectsApi	getObjects	GET /oss/v2/buckets/{bucketKey}/objects
ForgeOss.ObjectsApi	getSessionid	GET /oss/v2/buckets/{bucketKey}/objects/{objectName}/status/{sessionId}
ForgeOss.ObjectsApi	getSignedResource	GET /oss/v2/signedresources/{id}
ForgeOss.ObjectsApi	uploadChunk	PUT /oss/v2/buckets/{bucketKey}/objects/{objectName}/resumable
ForgeOss.ObjectsApi	uploadObject	PUT /oss/v2/buckets/{bucketKey}/objects/{objectName}
ForgeOss.ObjectsApi	uploadSignedResource	PUT /oss/v2/signedresources/{id}
ForgeOss.ObjectsApi	uploadSignedResourcesChunk	PUT /oss/v2/signedresources/{id}/resumable

Documentation for Models

• ForgeOss.Bucket
• ForgeOss.BucketPermissions
• ForgeOss.InlineResponse200
• ForgeOss.InlineResponse2001
• ForgeOss.InlineResponse200Items
• ForgeOss.InputStream
• ForgeOss.ObjectDetails
• ForgeOss.ObjectFullDetails
• ForgeOss.ObjectFullDetailsDeltas
• ForgeOss.PostBucketsPayload
• ForgeOss.PostBucketsPayloadAllow
• ForgeOss.PostBucketsSigned
• ForgeOss.PostObjectSigned
• ForgeOss.Reason

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/data/v2/

For support, please use http://stackoverflow.com/questions/tagged/autodesk-data-management

---

License

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