Request

Response

    Get File Version Content Metadata
    HEAD

    vaults/{vaultId}/file-versions/{id}/content

    Retrieves metadata for a file version’s 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 a three-legged access token obtained via an Authorization Code flow or a Secure Service Account (SSA) flow.

    The SSA flow is designed for headless server-to-server operations. While it functions like a two-legged flow (no user interaction), it is classified as three-legged because it preserves user context.

    * Required

    Request

    URI Parameters

    vaultId
    string
    The unique identifier of a Knowledge 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 synced to the local site.

    true: File is not on the local site, it will be copied to the local site.

    false: (Default) File is not copied to the local site.

    wmSrcItemVerId
    string
    The item version ID to use as the watermark source. Supply this when the current file is a DWF associated with an Item and you want to download its watermarked version.
    wmSrcFileVerId
    string
    The file version ID (or CAD file version ID) to use as the watermark source. Supply this when the current file is a DWF associated with an Item, either directly or as a CAD file’s visualization attachment, and you want to download its watermarked version.
    contentDisposition
    string
    The Content-Disposition header value to apply to the response.
    • inline: The file is displayed inside the web page.
    • attachment (or null): The file is saved as a download.

    Any other value is passed through as-is, but the resulting browser behavior is not guaranteed.

    Response

    HTTP Status Code Summary

    200
    OK
    The file version content metadata was successfully retrieved.
    400
    Bad Request
    The server could not process the metadata request. Verify URI parameters and query parameters such as wmSrcItemVerId or wmSrcFileVerId, then try again. Inspect x-vault-error-code and x-vault-error-detail for details.
    401
    Unauthorized
    The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again. Inspect x-vault-error-code and x-vault-error-detail for details.
    403
    Forbidden
    The request was successfully validated but lacking the required permissions. Verify your credentials and permissions before you send this request again.
    404
    Not Found
    The file version content was not found or you do not have access to it. Verify vaultId and id, then try again. Inspect x-vault-error-code and x-vault-error-detail for details.

    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.