Get version history for item
GET
vaults/{vaultId}/items/{id}/versions
Get the item history by revision Id
Resource Information
Method and URI | GET /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/items/{id}/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 obtained via a three-legged OAuth flow. |
* Required
Request
URI Parameters
vaultId string | The unique identifier of a vault. |
id string | The unique identifier of an item used to group all the versions of an Item. In other words, different versions of an item will have a different Id(version/iteration) but the same MasterId. |
Request
Query String Parameters
option[history] enum:string | Allow option is: All, ReleasedOnly, ReleasedAndRevisionTip or RevisionTip. Default value is All
Possible values: All , ReleasedOnly , ReleasedAndRevisionTip , RevisionTip |
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. |
descending boolean | true : Return latest file version at top.
|
limit int | Specifies the number of results to return per page. Maximum limit is controlled by “Page size conifguration” setting which could be updated using ADMS (“Global Setting” -> “Page size conifguration”). |
cursorState string | Indicates the state of the cursor for pagination. Use this parameter to navigate through paged results |
Response
HTTP Status Code Summary
200 OK | The request succeeded. |
400 Bad Request | The server was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request. |
401 Unauthorized | The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again. |
403 Forbidden | The request was successfully validated but lacking the required permissions. Verify your credentials and permissions before you send this request again. |
404 Not Found | The requested resource was not found. |
Response
Body Structure (200)
Expand all
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 | |
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 | |
propertyDefinition object | |
* object | Property definition object. |
id string | Get the unique identifier for a server-based property definition |
url string | The relative URL to access this object. |
displayName string | Get or sets the Display name for this Property Definition |
systemName string | Get the System Name for this Property Definition. |
dataType enum:string | The value defined in SQL database.
Possible values: String , Numeric , Bool , DateTime , Image |
active boolean | Get or sets whether this Property Definition is Active. |
isSystem boolean | Get whether or not this is a System Property (as opposed to an userDefined property) |
initialValue string | Default Value that will be applied to entities that do not have an existing value associated with this PropertyDefinition |
Example
This example illustrates how to get item history.
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/items/55/versions' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
Response
{
"pagination": {
"limit": 1000,
"totalResults": 2,
"indexingStatus": "NA"
},
"results": [
{
"name": "Assembly1",
"id": "56",
"revision": "A",
"lastModifiedUserName": "TestAccount",
"lastModifiedDate": "2024-10-22T08:21:16.19Z",
"number": "Assembly1",
"title": "Assembly1",
"description": "",
"comment": "",
"state": "",
"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": 1,
"entityType": "ItemVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/item-versions/56"
},
{
"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"
}
]
}
Show More