componentVersion
Retrieves an object representing a version of a component.
For example, there can be different versions of a lug nut in a wheel assembly.
Template for Query:
query GetComponentVersion($componentVersionId: ID!) {
componentVersion(componentVersionId: $componentVersionId) {
# ComponentVersion Fields
}
}
Template for Query Variables:
{
"componentVersionId" : "<SOME-ID-TYPE-SCALAR-VALUE>"
}
Arguments
componentVersionId* ID! non-null | The ID of the component version to fetch. |
Possible Returns
Value Type | Description |
---|---|
ComponentVersion | Represents a version of a component. |
Examples
Example 1
Retrieves a version of a component along with the design item version, its thumbnail and its un-versioned component.
Query:
query GetComponentVersion($componentVersionId: ID!) {
componentVersion(componentVersionId: $componentVersionId) {
id
name
partNumber
partDescription
designItemVersion {
id
name
extensionType
}
thumbnail {
status
signedUrl
}
component {
id
name
}
}
}
Query Variables:
{
"componentVersionId": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ34zMlBTQ2daMXJLY2V3SHlCN1dkbEZyX2FnYX53RnlaU1BGSmNQY2l3NDdFeTBIemJX"
}
Response:
{
"data": {
"componentVersion": {
"id": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ34zMlBTQ2daMXJLY2V3SHlCN1dkbEZyX2FnYX53RnlaU1BGSmNQY2l3NDdFeTBIemJX",
"name": "3D_Arm_Scan",
"partNumber": "3D_Arm_Scan",
"partDescription": "",
"designItemVersion": {
"id": "urn:adsk.wipstg:fs.file:vf.2T9wT3rFSZW0SJkfo139PQ?version=1",
"name": "3D_Arm_Scan",
"extensionType": "versions:autodesk.fusion360:Design"
},
"thumbnail": {
"status": "SUCCESS",
"signedUrl": "https://cdn-stg.derivative.autodesk.com/dXJuOmFkc2suZm9yZ2U6bDJhZy5hc3NldDpzdGc6MzJQU0NnWjFyS2Nld0h5QjdXZGxGcl9hZ2E_c25hcHNob3Q9d0Z5WlNQRkpjUGNpdzQ3RXkwSHpiVw/output/NDNlNmMwMDgtNjVmYS00YmEwLWI1OGQtYzRiOTU2Yzc5Y2Rh.png?Policy=eyJTdGF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6Imh0dHBzOi8vY2RuLXN0Zy5kZXJpdmF0aXZlLmF1dG9kZXNrLmNvbS9kWEp1T21Ga2Myc3VabTl5WjJVNmJESmhaeTVoYzNObGREcHpkR2M2TXpKUVUwTm5XakZ5UzJObGQwaDVRamRYWkd4R2NsOWhaMkVfYzI1aGNITm9iM1E5ZDBaNVdsTlFSa3BqVUdOcGR6UTNSWGt3U0hwaVZ3L291dHB1dC9ORE5sTm1Nd01EZ3ROalZtWVMwMFltRXdMV0kxT0dRdFl6UmlPVFUyWXpjNVkyUmgqIiwiQ29uZGl0aW9uIjp7IkRhdGVMZXNzVGhhbiI6eyJBV1M6RXBvY2hUaW1lIjoxNzI1OTAyMTk5fX19XX0_&Key-Pair-Id=APKAJVJIJZ6OEYDPJSQA&Signature=XngMCsAh3oAKdtZ-i44h-82ycEvJ~q0jV6kqQRW9~v3YV1s2LZSrNBwQ9gcAlxdXrmHYwrWxkZi2KnvzvAPQFP3fluGtScBGkkINZFD8jDh8Ho2-vi6l8G4E~4~mi8iJyOmbxCRI1KZ2-gxIlTaTd~pC4r8TFvopAclp-1kFaUCXuQosfXxoMF6yCGufhTshu-KKdyfja2gLzH0ok2JySGGdC7uPFYALUtzTVHI5fNvjMFpIPaYxydCEhN0fyp-T1zlLzV87QHBuM3b2SL0m0YCk3Ef3x1rsWqEVyviFyPTXt8Tk4-MUizTBr1NDpjFR3z1Ot1e3TS2hg97kIfLXnA__"
},
"component": {
"id": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ34zMlBTQ2daMXJLY2V3SHlCN1dkbEZyX2FnYQ",
"name": "3D_Arm_Scan"
}
}
}
}
Example 2
Retrieves Manage Extension Data for a version of a component.
Query:
query GetManageExtensionDetails($componentVersionId: ID!) {
componentVersion (componentVersionId: $componentVersionId) {
id
name
manage {
changeOrder
changeOrderURL
changeOrderURN
isLocked
isNextReleaseMilestone
itemNumber
lifeCycle
releasedOn
revision
}
component {
manage {
lifeCycle
revision
itemNumber
itemURN
itemURL
}
}
}
}
Query Variables:
{
"componentVersionId": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35FQlNERENFWmhOcU1YSkpUUHpHbnpvX2FnYX43bVk0UFJHdTV4MUZ4SXdwQkZqbzF3"
}
Response:
{
"data": {
"componentVersion": {
"id": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35FQlNERENFWmhOcU1YSkpUUHpHbnpvX2FnYX43bVk0UFJHdTV4MUZ4SXdwQkZqbzF3",
"name": "Drawings Utility Knife",
"manage": {
"changeOrder": "CO-000008 - Test",
"changeOrderURL": "https://AUTODESK2398.autodeskplm.com/plm/extAccess?itemUrn=urn%3Aadsk.plm%3Atenant.workspace.item%3AAUTODESK2398.9.15145&tab=details",
"changeOrderURN": "urn:adsk.plm:tenant.workspace.item:AUTODESK2398.9.15145",
"isLocked": true,
"isNextReleaseMilestone": false,
"itemNumber": "PN-000003",
"lifeCycle": "Pre-Production",
"releasedOn": "2024-02-09T01:05:44.662Z",
"revision": "1"
},
"component": {
"manage": {
"lifeCycle": "Pre-Production",
"revision": "1",
"itemNumber": "PN-000003",
"itemURN": "urn:adsk.plm:tenant.workspace.item:AUTODESK2398.57.15148",
"itemURL": "https://AUTODESK2398.autodeskplm.com/plm/extAccess?itemUrn=urn%3Aadsk.plm%3Atenant.workspace.item%3AAUTODESK2398.57.15148&tab=details"
}
}
}
}
}
Example 3
This example retrieves the full list of occurrences under a given componentVersion.
Query:
query GetAllModelOccurrences($componentVersionId: ID!) {
componentVersion(componentVersionId: $componentVersionId) {
id
name
occurrences {
results {
parentComponentVersion {
id
name
}
componentVersion {
id
name
}
}
}
}
}
Query Variables:
{
"componentVersionId": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35GUnM3Nkl1NGlxdGlaNFZXejZiYU13X2FnYX42eWJick15dTlsM2I0Nk9KWTE2MnF2"
}
Response:
{
"data": {
"componentVersion": {
"id": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35GUnM3Nkl1NGlxdGlaNFZXejZiYU13X2FnYX42eWJick15dTlsM2I0Nk9KWTE2MnF2",
"name": "ALCOA Bracket (1)",
"occurrences": {
"results": [
{
"parentComponentVersion": {
"id": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35GUnM3Nkl1NGlxdGlaNFZXejZiYU13X2FnYX42eWJick15dTlsM2I0Nk9KWTE2MnF2",
"name": "ALCOA Bracket (1)"
},
"componentVersion": {
"id": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ351N013ZXJSWkpoeDdyYzhaREFBZkdtX2FnYX5EVDh2V3I2MldDYUR2MXdrSGQ0bHdz",
"name": "ALCOA Bracket"
}
}
]
}
}
}
}
Example 4
Retrieves url to download and export different derivative formats of a component version.
Query:
query GetDerivatives($componentVersionId: ID!, $derivativeInput: DerivativeInput!) {
componentVersion(componentVersionId: $componentVersionId) {
id
name
derivatives (derivativeInput: $derivativeInput) {
expires
id
outputFormat
signedUrl
status
}
}
}
Query Variables:
{
"componentVersionId": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35lazJXeTN5Tzg3a0ZQcll5aGlYMmdTX2FnYX44UDZOMThJU3k1aGVwZENJN01td0tO",
"derivativeInput": {
"generate": true,
"outputFormat": ["STEP"]
}
}
Response:
{
"data": {
"componentVersion": {
"id": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35lazJXeTN5Tzg3a0ZQcll5aGlYMmdTX2FnYX44UDZOMThJU3k1aGVwZENJN01td0tO",
"name": "Bearing_Bracket",
"derivatives": [
{
"expires": "1725902202888",
"id": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35lazJXeTN5Tzg3a0ZQcll5aGlYMmdTX2FnYX44UDZOMThJU3k1aGVwZENJN01td0tO",
"outputFormat": "STEP",
"signedUrl": "https://cdn-stg.derivative.autodesk.com/dXJuOmFkc2suZm9yZ2U6bDJhZy5hc3NldDpzdGc6ZWsyV3kzeU84N2tGUHJZeWhpWDJnU19hZ2E_c25hcHNob3Q9OFA2TjE4SVN5NWhlcGRDSTdNbXdLTg/output/files/85709109-dfb5-4a10-8c3b-82b2a9b898d5/1b5776c6-ca21-4c54-bb37-cb592b948dc8.stp?Policy=eyJTdGF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6Imh0dHBzOi8vY2RuLXN0Zy5kZXJpdmF0aXZlLmF1dG9kZXNrLmNvbS9kWEp1T21Ga2Myc3VabTl5WjJVNmJESmhaeTVoYzNObGREcHpkR2M2WldzeVYza3plVTg0TjJ0R1VISlplV2hwV0RKblUxOWhaMkVfYzI1aGNITm9iM1E5T0ZBMlRqRTRTVk41TldobGNHUkRTVGROYlhkTFRnL291dHB1dC9maWxlcy84NTcwOTEwOS1kZmI1LTRhMTAtOGMzYi04MmIyYTliODk4ZDUvMWI1Nzc2YzYtY2EyMS00YzU0LWJiMzctY2I1OTJiOTQ4ZGM4LnN0cCIsIkNvbmRpdGlvbiI6eyJEYXRlTGVzc1RoYW4iOnsiQVdTOkVwb2NoVGltZSI6MTcyNTkwMjIwMn19fV19&Key-Pair-Id=APKAJVJIJZ6OEYDPJSQA&Signature=ebxgjoZGOegtgVljM8fbqlmurks3JLnqjKwnKoJ~Qm4oox8qbX9tjVeb9BSbWhnlSRzZsYfpi~jBQzMW0OlIrjeI6csm-r7xb8JHcGaHz6Ld3rA9ytv9nSFspYRyH8wX63oLACnynxpgl~1zEkCuIecVeBdbrxAO1x7OpN8e4rAU2Q9LuTDG4uOyFvx36R2bM2lHNmj5aGgOLnqrxBSJGdSYeS18HvaEgbYXcZukDJQ4dfYJ9Dhy4miSU672UX4w3dvE3U-NIAXc2dcJEk6028mOnWJenifJtJlqpn9UuK5CT0LN~xpqlewRn9x1d2inZ3PZibEVpi0MwhWUQ-Qtrg__",
"status": "SUCCESS"
}
]
}
}
}
Example 5
Checks whether the component version is a configuration member.
Query:
query componentVersion($componentVersionId: ID!) {
componentVersion(componentVersionId: $componentVersionId) {
id
name
isConfiguration
}
}
Query Variables:
{
"componentVersionId": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35qbFhkMXU0akMzTjc0dlBpZ0RGS2FHX2FnYX45WUtYWDhWRklMRUNSR3pqUGZlcDF3"
}
Response:
{
"data": {
"componentVersion": {
"id": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35qbFhkMXU0akMzTjc0dlBpZ0RGS2FHX2FnYX45WUtYWDhWRklMRUNSR3pqUGZlcDF3",
"name": "ConfigRow-Height",
"isConfiguration": true
}
}
}
Example 6
Retrieves root configuration member of the component version.
Query:
query componentVersion($componentVersionId: ID!) {
componentVersion(componentVersionId: $componentVersionId) {
id
name
partNumber
isMilestone
materialName
lastModifiedOn
configuredDesignItemVersion{
configurationTable{
id
rows{
id
name
rootConfigurationMember{
id
}
}
}
}
}
}
Query Variables:
{
"componentVersionId": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35qbFhkMXU0akMzTjc0dlBpZ0RGS2FHX2FnYX45WUtYWDhWRklMRUNSR3pqUGZlcDF3"
}
Response:
{
"data": {
"componentVersion": {
"id": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35qbFhkMXU0akMzTjc0dlBpZ0RGS2FHX2FnYX45WUtYWDhWRklMRUNSR3pqUGZlcDF3",
"name": "ConfigRow-Height",
"partNumber": "ConfigRow-Height",
"isMilestone": false,
"materialName": "Steel",
"lastModifiedOn": "2024-04-04T06:45:53.000Z",
"configuredDesignItemVersion": {
"configurationTable": {
"id": "1",
"rows": [
{
"id": "2854fcd2-c197-472d-a6cd-a42309f31925",
"name": "ConfigRow-Height",
"rootConfigurationMember": {
"id": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35qbFhkMXU0akMzTjc0dlBpZ0RGS2FHX2FnYX45WUtYWDhWRklMRUNSR3pqUGZlcDF3"
}
}
]
}
}
}
}
}
Example 7
Retrieves configuration row data of a component version.
Query:
query componentVersion($componentVersionId: ID!) {
componentVersion(componentVersionId: $componentVersionId) {
id
name
configurationRow {
id
name
rootConfigurationMember {
id
name
}
}
}
}
Query Variables:
{
"componentVersionId": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35qWk9hM1ZZYUx6enZYNnllQnh3SVA4X2FnYX5NZlNRMGd0dHZ1YTN0SHlnVHFWdmZ2"
}
Response:
{
"data": {
"componentVersion": {
"id": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35qWk9hM1ZZYUx6enZYNnllQnh3SVA4X2FnYX5NZlNRMGd0dHZ1YTN0SHlnVHFWdmZ2",
"name": "DiaSphere",
"configurationRow": {
"id": "0b1814f3-80ea-4d17-acff-85a5899050dc",
"name": "DiaSphere",
"rootConfigurationMember": {
"id": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35qWk9hM1ZZYUx6enZYNnllQnh3SVA4X2FnYX5NZlNRMGd0dHZ1YTN0SHlnVHFWdmZ2",
"name": "DiaSphere"
}
}
}
}
}
Example 8
Retrieve all drawing versions that represent the 2D view of the component version.
Query:
query GetDrawingVersions($componentVersionId: ID!) {
componentVersion(componentVersionId: $componentVersionId) {
id
name
drawingVersions {
results {
id
name
}
}
}
}
Query Variables:
{
"componentVersionId": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ34zMlBTQ2daMXJLY2V3SHlCN1dkbEZyX2FnYX53RnlaU1BGSmNQY2l3NDdFeTBIemJX"
}
Response:
{
"data": {
"componentVersion": {
"id": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ34zMlBTQ2daMXJLY2V3SHlCN1dkbEZyX2FnYX53RnlaU1BGSmNQY2l3NDdFeTBIemJX",
"name": "3D_Arm_Scan",
"drawingVersions": {
"results": [
{
"id": "ZHJhd35WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ344SkNrWE1nMDkxNDV2bXpvdWRXRmF2X2FnYX44a2JrNE5pcTY2bGZ6UXRwUk9aTjlw",
"name": "3D_Arm_Scan Drawing"
}
]
}
}
}
}
Example 9
Retrieves Physical Properties associated with the ComponentVersion.
Query:
query GetPhysicalProperties($componentVersionId: ID!) {
componentVersion(componentVersionId: $componentVersionId) {
id
name
partNumber
isMilestone
materialName
lastModifiedOn
physicalProperties {
status
mass {
displayValue
value
definition {
name
specification
units {
id
name
}
}
}
volume {
displayValue
value
definition {
name
specification
units {
id
name
}
}
}
area {
displayValue
value
definition {
name
units {
name
}
}
}
density {
displayValue
value
definition {
name
units {
name
}
}
}
boundingBox {
length {
displayValue
value
}
width {
displayValue
value
}
height {
displayValue
value
}
}
}
}
}
Query Variables:
{
"componentVersionId": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35WVGxxN01wd3I5a3lnVFV1eFlUbkZoX2FnYX5SeXlYZHlmbWFhd1dOV3ZrSFhzcUdL"
}
Response:
{
"data": {
"componentVersion": {
"id": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35WVGxxN01wd3I5a3lnVFV1eFlUbkZoX2FnYX5SeXlYZHlmbWFhd1dOV3ZrSFhzcUdL",
"name": "Gas Pedal",
"partNumber": "Gas Pedal",
"isMilestone": false,
"materialName": "Steel",
"lastModifiedOn": "2024-02-08T10:52:41.000Z",
"physicalProperties": {
"status": "COMPLETED",
"mass": {
"displayValue": "1.537328313794392",
"value": 1.537328313794392,
"definition": {
"name": "mass",
"specification": "MASS",
"units": {
"id": "kilograms",
"name": "Kilograms"
}
}
},
"volume": {
"displayValue": "195.8380017572474",
"value": 195.8380017572474,
"definition": {
"name": "volume",
"specification": "VOLUME",
"units": {
"id": "cubicCentimeters",
"name": "Cubic centimeters"
}
}
},
"area": {
"displayValue": "859.986463604413",
"value": 859.986463604413,
"definition": {
"name": "area",
"units": {
"name": "Square centimeters"
}
}
},
"density": {
"displayValue": "0.00785",
"value": 0.00785,
"definition": {
"name": "density",
"units": {
"name": "Kilograms per Cubic Centimeter"
}
}
},
"boundingBox": {
"length": {
"displayValue": "24.3334639034822",
"value": 24.3334639034822
},
"width": {
"displayValue": "14",
"value": 14
},
"height": {
"displayValue": "8.4",
"value": 8.4
}
}
}
}
}
}
Example 10
Retrieves Custom Properties associated with the ComponentVersion.
Query:
query GetComponentVersionProperties($componentVersionId: ID!) {
componentVersion(componentVersionId: $componentVersionId) {
id
name
customProperties {
results {
value
displayValue
definition {
id
name
specification
isHidden
isReadOnly
isArchived
description
propertyBehavior
units {
id
name
}
}
}
}
}
}
Query Variables:
{
"componentVersionId": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35TcFFEOFlTdEZqNTN1SEY2R1RJTWFYX2FnYX45Y3BrZVFuNGZFdDhLbExkY1N0RHEz"
}
Response:
{
"data": {
"componentVersion": {
"id": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35TcFFEOFlTdEZqNTN1SEY2R1RJTWFYX2FnYX45Y3BrZVFuNGZFdDhLbExkY1N0RHEz",
"name": "Connector Joint",
"customProperties": {
"results": [
{
"value": 10,
"displayValue": "10",
"definition": {
"id": "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcwNzM3NjE0MTM1N35wYXJhbWV0ZXJzLkNmWG9hQzRLNTNTVHdiNlRuSXJYWFpUQUlFZGRHOUFyOjU4ODExNjVkYTFjYTQxYTZhZDEwZTRiY2MyZWNkOTU2LTEuMC4w",
"name": "supplier cost",
"specification": "INTEGER",
"isHidden": false,
"isReadOnly": false,
"isArchived": false,
"description": "description",
"propertyBehavior": "DYNAMIC",
"units": null
}
},
{
"value": 10.12,
"displayValue": "10.12",
"definition": {
"id": "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcwNzM3NjE0MTM1N35wYXJhbWV0ZXJzLkNmWG9hQzRLNTNTVHdiNlRuSXJYWFpUQUlFZGRHOUFyOjUzNGU2MDI0OWEwZDRjYzBhZGQ5YWU2ZmIyZjY1NzlhLTEuMC4w",
"name": "material length",
"specification": "FLOAT",
"isHidden": false,
"isReadOnly": false,
"isArchived": false,
"description": "description",
"propertyBehavior": "DYNAMIC_AT_VERSION",
"units": null
}
}
]
}
}
}
}