Initializes new client with specific authentication method.
Authentication object,
containing either client_id
and client_secret
properties (for 2-legged authentication),
or a single token
property (for 2-legged or 3-legged authentication with pre-generated access token).
Optional
host: stringForge API host.
Optional
_region: RegionOptional
region: DesignAutomationRegionDesign Automation specific availability region.
Will be removed in next major version.
Protected
Optional
authProtected
axiosProtected
hostProtected
regionProtected
rootProtected
Optional
tokenPrivate
_collectPrivate
_pagerCreates new activity (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-POST|docs).
New activity ID.
ID of one of the supported engines.
One or more CLI commands to be executed within the activity.
Optional
appBundleIDs: string | string[]Fully qualified IDs of zero or more app bundles used by the activity.
Optional
parameters: { Input/output parameter descriptors.
Optional
settings: { Additional activity settings.
Optional
description: stringActivity description.
Details of created activity.
Creates new alias for an activity (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-id-aliases-POST|docs).
Activity ID.
New alias name.
Activity version to link to this alias.
Optional
receiver: stringOptional ID of another Forge application to share this activity with.
Details of created alias.
Creates a new app bundle (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-POST|docs).
Unique name of the bundle.
ID of one of the supported engines.
Optional
settings: { Additional app bundle settings.
Optional
description: stringApp bundle description.
Details of the created app bundle, incl. parameters for uploading the actual zip file with app bundle binaries.
Error when the request fails, for example, due to insufficient rights.
Creates new alias for an app bundle (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-id-aliases-POST/|docs).
Name of the app bundle.
Alias name.
Version of app bundle to link to this alias.
Optional
receiver: stringOptional ID of another Forge application to share this app bundle with.
Details of the created alias.
Error when the request fails, for example, due to insufficient rights.
Creates new work item (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/workitems-POST|docs).
Activity ID.
Optional
args: { Arguments to pass in as activity parameters.
Optional
signatures: { Signatures.
Optional
activityOptional
baseOptional
limitProcessingTimeSec: numberlimit of max processing time in seconds.
Protected
deleteDeletes activity and all its versions and aliases (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-id-DELETE|docs).
Short (unqualified) activity ID.
Deletes activity alias (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-id-aliases-aliasId-DELETE|docs).
Short (unqualified) activity ID.
Activity alias.
Deletes activity version (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-id-versions-version-DELETE|docs).
Short (unqualified) activity ID.
Activity version.
Deletes app bundle and all its versions and aliases (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-id-DELETE|docs).
Short (unqualified) app bundle ID.
Deletes app bundle alias (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-id-aliases-aliasId-DELETE|docs).
Short (unqualified) app bundle ID.
App bundle alias.
Deletes app bundle version (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-id-versions-version-DELETE|docs).
Short (unqualified) app bundle ID.
App bundle version.
Removes current nickname for all your Design Automation entities (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/design-automation-forgeapps-id-DELETE|docs).
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Cancels work item, removing it from waiting queue or cancelling a running job (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/workitems-id-DELETE|docs).
Work item ID.
Protected
fetchProtected
getGets single activity details (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-id-GET|docs).
Fully qualified activity ID.
Activity details.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Gets single activity version details (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-id-versions-version-GET|docs).
Short (unqualified) activity ID.
Activity version.
Activity details.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Gets single appbundle details (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-id-GET|docs).
Fully qualified appbundle ID.
Appbundle details.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Gets single appbundle version details (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-id-versions-version-GET|docs).
Short (unqualified) app bundle ID.
App bundle version.
Appbundle details.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Protected
getGets single engine details (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/engines-id-GET|docs).
Fully qualified engine ID.
Engine details.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Gets current nickname for all your Design Automation entities (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/design-automation-forgeapps-id-GET|docs).
Current nickname.
Protected
getGets details of a specific work item (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/workitems-id-GET|docs).
Work item ID.
Work item details.
Error when the request fails, for example, due to insufficient rights.
Iterates over all activities in pages of predefined size (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-GET|docs).
List of activity (full) IDs.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Iterates over all activity aliases in pages of predefined size (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-id-aliases-GET|docs).
Unique name of activity.
List of activity alias objects.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Iterates over all activity versions in pages of predefined size (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-id-versions-GET|docs).
Unique name of activity.
List of activity versions.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Iterates over all app bundle aliases in pages of predefined size (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-id-aliases-GET|docs).
Unique name of the bundle.
List of appbundle alias objects.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Iterates over all app bundle versions in pages of predefined size (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-id-versions-GET|docs).
Unique name of the bundle.
List of appbundle version numbers.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Iterates over all app bundles in pages of predefined size (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-GET|docs).
List of appbundle (full) IDs.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Iterates over all engines in pages of predefined size (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/engines-GET|docs).
List of engine (full) IDs.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Gets a list of all activities (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-GET|docs).
List of activity (full) IDs.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Gets a list of all activity aliases (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-id-aliases-GET|docs).
Unique name of activity.
List of activity alias objects.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Gets a list of all activity versions (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-id-versions-GET|docs).
Unique name of activity.
List of activity versions.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Gets a list of all appbundle aliases (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-id-aliases-GET|docs).
Unique name of the bundle.
List of appbundle alias objects.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Gets a list of all appbundle versions (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-id-versions-GET|docs).
Unique name of the bundle.
List of appbundle version numbers.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Gets a list of all appbundles (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-GET|docs).
List of appbundle (full) IDs.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Gets a list of all engines (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/engines-GET|docs).
List of engine (full) IDs.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Protected
patchProtected
postProtected
putResets client to specific authentication method, Forge host, and availability region.
Optional
auth: IAuthOptionsAuthentication object,
containing either client_id
and client_secret
properties (for 2-legged authentication),
or a single token
property (for 2-legged or 3-legged authentication with pre-generated access token).
Optional
host: stringForge API host.
Optional
_region: RegionOptional
region: DesignAutomationRegionDesign Automation specific availability region.
Will be removed in next major version.
Protected
setSets new nickname for all your Design Automation entities (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/design-automation-forgeapps-id-PATCH|docs).
New nickname.
Error when the request fails, for example, due to insufficient rights, or incorrect scopes.
Updates existing activity, creating its new version (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-id-versions-POST|docs).
New activity ID.
ID of one of the supported engines.
One or more CLI commands to be executed within the activity.
Optional
appBundleIDs: string | string[]Fully qualified IDs of zero or more app bundles used by the activity.
Optional
parameters: { Input/output parameter descriptors.
Optional
settings: { Additional activity settings.
Optional
description: stringActivity description.
Details of created activity.
Updates existing alias for an activity (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/activities-id-aliases-aliasId-PATCH|docs).
Activity ID.
Activity alias.
Activity version to link to this alias.
Optional
receiver: stringOptional ID of another Forge application to share this activity with.
Details of updated alias.
Updates an existing app bundle, creating its new version (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-id-versions-POST|docs).
ID of the app bundle.
Optional
engine: stringID of one of the supported engines.
Optional
settings: { Additional app bundle settings.
Optional
description: stringApp bundle description.
Details of the created app bundle, incl. parameters for uploading the actual zip file with app bundle binaries.
Error when the request fails, for example, due to insufficient rights.
Updates existing alias for an app bundle (https://forge.autodesk.com/en/docs/design-automation/v3/reference/http/appbundles-id-aliases-aliasId-PATCH/|docs).
Name of the app bundle.
Alias name.
Version of app bundle to link to this alias.
Optional
receiver: stringOptional ID of another Forge application to share this app bundle with.
Details of the updated alias.
Error when the request fails, for example, due to insufficient rights.
Uploads zip file with contents of a specific app bundle.
App bundle upload parameters (returned by createAppBundle and updateAppBundle).
Stream to read the app bundle zip from.
Response from the file submission.
const appBundle = await designAutomationClient.createAppBundle('MyAppBundle', 'Autodesk.Inventor+23', 'My App Bundle Description');
const appBundleStream = fs.createReadStream('./MyAppBundle.zip');
await designAutomationClient.uploadAppBundleArchive(appBundle, appBundleStream);
Generated using TypeDoc
Client providing access to Autodesk Forge automation APIs.
Tutorial
design-automation