Request

Response

    Objects

    Component

    object

    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.


    Fields

    Expand all
    id*
    ID! non-null
    A system-generated ID that uniquely identifies this object.
    timestamp*
    DateTime! non-null
    The date and time used for traversing the BOM item
    composition*The current composition in which the Component is resolved.
    description*
    Property! non-null
    A human-readable description of the component.
    materialNameName of the material from which the component consists.
    totalCompositeMaterialNameAn aggregation of all of the materials present in the bodies of the model. Value will be Various if there are different materials present. For assemblies this value is not present.
    nameThe human-readable name of the component.
    partNumber*
    Property! non-null
    The part number assigned to this component, resolved at the component’s current state.
    tipPartNumber*
    Property! non-null
    The part number assigned to this component at the most recent save (tip).
    hasChildrenIndicates whether this Bill of Materials (BOM) item has child items. true: The BOM item has one or more child items. false: The BOM item does not have any child items and represents a leaf in the BOM structure.
    bomStructureTypeProperty*
    Property! non-null
    The BOM structure type property, which determines how a component is treated in all Bills of Materials. Supported values: 0 (DEFAULT), 2 (HIDDEN_CHILDREN).
    isStandaloneIndicates whether the component has exactly one design. Returns true only when the component has exactly one design; returns false when it has no designs (non-CAD or orphan components) and when it has several designs (Shared Part Number). DEPRECATED: Please use Component.type instead - standalone component’s type is SHARED_PART_NUMBER. deprecated Please use Component.type instead - standalone component’s type is SHARED_PART_NUMBER.
    isTip*
    Boolean! non-null
    Indicates whether this component is resolved at the latest possible point in time (tip). true: The component reflects the most recent saved state. false: The component is resolved at a specific historical point in time.
    shareLinkA URL that provides a direct link to access the BOM in Fusion Team. Returns null for internal components.
    viewType
    itemNumberThe item number assigned to this component through the Fusion Manage extension.
    lifecycleLifecycle management information for this component from the Fusion Manage extension.
    revisionRevision information for this component when managed through the Fusion Manage extension.
    componentStateAn opaque state string used for subsequent queries to retrieve this component in its current resolved state.
    basePropertiesRetrieves Base Properties present on a Component. Pagination is currently not supported, the API will return all available base properties without pagination.
    pagination
    filter
    customPropertiesRetrieves custom properties present on a Component. Pagination is currently not supported, the API will return all available custom properties without pagination.
    pagination
    filter
    computedProperties*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. This API require ids in filter, which is mandatory input. Maximum size of ids can be 20.
    filter*
    computeTime
    allPropertiesRetrieves all properties present on a Component. Pagination is currently not supported, the API will return all available properties without pagination.
    pagination
    primaryModelRepresents the primary model of the Part Number Group (Component). Might not exist if the corresponding BOM item does not have a CAD model.
    modelsRetrieves all models that share this component’s part number.
    pagination
    bomRelations*
    BOMRelations! non-null
    Contains a flat list of BOM relations for this BOM item for a specific depth (default is 0 which means all BOM relations, whole BOM tree).
    depth
    pagination
    thumbnailRetrieves the thumbnail image of this component.
    isWritableByUser*
    Boolean! non-null
    Indicates whether a user has WRITE access on this component.
    versionThe version associated with this component, resolved in the context of a BOM relation traversal.
    hub*
    Hub! non-null
    An object representing the hub that contains this component.
    partsList*Retrieves parts list of a component.
    pagination
    filter
    computeTime
    * Required


    Where Used

    UsageUsed ByDescription
    Field Of BOMRelation Represents a parent-child relationship between two components in a Bill of Materials (BOM).
    Field Of BulkComponentFromStateQueryResponse Response object when retrieving components in bulk based on component state.
    Field Of BulkComponentsQueryResponse Response object when retrieving components in bulk.
    Field Of CompareComponentResult Return payload containing a component and its comparison result.
    Field Of ComponentPartNumberHistoryChange Object representing the Part Number Change that occurred on a Component.
    Field Of ComponentPrimaryHistoryChange Object representing the Changes that occurred to the primary of the Component.
    Field Of InsertComponentToBOMPayload Represents response for inserting component in BOM.
    Field Of Model Represents a CAD model within a design. A model is an individual part or sub-assembly that acts as a single unit. For example, a lug nut is an individual model in a wheel assembly.
    Field Of ModelComponentHistoryChange Object representing the Component change that occurred for the Model.
    Field Of PartsListItem Represents a single entry in a parts list, corresponding to a leaf-level component with no children.
    Field Of PropertiesUpdatedHistoryChange Object representing the Changes that occurred to properties on a Component.
    Field Of RemoveComponentFromBOMPayload Represents response for removing a component from BOM.
    Field Of RenumberComponentPayload Response payload for the renumberComponent mutation.
    Field Of RenumberPartNumberGroupPayload Response payload for the renumberPartNumberGroup mutation.
    Field Of SharedPartNumberInfo Aggregated information about a Part Number in a hub.
    Field Of Version Represents a named snapshot of an entity’s state at a specific point in time. Versions track the history of changes and support lifecycle management workflows.
    Query By component 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.
    Query By componentFromState Retrieves a Component and its comparison data based on the specified state string.
    Mutated By updateComponentDescription Updates the description of a component.