Package com.onshape.api.requests

Class AppElementsGetJsonRequest.Builder

java.lang.Object

com.onshape.api.requests.AppElementsGetJsonRequest.Builder

Enclosing class:

AppElementsGetJsonRequest

public static final class AppElementsGetJsonRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AppElementsGetJsonResponse	call(OnshapeDocument document)	Calls getJson method, Gets the JSON tree at a workspace/microversion/version
AppElementsGetJsonResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls getJson method, Gets the JSON tree at a workspace/microversion/version
String	changeId()	Get Id of the change at which the JSON should be retrieved Valid only when used with a workspaceId
AppElementsGetJsonRequest.Builder	changeId(String value)	Set Id of the change at which the JSON should be retrieved Valid only when used with a workspaceId
String	transactionId()	Get Id of the transaction in which the JSON should be retrieved Valid only when used with a workspaceId
AppElementsGetJsonRequest.Builder	transactionId(String value)	Set Id of the transaction in which the JSON should be retrieved Valid only when used with a workspaceId

Methods inherited from class java.lang.Object

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

Method Detail

transactionId

public final String transactionId()

Get Id of the transaction in which the JSON should be retrieved Valid only when used with a workspaceId

Returns:

Id of the transaction in which the JSON should be retrieved Valid only when used with a workspaceId

transactionId

public final AppElementsGetJsonRequest.Builder transactionId(String value)

Set Id of the transaction in which the JSON should be retrieved Valid only when used with a workspaceId

Parameters:

value - Id of the transaction in which the JSON should be retrieved Valid only when used with a workspaceId

Returns:

the Builder object.

changeId

public final String changeId()

Get Id of the change at which the JSON should be retrieved Valid only when used with a workspaceId

Returns:

Id of the change at which the JSON should be retrieved Valid only when used with a workspaceId

changeId

public final AppElementsGetJsonRequest.Builder changeId(String value)

Set Id of the change at which the JSON should be retrieved Valid only when used with a workspaceId

Parameters:

value - Id of the change at which the JSON should be retrieved Valid only when used with a workspaceId

Returns:

the Builder object.

call

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

Calls getJson method, Gets the JSON tree at a workspace/microversion/version

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 AppElementsGetJsonResponse call(OnshapeDocument document)
                                      throws OnshapeException

Calls getJson method, Gets the JSON tree at a workspace/microversion/version

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error