Request

Response

    Inputs

    BOMExportInput

    input

    Specifies a Bill of Materials export. An identical input always refers to the same export, so repeating a request returns the existing job rather than starting another.


    Fields

    componentId*
    ID! non-null
    The ID of the component whose Bill of Materials is exported.
    time*
    DateTime! non-null
    The point in time at which to resolve the Bill of Materials. Pinning the export to an instant makes its output reproducible, so the same input always describes the same file. Send the same value on every call while tracking one export. This value distinguishes one export from another, so passing the current clock time on each call starts a new export every time: capture it once when the export is started and reuse it until the export completes or fails.
    viewTypeThe Bill of Materials view to export. Defaults to STRUCTURED.
    compositionThe Bill of Materials composition to traverse. Defaults to WORKING.
    exportTypeThe file format to produce. Defaults to XLSX.
    additionalPropertyColumnsProperty definitions to add as columns, on top of the columns every export already includes: sequence number and part name. Given in the order they should appear after those, and order is significant: reordering the same definitions describes a different export. Optional. Omit it, or send an empty list, to export only the default columns.
    * Required


    Where Used

    UsageUsed ByDescription
    Argument for Query bomExport Requests export of Bill of Materials. Call this repeatedly with the same input to track progress. The first call starts the export; subsequent calls with an identical input return the state of that same export rather than starting another. When status becomes COMPLETED, signedUrl is a time-limited link to the exported file. Column headers and formatted values are localized according to the request locale, defaulting to English when no supported locale is provided.