Package com.onshape.api.requests

Class PartsGetBodyDetailsRequest.Builder

java.lang.Object

com.onshape.api.requests.PartsGetBodyDetailsRequest.Builder

Enclosing class:

PartsGetBodyDetailsRequest

public static final class PartsGetBodyDetailsRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartsGetBodyDetailsResponse	call(OnshapeDocument document, String partid)	Calls getBodyDetails method, Get the body details of a part.
PartsGetBodyDetailsResponse	call(String did, WVM wvmType, String wvm, String eid, String partid)	Calls getBodyDetails method, Get the body details of a part.
String	configuration()	Get Configuration string
PartsGetBodyDetailsRequest.Builder	configuration(String value)	Set Configuration string
String	linkDocumentId()	Get Id of document that links to the document being accessed.
PartsGetBodyDetailsRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.

Methods inherited from class java.lang.Object

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

Method Detail

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 PartsGetBodyDetailsRequest.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.

configuration

public final String configuration()

Get Configuration string

Returns:

Configuration string

configuration

public final PartsGetBodyDetailsRequest.Builder configuration(String value)

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

call

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

Calls getBodyDetails method, Get the body details of a part. All coordinates are in meters.

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

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

eid - Element ID

partid - Part ID (must be URL encoded)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final PartsGetBodyDetailsResponse call(OnshapeDocument document,
                                              String partid)
                                       throws OnshapeException

Calls getBodyDetails method, Get the body details of a part. All coordinates are in meters.

Parameters:

document - Document object from Onshape URL.

partid - Part ID (must be URL encoded)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error