Package com.onshape.api.requests

Class ElementsUpdateReferencesRequestReferenceUpdatesFromReference

java.lang.Object

com.onshape.api.requests.ElementsUpdateReferencesRequestReferenceUpdatesFromReference

public final class ElementsUpdateReferencesRequestReferenceUpdatesFromReference
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	ElementsUpdateReferencesRequestReferenceUpdatesFromReference.Builder

Field Summary

Fields

Modifier and Type	Field	Description
String	documentId	The Document ID of the reference to update.
String	elementId	The Element ID of the reference to update.
Map	elementType	The elementType of the item that is to be updated.
Map	partNumber	The part number identifying the item that is to be updated.
Map	revision	The revision containing the items to be updated.
String	versionId	The Version ID of the reference to update.

Method Summary

Modifier and Type	Method	Description
static ElementsUpdateReferencesRequestReferenceUpdatesFromReference.Builder	builder()
String	getDocumentId()	Get The Document ID of the reference to update.
String	getElementId()	Get The Element ID of the reference to update.
Map	getElementType()	Get The elementType of the item that is to be updated.
Map	getPartNumber()	Get The part number identifying the item that is to be updated.
Map	getRevision()	Get The revision containing the items to be updated.
String	getVersionId()	Get The Version ID of the reference to update.
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 reference to update.

versionId

public String versionId

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

elementId

public String elementId

The Element ID of the reference to update. If unspecified, all items at the relevant document/version or document/workspace will be updated.

revision

public Map revision

The revision containing the items to be updated.

partNumber

public Map partNumber

The part number identifying the item that is to be updated.

elementType

public Map elementType

The elementType of the item that is to be updated. This can be: ASSEMBLY or PARTSTUDIO (for parts).

Method Detail

getDocumentId

public final String getDocumentId()

Get The Document ID of the reference to update.

Returns:

The Document ID of the reference to update.

getVersionId

public final String getVersionId()

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

Returns:

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

getElementId

public final String getElementId()

Get The Element ID of the reference to update. If unspecified, all items at the relevant document/version or document/workspace will be updated.

Returns:

The Element ID of the reference to update. If unspecified, all items at the relevant document/version or document/workspace will be updated.

getRevision

public final Map getRevision()

Get The revision containing the items to be updated.

Returns:

The revision containing the items to be updated.

getPartNumber

public final Map getPartNumber()

Get The part number identifying the item that is to be updated.

Returns:

The part number identifying the item that is to be updated.

getElementType

public final Map getElementType()

Get The elementType of the item that is to be updated. This can be: ASSEMBLY or PARTSTUDIO (for parts).

Returns:

The elementType of the item that is to be updated. This can be: ASSEMBLY or PARTSTUDIO (for parts).

builder

public static final ElementsUpdateReferencesRequestReferenceUpdatesFromReference.Builder builder()

toString

public String toString()

Overrides:

toString in class Object