Package com.onshape.api.requests

Class AppElementsCreateReferenceRequest

java.lang.Object

com.onshape.api.requests.AppElementsCreateReferenceRequest

public final class AppElementsCreateReferenceRequest
extends Object

Request object for createReference API endpoint. © 2018-Present Onshape Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AppElementsCreateReferenceRequest.Builder

Method Summary

Modifier and Type	Method	Description
static AppElementsCreateReferenceRequest.Builder	builder(Onshape onshape)
String	getIdTag()	Get An optional deterministic id within the target element that should be tracked
String	getIdTagMicroversionId()	Get If idTag is specified, the document microversion associated with the idTag
String	getParentChangeId()	Get Id of the prior change to the application element
String	getSketchId()	Get An optional sketch feature id within the target element that should be tracked
String	getTargetConfiguration()	Get If not blank, specifies the configuration of the element.
String	getTargetDocumentId()	Get The Id of the document of the element that is or contains the target of the reference
String	getTargetElementId()	Get The element Id of the element that is or contains the target of the reference
String	getTargetMicroversionId()	Get An optional document microversionId that should be tracked, in case a specific point in history should be tracked by the reference
String	getTargetVersionId()	Get The Id of the version the document that contains the target of the reference
String	getTransactionId()	Get Id of the transaction in which the reference creation should occur
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getTransactionId

public final String getTransactionId()

Get Id of the transaction in which the reference creation should occur

Returns:

Id of the transaction in which the reference creation should occur

getParentChangeId

public final String getParentChangeId()

Get Id of the prior change to the application element

Returns:

Id of the prior change to the application element

getTargetDocumentId

public final String getTargetDocumentId()

Get The Id of the document of the element that is or contains the target of the reference

Returns:

The Id of the document of the element that is or contains the target of the reference

getTargetVersionId

public final String getTargetVersionId()

Get The Id of the version the document that contains the target of the reference

Returns:

The Id of the version the document that contains the target of the reference

getTargetElementId

public final String getTargetElementId()

Get The element Id of the element that is or contains the target of the reference

Returns:

The element Id of the element that is or contains the target of the reference

getTargetMicroversionId

public final String getTargetMicroversionId()

Get An optional document microversionId that should be tracked, in case a specific point in history should be tracked by the reference

Returns:

An optional document microversionId that should be tracked, in case a specific point in history should be tracked by the reference

getIdTag

public final String getIdTag()

Get An optional deterministic id within the target element that should be tracked

Returns:

An optional deterministic id within the target element that should be tracked

getIdTagMicroversionId

public final String getIdTagMicroversionId()

Get If idTag is specified, the document microversion associated with the idTag

Returns:

If idTag is specified, the document microversion associated with the idTag

getTargetConfiguration

public final String getTargetConfiguration()

Get If not blank, specifies the configuration of the element. Otherwise, the configuration is the default configuration for the element.

Returns:

If not blank, specifies the configuration of the element. Otherwise, the configuration is the default configuration for the element.

getSketchId

public final String getSketchId()

Get An optional sketch feature id within the target element that should be tracked

Returns:

An optional sketch feature id within the target element that should be tracked

toString

public String toString()

Overrides:

toString in class Object

builder

public static final AppElementsCreateReferenceRequest.Builder builder(Onshape onshape)