Get an item version
GET
vaults/{vaultId}/item-versions/{id}
Get item version by its id.
Resource Information
Method and URI | GET /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/item-versions/{id} |
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 version. |
Response
HTTP Status Code Summary
200 OK | The request succeeded. The response contains the item version. |
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
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 |
Example
This example illustrates how to get a specific item version by ID.
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/57' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
Response
{
"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"
},
"properties": [
{
"propertyDefinitionId": "61",
"value": "TestAccount",
"definition": {
"id": "61",
"displayName": "Last Updated By",
"systemName": "LastModifiedUserName",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/property-definitions/61"
}
},
{
"propertyDefinitionId": "11",
"value": "2024-10-22T08:21:31.65Z",
"definition": {
"id": "11",
"displayName": "Date Modified",
"systemName": "ModDate",
"dataType": "DateTime",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/property-definitions/11"
}
},
......
],
"version": 2,
"entityType": "ItemVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/item-versions/57"
}
Show More