Get the Bill Of Materials (BOM) content for the specified assembly.
Returns the BOM in JSON in the Onshape BOM Standard format.
Path parameters
The id of the document in which to perform the operation.
Indicates which of workspace (w), version (v), or document microversion (m) id is specified below.
The id of the workspace, version or document microversion in which the operation should be performed.
The id of the element in which to perform the operation.
Query parameters
The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both.
URL-encoded string of configuration values (separated by ;). See the Configurations API Guide for details.
Ids of the columns to include, or all columns if empty. BOM column ids correspond to metadata property ids.
Return the Structured BOM table with all rows collapsed, otherwise returns the Flattened BOM.
Return the Structured BOM table with all rows expanded. Ignored if indented is false.
Return the BOM table data even if the BOM does not exist. If this is false and the BOM does not exist, a 404 status code will be returned. This option is highly recommended.
The id of the BOM table template to use when generating the table.
Include items that have been excluded from the BOM table.
Only return data for visible columns, instead of all possible columns.
Ignore the 'Subassembly BOM behavior' property when constructing the BOM table.
Include element microversions and version metadata microversions in the JSON.
Include top-level assembly row when constructing the BOM table.
Return thumbnail info
Force respect subassembly BOM Behavior Property
Response
default response