ModelDerivativeClient | simpler-forge-apis

Client providing access to Autodesk Forge Model Derivative APIs.

link: https://forge.autodesk.com/en/docs/model-derivative/v2

Hierarchy

ModelDerivativeClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ModelDerivativeClient(auth: AuthOptions, options?: IClientOptions): ModelDerivativeClient

- Defined in md.ts:201
Parameters
- auth: AuthOptions
- Optional options: IClientOptions
Returns ModelDerivativeClient

Properties

Protected apiClient

apiClient: ApiClient

Protected auth

auth: AuthOptions

Protected authProvider

authProvider: IAuthProvider

Protected derivativesApi

derivativesApi: DerivativesApi

Protected host

host: string

Protected region

region: Region

Methods

deleteManifest

deleteManifest(urn: string): Promise<void>

- Defined in md.ts:248
Deletes manifest and all derivatives associated with it.

link

https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-DELETE

async

throws

Error when the request fails, for example, due to insufficient rights, or incorrect scopes.

Parameters
- urn: string
  
  Document derivative URN.
Returns Promise<void>

getDerivativeContent

getDerivativeContent(modelUrn: string, derivativeUrn: string): Promise<Buffer>

- Defined in md.ts:311
Downloads content of a specific model derivative.

link

https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-derivativeurn-GET

async

throws

Error when the request fails, for example, due to insufficient rights, or incorrect scopes.

Parameters
- modelUrn: string
  
  Model URN.
- derivativeUrn: string
  
  Derivative URN.
Returns Promise<Buffer>

Derivative content.

getDerivativeProperties

getDerivativeProperties(urn: string, guid: string, objectId?: number, forceLargeResult?: boolean, forceRebuild?: boolean): Promise<IDerivativeProperties>

- Defined in md.ts:296
Retrieves properties of a specific derivative.

link

https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-metadata-guid-properties-GET

async

throws

Error when the request fails, for example, due to insufficient rights.

Parameters
- urn: string
  
  Document derivative URN.
- guid: string
  
  Viewable GUID.
- Optional objectId: number
  
  Optional ID of a single object to retrieve the properties for.
- Optional forceLargeResult: boolean
- Optional forceRebuild: boolean
Returns Promise<IDerivativeProperties>

Viewable properties.

getDerivativeSize

getDerivativeSize(modelUrn: string, derivativeUrn: string): Promise<number>

- Defined in md.ts:326
Retrieves size (in bytes) of a specific model derivative.

link

https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-derivativeurn-HEAD

async

throws

Error when the request fails, for example, due to insufficient rights, or incorrect scopes.

Parameters
- modelUrn: string
  
  Model URN.
- derivativeUrn: string
  
  Derivative URN.
Returns Promise<number>

Derivative size in bytes.

getDerivativeTree

getDerivativeTree(urn: string, guid: string, forceLargeResult?: boolean, forceRebuild?: boolean): Promise<IDerivativeTree>

- Defined in md.ts:278
Retrieves object tree of a specific derivative.

link

https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-metadata-guid-GET

async

throws

Error when the request fails, for example, due to insufficient rights.

Parameters
- urn: string
  
  Document derivative URN.
- guid: string
  
  Viewable GUID.
- Optional forceLargeResult: boolean
- Optional forceRebuild: boolean
Returns Promise<IDerivativeTree>

Viewable object tree.

getFormats

getFormats(): Promise<IDerivativeFormats>

- Defined in md.ts:221
Gets a list of supported translation formats.

link

https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/formats-GET

async

yields

{Promise} Dictionary of all supported output formats mapped to arrays of formats these outputs can be obtained from.

throws

Error when the request fails, for example, due to insufficient rights.

Returns Promise<IDerivativeFormats>

getManifest

getManifest(urn: string): Promise<IDerivativeManifest>

- Defined in md.ts:235
Retrieves manifest of a derivative.

link

https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-manifest-GET

async

throws

Error when the request fails, for example, due to insufficient rights.

Parameters
- urn: string
  
  Document derivative URN.
Returns Promise<IDerivativeManifest>

Document derivative manifest.

getMetadata

getMetadata(urn: string): Promise<IDerivativeMetadata>

- Defined in md.ts:261
Retrieves metadata of a derivative.

link

https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-metadata-GET

async

throws

Error when the request fails, for example, due to insufficient rights.

Parameters
- urn: string
  
  Document derivative URN.
Returns Promise<IDerivativeMetadata>

Document derivative metadata.

getThumbnail

getThumbnail(urn: string, size?: ThumbnailSize): Promise<Buffer>

- Defined in md.ts:341
Retrieves derivative thumbnail.

link

https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/urn-thumbnail-GET

async

throws

Error when the request fails, for example, due to insufficient rights, or incorrect scopes.

Parameters
- urn: string
  
  Document derivative URN.
- size: ThumbnailSize = ...
Returns Promise<Buffer>

Thumbnail data.

submitJob

submitJob(urn: string, outputs: IDerivativeOutputFormat[], rootFilename?: string, force?: boolean, workflowId?: string, workflowAttr?: object): Promise<IJob>

- Defined in md.ts:360
Submits a translation job.

link

https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/job-POST.

async

throws

Error when the request fails, for example, due to insufficient rights.

Parameters
- urn: string
  
  Document to be translated.
- outputs: IDerivativeOutputFormat[]
  
  List of requested output formats.
- Optional rootFilename: string
- Optional force: boolean
- Optional workflowId: string
- Optional workflowAttr: object
Returns Promise<IJob>

Translation job details.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

auth: AuthOptions

Optional options: IClientOptions

Returns ModelDerivativeClient

Properties

Protected apiClient

Protected auth

Protected authProvider

Protected derivativesApi

Protected host

Protected region

Methods

deleteManifest

Parameters

urn: string

Returns Promise<void>

getDerivativeContent

Parameters

modelUrn: string

derivativeUrn: string

Returns Promise<Buffer>

getDerivativeProperties

Parameters

urn: string

guid: string

Optional objectId: number

Optional forceLargeResult: boolean

Optional forceRebuild: boolean

Returns Promise<IDerivativeProperties>

getDerivativeSize

Parameters

modelUrn: string

derivativeUrn: string

Returns Promise<number>

getDerivativeTree

Parameters

urn: string

guid: string

Optional forceLargeResult: boolean

Optional forceRebuild: boolean

Returns Promise<IDerivativeTree>

getFormats

Returns Promise<IDerivativeFormats>

getManifest

Parameters

urn: string

Returns Promise<IDerivativeManifest>

getMetadata

Parameters

urn: string

Returns Promise<IDerivativeMetadata>

getThumbnail

Parameters

urn: string

size: ThumbnailSize = ...

Returns Promise<Buffer>

submitJob

Parameters

urn: string

outputs: IDerivativeOutputFormat[]

Optional rootFilename: string

Optional force: boolean

Optional workflowId: string

Optional workflowAttr: object

Returns Promise<IJob>