vaults/{vaultId}/folders/{id}/contents
Retrieves the contents of the specified folder, including its child folders and entities.
Resource Information
| Method and URI | GET /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/folders/{id}/contents |
| 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 folder. The reserved keyword root returns the contents of the Knowledge Vault’s root folder. |
Request
Query String Parameters
| q string | The value to search for. By default, Vault searches across all properties of the entity.
When the Example: |
| option[searchContent] boolean | true: Search query text within all properties or both in all properties and content.
|
| option[searchSubFolders] boolean | true: Search query text within all sub folders.
|
| option[includeFolders] boolean | true: (Default) Include folders or folder links in the search result.
|
| option[includeItemEcoLinks] boolean | true: (Default) Include Item/Change-order Link in the search result.
|
| option[releasedFilesOnly] boolean | true: Include only file/file links that are in consumable (released) state.
|
| option[releasedItemsOnly] boolean | true: Include only itemLink that are consumable 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 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. |
| sort string | The sorting criteria for the results. Supports multi-sort with one or more comma-separated entries.
Each entry takes the form |
| 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 folder contents were successfully retrieved. |
| 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 entities. |
| anyOf | |
| File Version object | Contains standard file iteration metadata returned by Vault. |
| 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 all of | The classification assigned to this file. |
| File Classification Enum 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 all of | The file master object for this file version. |
| File object | Contains the Vault file master identity and referenced file version. |
| id string | The unique identifier (master ID) of the file. |
| url all of | The relative URL to access this file. |
| 0 string | The relative URL to access this object. |
| versionType all of | The version type of the referenced file version. |
| Version Type Enum enum:string | Specifies which file or item iteration to resolve. Possible values:
|
| fileVersion all of | The referenced file version details. |
| File Version Extended all of | Contains extended file version metadata including checkout user and lifecycle state. |
| File Version | |
| 1 object | |
| parent all of | The parent folder containing this file version. |
| Folder 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. |
| 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 all of | The relative URL to access this file version. |
| 0 string | The relative URL to access this object. |
| hasVisualizationAttachment boolean | Indicates whether a valid visualization attachment status is available (value is not None).
|
| visualizationAttachmentStatus all of | The visualization attachment status for this file version. |
| File Visualization Attachment Status Enum 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 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. |
| File Version Extended all of | Contains extended file version metadata including checkout user and lifecycle state. |
| File Version object | Contains standard file iteration metadata returned by Vault. |
| 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 all of | The classification assigned to this file. |
| File Classification Enum 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 all of | The file master object for this file version. |
| File object | Contains the Vault file master identity and referenced file version. |
| id string | The unique identifier (master ID) of the file. |
| url all of | The relative URL to access this file. |
| 0 string | The relative URL to access this object. |
| versionType all of | The version type of the referenced file version. |
| Version Type Enum enum:string | Specifies which file or item iteration to resolve. Possible values:
|
| fileVersion all of | The referenced file version details. |
| File Version Extended | |
| parent all of | The parent folder containing this file version. |
| Folder 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. |
| 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 all of | The relative URL to access this file version. |
| 0 string | The relative URL to access this object. |
| hasVisualizationAttachment boolean | Indicates whether a valid visualization attachment status is available (value is not None).
|
| visualizationAttachmentStatus all of | The visualization attachment status for this file version. |
| File Visualization Attachment Status Enum 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 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. |
| 1 object | |
| Folder 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. |
| Folder Extended all of | Contains extended folder metadata such as parent folder and lifecycle state. |
| Folder 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. |
| 1 object | |
| Change Order object | Contains core change order metadata and properties returned by the API. |
| id string | The unique identifier (master ID) of this Change Order. |
| url all of | The relative URL to access this Change Order. |
| 0 string | The relative URL to access this object. |
| name string | The descriptive name of this Change Order. This value is the Change Order number. |
| createDate datetime: ISO 8601 | The date and time when the Change Order was created. |
| number string | The Change Order number. Numbers are generated based on the configured numbering scheme. |
| title string | The title of the Change Order. |
| description string | The description of the Change Order. |
| approveDeadline datetime: ISO 8601 | The date and time by which the Change Order must be approved. |
| lastModifiedDate datetime: ISO 8601 | The date and time when the Change Order was last modified. |
| lastModifiedUserId string | The unique identifier of the user who last modified the Change Order. |
| closeDate datetime: ISO 8601 | The date and time when the Change Order was closed. |
| lastTouchedDate datetime: ISO 8601 | The date and time when the Change Order was last touched (modified or interacted with). |
| entityType string | The type of entity represented by this Change Order. |
| numberOfAttachments number | The number of file attachments on this Change Order. |
| properties array: object | An array of property values for this Change Order. |
| 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. |
| state string | The name of the Change Order’s lifecycle state. |
| stateColor number | The color of the state. |
| isReadOnly boolean | Indicates whether the Change Order is currently locked.
|
| Change Order Extended all of | Contains extended change order details, including assignees, in addition to core change order fields. |
| Change Order object | Contains core change order metadata and properties returned by the API. |
| id string | The unique identifier (master ID) of this Change Order. |
| url all of | The relative URL to access this Change Order. |
| 0 string | The relative URL to access this object. |
| name string | The descriptive name of this Change Order. This value is the Change Order number. |
| createDate datetime: ISO 8601 | The date and time when the Change Order was created. |
| number string | The Change Order number. Numbers are generated based on the configured numbering scheme. |
| title string | The title of the Change Order. |
| description string | The description of the Change Order. |
| approveDeadline datetime: ISO 8601 | The date and time by which the Change Order must be approved. |
| lastModifiedDate datetime: ISO 8601 | The date and time when the Change Order was last modified. |
| lastModifiedUserId string | The unique identifier of the user who last modified the Change Order. |
| closeDate datetime: ISO 8601 | The date and time when the Change Order was closed. |
| lastTouchedDate datetime: ISO 8601 | The date and time when the Change Order was last touched (modified or interacted with). |
| entityType string | The type of entity represented by this Change Order. |
| numberOfAttachments number | The number of file attachments on this Change Order. |
| properties array: object | An array of property values for this Change Order. |
| 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. |
| state string | The name of the Change Order’s lifecycle state. |
| stateColor number | The color of the state. |
| isReadOnly boolean | Indicates whether 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 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. |
| Link object | Contains metadata linking two Vault entities. |
| name string | The name of the link. |
| id string | The unique identifier of this link. |
| createDate datetime: ISO 8601 | The date and time when the link was created. |
| createUserName string | The user name of the user who created the link. |
| entityType string | The type of entity represented by this link. |
| url all of | The relative URL to access this link. |
| 0 string | The relative URL to access this object. |
| toEntity all of | The destination entity for this link. |
| Entity object | Contains a generic entity representation with every field the API supports for mixed search results. |
| id string | The unique identifier of the entity. |
| name string | The name of the entity. |
| fullName string | The full Vault path of this entity when it is a folder. |
| number string | The entity number when this entity type supports numbering. |
| category string | The category assigned to this entity. |
| categoryColor number | The color of the category. |
| entityType string | The type of entity represented by this result. |
| version number | The version number when the entity is an iteration object. |
| createDate datetime: ISO 8601 | The date and time when this version of the entity was created in the Vault. |
| lastModifiedDate datetime: ISO 8601 | The date and time when this entity was last modified. |
| revision string | The revision label for this entity. |
| state string | The name of the lifecycle state for the entity. |
| stateColor number | The color of the state. |
| parentFolderId string | The unique identifier of the parent folder. |
| parent all of | The parent folder of this entity. |
| Folder 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. |
| isCheckedOut boolean | Indicates whether the latest version of this entity is checked out.
|
| createUserName string | The user name of the user who created this entity version. |
| checkinDate datetime: ISO 8601 | The date and time when this entity was checked in. |
| checkoutDate datetime: ISO 8601 | The date and time when this entity was checked out. |
| size number | The size of the entity content in bytes. |
| url all of | The relative URL to access this entity. |
| 0 string | The relative URL to access this object. |
| hasVisualizationAttachment boolean | Indicates whether a visualization attachment is available for this entity.
|
| checkoutUserName string | The user name of the user who currently has this entity checked out. |
| isLibrary boolean | Indicates whether this entity belongs to a library.
|
| isReadOnly boolean | Indicates whether this entity is read-only for the current user.
|
| isCloaked boolean | Indicates whether this entity is cloaked.
|
| file all of | The file object associated with this entity. |
| File object | Contains the Vault file master identity and referenced file version. |
| id string | The unique identifier (master ID) of the file. |
| url all of | The relative URL to access this file. |
| 0 string | The relative URL to access this object. |
| versionType all of | The version type of the referenced file version. |
| Version Type Enum enum:string | Specifies which file or item iteration to resolve. Possible values:
|
| fileVersion all of | The referenced file version details. |
| File Version Extended all of | Contains extended file version metadata including checkout user and lifecycle state. |
| File Version object | Contains standard file iteration metadata returned by Vault. |
| 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 all of | The classification assigned to this file. |
| File Classification Enum 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 all of | The file master object for this file version. |
| File | |
| parent all of | The parent folder containing this file version. |
| Folder 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. |
| 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 all of | The relative URL to access this file version. |
| 0 string | The relative URL to access this object. |
| hasVisualizationAttachment boolean | Indicates whether a valid visualization attachment status is available (value is not None).
|
| visualizationAttachmentStatus all of | The visualization attachment status for this file version. |
| File Visualization Attachment Status Enum 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 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. |
| 1 object | |
| item all of | The item object associated with this entity. |
| Item object | Contains the item identity and referenced item iteration returned by list operations. |
| id string | The unique identifier (master ID) of the item. |
| url all of | The relative URL to access this item. |
| 0 string | The relative URL to access this object. |
| versionType all of | The version type of the referenced item version. |
| Version Type Enum enum:string | Specifies which file or item iteration to resolve. Possible values:
|
| itemVersion all of | The referenced item version details. |
| Item Version object | Contains metadata for an item iteration, including numbering, lifecycle, and referenced item master. |
| id string | The unique identifier (iteration ID) of the item version. |
| url all of | The relative URL to access this item version. |
| 0 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 | The comment associated with this item version. |
| title string | The display title. |
| state string | The lifecycle state of this item version. |
| stateColor number | The color associated with the item’s lifecycle state. |
| name string | The display name of the item. |
| category string | The category assigned to this item. |
| categoryColor number | The color associated with the item’s category. |
| entityType string | The type of entity represented by this item version. |
| isReadOnly boolean | Indicates whether this item version is read-only for the current user.
|
| isCloaked boolean | Indicates whether this item version is cloaked for the logged-in user.
|
| isLatestObsolete boolean | Indicates whether the latest item version is obsolete.
|
| item all of | The item master associated with this item version. |
| Item | |
| lifecycleState all of | The lifecycle state of this item 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. |
| properties array: object | An array of property values for this item version. |
| 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. |
| subfolderCount number | The number of immediate subfolders. |
| children string | The URI to retrieve child entities. |
| properties array: object | An array of property values for this entity. |
| 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. |
| fromEntity all of | The source entity for this link. |
| Folder 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. |
| Item Version object | Contains metadata for an item iteration, including numbering, lifecycle, and referenced item master. |
| id string | The unique identifier (iteration ID) of the item version. |
| url all of | The relative URL to access this item version. |
| 0 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 | The comment associated with this item version. |
| title string | The display title. |
| state string | The lifecycle state of this item version. |
| stateColor number | The color associated with the item’s lifecycle state. |
| name string | The display name of the item. |
| category string | The category assigned to this item. |
| categoryColor number | The color associated with the item’s category. |
| entityType string | The type of entity represented by this item version. |
| isReadOnly boolean | Indicates whether this item version is read-only for the current user.
|
| isCloaked boolean | Indicates whether this item version is cloaked for the logged-in user.
|
| isLatestObsolete boolean | Indicates whether the latest item version is obsolete.
|
| item all of | The item master associated with this item version. |
| Item object | Contains the item identity and referenced item iteration returned by list operations. |
| id string | The unique identifier (master ID) of the item. |
| url all of | The relative URL to access this item. |
| 0 string | The relative URL to access this object. |
| versionType all of | The version type of the referenced item version. |
| Version Type Enum enum:string | Specifies which file or item iteration to resolve. Possible values:
|
| itemVersion all of | The referenced item version details. |
| Item Version | |
| lifecycleState all of | The lifecycle state of this item 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. |
| properties array: object | An array of property values for this item version. |
| 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. |
| included object | Contains additional resources included with the entity 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 contents for a particular folder and include HasDrawing property in response.
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/folders/2/contents?option[propDefIds]=34' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
Response
{
"pagination": {
"limit": 1000,
"totalResults": 7,
"indexingStatus": "IndexingComplete"
},
"results": [
{
"name": "Assembly1.iam",
"id": "46",
"state": "For Review",
"stateColor": -2052277,
"revision": "A",
"category": "Engineering",
"categoryColor": -10188850,
"lastModifiedDate": "2024-10-15T18:48:32.537Z",
"isCheckedOut": false,
"hasVisualizationAttachment": false,
"size": 242176,
"isCloaked": false,
"checkinDate": "2024-10-22T07:06:33.84Z",
"checkoutDate": "2024-10-22T07:06:33.8Z",
"isHidden": false,
"isReadOnly": false,
"parentFolderId": "2",
"file": {
"id": "27",
"entityType": "File",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/files/27"
},
"isOnSite": true,
"createDate": "2024-10-22T07:06:33.84Z",
"createUserName": "TestAccount",
"properties": [
{
"propertyDefinitionId": "34",
"value": false
}
],
"classification": "None",
"visualizationAttachmentStatus": "None",
"version": 3,
"entityType": "FileVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/file-versions/46"
},
{
"name": "Part1.ipt",
"id": "44",
"state": "",
"stateColor": 0,
"revision": "",
"category": "Base",
"categoryColor": -2302756,
"lastModifiedDate": "2024-10-15T20:14:44.037Z",
"isCheckedOut": true,
"hasVisualizationAttachment": true,
"size": 171008,
"isCloaked": false,
"checkinDate": "0001-01-01T00:00:00Z",
"checkoutDate": "2024-10-22T06:25:40.833Z",
"checkoutUserName": "TestAccount",
"isHidden": false,
"isReadOnly": false,
"parentFolderId": "2",
"file": {
"id": "23",
"entityType": "File",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/files/23"
},
"isOnSite": true,
"createDate": "2024-10-15T20:15:01.88Z",
"createUserName": "TestAccount",
"properties": [
{
"propertyDefinitionId": "34",
"value": false
}
],
"classification": "None",
"visualizationAttachmentStatus": "NotSyncronized",
"version": 2,
"entityType": "FileVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/file-versions/44"
},
{
"name": "Assembly2.iam",
"id": "43",
"state": "",
"stateColor": 0,
"revision": "",
"category": "Base",
"categoryColor": -2302756,
"lastModifiedDate": "2024-10-17T19:17:40.043Z",
"isCheckedOut": true,
"hasVisualizationAttachment": true,
"size": 237568,
"isCloaked": false,
"checkinDate": "0001-01-01T00:00:00Z",
"checkoutDate": "2024-10-17T19:23:18.383Z",
"checkoutUserName": "TestAccount",
"isHidden": false,
"isReadOnly": false,
"parentFolderId": "2",
"file": {
"id": "37",
"entityType": "File",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/files/37"
},
"isOnSite": true,
"createDate": "2024-10-17T19:17:49.8Z",
"createUserName": "TestAccount",
"properties": [
{
"propertyDefinitionId": "34",
"value": false
}
],
"classification": "None",
"visualizationAttachmentStatus": "NotSyncronized",
"version": 3,
"entityType": "FileVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/file-versions/43"
},
{
"name": "Test1.ipt",
"id": "40",
"state": "",
"stateColor": 0,
"revision": "",
"category": "Base",
"categoryColor": -2302756,
"lastModifiedDate": "2024-10-17T18:46:33.497Z",
"isCheckedOut": false,
"hasVisualizationAttachment": true,
"size": 209920,
"isCloaked": false,
"checkinDate": "2024-10-17T19:17:46.297Z",
"checkoutDate": "2024-10-17T18:45:51.907Z",
"isHidden": false,
"isReadOnly": false,
"parentFolderId": "2",
"file": {
"id": "31",
"entityType": "File",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/files/31"
},
"isOnSite": true,
"createDate": "2024-10-17T19:17:46.297Z",
"createUserName": "TestAccount",
"properties": [
{
"propertyDefinitionId": "34",
"value": false
}
],
"classification": "None",
"visualizationAttachmentStatus": "NotSyncronized",
"version": 2,
"entityType": "FileVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/file-versions/40"
},
{
"name": "Part2-1.dwfx",
"id": "20",
"state": "",
"stateColor": 0,
"revision": "",
"category": "Base",
"categoryColor": -2302756,
"lastModifiedDate": "2024-10-11T08:31:06.007Z",
"isCheckedOut": false,
"hasVisualizationAttachment": false,
"size": 18419,
"isCloaked": false,
"checkinDate": "2024-10-11T08:32:06.363Z",
"isHidden": false,
"isReadOnly": false,
"parentFolderId": "2",
"file": {
"id": "19",
"entityType": "File",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/files/19"
},
"isOnSite": true,
"createDate": "2024-10-11T08:32:06.363Z",
"createUserName": "TestAccount",
"properties": [
{
"propertyDefinitionId": "34",
"value": ""
}
],
"classification": "None",
"visualizationAttachmentStatus": "None",
"version": 1,
"entityType": "FileVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/file-versions/20"
},
{
"name": "Part2.ipt",
"id": "18",
"state": "Work in Progress",
"stateColor": -12859030,
"revision": "B",
"category": "Standard",
"categoryColor": -6710887,
"lastModifiedDate": "2024-10-11T07:28:08.27Z",
"isCheckedOut": true,
"hasVisualizationAttachment": true,
"size": 183296,
"isCloaked": false,
"checkinDate": "0001-01-01T00:00:00Z",
"checkoutDate": "2024-10-11T08:29:57.073Z",
"checkoutUserName": "TestAccount",
"isHidden": false,
"isReadOnly": false,
"parentFolderId": "2",
"file": {
"id": "7",
"entityType": "File",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/files/7"
},
"isOnSite": true,
"createDate": "2024-10-11T07:28:14.953Z",
"createUserName": "TestAccount",
"properties": [
{
"propertyDefinitionId": "34",
"value": false
}
],
"classification": "None",
"visualizationAttachmentStatus": "NotSyncronized",
"version": 8,
"entityType": "FileVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/file-versions/18"
},
{
"name": "ProjectName.ipj",
"id": "4",
"state": "",
"stateColor": 0,
"revision": "",
"category": "Base",
"categoryColor": -2302756,
"lastModifiedDate": "2024-10-11T06:42:34.173Z",
"isCheckedOut": false,
"hasVisualizationAttachment": false,
"size": 10308,
"isCloaked": false,
"checkinDate": "2024-10-11T07:04:12.793Z",
"isHidden": false,
"isReadOnly": false,
"parentFolderId": "2",
"file": {
"id": "3",
"entityType": "File",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/files/3"
},
"isOnSite": true,
"createDate": "2024-10-11T07:04:12.793Z",
"createUserName": "TestAccount",
"properties": [
{
"propertyDefinitionId": "34",
"value": ""
}
],
"classification": "None",
"visualizationAttachmentStatus": "None",
"version": 1,
"entityType": "FileVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/file-versions/4"
}
],
"included": {
"folder": {
"2": {
"name": "ColinTest",
"id": "2",
"fullName": "$/ColinTest",
"category": "Folder",
"categoryColor": -2302756,
"stateColor": 0,
"subfolderCount": 0,
"isLibrary": false,
"isCloaked": false,
"isReadOnly": false,
"createDate": "2024-10-11T07:04:11.723Z",
"createUserName": "TestAccount",
"entityType": "Folder",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/folders/2"
}
},
"propertyDefinition": {
"34": {
"id": "34",
"displayName": "Has Drawing",
"systemName": "HasDrawing",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/property-definitions/34"
}
}
}
}