Request

Response

    Check Out File (Beta)
    POST

    vaults/{vaultId}/files/{id}:checkout

    This operation is currently in beta testing and can change before general availability (GA). Avoid using it in production applications.

    Checks out the current version of a file for the authenticated user and returns the checked-out version.

    Resource Information

    Method and URI
    POST
    /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/files/{id}:checkout
    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 the file.

    Response

    HTTP Status Code Summary

    200
    OK
    The file was successfully checked out.
    400
    Bad Request
    The server was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request.
    401
    Unauthorized
    The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again.
    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 requested resource was not found.
    409
    Conflict
    The request conflicts with the current Vault state, such as an item number that is already in use.

    Response

    Body Structure (200)

    Expand all
    id
    string
    The unique identifier (iteration ID) of the file version.
    name
    string
    The name of the file. This value applies to all versions of the file.
    category
    string
    The category assigned to this file.
    categoryColor
    number
    The color of the category.
    classification
    enum:string
    The Vault classification for the file master. Possible values:
    • None - No specialized classification.
    • DesignVisualization - Design visualization asset (for example, DWF).
    • DesignDocument - Primary design document.
    • ConfigurationMember - Member of a configuration.
    • ConfigurationFactory - Factory configuration asset.
    • ElectricalProject - Electrical project content.
    • DesignSubstitute - Substitute component representation.
    • DesignRepresentation - Alternate design representation.
    • DesignPresentation - Presentation-oriented design content.
    entityType
    string
    The type of entity represented by this file version.
    version
    number
    The sequential version number of the file. A file that has just been added to the Vault has a version of 1.
    createDate
    datetime: ISO 8601
    The date and time when this version of the file was created in the Vault. For the first version of a file, this matches the check-in date. For later versions, this is the time when the previous version was checked out.
    lastModifiedDate
    datetime: ISO 8601
    The last modified date of the file. This value is set by the client that uploaded the file.
    revision
    string
    The revision label for this file.
    state
    string
    The name of the lifecycle state for this file version.
    stateColor
    number
    The color of the lifecycle state.
    parentFolderId
    string
    The unique identifier of the parent folder containing this file.
    file
    object
    Contains the Vault file master identity and referenced file version.
    id
    string
    The unique identifier (master ID) of the file.
    url
    string
    The relative URL to access this object.
    versionType
    enum:string
    Specifies which file or item iteration to resolve. Possible values:
    • None - No special version selection.
    • Latest - Use the latest iteration.
    • LatestReleased - Use the latest released (consumable) iteration.
    fileVersion
    object
    Contains extended file version metadata including checkout user and lifecycle state.
    checkoutUser
    all of
    The user who currently has this file version checked out.
    User
    object
    Contains core Vault account metadata returned for directory operations.
    id
    string
    A unique number that the Vault uses to reference the user.
    name
    string
    The login name of the user.
    email
    string
    The email address of the user.
    authTypes
    all of
    The authentication types available for this user.
    AuthType Enum
    enum:string
    Specifies which account directory backs the sign-in record. Possible values:
    • ActiveDirectory - Account is linked to Active Directory.
    • Vault - Account is native to Vault.
    • Autodesk - Account is linked to Autodesk ID.
    systemName
    string
    The internal system name of the user.
    createDate
    datetime: ISO 8601
    The date that the user was created.
    isActive
    boolean
    Indicates whether this user is active.

    true: The user is active.

    false: The user is inactive.

    url
    all of
    The relative URL to access this user.
    0
    string
    The relative URL to access this object.
    lifecycleState
    all of
    The lifecycle state of this file version.
    Lifecycle State
    object
    Contains a lifecycle state.
    id
    string
    The unique identifier of a server-based lifecycle state.
    url
    all of
    The relative URL to access this lifecycle state.
    0
    string
    The relative URL to access this object.
    name
    string
    The name of this lifecycle state.
    displayName
    string
    The display name of this lifecycle state.
    description
    string
    The description of this lifecycle state.
    comments
    array: string
    A list of predefined comments available for selection when changing entity states.
    isDefault
    boolean
    true: This state is the default state of the lifecycle definition.

    false: This state is not the default state of the lifecycle definition.

    color
    int
    The color code of this lifecycle state icon.
    isReleasedState
    boolean
    Indicates whether this state is a released state.

    true: This state is a released state.

    false: This state is not a released state.

    isObsoleteState
    boolean
    Indicates whether this state is an obsolete state.

    true: This state is an obsolete state.

    false: This state is not an obsolete state.

    displayOrder
    int
    The display order of this state among other states of the same lifecycle definition.
    parent
    object
    Contains standard folder metadata returned by Vault.
    id
    string
    The unique identifier of this folder.
    url
    string
    The relative URL to access this object.
    name
    string
    The descriptive name of this folder. This is the folder name without the full path.
    fullName
    string
    The full Vault path for this folder (for example, $/Folder1).
    createDate
    datetime: ISO 8601
    The date and time when the folder was created.
    createUserName
    string
    The name of the user who created this folder.
    category
    string
    The category assigned to this folder.
    categoryColor
    number
    The color of the category.
    state
    string
    The name of the lifecycle state for this folder.
    stateColor
    number
    The color of the lifecycle state.
    subfolderCount
    number
    The number of immediate child folders.
    children
    string
    The URI to retrieve child folders.
    isLibrary
    boolean
    Indicates whether this folder is a library folder.

    true: This folder is a library folder.

    false: This folder is not a library folder.

    isReadOnly
    boolean
    Indicates whether this folder can be modified by the logged-in user.

    true: This folder is read-only for the logged-in user.

    false: This folder can be modified by the logged-in user.

    isCloaked
    boolean
    Indicates whether this folder is cloaked. A cloaked object is one that the caller does not have permissions to view.

    true: This folder is cloaked.

    false: This folder is not cloaked.

    properties
    array: object
    An array of property values for this folder.
    propertyDefinitionId
    string
    The unique identifier of the property definition that this value belongs to.
    definition
    object
    Contains server-side metadata for a Vault property definition, including datatype and naming.
    id
    string
    The unique identifier of the property definition.
    url
    string
    The relative URL to access this object.
    displayName
    string
    The display name of this property definition.
    systemName
    string
    The system name of this property definition.
    dataType
    enum:string
    The underlying data type stored for values of this property. Possible values: String, Numeric, Bool, DateTime, Image
    active
    boolean
    Indicates whether this property definition is active.

    true: This property definition is active.

    false: This property definition is inactive.

    isSystem
    boolean
    Indicates whether this property definition is a built-in system property.

    true: This is a system property.

    false: This is a user-defined property.

    initialValue
    string
    The default value applied to entities that do not have an existing value for this property definition.
    value
    string
    The property value associated with the entity for the referenced property definition.
    isCheckedOut
    boolean
    Indicates whether the latest version of this file is in the checked-out state.

    true: The latest file version is checked out.

    false: The latest file version is not checked out.

    createUserName
    string
    The Name of the user who checked-in or uploaded this file.
    checkinDate
    datetime: ISO 8601
    The date and time that the file was checked in. This property is only valid if isCheckedOut is false.
    checkoutDate
    datetime: ISO 8601
    The date and time when the file was last checked out.
    checkoutUserName
    string
    The user name of the user who currently has the file checked out.
    size
    number
    The size, in bytes, of the file. This property is only valid if isCheckedOut is false.
    url
    string
    The relative URL to access this object.
    hasVisualizationAttachment
    boolean
    Indicates whether a valid visualization attachment status is available (value is not None).

    true: A valid visualization attachment status is available.

    false: A valid visualization attachment status is not available.

    visualizationAttachmentStatus
    enum:string
    The synchronization state of design visualization attachments. Possible values:
    • None - No visualization attachment status applies.
    • Syncronized - Visualization is synchronized with the CAD source (wire spelling as returned by Vault).
    • NotSyncronized - Visualization is not synchronized.
    • UserVerified - A user verified the visualization attachment.
    • Legacy - Legacy visualization attachment record.
    isReadOnly
    boolean
    Indicates whether this file is read-only for the current user.

    true: This file is read-only.

    false: This file is editable.

    isCloaked
    boolean
    Indicates whether this file is cloaked. A cloaked object is one that the caller does not have permissions to view.

    true: This file is cloaked.

    false: This file is not cloaked.

    isOnSite
    boolean
    Indicates whether the file is on the local site (in a multi-site environment). This value is always true in a single-site environment.

    true: The file is on the local site.

    false: The file is not on the local site.

    properties
    array: object
    An array of property values for this file version.
    propertyDefinitionId
    string
    The unique identifier of the property definition that this value belongs to.
    definition
    object
    Contains server-side metadata for a Vault property definition, including datatype and naming.
    id
    string
    The unique identifier of the property definition.
    url
    string
    The relative URL to access this object.
    displayName
    string
    The display name of this property definition.
    systemName
    string
    The system name of this property definition.
    dataType
    enum:string
    The underlying data type stored for values of this property. Possible values: String, Numeric, Bool, DateTime, Image
    active
    boolean
    Indicates whether this property definition is active.

    true: This property definition is active.

    false: This property definition is inactive.

    isSystem
    boolean
    Indicates whether this property definition is a built-in system property.

    true: This is a system property.

    false: This is a user-defined property.

    initialValue
    string
    The default value applied to entities that do not have an existing value for this property definition.
    value
    string
    The property value associated with the entity for the referenced property definition.

    Example

    This example illustrates how to check out a file.

    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/9/files/219:checkout' \
      -X 'POST' \
      -H 'Accept: application/json'\
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
    

    Response

    {
      "name": "Bracket.ipt",
      "id": "224",
      "state": "Work in Progress",
      "category": "Engineering",
      "isCheckedOut": true,
      "size": 26,
      "checkoutDate": "2026-09-18T06:07:37.327Z",
      "checkoutUserName": "Administrator",
      "file": {
        "id": "219",
        "entityType": "File",
        "url": "/AutodeskDM/Services/api/vault/v2/vaults/9/files/219"
      },
      "url": "/AutodeskDM/Services/api/vault/v2/vaults/9/file-versions/224"
    }
    
    Show More