Package com.onshape.api.responses

Class AppElementsResolveReferencesResponseResolvedReferences

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.AppElementsResolveReferencesResponseResolvedReferences

public final class AppElementsResolveReferencesResponseResolvedReferences
extends AbstractResponseObject

Object used in calls to resolveReferences API endpoint. © 2018-Present Onshape Inc.

Field Summary

Fields

Modifier and Type	Field	Description
String	changeId	The changeId of the creation operation
String	idTag	The idTag of a target within the target element
String	idTagIsValid	Set to true if the idTag value is valid
Boolean	isConfigurable	True if the element configuration can be changed to a non-default value
String	referenceId	The id of the retrieved reference
String	resolvedDocumentMicroversionId	The document microversion contained in the reference, or the current document microversion if not set in the reference
String	targetConfiguration	The configuration string for the target element
String	targetDocumentId	The Id of the document contained in the reference
String	targetDocumentMicroversionId	The document microversion contained in the reference, if set
String	targetElementId	The id of the referenced element
String	targetVersionId	The Id of the version of the document contained in the reference
Boolean	trackNewVersions	for internal use

Constructor Summary

Constructors

Constructor	Description
AppElementsResolveReferencesResponseResolvedReferences()

Method Summary

Modifier and Type	Method	Description
String	getChangeId()	Get The changeId of the creation operation
String	getIdTag()	Get The idTag of a target within the target element
String	getIdTagIsValid()	Get Set to true if the idTag value is valid
Boolean	getIsConfigurable()	Get True if the element configuration can be changed to a non-default value
String	getReferenceId()	Get The id of the retrieved reference
String	getResolvedDocumentMicroversionId()	Get The document microversion contained in the reference, or the current document microversion if not set in the reference
String	getTargetConfiguration()	Get The configuration string for the target element
String	getTargetDocumentId()	Get The Id of the document contained in the reference
String	getTargetDocumentMicroversionId()	Get The document microversion contained in the reference, if set
String	getTargetElementId()	Get The id of the referenced element
String	getTargetVersionId()	Get The Id of the version of the document contained in the reference
Boolean	getTrackNewVersions()	Get for internal use
String	toString()

Methods inherited from class com.onshape.api.types.AbstractResponseObject

getOtherProperties

Methods inherited from class java.lang.Object

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

Field Detail

changeId

public String changeId

The changeId of the creation operation

referenceId

public String referenceId

The id of the retrieved reference

targetDocumentId

public String targetDocumentId

The Id of the document contained in the reference

targetVersionId

public String targetVersionId

The Id of the version of the document contained in the reference

targetElementId

public String targetElementId

The id of the referenced element

targetDocumentMicroversionId

public String targetDocumentMicroversionId

The document microversion contained in the reference, if set

resolvedDocumentMicroversionId

public String resolvedDocumentMicroversionId

The document microversion contained in the reference, or the current document microversion if not set in the reference

idTag

public String idTag

The idTag of a target within the target element

idTagIsValid

public String idTagIsValid

Set to true if the idTag value is valid

trackNewVersions

public Boolean trackNewVersions

for internal use

targetConfiguration

public String targetConfiguration

The configuration string for the target element

isConfigurable

public Boolean isConfigurable

True if the element configuration can be changed to a non-default value

Constructor Detail

AppElementsResolveReferencesResponseResolvedReferences

public AppElementsResolveReferencesResponseResolvedReferences()

Method Detail

getChangeId

public final String getChangeId()

Get The changeId of the creation operation

Returns:

The changeId of the creation operation

getReferenceId

public final String getReferenceId()

Get The id of the retrieved reference

Returns:

The id of the retrieved reference

getTargetDocumentId

public final String getTargetDocumentId()

Get The Id of the document contained in the reference

Returns:

The Id of the document contained in the reference

getTargetVersionId

public final String getTargetVersionId()

Get The Id of the version of the document contained in the reference

Returns:

The Id of the version of the document contained in the reference

getTargetElementId

public final String getTargetElementId()

Get The id of the referenced element

Returns:

The id of the referenced element

getTargetDocumentMicroversionId

public final String getTargetDocumentMicroversionId()

Get The document microversion contained in the reference, if set

Returns:

The document microversion contained in the reference, if set

getResolvedDocumentMicroversionId

public final String getResolvedDocumentMicroversionId()

Get The document microversion contained in the reference, or the current document microversion if not set in the reference

Returns:

The document microversion contained in the reference, or the current document microversion if not set in the reference

getIdTag

public final String getIdTag()

Get The idTag of a target within the target element

Returns:

The idTag of a target within the target element

getIdTagIsValid

public final String getIdTagIsValid()

Get Set to true if the idTag value is valid

Returns:

Set to true if the idTag value is valid

getTrackNewVersions

public final Boolean getTrackNewVersions()

Get for internal use

Returns:

for internal use

getTargetConfiguration

public final String getTargetConfiguration()

Get The configuration string for the target element

Returns:

The configuration string for the target element

getIsConfigurable

public final Boolean getIsConfigurable()

Get True if the element configuration can be changed to a non-default value

Returns:

True if the element configuration can be changed to a non-default value

toString

public String toString()

Overrides:

toString in class Object