Request

Response

    Queries

    component

    query

    Retrieves a Component based on the specified component ID and component state. The state of the component can be provided with: - composition and time arguments, or - state argument.

    If both options are specified, the query is considered invalid.

    Template for Query:

    query GetComponent($componentId: ID!, $composition: BOMCompositionEnum, $time: DateTime, $state: String) {
      component(componentId: $componentId, composition: $composition, time: $time, state: $state) {
        # Component Fields
      }
    }
    

    Arguments

    componentId*
    ID! non-null
    The ID of the component to retrieve.
    compositionThe BOM composition state to resolve the component in. Defaults to WORKING.
    timeThe point in time at which to resolve the component.
    stateAn opaque state string from a previously queried component, used to continue traversal.
    * Required

    Possible Returns

    Value TypeDescription
    Component An object representing an item in the bill of materials (BOM). It can be a part, an assembly, a sub-assembly or an end product which is the very top-level with no parent above it.


    Examples

    Example 1

    Retrieves a component’s details along with the lifecycle details, itemNumber, itemURN and itemURL.

    Query:

    query GetComponent($componentId: ID!) {
           component (componentId: $componentId) {
               id
               name {
                   value
               }
               itemNumber {
                   id
                   schema {
                       id
                       name
                   }
               }
               lifecycle {
                   itemUrl
                   itemUrn
                   itemState {
                       value
                   }
                   eco {
                       id
                       ecoUrl
                       affectedByProperty {
                           name
                           value
                       }
                   }
                   state {
                       value
                   }
               }
           }
     }
    
    Show More

    Query Variables:

    {
     "componentId": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35Oaklmb1RRRkluM2dMUlFhWFZ5VG93X2FnYQ"
    }
    

    Response:

    {
       "data": {
           "component": {
               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35Oaklmb1RRRkluM2dMUlFhWFZ5VG93X2FnYQ",
               "name": {
                   "value": "Generator"
               },
               "itemNumber": {
                   "id": "PN-000001",
                   "schema": {
                       "id": "e01a6482-8a4f-4970-859e-472c4f61e098",
                       "name": "Component (System)"
                   }
               },
               "lifecycle": {
                   "itemUrl": "https://YOPMAIL9163.autodeskplm.com/plm/extAccess?itemUrn=urn%3Aadsk.plm%3Atenant.workspace.item%3AYOPMAIL9163.57.15146&tab=details",
                   "itemUrn": "urn:adsk.plm:tenant.workspace.item:YOPMAIL9163.57.15146",
                   "itemState": {
                       "value": "Working"
                   },
                   "eco": null,
                   "state": {
                       "value": "Production"
                   }
               }
           }
       }
    }
    
    Show More

    Example 2

    Retrieves BOM relations for a component showing child components, state and quantities.

    Query:

    query GetBomRelationsWithState(
     $componentId: ID!
     $composition: BOMCompositionEnum!
     $time: DateTime
     $cursor: String
    
    ) {
    component(componentId: $componentId, composition: $composition, time: $time) {

    …ComponentStructure bomRelations(depth: 1, pagination: { cursor: $cursor }) {

    pagination {

    cursor

    } results {

    id sequenceNumber fromComponent {

    id componentState

    } toComponent {

    …ComponentStructure

    } toComponentState

    }

    }

    }

    }

    fragment ComponentStructure on Component {

    id timestamp composition hasChildren componentState name {

    value

    } isTip }

    Query Variables:

    {
     "componentId": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35MaTJtRExDR0xrOTRjSXJuaW9OUXB2X2FnYQ",
     "composition": "WORKING",
     "time": null,
     "cursor": null
    }
    

    Response:

    {
       "data": {
           "component": {
               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35MaTJtRExDR0xrOTRjSXJuaW9OUXB2X2FnYQ",
               "name": {
                   "value": "Espresso Machine"
               },
               "bomRelations": {
                   "results": [
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-c01ST1JtWjhCODIyTmpIOG1Bd0ZqWA",
                           "sequenceNumber": 1,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35HNWh3Nmxjb2RxQWRLbzREUmR0VzJpX2FnYQ",
                               "name": {
                                   "value": "Main Shell Component"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-42-19-454"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-OXVCa2h2enlqNzJyNmpJMnNNb3hVMw",
                           "sequenceNumber": 2,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35GSHhvZGQ3TzNQblFMWEhRc04xVFZuX2FnYQ",
                               "name": {
                                   "value": "Logo Mount"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-42-19-487"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-dXBVRXR4blZnaFlLRnJ6N1ozMExnMg",
                           "sequenceNumber": 3,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ355TzMzNnNkUXJRUTZIQWQ4MUYyTFltX2FnYQ",
                               "name": {
                                   "value": "Hoses"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-42-19-488"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-R1lHcm5QeXU2T29WMm51Q2k1Vmd5Yw",
                           "sequenceNumber": 4,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35Oaklmb1RRRkluM2dMUlFhWFZ5VG93X2FnYQ",
                               "name": {
                                   "value": "Generator"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-42-02-850"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-aDVrQzgzNlRBMjh1NFVMM3VRVmExUw",
                           "sequenceNumber": 5,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35VSHJqcjFmZTNyTFZjZlpPMGtvU2FyX2FnYQ",
                               "name": {
                                   "value": "Bottom Front Cover"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-42-19-474"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-UldaQkJ5dTJwMGJHYUNabXRocllWRw",
                           "sequenceNumber": 6,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35UWVVqeVo2VnRra2FNVjVuaEpkZFU3X2FnYQ",
                               "name": {
                                   "value": "Frother"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-41-57-703"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-NXN6VXBzcVduZ3FMbTZWNmRCTGFJcA",
                           "sequenceNumber": 7,
                           "quantityProperty": {
                               "value": 2,
                               "displayValue": "2"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35iRVc2aGhMZlBEU0xMVVNTNE02M2lvX2FnYQ",
                               "name": {
                                   "value": "Connector 70"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-41-30-861"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-dExlRFdVaHN1Rzl5VDdXV2FpaE1BVg",
                           "sequenceNumber": 8,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35tUUo2TGFCNFJiN1V0RnJuRGNzek93X2FnYQ",
                               "name": {
                                   "value": "Under Cover"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-42-19-461"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-cDVGRDlINTRmSTZBdU9xSUxqb0ZTbQ",
                           "sequenceNumber": 9,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35QaUYzQ29mUlNITmhEVDZEcVNmVFEzX2FnYQ",
                               "name": {
                                   "value": "Connector"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-41-49-433"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-SUtWZDgyaE1xbXVBSk5RRXkwZ2Z1eA",
                           "sequenceNumber": 10,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35NeWpwUUR6Q3YwdFZQQzBYMVRhUVdPX2FnYQ",
                               "name": {
                                   "value": "Cup"
                               },
                               "partNumber": {
                                   "value": "{{uniquePNGComponent}}"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-QnJjc1hZMnc4VzFzNmlubFBIYUZ5Zg",
                           "sequenceNumber": 11,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ351WVJ6eG5abkQ0SXJDSnRuZ2JweGROX2FnYQ",
                               "name": {
                                   "value": "Top Lid Assembly"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-42-19-455"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-SlJXN0U4STVCcFhFZjc0V3psQ1E5OQ",
                           "sequenceNumber": 12,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35rUndxcWJ0S2x5VWxPVm1nc2lsQ3d1X2FnYQ",
                               "name": {
                                   "value": "Bottom Shell"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-42-19-462"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-Y01Udkh1WVZDZ3ZwR0hBYjFud2JzOQ",
                           "sequenceNumber": 13,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35LR2RNdENySHNyVkJWdXA3RndNdmJxX2FnYQ",
                               "name": {
                                   "value": "Water Tank"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-42-19-470"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-Sjl6V3lTSVFRUzQ3ZFR6OTF1aFdNdA",
                           "sequenceNumber": 14,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35WMzVYMFRIVDNYeGd3dlFsQm1rWnN2X2FnYQ",
                               "name": {
                                   "value": "Inside Components"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-42-19-477"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-NEppd2NxeFN3Q2xXVVM3QUphOU1waQ",
                           "sequenceNumber": 15,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35aWkdnZ0VFTkJLOE1QcUhNZUxsMnlHX2FnYQ",
                               "name": {
                                   "value": "Sump"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-41-51-884"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-eGVNRnQ0WUZrWUVEZjBhSHY3clkwcQ",
                           "sequenceNumber": 16,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35DYXlWYWZ6WFVDaGVuQ21mZ3ZNSWtCX2FnYQ",
                               "name": {
                                   "value": "Connector"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-42-19-496"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-TkVQMXdPNm8wWDBEMjlReGk2cTRxVg",
                           "sequenceNumber": 17,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35kT3F3U2g2b0U4NXYxa1dnempRdEpCX2FnYQ",
                               "name": {
                                   "value": "Valve"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-41-33-195"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-bFpHMG9HbFl6TUFib0V5RUtva2xPSg",
                           "sequenceNumber": 18,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35kb2ZIQndkeVgzUnJxcnM4dnNwZVhBX2FnYQ",
                               "name": {
                                   "value": "Frother Mechanism"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-41-41-258"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-OWZBYTBJaHFSSjFYNllIM2o4ZFYyOQ",
                           "sequenceNumber": 19,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35pNmFadmRhdWpSUkNNS29MeWFHU0tYX2FnYQ",
                               "name": {
                                   "value": "Espresso PCB"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-41-47-624"
                               }
                           }
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-cXdyU05EdFZVVGVwa05LVmU4ZWhTZQ",
                           "sequenceNumber": 20,
                           "quantityProperty": {
                               "value": 1,
                               "displayValue": "1"
                           },
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35nUXBmblUxYkdkeUppb2tiMHZSM2xrX2FnYQ",
                               "name": {
                                   "value": "Pump"
                               },
                               "partNumber": {
                                   "value": "2026-01-16-10-41-42-571"
                               }
                           }
                       }
                   ],
                   "pagination": {
                       "cursor": null,
                       "pageSize": 20
                   }
               }
           }
       }
    }
    
    Show More

    Example 3

    Retrieves the parts list for a component showing all parts and quantities.

    Query:

    query GetComponentPartsList($componentId: ID!, $computeTime: DateTime) {
     component(componentId: $componentId) {
       id
       name {
         value
       }
       partsList (computeTime: $computeTime){
           status
         results {
           component{
               id
           }
           quantityProperty{
               name
               value
               displayValue
           }
           sequenceNumber
         }
         pagination {
           cursor
           pageSize
         }
       }
     }
     }
    
    Show More

    Query Variables:

    {
       "componentId": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35MaTJtRExDR0xrOTRjSXJuaW9OUXB2X2FnYQ",
       "computeTime": "2026-10-30T15:14:56.258Z"
    }
    

    Response:

    {
       "data": {
           "component": {
               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35MaTJtRExDR0xrOTRjSXJuaW9OUXB2X2FnYQ",
               "name": {
                   "value": "Espresso Machine"
               },
               "partsList": {
                   "status": "IN_PROGRESS",
                   "results": [],
                   "pagination": {
                       "cursor": "",
                       "pageSize": 0
                   }
               }
           }
       }
    }
    
    Show More

    Example 4

    Retrieves Properties associated with the Component.

    Query:

    query GetComponentProperties($componentId: ID!) {
           component(componentId: $componentId) {
               id
               name{
                   value
               }
               customProperties {
                   results {
                       value
                       displayValue
                       definition {
                           id
                           name
                           specification
                           isHidden
                           isReadOnly
                           isArchived
                           description
                           propertyBehavior
                           units {
                               id
                               name
                           }
                       }
                   }
               }
           }
     }
    
    Show More

    Query Variables:

    {
     "componentId": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35NeWpwUUR6Q3YwdFZQQzBYMVRhUVdPX2FnYQ"
    }
    

    Response:

    {
       "data": {
           "component": {
               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35NeWpwUUR6Q3YwdFZQQzBYMVRhUVdPX2FnYQ",
               "name": {
                   "value": "Cup"
               },
               "customProperties": {
                   "results": [
                       {
                           "value": "White",
                           "displayValue": "White",
                           "definition": {
                               "id": "cHJvcGRlZn5BQ040RXZkSExNVFppdzduZmtIVXBQanNBNFZmWmFuVH5BQ040RXZkSExNVFppdzduZmtIVXBQanNBNFZmWmFuVH5wcm9wX2RlZl9jb2xfMTc2ODg4MjUxNzkxOH5wYXJhbWV0ZXJzLkFDTjRFdmRITE1UWml3N25ma0hVcFBqc0E0VmZaYW5UOjE3ODYyYzU4NDdmMTRlNzNhNzVlZjU4M2ZjNzdkYTI1LTEuMC4w",
                               "name": "Border Color 1768897661542",
                               "specification": "STRING",
                               "isHidden": false,
                               "isReadOnly": false,
                               "isArchived": false,
                               "description": "border color",
                               "propertyBehavior": "TIMELESS",
                               "units": null
                           }
                       },
                       {
                           "value": "Green",
                           "displayValue": "Green",
                           "definition": {
                               "id": "cHJvcGRlZn5BQ040RXZkSExNVFppdzduZmtIVXBQanNBNFZmWmFuVH5BQ040RXZkSExNVFppdzduZmtIVXBQanNBNFZmWmFuVH5wcm9wX2RlZl9jb2xfMTc2ODg4MjUxNzkxOH5wYXJhbWV0ZXJzLkFDTjRFdmRITE1UWml3N25ma0hVcFBqc0E0VmZaYW5UOjVkOGRmOTEzZjQwMjRjZmFhZGE0MGZkMjcxMjJmNGQxLTEuMC4w",
                               "name": "Background Color 1768897661542",
                               "specification": "STRING",
                               "isHidden": false,
                               "isReadOnly": false,
                               "isArchived": false,
                               "description": "bg color",
                               "propertyBehavior": "STANDARD",
                               "units": null
                           }
                       },
                       {
                           "value": "10E23",
                           "displayValue": "10E23",
                           "definition": {
                               "id": "cHJvcGRlZn5BQ040RXZkSExNVFppdzduZmtIVXBQanNBNFZmWmFuVH5BQ040RXZkSExNVFppdzduZmtIVXBQanNBNFZmWmFuVH5wcm9wX2RlZl9jb2xfMTc2ODg4MjUxNzkxOH5wYXJhbWV0ZXJzLkFDTjRFdmRITE1UWml3N25ma0hVcFBqc0E0VmZaYW5UOjNjOWU4YWRkMDkzMDQ2MTNhOGIzNjdiYWJjOGZhNjYwLTEuMC4w",
                               "name": "ERP ID",
                               "specification": "STRING",
                               "isHidden": true,
                               "isReadOnly": false,
                               "isArchived": false,
                               "description": "description updated",
                               "propertyBehavior": "TIMELESS",
                               "units": null
                           }
                       }
                   ]
               }
           }
       }
    }
    
    Show More

    Example 5

    Retrieves the BOM Structure Type property which determines how a component should be treated in all Bills of Materials (e.g., DEFAULT, HIDDEN_CHILDREN).

    Query:

    query GetBomStructureTypeProperty($componentId: ID!) {
     component(componentId: $componentId) {
       id
       bomStructureTypeProperty {
         value
         name
         definition {
           id
           name
           propertyBehavior
         }
       }
     }
     }
    
    Show More

    Query Variables:

    {
     "componentId": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35ZVTNrUXp0eWRWQTdTY2NCTklrZGtmX2FnYQ"
    }
    

    Response:

    {
       "data": {
           "component": {
               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35ZVTNrUXp0eWRWQTdTY2NCTklrZGtmX2FnYQ",
               "bomStructureTypeProperty": {
                   "value": "2",
                   "name": "bomStructureType",
                   "definition": {
                       "id": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflNXNTBjbWx1YzJsalVISnZjR1Z5ZEdsbGMwZHliM1Z3VTNSbn5SMlZ1WlhKaGJBfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo1N2VmZWNjMWYxODE0YjRkYjQwZmMxZjZhZWE0ZWVlYi0xLjAuMA",
                       "name": "BOM Structure Type",
                       "propertyBehavior": "STANDARD"
                   }
               }
           }
       }
    }
    
    Show More

    Example 6

    Lists BOM children of the RFTP Parent assembly (Child1 and Child2). Use before bulkRemoveComponentFromBOM (RFTP) to verify the assembly structure.

    Query:

    query GetRftpParentBomRelations($componentId: ID!) {
     component(componentId: $componentId) {
       id
       name {
         value
       }
       bomRelations(depth: 1) {
         results {
           id
           sequenceNumber
           toComponent {
             id
             name {
               value
             }
             partNumber {
               value
             }
           }
         }
         pagination {
           cursor
           pageSize
         }
       }
     }
     }
    
    Show More

    Query Variables:

    {
     "componentId": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35DUG1iYzFQbVdMakpKazNwbjdyYXVVX2FnYQ"
    }
    

    Response:

    {
       "data": {
           "component": {
               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35DUG1iYzFQbVdMakpKazNwbjdyYXVVX2FnYQ",
               "name": {
                   "value": "RFTP Parent"
               },
               "bomRelations": {
                   "results": [],
                   "pagination": {
                       "cursor": null,
                       "pageSize": 0
                   }
               }
           }
       }
    }
    
    Show More

    Example 7

    Lists BOM relations of the parent component along with their component resolution (time override). toComponentResolution is null until it is set. Supported values: 0 (FOLLOW_CAD), 1 (LATEST_CHANGE), 2 (LATEST_VERSION), 3 (LATEST_REVISION).

    Query:

    query GetBomRelationsComponentResolution($componentId: ID!) {
     component(componentId: $componentId) {
       id
       bomRelations(depth: 1) {
         results {
           id
           sequenceNumber
           toComponent {
             id
             name {
               value
             }
           }
           quantityProperty {
             value
           }
           toComponentResolution {
             name
             value
             displayValue
             definition {
               id
               name
             }
           }
         }
       }
     }
     }
    
    Show More

    Query Variables:

    {
     "componentId": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ341SE1iR2Zsb1E0VjJMdDlzY1JVcUtZX2FnYQ"
    }
    

    Response:

    {
       "data": {
           "component": {
               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ341SE1iR2Zsb1E0VjJMdDlzY1JVcUtZX2FnYQ",
               "bomRelations": {
                   "results": [
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-UmJya2Zla05sZWwwZ2VBdFh0M1BqWA",
                           "sequenceNumber": 1,
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35SUDhoU20yS2hJTm1RTDZRMWhLbnM0X2FnYQ",
                               "name": {
                                   "value": "A"
                               }
                           },
                           "quantityProperty": {
                               "value": 1
                           },
                           "toComponentResolution": null
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-TEtIRmVPRkk0Vk9NMU1DU2hrNDgzQg",
                           "sequenceNumber": 2,
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ345bUdDcUlQYzVRaGVrc2RORHpTVjhsX2FnYQ",
                               "name": {
                                   "value": "C"
                               }
                           },
                           "quantityProperty": {
                               "value": 1
                           },
                           "toComponentResolution": null
                       },
                       {
                           "id": "Ym9tcmVsYXRpb25-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-ZlppYzVldmw4NDZIR2JoTWxuWnAzaQ",
                           "sequenceNumber": 3,
                           "toComponent": {
                               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35nZmxTYU1iNVVOQU5oZkZLWHlrMkc5X2FnYQ",
                               "name": {
                                   "value": "B"
                               }
                           },
                           "quantityProperty": {
                               "value": 1
                           },
                           "toComponentResolution": null
                       }
                   ]
               }
           }
       }
    }
    
    Show More

    Example 8

    Retrieves Properties associated with the component, supported by a filter on property name.

    Query:

    query GetComponentProperties($componentId: ID!, $filter: PropertyFilterInput) {
           component(componentId: $componentId) {
               id
               name{
                   value
               }
               customProperties(filter: $filter) {
                   results {
                       name
                       value
                       displayValue
                       definition {
                           id
                           name
                           specification
                           isHidden
                           isReadOnly
                           isArchived
                           description
                           propertyBehavior
                           units {
                               id
                               name
                           }
                       }
                   }
               }
           }
     }
    
    Show More

    Query Variables:

    {
     "componentId": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35NeWpwUUR6Q3YwdFZQQzBYMVRhUVdPX2FnYQ",
     "filter": {
       "names": ["ERP ID"]
     }
    }
    

    Response:

    {
       "data": {
           "component": {
               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35NeWpwUUR6Q3YwdFZQQzBYMVRhUVdPX2FnYQ",
               "name": {
                   "value": "Cup"
               },
               "customProperties": {
                   "results": [
                       {
                           "name": "ERP ID",
                           "value": "10E23",
                           "displayValue": "10E23",
                           "definition": {
                               "id": "cHJvcGRlZn5BQ040RXZkSExNVFppdzduZmtIVXBQanNBNFZmWmFuVH5BQ040RXZkSExNVFppdzduZmtIVXBQanNBNFZmWmFuVH5wcm9wX2RlZl9jb2xfMTc2ODg4MjUxNzkxOH5wYXJhbWV0ZXJzLkFDTjRFdmRITE1UWml3N25ma0hVcFBqc0E0VmZaYW5UOjNjOWU4YWRkMDkzMDQ2MTNhOGIzNjdiYWJjOGZhNjYwLTEuMC4w",
                               "name": "ERP ID",
                               "specification": "STRING",
                               "isHidden": true,
                               "isReadOnly": false,
                               "isArchived": false,
                               "description": "description updated",
                               "propertyBehavior": "TIMELESS",
                               "units": null
                           }
                       }
                   ]
               }
           }
       }
    }
    
    Show More

    Example 9

    Retrieves base properties of given component.

    Query:

    query Component($componentId: ID!) {
     component(componentId: $componentId) {
       id
       name{
           value
       }
       baseProperties {
         results {
           name
           displayValue
           value
           definition {
             id
           }
         }
       }
     }
     }
    
    Show More

    Query Variables:

    {
       "componentId": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35NeWpwUUR6Q3YwdFZQQzBYMVRhUVdPX2FnYQ"
    }
    

    Response:

    {
       "data": {
           "component": {
               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35NeWpwUUR6Q3YwdFZQQzBYMVRhUVdPX2FnYQ",
               "name": {
                   "value": "Cup"
               },
               "baseProperties": {
                   "results": [
                       {
                           "name": "Manufacturer",
                           "displayValue": "Autodesk",
                           "value": "Autodesk",
                           "definition": {
                               "id": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflFtRnpaVkJ5YjNCbGNuUnBaWE5IY205MWNGTjBZV2RwYm1jflEyOXRjRzl1Wlc1MH5wYXJhbWV0ZXJzLlFtRnpaVkJ5YjNCbGNuUnBaWE5UZEdGbmFXNW46ZTM1NDM5ZTJlMDI0NDhjYTgyNWQ0MTI4MTY4NDJlY2ItMS4wLjA"
                           }
                       }
                   ]
               }
           }
       }
    }
    
    Show More

    Example 10

    Retrieves base properties of given component and it’s localized name.

    Query:

    query Component($componentId: ID!) {
     component(componentId: $componentId) {
       id
       name{
           value
       }
       baseProperties {
         results {
           name
           displayValue
           value
           definition {
             id
             localizedName
           }
         }
       }
     }
     }
    
    Show More

    Query Variables:

    {
       "componentId": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35NeWpwUUR6Q3YwdFZQQzBYMVRhUVdPX2FnYQ"
    }
    

    Response:

    {
       "data": {
           "component": {
               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35NeWpwUUR6Q3YwdFZQQzBYMVRhUVdPX2FnYQ",
               "name": {
                   "value": "Cup"
               },
               "baseProperties": {
                   "results": [
                       {
                           "name": "Manufacturer",
                           "displayValue": "Autodesk",
                           "value": "Autodesk",
                           "definition": {
                               "id": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflFtRnpaVkJ5YjNCbGNuUnBaWE5IY205MWNGTjBZV2RwYm1jflEyOXRjRzl1Wlc1MH5wYXJhbWV0ZXJzLlFtRnpaVkJ5YjNCbGNuUnBaWE5UZEdGbmFXNW46ZTM1NDM5ZTJlMDI0NDhjYTgyNWQ0MTI4MTY4NDJlY2ItMS4wLjA",
                               "localizedName": "Produttore"
                           }
                       }
                   ]
               }
           }
       }
    }
    
    Show More

    Example 11

    Retrieves base properties of given component and fetch it’s localization resources.

    Query:

    query Component($componentId: ID!, $filter: LocalesFilterInput) {
     component(componentId: $componentId) {
       id
       name{
           value
       }
       baseProperties {
         results {
           name
           displayValue
           value
           definition {
             id
             localizations(filter: $filter) {
                   locale
                   localizedFields {
                       name
                       value
                   }
               }
           }
         }
       }
     }
     }
    
    Show More

    Query Variables:

    {
       "componentId": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35NeWpwUUR6Q3YwdFZQQzBYMVRhUVdPX2FnYQ",
       "filter": {
           "locales": ["es", "it"]
       }
    }
    

    Response:

    {
       "data": {
           "component": {
               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35NeWpwUUR6Q3YwdFZQQzBYMVRhUVdPX2FnYQ",
               "name": {
                   "value": "Cup"
               },
               "baseProperties": {
                   "results": [
                       {
                           "name": "Manufacturer",
                           "displayValue": "Autodesk",
                           "value": "Autodesk",
                           "definition": {
                               "id": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflFtRnpaVkJ5YjNCbGNuUnBaWE5IY205MWNGTjBZV2RwYm1jflEyOXRjRzl1Wlc1MH5wYXJhbWV0ZXJzLlFtRnpaVkJ5YjNCbGNuUnBaWE5UZEdGbmFXNW46ZTM1NDM5ZTJlMDI0NDhjYTgyNWQ0MTI4MTY4NDJlY2ItMS4wLjA",
                               "localizations": [
                                   {
                                       "locale": "es",
                                       "localizedFields": [
                                           {
                                               "name": "name",
                                               "value": "Fabricante"
                                           },
                                           {
                                               "name": "description",
                                               "value": "Definición de propiedad base de fabricante"
                                           }
                                       ]
                                   },
                                   {
                                       "locale": "it",
                                       "localizedFields": [
                                           {
                                               "name": "name",
                                               "value": "Produttore"
                                           },
                                           {
                                               "name": "description",
                                               "value": "Definizione proprietà di base produttore"
                                           }
                                       ]
                                   }
                               ]
                           }
                       }
                   ]
               }
           }
       }
    }
    
    Show More

    Example 12

    Retrieves computed properties present on a Component, at time which is provided by computeTime argument. Between Component state time and provided computeTime, Component state time will take precedence.

    Query:

    query GetComponentFromState(
     $state: String!
     $computedPropertiesComputeTime: DateTime!
     $allComputedPropertiesIds: [ID!]!
    
    ) {
    componentFromState(state: $state) {

    id name {

    value

    } computedProperties(

    filter: { ids: $allComputedPropertiesIds } computeTime: $computedPropertiesComputeTime

    ) {
    results {

    name status value displayValue definition {

    id

    }

    } errors {

    code message

    }

    }

    Query Variables:

    {
       "state": "c3RhdGV-V09SS0lOR35udWxsfnsicm9vdFN0YXRlIjpudWxsLCJzdGF0ZSI6eyJhbmNlc3RvclNlY29uZGFyeVJlYXNvbiI6bnVsbCwiYW5jZXN0b3JTdHJ1Y3R1cmUiOiJERUZBVUxUIiwiY29tcG9zaXRpb24iOiJXT1JLSU5HIiwiaWQiOiJjSEp2WkhWamRINDVZV0pOWTBaNFMyZG9VSGxqZDNWTmIyRkhUbWxyWDB3eVEzNU1hVEp0UkV4RFIweHJPVFJqU1hKdWFXOU9VWEIyWDJGbllRIiwidGltZSI6bnVsbCwidHlwZSI6IkNPTVBPTkVOVCJ9fQ",
       "computedPropertiesComputeTime": "2026-10-30T15:16:23.765Z",
       "allComputedPropertiesIds": ["cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flEyOXRjSFYwWldRfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjozZDcyNzdjODE3ODQ0YTk1OWZhNjdlYmU2Y2Y1MDRiMi0xLjAuMA","cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flEyOXRjSFYwWldRfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjpjYjE3MDZlZGE5MzA0MGYyYjQ4MzEwNDJiMTk2Y2EwYi0xLjAuMA","cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flEyOXRjSFYwWldRfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjpiMWVjOWVlYzkxNmY0OTk4OTVkY2JiNTc2MTMxM2YxMy0xLjAuMA","cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flEyOXRjSFYwWldRfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo1MzY1MWE4NTBjYjQ0NjNkOWEyMzQyY2FiNDVhNDM1ZS0xLjAuMA","cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flEyOXRjSFYwWldRfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo3OTIyM2U2NDMxNWY0NjkxOGJkN2QwNmZlYmE4NmM5Zi0xLjAuMA","cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flEyOXRjSFYwWldRfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo5NTgzMmM1YWFmYjQ0ZWMyYTVlMjk4OGJhMDE1OTgzNS0xLjAuMA","cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flEyOXRjSFYwWldRfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo3ZWU4ZDQ1MjE2MDk0ZjdiYTFkZjI2MDMyMWY3Y2U1My0xLjAuMA","cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flVHaDVjMmxqWVd3fnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjplY2VlMjU0OWRiMmU0MTUxYmVkYmMwYmJlNjQxNDE3YS0xLjAuMA","cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flVHaDVjMmxqWVd3fnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo3Y2UyYjk2MmJiM2U0MWJhODQxNDQyOTNmZjlkN2Q3Yy0xLjAuMA","cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flVHaDVjMmxqWVd3fnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjoxYjM3ZmU4ZDk5ZTY0NjFlYWI5ZWY5ZWI1OGQ0ZGMwZS0xLjAuMA","cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flVHaDVjMmxqWVd3fnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjoxMGM0YzhjNWUwYTE0NzNlYTI4NzMzODY3MmIzNGJlZi0xLjAuMA","cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flVHaDVjMmxqWVd3fnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjpkYWUxYzM4MjI3NWY0NzRhYThmYzYwNDI1NDRmOGY5MC0xLjAuMA","cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flVHaDVjMmxqWVd3fnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjpkMzlhMzkwNjNhNjA0YjFhOGFmNmQzNjU5YWFjNWE2NC0xLjAuMA"]
    }
    

    Response:

    {
       "data": {
           "componentFromState": {
               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35MaTJtRExDR0xrOTRjSXJuaW9OUXB2X2FnYQ",
               "name": {
                   "value": "Espresso Machine"
               },
               "computedProperties": {
                   "results": [
                       {
                           "name": "Density",
                           "status": "IN_PROGRESS",
                           "value": "",
                           "displayValue": "",
                           "definition": {
                               "id": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flEyOXRjSFYwWldRfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjozZDcyNzdjODE3ODQ0YTk1OWZhNjdlYmU2Y2Y1MDRiMi0xLjAuMA"
                           }
                       },
                       {
                           "name": "Total Area",
                           "status": "IN_PROGRESS",
                           "value": "",
                           "displayValue": "",
                           "definition": {
                               "id": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flEyOXRjSFYwWldRfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjpjYjE3MDZlZGE5MzA0MGYyYjQ4MzEwNDJiMTk2Y2EwYi0xLjAuMA"
                           }
                       },
                       {
                           "name": "Total Height",
                           "status": "IN_PROGRESS",
                           "value": "",
                           "displayValue": "",
                           "definition": {
                               "id": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flEyOXRjSFYwWldRfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjpiMWVjOWVlYzkxNmY0OTk4OTVkY2JiNTc2MTMxM2YxMy0xLjAuMA"
                           }
                       },
                       {
                           "name": "Total Length",
                           "status": "IN_PROGRESS",
                           "value": "",
                           "displayValue": "",
                           "definition": {
                               "id": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flEyOXRjSFYwWldRfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo1MzY1MWE4NTBjYjQ0NjNkOWEyMzQyY2FiNDVhNDM1ZS0xLjAuMA"
                           }
                       },
                       {
                           "name": "Total Mass",
                           "status": "IN_PROGRESS",
                           "value": "",
                           "displayValue": "",
                           "definition": {
                               "id": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flEyOXRjSFYwWldRfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo3OTIyM2U2NDMxNWY0NjkxOGJkN2QwNmZlYmE4NmM5Zi0xLjAuMA"
                           }
                       },
                       {
                           "name": "Total Volume",
                           "status": "IN_PROGRESS",
                           "value": "",
                           "displayValue": "",
                           "definition": {
                               "id": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flEyOXRjSFYwWldRfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo5NTgzMmM1YWFmYjQ0ZWMyYTVlMjk4OGJhMDE1OTgzNS0xLjAuMA"
                           }
                       },
                       {
                           "name": "Total Width",
                           "status": "IN_PROGRESS",
                           "value": "",
                           "displayValue": "",
                           "definition": {
                               "id": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flEyOXRjSFYwWldRfnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo3ZWU4ZDQ1MjE2MDk0ZjdiYTFkZjI2MDMyMWY3Y2U1My0xLjAuMA"
                           }
                       },
                       {
                           "name": "Area",
                           "status": "IN_PROGRESS",
                           "value": "",
                           "displayValue": "",
                           "definition": {
                               "id": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flVHaDVjMmxqWVd3fnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjplY2VlMjU0OWRiMmU0MTUxYmVkYmMwYmJlNjQxNDE3YS0xLjAuMA"
                           }
                       },
                       {
                           "name": "Height",
                           "status": "IN_PROGRESS",
                           "value": "",
                           "displayValue": "",
                           "definition": {
                               "id": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flVHaDVjMmxqWVd3fnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjo3Y2UyYjk2MmJiM2U0MWJhODQxNDQyOTNmZjlkN2Q3Yy0xLjAuMA"
                           }
                       },
                       {
                           "name": "Length",
                           "status": "IN_PROGRESS",
                           "value": "",
                           "displayValue": "",
                           "definition": {
                               "id": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flVHaDVjMmxqWVd3fnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjoxYjM3ZmU4ZDk5ZTY0NjFlYWI5ZWY5ZWI1OGQ0ZGMwZS0xLjAuMA"
                           }
                       },
                       {
                           "name": "Mass",
                           "status": "IN_PROGRESS",
                           "value": "",
                           "displayValue": "",
                           "definition": {
                               "id": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flVHaDVjMmxqWVd3fnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjoxMGM0YzhjNWUwYTE0NzNlYTI4NzMzODY3MmIzNGJlZi0xLjAuMA"
                           }
                       },
                       {
                           "name": "Volume",
                           "status": "IN_PROGRESS",
                           "value": "",
                           "displayValue": "",
                           "definition": {
                               "id": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flVHaDVjMmxqWVd3fnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjpkYWUxYzM4MjI3NWY0NzRhYThmYzYwNDI1NDRmOGY5MC0xLjAuMA"
                           }
                       },
                       {
                           "name": "Width",
                           "status": "IN_PROGRESS",
                           "value": "",
                           "displayValue": "",
                           "definition": {
                               "id": "cHJvcGRlZn5RbUZ6WlZCeWIzQmxjblJwWlhOVGRHRm5hVzVuflEyOXRjSFYwWldSUWNtOXdaWEowZVVSbFpuTkhjbTkxY0ZOMFp3flVHaDVjMmxqWVd3fnBhcmFtZXRlcnMuUW1GelpWQnliM0JsY25ScFpYTlRkR0ZuYVc1bjpkMzlhMzkwNjNhNjA0YjFhOGFmNmQzNjU5YWFjNWE2NC0xLjAuMA"
                           }
                       }
                   ],
                   "errors": []
               }
           }
       }
    }
    
    Show More

    Example 13

    Retrieves computed properties present on the parts list item along with Aggregated total values of properties across all parts in the list.

    Query:

    query GetComponentPartsList($componentId: ID!, $computeTime: DateTime) {
     component(componentId: $componentId) {
       id
       name {
         value
       }
       partsList(computeTime: $computeTime) {
           status
         results {
           component {
             id
           }
           computedProperties {
             results {
               name
               status
               value
               displayValue
               definition {
                 id
               }
             }
             errors {
               code
               message
             }
           }
           sequenceNumber
         }
         totals {
           results {
             name
             status
             value
             displayValue
             definition {
               id
             }
           }
           errors {
             code
             message
           }
         }
         pagination {
           cursor
           pageSize
         }
       }
     }
     }
    
    Show More

    Query Variables:

    {
       "componentId": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35MaTJtRExDR0xrOTRjSXJuaW9OUXB2X2FnYQ",
       "computeTime": "2026-10-30T15:16:34.160Z"
    }
    

    Response:

    {
       "data": {
           "component": {
               "id": "cHJvZHVjdH45YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35MaTJtRExDR0xrOTRjSXJuaW9OUXB2X2FnYQ",
               "name": {
                   "value": "Espresso Machine"
               },
               "partsList": {
                   "status": "IN_PROGRESS",
                   "results": [],
                   "totals": {
                       "results": [],
                       "errors": []
                   },
                   "pagination": {
                       "cursor": "",
                       "pageSize": 0
                   }
               }
           }
       }
    }
    
    Show More