vaults/{vaultId}/item-versions
Retrieves a list of item versions in the specified Knowledge Vault.
Resource Information
| Method and URI | GET /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/item-versions |
| 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. |
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[propDefIds] string | The properties to include in the response. Provide a comma-separated list of property definition IDs (for example, 1,2,3) or pass all to return every property. |
| option[releasedItemsOnly] boolean | true: Include only item versions that are in a consumable (released) state.
|
| option[latestOnly] boolean | true: (Default) Include only the latest version.
|
| 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 list of item versions was successfully retrieved. |
| 400 Bad Request | The server was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request. |
| 401 Unauthorized | The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again. |
| 403 Forbidden | The request was successfully validated but lacking the required permissions. Verify your credentials and permissions before you send this request again. |
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 item versions. |
| id string | The unique identifier (iteration ID) of the item version. |
| 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 | 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 object | Contains the item identity and referenced item iteration returned by list operations. |
| id string | The unique identifier (master ID) of the item. |
| url string | The relative URL to access this object. |
| versionType enum:string | Specifies which file or item iteration to resolve. Possible values:
|
| itemVersion object | The referenced item version details. |
| lifecycleState object | Contains a lifecycle state. |
| id string | The unique identifier of a server-based lifecycle state. |
| url 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 object | Contains server-side metadata for a Vault property definition, including datatype and naming. |
| id string | The unique identifier of the property definition. |
| url string | The relative URL to access this object. |
| displayName string | The display name of this property definition. |
| systemName string | The system name of this property definition. |
| dataType enum:string | The underlying data type stored for values of this property.
Possible values: String, Numeric, Bool, DateTime, Image |
| active boolean | Indicates whether this property definition is active.
|
| isSystem boolean | Indicates whether this property definition is a built-in system property.
|
| initialValue string | The default value applied to entities that do not have an existing value for this property definition. |
| value string | The property value associated with the entity for the referenced property definition. |
| included object | Contains additional resources included with the item version results. |
| 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 all item versions.
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/item-versions' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
Response
{
"pagination": {
"limit": 1000,
"totalResults": 2,
"indexingStatus": "IndexingComplete"
},
"results": [
{
"name": "Assembly1",
"id": "57",
"revision": "A",
"lastModifiedUserName": "TestAccount",
"lastModifiedDate": "2024-10-22T08:21:31.65Z",
"number": "Assembly1",
"title": "Assembly1",
"description": "",
"comment": "",
"state": "Work in Progress",
"stateColor": -12859030,
"category": "Assembly",
"categoryColor": -10188850,
"isReadOnly": false,
"isCloaked": false,
"item": {
"id": "55",
"entityType": "Item",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/items/55"
},
"version": 2,
"entityType": "ItemVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/item-versions/57"
},
{
"name": "100001",
"id": "53",
"revision": "A",
"lastModifiedUserName": "TestAccount",
"lastModifiedDate": "2024-10-22T08:19:49.753Z",
"number": "100001",
"title": "",
"description": "",
"comment": "",
"state": "Work in Progress",
"stateColor": -12859030,
"category": "Document",
"categoryColor": -3251596,
"isReadOnly": false,
"isCloaked": false,
"item": {
"id": "52",
"entityType": "Item",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/items/52"
},
"version": 1,
"entityType": "ItemVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/item-versions/53"
}
]
}