Package com.onshape.api.requests

Class AppElementsGetJsonPathsRequest.Builder

java.lang.Object

com.onshape.api.requests.AppElementsGetJsonPathsRequest.Builder

Enclosing class:

AppElementsGetJsonPathsRequest

public static final class AppElementsGetJsonPathsRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AppElementsGetJsonPathsResponse	call(OnshapeDocument document)	Calls getJsonPaths method, Gets the portions of a JSON tree at a workspace/microversion/version, as specified by JsonPaths
AppElementsGetJsonPathsResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls getJsonPaths method, Gets the portions of a JSON tree at a workspace/microversion/version, as specified by JsonPaths
String	changeId()	Get Id of the change at which the JSON should be retrieved Valid only when used with a workspaceId
AppElementsGetJsonPathsRequest.Builder	changeId(String value)	Set Id of the change at which the JSON should be retrieved Valid only when used with a workspaceId
String[]	paths()	Get lists of path in the JsonPath format
AppElementsGetJsonPathsRequest.Builder	paths(String[] value)	Set lists of path in the JsonPath format
String	transactionId()	Get Id of the transaction in which the JSON should be retrieved Valid only when used with a workspaceId
AppElementsGetJsonPathsRequest.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

paths

public final String[] paths()

Get lists of path in the JsonPath format

Returns:

lists of path in the JsonPath format

paths

public final AppElementsGetJsonPathsRequest.Builder paths(String[] value)

Set lists of path in the JsonPath format

Parameters:

value - lists of path in the JsonPath format

Returns:

the Builder object.

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 AppElementsGetJsonPathsRequest.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 AppElementsGetJsonPathsRequest.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 AppElementsGetJsonPathsResponse call(String did,
                                                  WVM wvmType,
                                                  String wvm,
                                                  String eid)
                                           throws OnshapeException

Calls getJsonPaths method, Gets the portions of a JSON tree at a workspace/microversion/version, as specified by JsonPaths

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

Calls getJsonPaths method, Gets the portions of a JSON tree at a workspace/microversion/version, as specified by JsonPaths

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error