Class DesignAutomationClient

Client providing access to Autodesk Forge automation APIs.

Tutorial

design-automation

Hierarchy (view full)

Constructors

  • Initializes new client with specific authentication method.

    Parameters

    • auth: IAuthOptions

      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: string

      Forge API host.

    • Optional _region: Region
    • Optional region: DesignAutomationRegion

      Design Automation specific availability region.

    Returns DesignAutomationClient

    Deprecated

    Will be removed in next major version.

Properties

axios: AxiosInstance
host: string
region: Region
root: string
token?: string

Methods

  • Parameters

    • endpoint: string
    • scopes: string[]

    Returns Promise<any>

  • Parameters

    • endpoint: string
    • scopes: string[]

    Returns AsyncGenerator<any, void, unknown>

  • Parameters

    • activityId: string

      Activity ID.

    • Optional args: {
          [name: string]: IWorkItemParam;
      }

      Arguments to pass in as activity parameters.

    • Optional signatures: {
          activityId?: string;
          baseUrls?: {
              signature: string;
              url: string;
          };
      }

      Signatures.

      • Optional activityId?: string
      • Optional baseUrls?: {
            signature: string;
            url: string;
        }
        • signature: string
        • url: string
    • Optional limitProcessingTimeSec: number

      limit of max processing time in seconds.

    Returns Promise<any>

    Async

  • Parameters

    • endpoint: string
    • headers: {
          [name: string]: string;
      } = {}
      • [name: string]: string
    • scopes: string[]

    Returns Promise<any>

  • Parameters

    • config: AxiosRequestConfig<any>

    Returns Promise<AxiosResponse<any, any>>

  • Parameters

    • endpoint: string
    • headers: {
          [name: string]: string;
      } = {}
      • [name: string]: string
    • scopes: string[]

    Returns Promise<any>

  • Parameters

    • endpoint: string
    • headers: {
          [name: string]: string;
      } = {}
      • [name: string]: string
    • scopes: string[]

    Returns Promise<any>

  • Parameters

    • endpoint: string
    • headers: {
          [name: string]: string;
      } = {}
      • [name: string]: string
    • scopes: string[]

    Returns Promise<any>

  • Parameters

    • endpoint: string
    • data: any
    • headers: {
          [name: string]: string;
      } = {}
      • [name: string]: string
    • scopes: string[]

    Returns Promise<any>

  • Parameters

    • endpoint: string
    • data: any
    • headers: {
          [name: string]: string;
      } = {}
      • [name: string]: string
    • scopes: string[]

    Returns Promise<any>

  • Parameters

    • endpoint: string
    • data: any
    • headers: {
          [name: string]: string;
      } = {}
      • [name: string]: string
    • scopes: string[]

    Returns Promise<any>

  • Resets client to specific authentication method, Forge host, and availability region.

    Parameters

    • Optional auth: IAuthOptions

      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: string

      Forge API host.

    • Optional _region: Region
    • Optional region: DesignAutomationRegion

      Design Automation specific availability region.

    Returns void

    Deprecated

    Will be removed in next major version.

  • Parameters

    • id: string

      New activity ID.

    • engine: string

      ID of one of the supported engines.

    • commands: string | string[]

      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: {
          [key: string]: IActivityParam;
      }

      Input/output parameter descriptors.

    • Optional settings: {
          [key: string]: any;
      }

      Additional activity settings.

      • [key: string]: any
    • Optional description: string

      Activity description.

    Returns Promise<IActivityDetail>

    Details of created activity.

    Async

  • Uploads zip file with contents of a specific app bundle.

    Parameters

    Returns Promise<any>

    Response from the file submission.

    Async

    Example

    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