Package com.onshape.api.requests

Class PartsGetPartsInPartstudioRequest.Builder

java.lang.Object

com.onshape.api.requests.PartsGetPartsInPartstudioRequest.Builder

Enclosing class:

PartsGetPartsInPartstudioRequest

public static final class PartsGetPartsInPartstudioRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartsGetPartsInPartstudioResponse	call(OnshapeDocument document)	Calls getPartsInPartstudio method, Get list of parts in a part studio.
PartsGetPartsInPartstudioResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls getPartsInPartstudio method, Get list of parts in a part studio.
Boolean	includeFlatParts()	Get Whether or not to include flattened sheet metal parts
PartsGetPartsInPartstudioRequest.Builder	includeFlatParts(Boolean value)	Set Whether or not to include flattened sheet metal parts
Boolean	includePropertyDefaults()	Get If true, include metadata schema property defaults in response
PartsGetPartsInPartstudioRequest.Builder	includePropertyDefaults(Boolean value)	Set If true, include metadata schema property defaults in response
String	linkDocumentId()	Get Id of document that links to the document being accessed.
PartsGetPartsInPartstudioRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
Boolean	withThumbnails()	Get Whether or not to include thumbnails (not supported for microversion)
PartsGetPartsInPartstudioRequest.Builder	withThumbnails(Boolean value)	Set Whether or not to include thumbnails (not supported for microversion)

Methods inherited from class java.lang.Object

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

Method Detail

withThumbnails

public final Boolean withThumbnails()

Get Whether or not to include thumbnails (not supported for microversion)

Returns:

Whether or not to include thumbnails (not supported for microversion)

withThumbnails

public final PartsGetPartsInPartstudioRequest.Builder withThumbnails(Boolean value)

Set Whether or not to include thumbnails (not supported for microversion)

Parameters:

value - Whether or not to include thumbnails (not supported for microversion)

Returns:

the Builder object.

includeFlatParts

public final Boolean includeFlatParts()

Get Whether or not to include flattened sheet metal parts

Returns:

Whether or not to include flattened sheet metal parts

includeFlatParts

public final PartsGetPartsInPartstudioRequest.Builder includeFlatParts(Boolean value)

Set Whether or not to include flattened sheet metal parts

Parameters:

value - Whether or not to include flattened sheet metal parts

Returns:

the Builder object.

linkDocumentId

public final String linkDocumentId()

Get Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

linkDocumentId

public final PartsGetPartsInPartstudioRequest.Builder linkDocumentId(String value)

Set Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Parameters:

value - Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

the Builder object.

includePropertyDefaults

public final Boolean includePropertyDefaults()

Get If true, include metadata schema property defaults in response

Returns:

If true, include metadata schema property defaults in response

includePropertyDefaults

public final PartsGetPartsInPartstudioRequest.Builder includePropertyDefaults(Boolean value)

Set If true, include metadata schema property defaults in response

Parameters:

value - If true, include metadata schema property defaults in response

Returns:

the Builder object.

call

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

Calls getPartsInPartstudio method, Get list of parts in a part studio. An error is returned if the specified element is not a part studio. Surface, wire, and mesh parts are not returned for a version but are included for a workspace or microversion.

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

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

eid - Part studio element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final PartsGetPartsInPartstudioResponse call(OnshapeDocument document)
                                             throws OnshapeException

Calls getPartsInPartstudio method, Get list of parts in a part studio. An error is returned if the specified element is not a part studio. Surface, wire, and mesh parts are not returned for a version but are included for a workspace or microversion.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error