vaults/{vaultId}/file-versions/{id}/uses
Retrieves the file dependencies and attachments (child associations) for the specified file version.
Resource Information
| Method and URI | GET /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/file-versions/{id}/uses |
| 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. |
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
| option[includeHidden] boolean | true: Include files marked as hidden.
|
| option[includeRelatedDocuments] boolean | true: Include related documentation files.
|
| option[releaseBiased] boolean | true: (Default) Use “Release biased” approach of gathering dependencies.
|
| option[releasedOnly] boolean | true: Include only associations that are in consumable state.
|
| option[extendedModels] boolean | true: The response will include additional detailed information for each entity. Examples include:
|
| option[propDefIds] string | The properties to include in the response. Provide a comma-separated list of property definition IDs (for example, 1,2,3) or pass all to return every property. |
| option[getLatestAssocs] boolean | true: (Default) Returns the latest file associations.
|
| option[recurse] boolean | true: Include all levels of child.
|
| limit int | The maximum number of results to return per page. Defaults to 100.
The hard upper bound is controlled by the Page size configuration setting, which an administrator can update through ADMS (Global Setting -> Page size configuration). |
| cursorState string | The cursor token used to fetch the next page of results. Pass the value returned in pagination.nextUrl from the previous response to continue paging. |
Response
HTTP Status Code Summary
| 200 OK | The child file associations were successfully retrieved. |
| 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. |
Response
Body Structure (200)
| pagination object | Contains pagination metadata for navigating through large result sets. |
| limit int | The maximum number of results that can be returned in this response. The actual number of results may be fewer due to filtering, data availability, or other constraints. This reflects the limit value applied by the server, which may differ from the requested limit. |
| totalResults int | The total number of results available across all pages that match the query criteria, regardless of pagination limits. |
| indexingStatus enum:string | Indicates the current status of the indexing engine. This status helps users understand whether the indexing operation is complete or still in progress. This is particularly important for customers with large datasets, as indexing can take a considerable amount of time to complete.
Possible values:
Note: When the status is either ‘IndexingProperties’ or ‘IndexingContent’, the search results are incomplete because the indexes are still being created. Complete search results will be available once fully indexed. |
| nextUrl string | The URL used to retrieve the next page of results. The URL includes an embedded cursor token for the subsequent call. When null or absent, this is the final page. Note that a page may be empty but still include a next page URL. Continue paging until this attribute is null or absent. |
| results array: object | An array of file associations. |
| parentFile object | Contains standard file iteration metadata returned by Vault. |
| 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:
|
| 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.
|
| 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.
|
| color int | The color code of this lifecycle state icon. |
| isReleasedState boolean | Indicates whether this state is a released state.
|
| isObsoleteState boolean | Indicates whether this state is an obsolete state.
|
| displayOrder int | The display order of this state among other states of the same lifecycle definition. |
| 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:
|
| 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:
|
| fileVersion object | The referenced file version details. |
| 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.
|
| isReadOnly boolean | Indicates whether 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.
|
| 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.
|
| isSystem boolean | Indicates whether this property definition is a built-in system 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.
|
| 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).
|
| visualizationAttachmentStatus enum:string | The synchronization state of design visualization attachments. Possible values:
|
| isReadOnly boolean | Indicates whether this file is read-only for the current user.
|
| isCloaked boolean | Indicates whether this file is cloaked. A cloaked object is one that the caller does not have permissions to view.
|
| 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.
|
| 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.
|
| isSystem boolean | Indicates whether this property definition is a built-in system 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. |
| childFile object | Contains standard file iteration metadata returned by Vault. |
| 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:
|
| 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.
|
| 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.
|
| color int | The color code of this lifecycle state icon. |
| isReleasedState boolean | Indicates whether this state is a released state.
|
| isObsoleteState boolean | Indicates whether this state is an obsolete state.
|
| displayOrder int | The display order of this state among other states of the same lifecycle definition. |
| 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:
|
| 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:
|
| fileVersion object | The referenced file version details. |
| 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.
|
| isReadOnly boolean | Indicates whether 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.
|
| 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.
|
| isSystem boolean | Indicates whether this property definition is a built-in system 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.
|
| 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).
|
| visualizationAttachmentStatus enum:string | The synchronization state of design visualization attachments. Possible values:
|
| isReadOnly boolean | Indicates whether this file is read-only for the current user.
|
| isCloaked boolean | Indicates whether this file is cloaked. A cloaked object is one that the caller does not have permissions to view.
|
| 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.
|
| 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.
|
| isSystem boolean | Indicates whether this property definition is a built-in system 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. |
| fileAssocType enum:string | Classifies how two file versions relate. Possible values:
|
| refId string | Per-association reference identifier for the child in the context of the parent (for example, a CAD application handle). |
| included object | Contains additional resources included with the file association results. |
| folder object | |
| * object | Contains standard folder metadata returned by Vault. |
| id string | The unique identifier of this folder. |
| url all of | The relative URL to access this folder. |
| 0 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.
|
| isReadOnly boolean | Indicates whether 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.
|
| 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 all of | The property definition metadata for this property value. |
| Property 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 all of | The relative URL to access this property definition. |
| 0 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.
|
| isSystem boolean | Indicates whether this property definition is a built-in system 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. |
| propertyDefinition object | |
| * object | Contains server-side metadata for a Vault property definition, including datatype and naming. |
| id string | The unique identifier of the property definition. |
| url all of | The relative URL to access this property definition. |
| 0 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.
|
| isSystem boolean | Indicates whether this property definition is a built-in system property.
|
| initialValue string | The default value applied to entities that do not have an existing value for this property definition. |
Example
This example illustrates how to get a file version’s uses.
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/uses?option[includeHidden]=true' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'