Asynchronous Javascript/Node.js library for the Autodesk Forge OSS API.
Forge API:
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.
npm install forge-oss --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):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
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.
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) ;
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) ;
}) ;
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 |
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
This SDK is licensed under the terms of the MIT License. Please see the LICENSE file for full details.
FAQs
Asynchronous Javascript/Node.js library for the Autodesk Forge OSS API.
The npm package forge-oss receives a total of 2 weekly downloads. As such, forge-oss popularity was classified as not popular.
We found that forge-oss demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.