vaults/{vaultId}/search-results
Basic Search: Find entities using a query string. The text is searched across all properties or both properties and content based on options passed.
Resource Information
Method and URI | GET /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/search-results |
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. |
Request
Query String Parameters
q string | The value to use for the search. Based on ‘SearchContent’ option, this parameter will either search across all properties or across all properties and content. Ex: q=Assembly, all objects that contain ‘Assembly’ within their properties will be returned. |
option[searchContent] boolean | true : Search full content of the file.
|
option[searchSubFolders] boolean | true : Search sub folders.
|
option[releasedFilesOnly] boolean | true : Include only versions that are consumable (released) state.
|
option[releasedItemsOnly] boolean | true : Include only versions that are consumable (released) state.
|
option[latestOnly] boolean | true : (Default) Include only the latest version.
|
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. |
sort string | Specifies sorting criteria for search results. Format: {propertyDefSysName} {sort-order} Accepted values for sort-order: asc, desc. Ex: sort = Revision desc,Name asc |
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. The response contains the search results. |
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. |
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 | |
anyOf | |
0 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 all of | file version extended object |
File Version | |
1 object | |
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. |
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 |
1 all of | file version extended object |
File Version 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 |
1 object | |
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. |
2 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 |
3 all of | folder extended object |
Folder 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 |
1 object | |
parentFolderId string | |
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 |
4 object | change order object |
id string | Master Id of this Change Order. The Master Id uniquely identifies this Change Order object |
url string | The relative URL to access this object. |
name string | The descriptive name for this Change Order.The Change Order Number will be used here. |
createDate string | The date and time the Change Order was created |
number string | The Change Order number. Numbers are generated based on the Numbering Scheme. |
title string | The title of the Change Order |
description string | The description of the Change Order. |
approveDeadline string | The date and time when the Change Order needs to be approved by. |
lastModifiedDate string | The last time that the Change Order was modified. |
lastModifiedUserId string | |
closeDate string | |
lastTouchedDate string | the last time that the Change Order was modified. |
entityType string | |
numberOfAttachments number | Number of File Attachments |
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 |
state string | Get the name of the Change Order State. |
stateColor number | The color of the state. |
isReadOnly boolean | Get if the Change Order is currently locked. |
5 all of | change order extended object |
Change Order object | change order object |
id string | Master Id of this Change Order. The Master Id uniquely identifies this Change Order object |
url string | The relative URL to access this object. |
name string | The descriptive name for this Change Order.The Change Order Number will be used here. |
createDate string | The date and time the Change Order was created |
number string | The Change Order number. Numbers are generated based on the Numbering Scheme. |
title string | The title of the Change Order |
description string | The description of the Change Order. |
approveDeadline string | The date and time when the Change Order needs to be approved by. |
lastModifiedDate string | The last time that the Change Order was modified. |
lastModifiedUserId string | |
closeDate string | |
lastTouchedDate string | the last time that the Change Order was modified. |
entityType string | |
numberOfAttachments number | Number of File Attachments |
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 |
state string | Get the name of the Change Order State. |
stateColor number | The color of the state. |
isReadOnly boolean | Get if the Change Order is currently locked. |
1 object | |
assignees array: 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. |
6 object | link object. |
name string | |
id string | Get the unique identifier for this link object |
createDate string | |
createUserName string | |
entityType string | |
url string | The relative URL to access this object. |
toEntity object | A generic entity object with all supported fields. |
id string | A unique identifier for the object |
name string | Name of the entity |
fullName string | The full vault path if Entity is a folder |
number string | |
category string | Category information about this entity |
categoryColor number | Category color |
entityType string | |
version number | Version number if entity is an Iteration object |
createDate string | Tells the date and time that this version of the entity was created in the Vault. |
lastModifiedDate string | |
revision string | Revision information about this entity. |
state string | The name of the life cycle state for the entity |
stateColor number | The color of the state. |
parentFolderId string | |
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 | |
createUserName string | |
checkinDate string | |
checkoutDate string | |
size number | |
url string | The relative URL to access this object. |
hasVisualizationAttachment boolean | |
checkoutUserName string | |
isLibrary boolean | |
isReadOnly boolean | |
isCloaked boolean | |
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 all of | file version extended object |
File Version 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 | |
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 |
1 object | |
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. |
item object | Item object. |
id string | MasterId of the item |
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 |
itemVersion object | The unique identifier for the object. |
id string | Item Iteration Id |
url string | The relative URL to access this object. |
number string | The Item number. |
version number | The version number, which is a sequential number given to each version. For example, if this value is 5, then the object is the 5th version. |
revision string | The display value for the revision. |
comment string | |
title string | The display title. |
state string | Life cycle state of the item |
stateColor number | |
name string | |
category string | Category assigned to the item |
categoryColor number | |
entityType string | |
isReadOnly boolean | |
isCloaked boolean | If true, the logged-in user is restricted from seeing this item. |
isLatestObsolete boolean | Flag to check if an latest Item’s version is obsolete |
item object | |
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 |
subfolderCount number | |
children string | |
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 |
fromEntity 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 |
7 object | The unique identifier for the object. |
id string | Item Iteration Id |
url string | The relative URL to access this object. |
number string | The Item number. |
version number | The version number, which is a sequential number given to each version. For example, if this value is 5, then the object is the 5th version. |
revision string | The display value for the revision. |
comment string | |
title string | The display title. |
state string | Life cycle state of the item |
stateColor number | |
name string | |
category string | Category assigned to the item |
categoryColor number | |
entityType string | |
isReadOnly boolean | |
isCloaked boolean | If true, the logged-in user is restricted from seeing this item. |
isLatestObsolete boolean | Flag to check if an latest Item’s version is obsolete |
item object | Item object. |
id string | MasterId of the item |
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 |
itemVersion object | |
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 |
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 search a file with name ‘blade_main.ipt’.
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/search-results?q=blade_main.ipt' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
Response
{
"pagination": {
"limit": 100,
"totalResults": 1,
"indexingStatus": "IndexingComplete"
},
"results": [
{
"name": "blade_main.ipt",
"id": "14380",
"state": "",
"stateColor": 0,
"revision": "",
"category": "Base",
"categoryColor": -1,
"lastModifiedDate": "2024-04-22T07:48:57.407Z",
"isCheckedOut": true,
"hasVisualizationAttachment": false,
"size": 246272,
"isCloaked": false,
"checkinDate": "0001-01-01T00:00:00Z",
"checkoutDate": "2024-04-22T08:14:02.613Z",
"checkoutUserName": "Administrator",
"isHidden": false,
"isReadOnly": false,
"parentFolderId": "1284",
"file": {
"id": "1287",
"entityType": "File",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/1/files/1287"
},
"isOnSite": true,
"createDate": "2024-04-22T07:48:57.88Z",
"createUserName": "Administrator",
"classification": "None",
"visualizationAttachmentStatus": "None",
"version": 3,
"entityType": "FileVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/1/file-versions/14380"
}
],
"included": {
"folder": {
"1284": {
"name": "Components",
"id": "1284",
"fullName": "$/Models/Assemblies/Scissors/Components",
"category": "Folder",
"categoryColor": -1,
"stateColor": 0,
"subfolderCount": 0,
"isLibrary": false,
"isCloaked": false,
"isReadOnly": false,
"createDate": "2016-10-17T19:35:14.583Z",
"createUserName": "Administrator",
"entityType": "Folder",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/1/folders/1284"
}
}
}
}