Get parent items for item version
GET
vaults/{vaultId}/item-versions/{id}/parents
Get item where used for item version
Resource Information
Method and URI | GET /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/item-versions/{id}/parents |
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. |
Request
Query String Parameters
option[bomType] enum:string | The type of BOM. Possible values: Effective, Historic, Latest, Tip. Default value is Latest |
option[date] string | The date that it was effective |
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. |
Response
Body Structure (200)
Expand all
itemVersions array: object | An array of Items. |
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 |
itemBomLinks array: object | The associations between the Items. |
bomComponentId string | Id of the BOM Component (only valid when BOM row is a component - not assigned an item) |
groupedRow boolean | Indicates if this BOM association is a grouped row of multiple BOM rows |
groupId string | Id of the Multiple Row grouping |
unitSize string | The unit size for this BOM row |
instCount string | Instance Count of this BOM association |
cad boolean | Indicates if this BOM row is created and maintained by CAD data or is a manual BOM row |
included boolean | Indicates if this BOM row is included or excluded from the BOM |
refDesId string | The reference designator ID. This value will be 0 if reference designators are not available. |
childHasChildren boolean | If true, the child Item has children of its own. If false, the child is a leaf. |
bomLinkMasterId string | Item association’s master Id (does not change between iterations) |
bomOrder string | The order that the child entry shows up in the BOM. |
units string | The display name for the Unit of Measure on CldItemUsage. |
quantity string | BOM row quantity |
childItemId string | The ID of the child Item. |
parentItemId string | The ID of the parent Item. |
id string | The ID for the object. |
parentMasterChildMasterAndRefDesMaster string | |
childMasterAndRefDesMaster string | |
isStatic boolean | If true, the dependency is static. If false, the dependency is computed. |
positionNumber string | Assigned BOM row position number |
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 |
referenceDesignatorsAvailable boolean | If true, reference designators are available. |
occurrences array: object | An array of occurrences. |
rootItemId string | The top most Item of the BOM. |
id string | A unique identifier for this occurrence within the Item BOM. |
parentOccurrenceId string | The immediate parent. -1 means no parent occurrence. |
bomLinkMasterId string | |
position string | The position on the BOM. |
detailId string | The value of the occurrence. Also known as the ‘Detail Id.’ |
path string | The path to the occurrence in the BOM. The format is the list of Item Master IDs separated by the ‘/’ delimiter. |
bOMComponents array: object | Array of BOM components in this BOM |
isCloaked boolean | Indicates if a BOM component is cloaked |
bOMStructure enum:string | An enumerated value representing the BOMStructure value of Component:
Possible values: |
baseQty string | A numeric value quantifying a single instance of the Component. For Components with discreet quantities, “1” should always be used. For measured quantities, a positive decimal value can be used. For example, a rod cut to 3.5 feet would have a BaseUOM of “foot” and a BaseQty of “3.5”. |
baseUOM string | The Unit of Measure the Component is quantified with. For discreet quantities, “Each” should be used. For measured quantities, a length (inch, cm, foot, etc.) volume (ounce, ml, liter, quart, etc.) or mass (gram, pound, kg, etc.) unit of measure should be used. |
componentType enum:string | An enumerated value specifying the type of component. Enum of Component Type:
Possible values: |
name string | The name of this component. |
xRefType enum:string | An enumerated value that specifies whether the Component is internal or external in relation to the design file.
Possible values: |
uniqueId string | Unique data within the scope of the design file used to identify the Component. For Inventor files, the GUID used to identify the Component is used (or GUID plus VirtualComponentDefinition._PropertySetsId for Virtual components). For DWG files, the HandleID associated with the Component is used. |
id string | |
xRefId string | For Components with a XRefType of “external”, XRefID represents the FileID of the design file associated with that component. For “internal” Components, XRefID should be set to -1. |
Example
This example illustrates how to get all parents for a specific item version.
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/60/parents' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
Response
{
"itemVersions": [
{
"name": "Part1",
"id": "60",
"revision": "A",
"lastModifiedUserName": "TestAccount",
"lastModifiedDate": "2024-10-22T08:35:08.983Z",
"number": "Part1",
"title": "Part1",
"description": "",
"comment": "",
"state": "Work in Progress",
"stateColor": -12859030,
"category": "Part",
"categoryColor": -2302756,
"isReadOnly": false,
"isCloaked": false,
"isLatestObsolete": false,
"item": {
"id": "59",
"entityType": "Item",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/items/59"
},
"version": 1,
"entityType": "ItemVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/item-versions/60"
}
],
"itemBomLinks": [],
"referenceDesignatorsAvailable": false,
"occurrences": [],
"bomComponents": []
}
Show More