Request

Response

    Retrieve Component Version

    This topic provides instructions on how to retrieve the following objects:

    • The version of each component, along with its design item version, thumbnail, and un-versioned component.
    • Manage extention data of a specific component version.

    You will use the following query in this topic:

    TypeOperationDescription
    Query componentVersion Retrieves version of a component.

    Step 1 - Retrieve Version of each Component

    The following steps demonstrate how you can run the componentVersion query to retrieve components version, along its design item version, thumbnail, and un-versioned component.

    1. Enter the following query in the Query Pane of the Manufacturing Data Model Explorer.

      Query

       query GetComponentVersion($componentVersionId: ID!) {
         componentVersion(componentVersionId: $componentVersionId) {
           id
           name
           partNumber
           partDescription
           designItemVersion {
              id
              name
              extensionType
           }
           thumbnail {
              status
              signedUrl
          }
          component {
              id
              name
          }
        }
      }
      
      Show More
    2. In the Query Variables Pane, enter the value of the componentVersionId. To know how to obtain the componentVersionId (tipRootComponentVersion), refer to Retrieve Items.

      Query Variables

      {
        "componentVersionId": "Y29tcH5jby5uckdoR0ZIb1FXU3NQdFlhU0V2YThnfko1RlJVYjBYbU1ieHdXVFBneG9PdXhfYWdhfndHdVVqdzNVbks2SGNXR2dTbWZKVjQ"
      }
      
    3. Click Play. A list of components version, along its design item version, thumbnail, and un-versioned component is displayed in the response.

      Response

      {
        "data": {
          "componentVersion": {
            "id": "Y29tcH5jby5uckdoR0ZIb1FXU3NQdFlhU0V2YThnfko1RlJVYjBYbU1ieHdXVFBneG9PdXhfYWdhfndHdVVqdzNVbks2SGNXR2dTbWZKVjQ",
            "name": "main-design-for-model-occurence",
            "partNumber": "main-design-for-model-occurence",
            "partDescription": "",
            "designItemVersion": {
              "id": "urn:adsk.wipprod:fs.file:vf.q_eTO0skS4yvFEJA6qSxpw?version=2",
              "name": "main-design-for-model-occurence",
              "extensionType": "versions:autodesk.fusion360:Design"
            },
            "thumbnail": {
              "status": "PENDING",
              "signedUrl": null
            },
            "component": {
              "id": "Y29tcH5jby5uckdoR0ZIb1FXU3NQdFlhU0V2YThnfko1RlJVYjBYbU1ieHdXVFBneG9PdXhfYWdh",
              "name": "main-design-for-model-occurence"
            }
           }
          }
         }
        }
      
      Show More

    Step 2 - Retrieve Manage Extention Data for a Specific Component Version.

    The following steps demonstrate how you can run the componentVersion query to retrieve manage extension data of a component version.

    1. Enter the following query in the Query Pane of the Manufacturing Data Model Explorer.

      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
                }
             }
          }
      }
      
      Show More
    2. In the Query Variables Pane, enter the value of the componentVersionId. To know how to obtain the componentVersionId (tipRootComponentVersion), refer to Retrieve Items.

      Query Variables

      {
        "componentVersionId": "Y29tcH5WQVZNUW1sYmxrZDBtaXJwU0NYMHJ0X0wyQ35FQlNERENFWmhOcU1YSkpUUHpHbnpvX2FnYX43bVk0UFJHdTV4MUZ4SXdwQkZqbzF3"
      }
      
    3. Click Play. A list of manage extension data of a component version is displayed in the response.

      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"
                 }
               }
             }
           }
         }
      
      Show More