Class: DataManagementClient
Defined in: custom-code/dataManagementClient.ts:11
Remarks
Represents a collection of functions to interact with the DataManagement API endpoints.
Extends
BaseClient
Constructors
new DataManagementClient()
new DataManagementClient(
optionalArgs?):DataManagementClient
Defined in: custom-code/dataManagementClient.ts:19
optionalArgs?
authenticationProvider?
IAuthenticationProvider
sdkManager?
SdkManager
Returns
Overrides
BaseClient.constructor
Accessors
authenticationProvider
Get Signature
get authenticationProvider():
IAuthenticationProvider
Defined in: node_modules/@aps_sdk/autodesk-sdkmanager/dist/src/baseClient.d.ts:4
Returns
IAuthenticationProvider
Set Signature
set authenticationProvider(
value):void
Defined in: node_modules/@aps_sdk/autodesk-sdkmanager/dist/src/baseClient.d.ts:5
Parameters
value
IAuthenticationProvider
Returns
void
Inherited from
BaseClient.authenticationProvider
Methods
createDownload()
Operation: Create Download
createDownload(
projectId,downloadPayload,optionalArgs):Promise<CreatedDownload>
Defined in: custom-code/dataManagementClient.ts:56
Kicks off a job to generate the specified download format of the version. Once the job completes, the specified format becomes available for download.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
downloadPayload
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<CreatedDownload>
Throws
createFolder()
Operation: Create a Folder
createFolder(
projectId,folderPayload,optionalArgs):Promise<Folder>
Defined in: custom-code/dataManagementClient.ts:90
Creates a new folder in the specified project. Use the parent attribute in the request body to specify where in the hierarchy the new folder should be located. Folders can be nested up to 25 levels deep.
Use the Modify a Folder operation to delete and restore folders.
Before you use the Data Management API to access BIM 360 Docs folders, provision your app through the BIM 360 Account Administrator portal. For details, see the Manage Access to Docs tutorial.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
folderPayload
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Folder>
Throws
createFolderRelationshipsRef()
Operation: Create a Custom Relationship for a Folder
createFolderRelationshipsRef(
folderId,projectId,relationshipRefsPayload,optionalArgs):Promise<void>
Defined in: custom-code/dataManagementClient.ts:119
Creates a custom relationship between a folder and another resource within the data domain service (folder, item, or version).
Parameters
folderId
string
The unique identifier of a folder.
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
relationshipRefsPayload
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<void>
Throws
createItem()
Operation: Create an Item
createItem(
projectId,itemPayload,optionalArgs):Promise<CreatedItem>
Defined in: custom-code/dataManagementClient.ts:180
Creates the first version of a file (item). To create additional versions of an item, use POST versions.
Before you create the first version of an item, you must create a placeholder for the file, and upload the file to the placeholder. For more details about the workflow, see the tutorial on uploading a file.
This operation also allows you to create a new item by copying a specific version of an existing item to another folder. The copied version becomes the first version of the new item in the target folder.
Note: You cannot copy versions of items across different projects and accounts.
Use the Create Version operation with the copyFrom parameter if you want to create a new version of an item by copying a specific version of another item.
Before you use the Data Management API to access BIM 360 Docs files, you must provision your app through the BIM 360 Account Administrator portal. For details, see the Manage Access to Docs tutorial.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
itemPayload
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
copyFrom?
string
The Version ID (URN) of the version to copy from.
Note: This parameter is relevant only for copying files to BIM 360 Docs.
For information on how to find the URN, see the initial steps of the Download a File tutorial.
You can only copy files to the Plans folder or to subfolders of the Plans folder with an item:autodesk.bim360:Document item extension type. You can only copy files to the Project Files folder or to subfolders of the Project Files folder with an item:autodesk.bim360:File item extension type.
To verify an item’s extension type, use the Get an Item operation, and check the attributes.extension.type attribute.
Note that if you copy a file to the Plans folder or to a subfolder of the Plans folder, the copied file inherits the permissions of the source file. For example, if users of your app did not have permission to download files in the source folder, but does have permission to download files in the target folder, they will not be able to download the copied file.
Note that you cannot copy a file while it is being uploaded, updated, or copied. To verify the current process state of a file, call the Get an Item operation , and check the attributes.extension.data.processState attribute.
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, the app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act on behalf of only the user specified.
Note that for a three-legged OAuth flow or for a two-legged OAuth flow with user impersonation (x-user-id), the users of your app must have permission to upload files to the specified parent folder (data.attributes.relationships.parent.data.id).
For copying files, users of your app must have permission to view the source folder.
For information about managing and verifying folder permissions for BIM 360 Docs, see the section on Managing Folder Permissions.’
Returns
Promise<CreatedItem>
Throws
createItemRelationshipsRef()
Operation: Create a Custom Relationship for an Item
createItemRelationshipsRef(
projectId,itemId,relationshipRefsPayload,optionalArgs):Promise<void>
Defined in: custom-code/dataManagementClient.ts:209
Creates a custom relationship between an item and another resource within the data domain service (folder, item, or version).
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
itemId
string
The unique identifier of an item.
relationshipRefsPayload
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<void>
Throws
createStorage()
Operation: Create a Storage Location in OSS
createStorage(
projectId,storagePayload,optionalArgs):Promise<Storage>
Defined in: custom-code/dataManagementClient.ts:239
Creates a placeholder for an item or a version of an item in the OSS. Later, you can upload the binary content for the item or version to this storage location.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
storagePayload
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Storage>
Throws
createVersion()
Operation: Create a Version
createVersion(
projectId,versionPayload,optionalArgs):Promise<CreatedVersion>
Defined in: custom-code/dataManagementClient.ts:293
Creates a new versions of an existing item.
Before creating a new version you must create a storage location for the version in OSS, and upload the file to that location. For more details about the workflow, see the tutorial on uploading a file.
This operation also allows you to create a new version of an item by copying a specific version of an existing item from another folder within the project. The new version becomes the tip version of the item.
Use the Create an Item operation to copy a specific version of an existing item as a new item in another folder.
This operation can also be used to delete files on BIM360 Document Management. For more information, please refer to the delete and restore a file tutorial.
Before you use the Data Management API to access BIM 360 Docs files, you must provision your app through the BIM 360 Account Administrator portal. For details, see the Manage Access to Docs tutorial.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
versionPayload
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
copyFrom?
string
The Version ID (URN) of the version to copy from.
Note: This parameter is relevant only for copying files to BIM 360 Docs.
For information on how to find the URN, see the initial steps of the Download a File tutorial.
You can only copy files to the Plans folder or to subfolders of the Plans folder with an item:autodesk.bim360:Document item extension type. You can only copy files to the Project Files folder or to subfolders of the Project Files folder with an item:autodesk.bim360:File item extension type.
To verify an item’s extension type, use the Get an Item operation, and check the attributes.extension.type attribute.
Note that if you copy a file to the Plans folder or to a subfolder of the Plans folder, the copied file inherits the permissions of the source file. For example, if users of your app did not have permission to download files in the source folder, but does have permission to download files in the target folder, they will not be able to download the copied file.
Note that you cannot copy a file while it is being uploaded, updated, or copied. To verify the current process state of a file, call the Get an Item operation , and check the attributes.extension.data.processState attribute.
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<CreatedVersion>
Throws
createVersionRelationshipsRef()
Operation: Create a Custom Relationship for a Version
createVersionRelationshipsRef(
projectId,versionId,relationshipRefsPayload,optionalArgs):Promise<void>
Defined in: custom-code/dataManagementClient.ts:322
Creates a custom relationship between a version of an item and another resource within the data domain service (folder, item, or version).
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
versionId
string
The URL encoded unique identifier of a version.
relationshipRefsPayload
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<void>
Throws
executeCheckPermissionCommand()
Operation: > executeCheckPermissionCommand(projectId, checkPermissionPayload, optionalArgs?): Promise<CheckPermission>
Defined in: custom-code/dataManagementClient.ts:1444
Checks if a user has permission to perform specified actions on specified resources.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
checkPermissionPayload
The payload for the check permission command.
optionalArgs?
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<CheckPermission>
Throws
executeGetPublishModelJobCommand()
Operation: > executeGetPublishModelJobCommand(projectId, publishModelJobPayload, optionalArgs?): Promise<PublishModel>
Defined in: custom-code/dataManagementClient.ts:1525
Verifies whether a Collaboration for Revit (C4R) model needs to be published to BIM 360 Docs.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
publishModelJobPayload
The payload for the get publish model job command.
optionalArgs?
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<PublishModel>
Throws
executeListItemsCommand()
Operation: > executeListItemsCommand(projectId, listItemsPayload, optionalArgs?): Promise<ListItems>
Defined in: custom-code/dataManagementClient.ts:1471
Retrieves metadata for up to 50 specified items.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
listItemsPayload
The payload for the list items command.
optionalArgs?
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<ListItems>
Throws
executeListRefsCommand()
Operation: > executeListRefsCommand(projectId, listRefsPayload, optionalArgs?): Promise<ListRefs>
Defined in: custom-code/dataManagementClient.ts:1499
Retrieves the custom relationships between specified versions of items and other resources
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
listRefsPayload
The payload for the list items command.
optionalArgs?
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<ListRefs>
Throws
executePublishModelCommand()
Operation: > executePublishModelCommand(projectId, publishModelPayload, optionalArgs?): Promise<PublishModel>
Defined in: custom-code/dataManagementClient.ts:1553
Publishes the latest version of a Collaboration for Revit (C4R) model to BIM 360 Docs.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
publishModelPayload
The payload for the publish model command.
optionalArgs?
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<PublishModel>
Throws
executePublishWithoutLinksCommand()
Operation: > executePublishWithoutLinksCommand(projectId, publishWithoutLinksPayload, optionalArgs?): Promise<PublishWithoutLinks>
Defined in: custom-code/dataManagementClient.ts:1580
Publishes the latest version of a Collaboration for Revit (C4R) model without the links it contains to BIM 360 Docs.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
publishWithoutLinksPayload
The payload for the publish model command.
optionalArgs?
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<PublishWithoutLinks>
Throws
Memberof
CommandsApiInterface
getDownload()
Operation: Get Download Details
getDownload(
projectId,downloadId,optionalArgs):Promise<Download>
Defined in: custom-code/dataManagementClient.ts:352
Returns the details of a downloadable format of a version of an item.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
downloadId
string
The Job ID of the job used to generate the download.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Download>
Throws
getDownloadJob()
Operation: Check Download Creation Progress
getDownloadJob(
projectId,jobId,optionalArgs):Promise<Job>
Defined in: custom-code/dataManagementClient.ts:383
Checks the status of a job that generates a downloadable format of a version of an item.
Note: If the job has finished, this operation returns a HTTP status 303, with the location return parameter set to the URI that returns the details of the download.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
jobId
string
The unique identifier of a job.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Job>
Throws
getFolder()
Operation: Get a Folder
getFolder(
projectId,folderId,optionalArgs):Promise<Folder>
Defined in: custom-code/dataManagementClient.ts:414
Returns the folder specified by the folder_id parameter from within the project identified by the project_id parameter. All folders and subfolders within a project (including the root folder) have a unique ID.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
folderId
string
The unique identifier of a folder.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
ifModifiedSince?
string
Specify a date in the YYYY-MM-DDThh:mm:ss.sz format. If the resource has not been modified since the specified date/time, the response will return a HTTP status of 304 without any response body; the Last-Modified response parameter will contain the date of last modification.
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Folder>
Throws
getFolderContents()
Operation: List Folder Contents
getFolderContents(
projectId,folderId,optionalArgs):Promise<FolderContents>
Defined in: custom-code/dataManagementClient.ts:459
Returns a list of items and folders within the specified folder. Items represent word documents, fusion design files, drawings, spreadsheets, etc.
The resources contained in the included array of the response are their tip versions.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
folderId
string
The unique identifier of a folder.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
filterExtensionType?
string[]
Filter by the extension type.
filterId?
string[]
Filter by the id of the ref target.
filterLastModifiedTimeRollup?
string[]
Filter by the lastModifiedTimeRollup attribute. Supported values are date-time string in the form YYYY-MM-DDTHH:MM:SS.000000Z or YYYY-MM-DDTHH:MM:SS based on RFC3339.
filterType?
Filter by the type of the objects in the folder. Supported values are folders and items.
options?
ApsServiceRequestConfig
Override http request option.
pageLimit?
number
Specifies the maximum number of elements to return in the page. The default value is 200. The min value is 1. The max value is 200.
pageNumber?
number
Specifies what page to return. Page numbers are 0-based (the first page is page 0).
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<FolderContents>
Throws
getFolderParent()
Operation: Get Parent of a Folder
getFolderParent(
projectId,folderId,optionalArgs):Promise<Folder>
Defined in: custom-code/dataManagementClient.ts:489
Returns the parent folder of the specified folder. In a project, folders are organized in a hierarchy. Each folder except for the root folder has a parent folder.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
folderId
string
The unique identifier of a folder.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Folder>
Throws
getFolderRefs()
Operation: List Related Resources for a Folder
getFolderRefs(
projectId,folderId,optionalArgs):Promise<FolderRefs>
Defined in: custom-code/dataManagementClient.ts:526
Returns the resources (items, folders, and versions) that have a custom relationship with the specified folder. Custom relationships can be established between a folder and other resources within the data domain service (folders, items, and versions).
Each relationship is defined by the id of the object at the other end of the relationship, together with type, attributes, and relationships links.
Callers will typically use a filter parameter to restrict the response to the custom relationship types (filter[meta.refType]) they are interested in.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
folderId
string
The unique identifier of a folder.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
filterExtensionType?
string[]
Filter by the extension type.
filterId?
string[]
Filter by the id of the ref target.
filterType?
Filter by the type of the ref target. Supported values include folders, items, and versions.
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<FolderRefs>
Throws
getFolderRelationshipsLinks()
Operation: List Relationship Links for a Folder
getFolderRelationshipsLinks(
projectId,folderId,optionalArgs):Promise<RelationshipLinks>
Defined in: custom-code/dataManagementClient.ts:558
Returns a list of links for the specified folder.
Custom relationships can be established between a folder and other external resources residing outside the data domain service. A link’s href attribute defines the target URI to access a resource.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
folderId
string
The unique identifier of a folder.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<RelationshipLinks>
Throws
getFolderRelationshipsRefs()
Operation: List Custom Relationships for a Folder
getFolderRelationshipsRefs(
folderId,projectId,optionalArgs):Promise<RelationshipRefs>
Defined in: custom-code/dataManagementClient.ts:598
Returns the custom relationships associated with the specified folder. Custom relationships can be established between a folder and other resources within the data domain service (folders, items, and versions).
Each relationship is defined by the ID of the object at the other end of the relationship, together with type, specific reference meta including extension data.
Callers will typically use a filter parameter to restrict the response to the custom relationship types (filter[meta.refType]) they are interested in.
The response body will have an included array that contains the resources in the relationship, which is essentially what is returned by the List Related Resources for a Folder operation.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
folderId
string
The unique identifier of a folder.
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
filterDirection?
Filter by the direction of the reference. Possible values: from and to.
filterExtensionType?
string[]
Filter by the extension type.
filterId?
string[]
Filter by the id of the ref target.
filterRefType?
Filter by refType. Possible values: derived, dependencies, auxiliary, xrefs, and includes.
filterType?
Filter by the type of the ref target. Supported values include folders, items, and versions.
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<RelationshipRefs>
Throws
getFolderSearch()
Operation: List Folder and Subfolder Contents
getFolderSearch(
projectId,folderId,optionalArgs):Promise<Search>
Defined in: custom-code/dataManagementClient.ts:641
Searches the specified folder and its subfolders and returns a list of the latest versions of the items you can access.
Use the filter query string parameter to narrow down the list as appropriate. You can filter by the following properties of the version payload:
typeproperty,idproperty,- any of the attributes object properties.
For example, you can filter by createTime and mimeType. It returns tip versions (latest versions) of properties where the filter conditions are satisfied. To verify the properties of the attributes object for a specific version, use the Get a Version operation.
To list the immediate contents of the folder without parsing subfolders, use the List Folder Contents operation.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
folderId
string
The unique identifier of a folder.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
filterFieldName?
string
Field name for filtering the data. See the Filtering section for details.
filterValue?
string[]
Value to match the filter with. See the Filtering section for details.
options?
ApsServiceRequestConfig
Override http request option.
pageNumber?
number
Specifies what page to return. Page numbers are 0-based (the first page is page 0).
Returns
Promise<Search>
Throws
getHub()
Operation: Get a Hub
getHub(
hubId,optionalArgs):Promise<Hub>
Defined in: custom-code/dataManagementClient.ts:667
Returns the hub specified by the hub_id parameter.
For BIM 360 Docs, a hub ID corresponds to a BIM 360 account ID. To convert a BIM 360 account ID to a hub ID, prefix the account ID with b.. For example, an account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
hubId
string
The unique identifier of a hub.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Hub>
Throws
getHubProjects()
Operation: Get Projects
getHubProjects(
hubId,optionalArgs):Promise<Projects>
Defined in: custom-code/dataManagementClient.ts:700
Returns a collection of active projects within the specified hub. The returned projects can be Autodesk Construction Cloud (ACC), BIM 360, BIM 360 Team, Fusion Team, and A360 Personal projects.
For BIM 360 and ACC projects a hub ID corresponds to an Account ID. To convert an Account ID to a hub ID, prefix the account ID with b.. For example, a BIM 360 account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert a BIM 360 and ACC project IDs to Data Management project IDs prefix the BIM 360 or ACC Project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
hubId
string
The unique identifier of a hub.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
filterExtensionType?
string[]
Filter by the extension type.
filterId?
string[]
Filter by the id of the ref target.
options?
ApsServiceRequestConfig
Override http request option.
pageLimit?
number
Specifies the maximum number of elements to return in the page. The default value is 200. The min value is 1. The max value is 200.
pageNumber?
number
Specifies what page to return. Page numbers are 0-based (the first page is page 0).
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Projects>
Throws
getHubs()
Operation: List Hubs
getHubs(
optionalArgs):Promise<Hubs>
Defined in: custom-code/dataManagementClient.ts:731
Returns a collection of hubs that the user of your app can access.
The returned hubs can be BIM 360 Team hubs, Fusion Team hubs (formerly known as A360 Team hubs), A360 Personal hubs, ACC Docs (Autodesk Docs) accounts, or BIM 360 Docs accounts. Only active hubs are returned.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
filterExtensionType?
string[]
Filter by the extension type.
filterId?
string[]
Filter by the id of the ref target.
filterName?
string[]
Filter by the name of the ref target.
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Hubs>
Throws
getItem()
Operation: Get an Item
getItem(
projectId,itemId,optionalArgs):Promise<Item>
Defined in: custom-code/dataManagementClient.ts:769
Retrieves an item. Items represent Word documents, Fusion 360 design files, drawings, spreadsheets, etc.
The tip version for the item is included in the included array of the payload. To retrieve multiple items, see the ListItems command.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
itemId
string
The unique identifier of an item.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
includePathInProject?
boolean
Specify whether to return pathInProject attribute in response for BIM 360 Docs projects. pathInProject is the relative path of the item starting from project’s root folder.
true: Response will include thepathInProjectattribute for BIM 360 Docs projects.false: (Default) Response will not includepathInProjectattribute for BIM 360 Docs projects.
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Item>
Throws
getItemParentFolder()
Operation: Get Parent of an Item
getItemParentFolder(
projectId,itemId,optionalArgs):Promise<Folder>
Defined in: custom-code/dataManagementClient.ts:799
Returns the parent folder of the specified item.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
itemId
string
The unique identifier of an item.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Folder>
Throws
getItemRefs()
Operation: List Related Resources for an Item
getItemRefs(
projectId,itemId,optionalArgs):Promise<Refs>
Defined in: custom-code/dataManagementClient.ts:838
Returns the resources (items, folders, and versions) that have a custom relationship with the specified item. Custom relationships can be established between an item and other resources within the data domain service (folders, items, and versions).
Each relationship is defined by the ID of the object at the other end of the relationship, together with type, attributes, and relationships links.
Callers will typically use a filter parameter to restrict the response to the custom relationship types (filter[meta.refType]) they are interested in.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
itemId
string
The unique identifier of an item.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
filterExtensionType?
string[]
Filter by the extension type.
filterId?
string[]
Filter by the id of the ref target.
filterType?
Filter by the type of the ref target. Supported values include folders, items, and versions.
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Refs>
Throws
getItemRelationshipsLinks()
Operation: List Relationship Links for an Item
getItemRelationshipsLinks(
projectId,itemId,optionalArgs):Promise<RelationshipLinks>
Defined in: custom-code/dataManagementClient.ts:870
Returns a list of links for the specified item.
Custom relationships can be established between an item and other external resources residing outside the data domain service. A link’s href attribute defines the target URI to access a resource.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
itemId
string
The unique identifier of an item.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<RelationshipLinks>
Throws
getItemRelationshipsRefs()
Operation: List Custom Relationships for an Item
getItemRelationshipsRefs(
projectId,itemId,optionalArgs):Promise<RelationshipRefs>
Defined in: custom-code/dataManagementClient.ts:910
Returns the custom relationships that are associated with the specified item. Custom relationships can be established between an item and other resources within the data domain service (folders, items, and versions).
Each relationship is defined by the ID of the object at the other end of the relationship, together with type, specific reference meta including extension data.
Callers will typically use a filter parameter to restrict the response to the custom relationship types (filter[meta.refType]) they are interested in.
The response body will have an included array that contains the resources in the relationship, which is essentially what is returned by the List Related Resources for an Item operation.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
itemId
string
The unique identifier of an item.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
filterDirection?
Filter by the direction of the reference. Possible values: from and to.
filterExtensionType?
string[]
Filter by the extension type.
filterId?
string[]
Filter by the id of the ref target.
filterRefType?
Filter by refType. Possible values: derived, dependencies, auxiliary, xrefs, and includes.
filterType?
Filter by the type of the ref target. Supported values include folders, items, and versions.
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<RelationshipRefs>
Throws
getItemTip()
Operation: Get Tip Version of an Item
getItemTip(
projectId,itemId,optionalArgs):Promise<ItemTip>
Defined in: custom-code/dataManagementClient.ts:940
Returns the latest version of the specified item. A project can contain multiple versions of a resource item. The latest version is referred to as the tip version, which is returned by this operation.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
itemId
string
The unique identifier of an item.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<ItemTip>
Throws
getItemVersions()
Operation: List all Versions of an Item
getItemVersions(
projectId,itemId,optionalArgs):Promise<Versions>
Defined in: custom-code/dataManagementClient.ts:976
Lists all versions of the specified item. A project can contain multiple versions of a resource item.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
itemId
string
The unique identifier of an item.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
filterExtensionType?
string[]
Filter by the extension type.
filterId?
string[]
Filter by the id of the ref target.
filterVersionNumber?
number[]
Filter by versionNumber.
options?
ApsServiceRequestConfig
Override http request option.
pageLimit?
number
Specifies the maximum number of elements to return in the page. The default value is 200. The min value is 1. The max value is 200.
pageNumber?
number
Specifies what page to return. Page numbers are 0-based (the first page is page 0).
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Versions>
Throws
getProject()
Operation: Get a Project
getProject(
hubId,projectId,optionalArgs):Promise<Project>
Defined in: custom-code/dataManagementClient.ts:1010
Returns the specified project from within the specified hub.
For BIM 360 Docs, a hub ID corresponds to a BIM 360 account ID. To convert a BIM 360 account ID to a hub ID, prefix the account ID with b.. For example, an account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert a BIM 360 project ID to a Data Management project ID prefix the BIM 360 Project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
hubId
string
The unique identifier of a hub.
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Project>
Throws
getProjectHub()
Operation: Get Hub for Project
getProjectHub(
hubId,projectId,optionalArgs):Promise<Hub>
Defined in: custom-code/dataManagementClient.ts:1040
Returns the hub that contains the project specified by the project_id parameter.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
hubId
string
The unique identifier of a hub.
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Hub>
Throws
getProjectTopFolders()
Operation: List Top-level Project Folders
getProjectTopFolders(
hubId,projectId,optionalArgs):Promise<TopFolders>
Defined in: custom-code/dataManagementClient.ts:1084
Returns the details of the highest level folders within a project that the user calling this operation has access to. The user must have at least read access to the folders.
If the user is a Project Admin, it returns all top-level folders in the project. Otherwise, it returns all the highest level folders in the folder hierarchy the user has access to.
Users with access permission to a folder has access permission to all its subfolders.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
hubId
string
The unique identifier of a hub.
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
excludeDeleted?
boolean
Specifies whether deleted folders are excluded from the response for BIM 360 Docs projects, when user context is provided.
true: Response excludes deleted folders for BIM 360 Docs projects.false: (Default) Response will not exclude deleted folders for BIM 360 Docs projects.
options?
ApsServiceRequestConfig
Override http request option.
projectFilesOnly?
boolean
Specifies what folders and subfolders to return for BIM 360 Docs projects, when user context is provided.
true: Response will be restricted to folder and subfolders containing project files for BIM 360 Docs projects.false: (Default) Response will include all available folders.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<TopFolders>
Throws
getVersion()
Operation: Get a Version
getVersion(
projectId,versionId,optionalArgs):Promise<Version>
Defined in: custom-code/dataManagementClient.ts:1114
Returns the specified version of an item.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
versionId
string
The URL encoded unique identifier of a version.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Version>
Throws
getVersionDownloadFormats()
Operation: List Supported Download Formats
getVersionDownloadFormats(
projectId,versionId,optionalArgs):Promise<DownloadFormats>
Defined in: custom-code/dataManagementClient.ts:1144
Returns a list of file formats the specified version of an item can be downloaded as.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
versionId
string
The URL encoded unique identifier of a version.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<DownloadFormats>
Throws
getVersionDownloads()
Operation: List Available Download Formats
getVersionDownloads(
projectId,versionId,optionalArgs):Promise<Downloads>
Defined in: custom-code/dataManagementClient.ts:1175
Returns the list of file formats of the specified version of an item currently available for download.
Note: This operation is not fully implemented as yet. It currently returns an empty data object.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
versionId
string
The URL encoded unique identifier of a version.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
filterFormatFileType?
string[]
Filter by the file type of the download object.
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Downloads>
Throws
getVersionItem()
Operation: Get Item by Version
getVersionItem(
projectId,versionId,optionalArgs):Promise<Item>
Defined in: custom-code/dataManagementClient.ts:1205
Returns the item corresponding to the specified version.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
versionId
string
The URL encoded unique identifier of a version.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Item>
Throws
getVersionRefs()
Operation: List Related Resources for a Version
getVersionRefs(
projectId,versionId,optionalArgs):Promise<Refs>
Defined in: custom-code/dataManagementClient.ts:1245
Returns the resources (items, folders, and versions) that have a custom relationship with the specified version.
Custom relationships can be established between a version of an item and other resources within the data domain service (folders, items, and versions).
- Each relationship is defined by the id of the object at the other end of the relationship, together with type, attributes, and relationships links.
- Callers will typically use a filter parameter to restrict the response to the custom relationship types (
filter[meta.refType]) they are interested in. - The response body will have an included array that contains the ref resources that are involved in the relationship, which is essentially the response to the List Custom Relationships for a Version operation.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
versionId
string
The URL encoded unique identifier of a version.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
filterExtensionType?
string[]
Filter by the extension type.
filterId?
string[]
Filter by the id of the ref target.
filterType?
Filter by the type of the ref target. Supported values include folders, items, and versions.
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Refs>
Throws
getVersionRelationshipsLinks()
Operation: List Links for a Version
getVersionRelationshipsLinks(
projectId,versionId,optionalArgs):Promise<RelationshipLinks>
Defined in: custom-code/dataManagementClient.ts:1275
Returns a collection of links for the specified version of an item. Custom relationships can be established between a version of an item and other external resources residing outside the data domain service. A link’s href defines the target URI to access the resource.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
versionId
string
The URL encoded unique identifier of a version.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<RelationshipLinks>
Throws
getVersionRelationshipsRefs()
Operation: List Custom Relationships for a Version
getVersionRelationshipsRefs(
projectId,versionId,optionalArgs):Promise<RelationshipRefs>
Defined in: custom-code/dataManagementClient.ts:1318
Returns the custom relationships for the specified version.
Custom relationships can be established between a version of an item and other resources within the data domain service (folders, items, and versions).
- Each relationship is defined by the id of the object at the other end of the relationship, together with type, specific reference meta including extension data.
- Callers will typically use a filter parameter to restrict the response to the custom relationship types (
filter[meta.refType]) they are interested in. - The response body will have an included array that contains the resources in the relationship, which is essentially the response to the List Related Resources operation.
- To get custom relationships for multiple versions, see the ListRefs command.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
versionId
string
The URL encoded unique identifier of a version.
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
filterDirection?
Filter by the direction of the reference. Possible values: from and to.
filterExtensionType?
string[]
Filter by the extension type.
filterId?
string[]
Filter by the id of the ref target.
filterRefType?
Filter by refType. Possible values: derived, dependencies, auxiliary, xrefs, and includes.
filterType?
Filter by the type of the ref target. Supported values include folders, items, and versions.
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<RelationshipRefs>
Throws
patchFolder()
Operation: Modify a Folder
patchFolder(
projectId,folderId,modifyFolderPayload,optionalArgs):Promise<Folder>
Defined in: custom-code/dataManagementClient.ts:1353
Renames, moves, hides, or unhides a folder. Marking a BIM 360 Docs folder as hidden effectively deletes it. You can restore it by changing its hidden attribute. You can also move BIM 360 Docs folders by changing their parent folder.
You cannot permanently delete BIM 360 Docs folders. They are tagged as hidden folders and are removed from the BIM 360 Docs UI and from regular Data Management API responses. You can use the hidden filter (filter[hidden]=true) to get a list of deleted folders with the List Folder Contents operation.
Before you use the Data Management API to access BIM 360 Docs folders, provision your app through the BIM 360 Account Administrator portal. For details, see the Manage Access to Docs tutorial.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
folderId
string
The unique identifier of a folder.
modifyFolderPayload
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Folder>
Throws
patchItem()
Operation: Update an Item
patchItem(
projectId,itemId,modifyItemPayload,optionalArgs):Promise<Item>
Defined in: custom-code/dataManagementClient.ts:1384
Updates the displayName of the specified item. Note that updating the displayName of an item is not supported for BIM 360 Docs or ACC items.
Note: This operation supports Autodesk Construction Cloud (ACC) Projects. For more information, see the ACC Platform API documentation.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
itemId
string
The unique identifier of an item.
modifyItemPayload
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
xUserId?
string
In a two-legged authentication context, an app has access to all users specified by the administrator in the SaaS integrations UI. By providing this parameter, the API call will be limited to act only on behalf of the specified user.
Returns
Promise<Item>
Throws
patchVersion()
Operation: Update a Version
patchVersion(
projectId,versionId,modifyVersionPayload,optionalArgs):Promise<Version>
Defined in: custom-code/dataManagementClient.ts:1415
Updates the properties of the specified version of an item. Currently, you can only change the name of the version.
Note: This operation is not supported for BIM 360 and ACC. If you want to rename a version, create a new version with a new name.
Parameters
projectId
string
The unique identifier of a project.
For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.
Similarly, to convert an ACC or BIM 360 project ID to a Data Management project ID prefix the ACC or BIM 360 project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.
versionId
string
The URL encoded unique identifier of a version.
modifyVersionPayload
optionalArgs
accessToken?
string
An access token obtained by a call to GetThreeLeggedTokenAsync() or GetTwoLeggedTokenAsync().
options?
ApsServiceRequestConfig
Override http request option.
Returns
Promise<Version>
