Package com.onshape.api.requests

Class AppElementsCompareAppElementJsonRequest.Builder

java.lang.Object

com.onshape.api.requests.AppElementsCompareAppElementJsonRequest.Builder

Enclosing class:

AppElementsCompareAppElementJsonRequest

public static final class AppElementsCompareAppElementJsonRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AppElementsCompareAppElementJsonResponse	call(OnshapeDocument document)	Calls compareAppElementJson method, Compare App Element JSON trees in different versions / workspaces of a Document.
AppElementsCompareAppElementJsonResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls compareAppElementJson method, Compare App Element JSON trees in different versions / workspaces of a Document.
String	jsonDifferenceFormat()	Get format of the return value.
AppElementsCompareAppElementJsonRequest.Builder	jsonDifferenceFormat(String value)	Set format of the return value.
String	linkDocumentId()	Get Id of document that links to the document being accessed.
AppElementsCompareAppElementJsonRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
Number	microversionId()	Get Id of a document microversion to compare the App element with
AppElementsCompareAppElementJsonRequest.Builder	microversionId(Number value)	Set Id of a document microversion to compare the App element with
String	versionId()	Get Id of a Version to compare the App element with
AppElementsCompareAppElementJsonRequest.Builder	versionId(String value)	Set Id of a Version to compare the App element with
String	workspaceId()	Get Id of the Workspace to compare the App element with
AppElementsCompareAppElementJsonRequest.Builder	workspaceId(String value)	Set Id of the Workspace to compare the App element with

Methods inherited from class java.lang.Object

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

Method Detail

workspaceId

public final String workspaceId()

Get Id of the Workspace to compare the App element with

Returns:

Id of the Workspace to compare the App element with

workspaceId

public final AppElementsCompareAppElementJsonRequest.Builder workspaceId(String value)

Set Id of the Workspace to compare the App element with

Parameters:

value - Id of the Workspace to compare the App element with

Returns:

the Builder object.

versionId

public final String versionId()

Get Id of a Version to compare the App element with

Returns:

Id of a Version to compare the App element with

versionId

public final AppElementsCompareAppElementJsonRequest.Builder versionId(String value)

Set Id of a Version to compare the App element with

Parameters:

value - Id of a Version to compare the App element with

Returns:

the Builder object.

microversionId

public final Number microversionId()

Get Id of a document microversion to compare the App element with

Returns:

Id of a document microversion to compare the App element with

microversionId

public final AppElementsCompareAppElementJsonRequest.Builder microversionId(Number value)

Set Id of a document microversion to compare the App element with

Parameters:

value - Id of a document microversion to compare the App element with

Returns:

the Builder object.

jsonDifferenceFormat

public final String jsonDifferenceFormat()

Get format of the return value. Values: default|full_path|json_patch

Returns:

format of the return value. Values: default|full_path|json_patch

jsonDifferenceFormat

public final AppElementsCompareAppElementJsonRequest.Builder jsonDifferenceFormat(String value)

Set format of the return value. Values: default|full_path|json_patch

Parameters:

value - format of the return value. Values: default|full_path|json_patch

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

call

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

Calls compareAppElementJson method, Compare App Element JSON trees in different versions / workspaces of a Document. Comparison can be done between any combinations of source Workspace | Version | Microversion (specified in URL) and target Workspace | Version | Microversion (specified as a query parameter). One of versionId, workspaceId, or microversionId query parameters needs to be specified to identify target microversion of the comparison. The result of the comparison is a list of BTGEdits

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

Calls compareAppElementJson method, Compare App Element JSON trees in different versions / workspaces of a Document. Comparison can be done between any combinations of source Workspace | Version | Microversion (specified in URL) and target Workspace | Version | Microversion (specified as a query parameter). One of versionId, workspaceId, or microversionId query parameters needs to be specified to identify target microversion of the comparison. The result of the comparison is a list of BTGEdits

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error