Get file version content metadata
HEAD
vaults/{vaultId}/file-versions/{id}/content
Retrieve metadata for a specific file version content without fetching the full content body
Resource Information
Method and URI | HEAD /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/file-versions/{id}/content |
Authentication Context | user context required |
Required OAuth Scopes | No scopes required |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via a three-legged OAuth flow. |
* Required
Request
URI Parameters
vaultId string | The unique identifier of a vault. |
id string | The unique identifier of a file version. |
Request
Query String Parameters
allowSync boolean | In a multi-site environment, this field tells if the file should be synched to the local site.
|
wmSrcItemVerId string | When current file is a dwf associated to an Item, to download its watermarked version, supply this Item Version’s id as the watermark source. |
wmSrcFileVerId string | When current file is a dwf associated to an Item, directly or as a CAD file’s visualization attachment, to download its watermarked version, supply this File Version’s id or its CAD File Version’s id as the watermark source. |
contentDisposition string | Specify the content disposition of the response header. Pass in ‘inline’ to allow the file to be displayed inside the web page; ‘attachment’ or null to save the file. Other values would be directly used as it is, but the behavior can’t be guaranteed. |
Response
HTTP Status Code Summary
200 OK | The request succeeded. The response contains the file version content metadata. |
400 Bad Request | |
401 Unauthorized | |
403 Forbidden | Unauthorized |
404 Not Found | Not Found |
Response
Header (200)
Content-Type string | Indicates the media type of the resource. |
Content-Length integer | Total size of the resource in bytes. |
Response
Header (400)
x-vault-error-code string | Vault error code for the specific error that occurred. |
x-vault-error-detail string | A brief, human-readable description of the error. |
Response
Header (401)
x-vault-error-code string | Vault error code for the specific error that occurred. |
x-vault-error-detail string | A brief, human-readable description of the error. |
Response
Body Structure (200)
Response for 200 has no body.
Example
This example illustrates how to check if user has download access to a file and retrieve metadata for a specific file version without fetching the full content body.
Note: {VaultServerAddress}
is used as a placeholder in the example(s) and could represent one of the following:
- Vault Server IP address or hostname. Ex: http://10.41.110.49.
- Vault Gateway URL if gateway is configured. Ex: https://test.vg.autodesk.com.
Request
curl -v '{VaultServerAddress}/AutodeskDM/Services/api/vault/v2/vaults/117/file-versions/43/content' \
-X 'HEAD' \
-H 'Accept: */*'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
Response
In response headers, the content length is returned if user has permission to download the file.