vaults/{vaultId}/file-versions/{id}/uses
Get file dependencies and attachments for given file version id
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 obtained via a three-legged OAuth flow. |
Request
URI Parameters
vaultId string | The unique identifier of a vault. |
id string | The unique identifier of a file version. |
Request
Query String Parameters
option[includeHidden] boolean | true : Include files marked as hidden.
|
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 that need to be returned. property ids separated by ‘,’, e.g. ‘1,2,3’ ‘all’ means return all properties. |
option[getLatestAssocs] boolean | true : (Default) Get the latest file associations.
|
option[recurse] boolean | true : Include all levels of child.
|
limit int | Specifies the number of results to return per page. Maximum limit is controlled by “Page size conifguration” setting which could be updated using ADMS (“Global Setting” -> “Page size conifguration”). |
cursorState string | Indicates the state of the cursor for pagination. Use this parameter to navigate through paged results |
Response
HTTP Status Code Summary
200 OK | The request succeeded. |
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 | Cursor-based pagination object. |
limit int | Limit requested for the current search |
totalResults int | Number of total hits. If this value is larger than the objects returned, then multiple searches will have to be performed to get the complete result set. |
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.
The statuses include:
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.
Possible values: |
nextUrl string | Used to continue a search if the results are too large for a single call. Url has bookmark string embedded for subsequent calls on that search |
results array: object | |
parentFile object | file version basic object. |
id string | File IterationId |
name string | The name of the file. This value applies to all versions of the file |
category string | Category information about this file |
categoryColor number | Category color |
classification enum:string | The classification of the file.
Possible values: None , DesignVisualization , DesignDocument , ConfigurationMember , ConfigurationFactory , ElectricalProject , DesignSubstitute , DesignRepresentation , DesignPresentation |
entityType string | |
version number | The version of the file. A file that has just been added to the Vault, will have 1 as its VerNum |
createDate string | Tells the date and time that this version of the file was created in the Vault. For the first version of a file, this date will match CkInDate. For later versions, this value will have the time when the previous version was checked out. |
lastModifiedDate string | The last modified date of the file. This value is set by the client that uploaded the file. |
revision string | Revision information about this file. |
state string | The name of the life cycle state for the current file |
stateColor number | The color of the state. |
parentFolderId string | FolderId of the parent the current file resides in |
file object | |
id string | File MasterId |
url string | The relative URL to access this object. |
versionType enum:string | An enumerated value that specifies the type of version to retrieve.
Possible values: None , Latest , LatestReleased |
fileVersion object | |
parent object | folder object |
id string | Get the unique identifier for this folder |
url string | The relative URL to access this object. |
name string | Get the descriptive name for this Folder. This is always the Folder Name without the full path. |
fullName string | Get the full vault path for this folder (ie. $/Folder1) |
createDate string | Get the date and time that the folder was created. |
createUserName string | Get the name of the user who created this folder. |
category string | Get the category that is assigned to this folder |
categoryColor number | Category color |
state string | The name of the life cycle state for the current folder |
stateColor number | The color of the state. |
subfolderCount number | Get the number of immediate child folders. |
children string | |
isLibrary boolean | Get whether or not this folder is a library folder |
isReadOnly boolean | Get whether this folder can be modified by the logged in user. |
isCloaked boolean | Get if this folder is cloaked. A cloaked object is one that the caller does not have permissions to view. |
properties array: object | |
propertyDefinitionId string | Unique identifier for a server-based property definition |
definition object | Property definition object. |
id string | Get the unique identifier for a server-based property definition |
url string | The relative URL to access this object. |
displayName string | Get or sets the Display name for this Property Definition |
systemName string | Get the System Name for this Property Definition. |
dataType enum:string | The value defined in SQL database.
Possible values: String , Numeric , Bool , DateTime , Image |
active boolean | Get or sets whether this Property Definition is Active. |
isSystem boolean | Get whether or not this is a System Property (as opposed to an userDefined property) |
initialValue string | Default Value that will be applied to entities that do not have an existing value associated with this PropertyDefinition |
value string | The property value associated with the entity and PropertyDefinition |
isCheckedOut boolean | If true, then 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 string | The date and time that the file was checked in. This property is only valid if isCheckedOut is false. |
checkoutDate string | The date and time that the file was last checked out |
checkoutUserName string | User that has the file checked out |
size number | The size, in bytes, of the file. This property is only valid if CheckedOut is false. |
url string | The relative URL to access this object. |
hasVisualizationAttachment boolean | Flag to determine if valid VizAttachmentStatus (Not None) |
visualizationAttachmentStatus enum:string | The design visualization attachment status of the file.
Possible values: None , Syncronized , NotSyncronized , UserVerified , Legacy |
isReadOnly boolean | |
isCloaked boolean | Get if this file is cloaked. A cloaked object is one that the caller does not have permissions to view |
isOnSite boolean | Gets whether or not the file is on the local site (in a multi-site environment). This value will always be true on a single-site environment. |
properties array: object | |
propertyDefinitionId string | Unique identifier for a server-based property definition |
definition object | Property definition object. |
id string | Get the unique identifier for a server-based property definition |
url string | The relative URL to access this object. |
displayName string | Get or sets the Display name for this Property Definition |
systemName string | Get the System Name for this Property Definition. |
dataType enum:string | The value defined in SQL database.
Possible values: String , Numeric , Bool , DateTime , Image |
active boolean | Get or sets whether this Property Definition is Active. |
isSystem boolean | Get whether or not this is a System Property (as opposed to an userDefined property) |
initialValue string | Default Value that will be applied to entities that do not have an existing value associated with this PropertyDefinition |
value string | The property value associated with the entity and PropertyDefinition |
checkoutUser object | User object. |
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 object | The type of account to retrieve. Allowed values are ActiveDirectory, Vault, and Autodesk.
Possible values: ActiveDirectory , Vault , Autodesk |
systemName string | |
createDate datetime: ISO 8601 | The date that the user was created. |
isActive string | Is the user active |
url string | The relative URL to access this object. |
childFile object | file version basic object. |
id string | File IterationId |
name string | The name of the file. This value applies to all versions of the file |
category string | Category information about this file |
categoryColor number | Category color |
classification enum:string | The classification of the file.
Possible values: None , DesignVisualization , DesignDocument , ConfigurationMember , ConfigurationFactory , ElectricalProject , DesignSubstitute , DesignRepresentation , DesignPresentation |
entityType string | |
version number | The version of the file. A file that has just been added to the Vault, will have 1 as its VerNum |
createDate string | Tells the date and time that this version of the file was created in the Vault. For the first version of a file, this date will match CkInDate. For later versions, this value will have the time when the previous version was checked out. |
lastModifiedDate string | The last modified date of the file. This value is set by the client that uploaded the file. |
revision string | Revision information about this file. |
state string | The name of the life cycle state for the current file |
stateColor number | The color of the state. |
parentFolderId string | FolderId of the parent the current file resides in |
file object | |
id string | File MasterId |
url string | The relative URL to access this object. |
versionType enum:string | An enumerated value that specifies the type of version to retrieve.
Possible values: None , Latest , LatestReleased |
fileVersion object | |
parent object | folder object |
id string | Get the unique identifier for this folder |
url string | The relative URL to access this object. |
name string | Get the descriptive name for this Folder. This is always the Folder Name without the full path. |
fullName string | Get the full vault path for this folder (ie. $/Folder1) |
createDate string | Get the date and time that the folder was created. |
createUserName string | Get the name of the user who created this folder. |
category string | Get the category that is assigned to this folder |
categoryColor number | Category color |
state string | The name of the life cycle state for the current folder |
stateColor number | The color of the state. |
subfolderCount number | Get the number of immediate child folders. |
children string | |
isLibrary boolean | Get whether or not this folder is a library folder |
isReadOnly boolean | Get whether this folder can be modified by the logged in user. |
isCloaked boolean | Get if this folder is cloaked. A cloaked object is one that the caller does not have permissions to view. |
properties array: object | |
propertyDefinitionId string | Unique identifier for a server-based property definition |
definition object | Property definition object. |
id string | Get the unique identifier for a server-based property definition |
url string | The relative URL to access this object. |
displayName string | Get or sets the Display name for this Property Definition |
systemName string | Get the System Name for this Property Definition. |
dataType enum:string | The value defined in SQL database.
Possible values: String , Numeric , Bool , DateTime , Image |
active boolean | Get or sets whether this Property Definition is Active. |
isSystem boolean | Get whether or not this is a System Property (as opposed to an userDefined property) |
initialValue string | Default Value that will be applied to entities that do not have an existing value associated with this PropertyDefinition |
value string | The property value associated with the entity and PropertyDefinition |
isCheckedOut boolean | If true, then 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 string | The date and time that the file was checked in. This property is only valid if isCheckedOut is false. |
checkoutDate string | The date and time that the file was last checked out |
checkoutUserName string | User that has the file checked out |
size number | The size, in bytes, of the file. This property is only valid if CheckedOut is false. |
url string | The relative URL to access this object. |
hasVisualizationAttachment boolean | Flag to determine if valid VizAttachmentStatus (Not None) |
visualizationAttachmentStatus enum:string | The design visualization attachment status of the file.
Possible values: None , Syncronized , NotSyncronized , UserVerified , Legacy |
isReadOnly boolean | |
isCloaked boolean | Get if this file is cloaked. A cloaked object is one that the caller does not have permissions to view |
isOnSite boolean | Gets whether or not the file is on the local site (in a multi-site environment). This value will always be true on a single-site environment. |
properties array: object | |
propertyDefinitionId string | Unique identifier for a server-based property definition |
definition object | Property definition object. |
id string | Get the unique identifier for a server-based property definition |
url string | The relative URL to access this object. |
displayName string | Get or sets the Display name for this Property Definition |
systemName string | Get the System Name for this Property Definition. |
dataType enum:string | The value defined in SQL database.
Possible values: String , Numeric , Bool , DateTime , Image |
active boolean | Get or sets whether this Property Definition is Active. |
isSystem boolean | Get whether or not this is a System Property (as opposed to an userDefined property) |
initialValue string | Default Value that will be applied to entities that do not have an existing value associated with this PropertyDefinition |
value string | The property value associated with the entity and PropertyDefinition |
checkoutUser object | User object. |
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 object | The type of account to retrieve. Allowed values are ActiveDirectory, Vault, and Autodesk.
Possible values: ActiveDirectory , Vault , Autodesk |
systemName string | |
createDate datetime: ISO 8601 | The date that the user was created. |
isActive string | Is the user active |
url string | The relative URL to access this object. |
fileAssocType enum:string | File association options.
Possible values: Dependency , Attachment |
included object | |
folder object | |
* object | folder object |
id string | Get the unique identifier for this folder |
url string | The relative URL to access this object. |
name string | Get the descriptive name for this Folder. This is always the Folder Name without the full path. |
fullName string | Get the full vault path for this folder (ie. $/Folder1) |
createDate string | Get the date and time that the folder was created. |
createUserName string | Get the name of the user who created this folder. |
category string | Get the category that is assigned to this folder |
categoryColor number | Category color |
state string | The name of the life cycle state for the current folder |
stateColor number | The color of the state. |
subfolderCount number | Get the number of immediate child folders. |
children string | |
isLibrary boolean | Get whether or not this folder is a library folder |
isReadOnly boolean | Get whether this folder can be modified by the logged in user. |
isCloaked boolean | Get if this folder is cloaked. A cloaked object is one that the caller does not have permissions to view. |
properties array: object | |
propertyDefinitionId string | Unique identifier for a server-based property definition |
definition object | Property definition object. |
id string | Get the unique identifier for a server-based property definition |
url string | The relative URL to access this object. |
displayName string | Get or sets the Display name for this Property Definition |
systemName string | Get the System Name for this Property Definition. |
dataType enum:string | The value defined in SQL database.
Possible values: String , Numeric , Bool , DateTime , Image |
active boolean | Get or sets whether this Property Definition is Active. |
isSystem boolean | Get whether or not this is a System Property (as opposed to an userDefined property) |
initialValue string | Default Value that will be applied to entities that do not have an existing value associated with this PropertyDefinition |
value string | The property value associated with the entity and PropertyDefinition |
propertyDefinition object | |
* object | Property definition object. |
id string | Get the unique identifier for a server-based property definition |
url string | The relative URL to access this object. |
displayName string | Get or sets the Display name for this Property Definition |
systemName string | Get the System Name for this Property Definition. |
dataType enum:string | The value defined in SQL database.
Possible values: String , Numeric , Bool , DateTime , Image |
active boolean | Get or sets whether this Property Definition is Active. |
isSystem boolean | Get whether or not this is a System Property (as opposed to an userDefined property) |
initialValue string | Default Value that will be applied to entities that do not have an existing value associated with this PropertyDefinition |
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...'