Package com.onshape.api.requests

Class ElementsUpdateReferencesRequestReferenceUpdatesToReference

java.lang.Object

com.onshape.api.requests.ElementsUpdateReferencesRequestReferenceUpdatesToReference

public final class ElementsUpdateReferencesRequestReferenceUpdatesToReference
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ElementsUpdateReferencesRequestReferenceUpdatesToReference.Builder

Field Summary

Fields

Modifier and Type	Field	Description
String	documentId	The Document ID of the destination reference.
String	elementId	The Element ID of the destination reference.
Map	elementType	The elementType of the item in the destination revision.
Map	partNumber	The part number identifying the item in the destination revision.
Map	revision	The destination revision.
String	versionId	The Version ID of the destination reference.

Method Summary

Modifier and Type	Method	Description
static ElementsUpdateReferencesRequestReferenceUpdatesToReference.Builder	builder()
String	getDocumentId()	Get The Document ID of the destination reference.
String	getElementId()	Get The Element ID of the destination reference.
Map	getElementType()	Get The elementType of the item in the destination revision.
Map	getPartNumber()	Get The part number identifying the item in the destination revision.
Map	getRevision()	Get The destination revision.
String	getVersionId()	Get The Version ID of the destination reference.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

documentId

public String documentId

The Document ID of the destination reference.

versionId

public String versionId

The Version ID of the destination reference. If unspecified, the workspaceId in the queryParams will be used.

elementId

public String elementId

The Element ID of the destination reference. If unspecified, all items will be updated to their respective elements in the specified document/version or document/workspace.

revision

public Map revision

The destination revision.

partNumber

public Map partNumber

The part number identifying the item in the destination revision.

elementType

public Map elementType

The elementType of the item in the destination revision. This can be: ASSEMBLY or PARTSTUDIO (for parts).

Method Detail

getDocumentId

public final String getDocumentId()

Get The Document ID of the destination reference.

Returns:

The Document ID of the destination reference.

getVersionId

public final String getVersionId()

Get The Version ID of the destination reference. If unspecified, the workspaceId in the queryParams will be used.

Returns:

The Version ID of the destination reference. If unspecified, the workspaceId in the queryParams will be used.

getElementId

public final String getElementId()

Get The Element ID of the destination reference. If unspecified, all items will be updated to their respective elements in the specified document/version or document/workspace.

Returns:

The Element ID of the destination reference. If unspecified, all items will be updated to their respective elements in the specified document/version or document/workspace.

getRevision

public final Map getRevision()

Get The destination revision.

Returns:

The destination revision.

getPartNumber

public final Map getPartNumber()

Get The part number identifying the item in the destination revision.

Returns:

The part number identifying the item in the destination revision.

getElementType

public final Map getElementType()

Get The elementType of the item in the destination revision. This can be: ASSEMBLY or PARTSTUDIO (for parts).

Returns:

The elementType of the item in the destination revision. This can be: ASSEMBLY or PARTSTUDIO (for parts).

builder

public static final ElementsUpdateReferencesRequestReferenceUpdatesToReference.Builder builder()

toString

public String toString()

Overrides:

toString in class Object