Class DataManagementClient

Client providing access to Autodesk Forge Data Management APIs.

link: https://forge.autodesk.com/en/docs/data/v2

Hierarchy

DataManagementClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

- Defined in dm.ts:106
Parameters
- auth: AuthOptions
- Optional options: IClientOptions
Returns DataManagementClient

Properties

Protected apiClient

apiClient: ApiClient

Protected auth

auth: AuthOptions

Protected authProvider

authProvider: IAuthProvider

Protected foldersApi

foldersApi: FoldersApi

Protected host

host: string

Protected hubsApi

hubsApi: HubsApi

Protected itemsApi

itemsApi: ItemsApi

Protected projectsApi

projectsApi: ProjectsApi

Protected region

region: Region

Protected versionsApi

versionsApi: VersionsApi

Methods

getFolderDetails

getFolderDetails(projectId: string, folderId: string): Promise<IFolder>

- Defined in dm.ts:228
Returns the folder by ID for any folder within a given project.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-GET

Parameters
- projectId: string
  
  Project ID.
- folderId: string
  
  Folder ID.
Returns Promise<IFolder>

Folder details.

getHubDetails

getHubDetails(hubId: string): Promise<IHub>

- Defined in dm.ts:153
Retrieves details of specific hub.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/hubs-hub_id-GET

async

Parameters
- hubId: string
  
  Hub ID.
Returns Promise<IHub>

Hub details.

getItemDetails

getItemDetails(projectId: string, itemId: string): Promise<IItem>

- Defined in dm.ts:243
Gets details of an item.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/projects-project_id-items-item_id-GET

async

Parameters
- projectId: string
  
  Project ID.
- itemId: string
  
  Item ID.
Returns Promise<IItem>

Item details.

getItemTipVersion

getItemTipVersion(projectId: string, itemId: string): Promise<IVersion>

- Defined in dm.ts:274
Gets "tip" version of an item.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/projects-project_id-items-item_id-tip-GET

async

Parameters
- projectId: string
  
  Project ID.
- itemId: string
  
  Item ID.
Returns Promise<IVersion>

Tip version of the item.

getProjectDetails

getProjectDetails(hubId: string, projectId: string): Promise<IProject>

- Defined in dm.ts:182
Gets details of specific project.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/hubs-hub_id-projects-project_id-GET

async

Parameters
- hubId: string
  
  Hub ID.
- projectId: string
  
  Project ID.
Returns Promise<IProject>

Hub details or null if there isn't one.

getVersionDetails

getVersionDetails(projectId: string, versionId: string): Promise<IVersion>

- Defined in dm.ts:289
Gets specific version of an item.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/projects-project_id-versions-version_id-GET

async

Parameters
- projectId: string
  
  Project ID.
- versionId: string
  
  Version ID.
Returns Promise<IVersion>

Specific version of folder item.

listFolderContents

listFolderContents(projectId: string, folderId: string): Promise<(IFolder | IItem)[]>

- Defined in dm.ts:213
Gets contents of a folder.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/projects-project_id-folders-folder_id-contents-GET

async

Parameters
- projectId: string
  
  Project ID.
- folderId: string
  
  Folder ID.
Returns Promise<(IFolder | IItem)[]>

List of folder contents.

listHubs

listHubs(): Promise<IHub[]>

- Defined in dm.ts:138
Gets a list of all hubs accessible to given credentials.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/hubs-GET

async

Returns Promise<IHub[]>

List of hubs.

listItemVersions

listItemVersions(projectId: string, itemId: string): Promise<IVersion[]>

- Defined in dm.ts:258
Lists versions of an item.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/projects-project_id-items-item_id-versions-GET

async

Parameters
- projectId: string
  
  Project ID.
- itemId: string
  
  Item ID.
Returns Promise<IVersion[]>

List of item versions.

listProjecFolders

listProjecFolders(hubId: string, projectId: string): Promise<IFolder[]>

- Defined in dm.ts:197
Gets a list of top folders in a project.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/hubs-hub_id-projects-project_id-topFolders-GET

async

Parameters
- hubId: string
  
  Hub ID.
- projectId: string
  
  Project ID.
Returns Promise<IFolder[]>

List of folder records.

listProjects

listProjects(hubId: string): Promise<IProject[]>

- Defined in dm.ts:166
Lists all projects in a hub.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/hubs-hub_id-projects-GET

async

Parameters
- hubId: string
  
  Hub ID.
Returns Promise<IProject[]>

List of projects.

Generated using TypeDoc