Package com.onshape.api.requests

Class AssembliesGetBillOfMaterialsRequest.Builder

java.lang.Object

com.onshape.api.requests.AssembliesGetBillOfMaterialsRequest.Builder

Enclosing class:

AssembliesGetBillOfMaterialsRequest

public static final class AssembliesGetBillOfMaterialsRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
String	bomColumnIds()	Get Ids of the columns to include, or empty if all.
AssembliesGetBillOfMaterialsRequest.Builder	bomColumnIds(String value)	Set Ids of the columns to include, or empty if all.
AssembliesGetBillOfMaterialsResponse	call(OnshapeDocument document)	Calls getBillOfMaterials method, Get content of the bill of materials in json format matching the Onshape BOM Standard for the specified assembly
AssembliesGetBillOfMaterialsResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls getBillOfMaterials method, Get content of the bill of materials in json format matching the Onshape BOM Standard for the specified assembly
Boolean	generateIfAbsent()	Get If this is false and the BOM does not exist for the Assembly a 404 status code will be returned.
AssembliesGetBillOfMaterialsRequest.Builder	generateIfAbsent(Boolean value)	Set If this is false and the BOM does not exist for the Assembly a 404 status code will be returned.
Boolean	indented()	Get If true will return an indented bom, otherwise a parts list will be returned
AssembliesGetBillOfMaterialsRequest.Builder	indented(Boolean value)	Set If true will return an indented bom, otherwise a parts list will be returned
String	metadataWorkspaceId()	Get if m is specified for [wvm] this workspaceId is required and is used to retrieve metadata, otherwise it is ignored.
AssembliesGetBillOfMaterialsRequest.Builder	metadataWorkspaceId(String value)	Set if m is specified for [wvm] this workspaceId is required and is used to retrieve metadata, otherwise it is ignored.
Boolean	multiLevel()	Get Will return a multilevel bom if true, otherwise returns a top level bom.
AssembliesGetBillOfMaterialsRequest.Builder	multiLevel(Boolean value)	Set Will return a multilevel bom if true, otherwise returns a top level bom.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

metadataWorkspaceId

public final String metadataWorkspaceId()

Get if m is specified for [wvm] this workspaceId is required and is used to retrieve metadata, otherwise it is ignored.

Returns:

if m is specified for [wvm] this workspaceId is required and is used to retrieve metadata, otherwise it is ignored.

metadataWorkspaceId

public final AssembliesGetBillOfMaterialsRequest.Builder metadataWorkspaceId(String value)

Set if m is specified for [wvm] this workspaceId is required and is used to retrieve metadata, otherwise it is ignored.

Parameters:

value - if m is specified for [wvm] this workspaceId is required and is used to retrieve metadata, otherwise it is ignored.

Returns:

the Builder object.

bomColumnIds

public final String bomColumnIds()

Get Ids of the columns to include, or empty if all. BOM column ids correspond to the ids of metadata properties retrieved from BTRestMetadataSchema, with the exception of billOfMaterialsItemNo and billOfMaterialsQuantity which identify the Item Number and Quantity columns respectively

Returns:

Ids of the columns to include, or empty if all. BOM column ids correspond to the ids of metadata properties retrieved from BTRestMetadataSchema, with the exception of billOfMaterialsItemNo and billOfMaterialsQuantity which identify the Item Number and Quantity columns respectively

bomColumnIds

public final AssembliesGetBillOfMaterialsRequest.Builder bomColumnIds(String value)

Set Ids of the columns to include, or empty if all. BOM column ids correspond to the ids of metadata properties retrieved from BTRestMetadataSchema, with the exception of billOfMaterialsItemNo and billOfMaterialsQuantity which identify the Item Number and Quantity columns respectively

Parameters:

value - Ids of the columns to include, or empty if all. BOM column ids correspond to the ids of metadata properties retrieved from BTRestMetadataSchema, with the exception of billOfMaterialsItemNo and billOfMaterialsQuantity which identify the Item Number and Quantity columns respectively

Returns:

the Builder object.

indented

public final Boolean indented()

Get If true will return an indented bom, otherwise a parts list will be returned

Returns:

If true will return an indented bom, otherwise a parts list will be returned

indented

public final AssembliesGetBillOfMaterialsRequest.Builder indented(Boolean value)

Set If true will return an indented bom, otherwise a parts list will be returned

Parameters:

value - If true will return an indented bom, otherwise a parts list will be returned

Returns:

the Builder object.

multiLevel

public final Boolean multiLevel()

Get Will return a multilevel bom if true, otherwise returns a top level bom. Ignored if indented is false.

Returns:

Will return a multilevel bom if true, otherwise returns a top level bom. Ignored if indented is false.

multiLevel

public final AssembliesGetBillOfMaterialsRequest.Builder multiLevel(Boolean value)

Set Will return a multilevel bom if true, otherwise returns a top level bom. Ignored if indented is false.

Parameters:

value - Will return a multilevel bom if true, otherwise returns a top level bom. Ignored if indented is false.

Returns:

the Builder object.

generateIfAbsent

public final Boolean generateIfAbsent()

Get If this is false and the BOM does not exist for the Assembly a 404 status code will be returned. Otherwise, the contents will be generated and returned, without creating the BOM element.

Returns:

If this is false and the BOM does not exist for the Assembly a 404 status code will be returned. Otherwise, the contents will be generated and returned, without creating the BOM element.

generateIfAbsent

public final AssembliesGetBillOfMaterialsRequest.Builder generateIfAbsent(Boolean value)

Set If this is false and the BOM does not exist for the Assembly a 404 status code will be returned. Otherwise, the contents will be generated and returned, without creating the BOM element.

Parameters:

value - If this is false and the BOM does not exist for the Assembly a 404 status code will be returned. Otherwise, the contents will be generated and returned, without creating the BOM element.

Returns:

the Builder object.

call

public final AssembliesGetBillOfMaterialsResponse call(String did,
                                                       WVM wvmType,
                                                       String wvm,
                                                       String eid)
                                                throws OnshapeException

Calls getBillOfMaterials method, Get content of the bill of materials in json format matching the Onshape BOM Standard for the specified assembly

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

wvm - Workspace (w), Version (v) or Microversion (m) ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final AssembliesGetBillOfMaterialsResponse call(OnshapeDocument document)
                                                throws OnshapeException

Calls getBillOfMaterials method, Get content of the bill of materials in json format matching the Onshape BOM Standard for the specified assembly

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error