Package com.onshape.api.responses

Class AssembliesGetAssemblyDefinitionResponseParts

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.AssembliesGetAssemblyDefinitionResponseParts

All Implemented Interfaces:

ResponseWithDocument

public final class AssembliesGetAssemblyDefinitionResponseParts
extends AbstractResponseObject
implements ResponseWithDocument

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

Field Summary

Fields

Modifier and Type	Field	Description
String	bodyType	Type of part body.
String	configuration	Configuration of the Part studio element.
String	documentId	Document ID of the document containing the part
String	documentMicroversion	Document microversion ID of the document containing the part
String	documentVersion	Version ID of document containing the part, if reached through one or more version references
String	elementId	Element ID
Boolean	isStandardContent	Indicates whether the part is Standard Content.
Map[]	mateConnectors	Array of part mate connectors
String	partId	Deterministic part ID.
String	partNumber	The part number, if from a revision
String	revision	The revision this part was inserted from, if any

Constructor Summary

Constructors

Constructor	Description
AssembliesGetAssemblyDefinitionResponseParts()

Method Summary

Modifier and Type	Method	Description
String	getBodyType()	Get Type of part body.
String	getConfiguration()	Get Configuration of the Part studio element.
OnshapeDocument	getDocument()	Returns an OnshapeDocument object that can be used in subsequent calls to the related document
String	getDocumentId()	Get Document ID of the document containing the part
String	getDocumentMicroversion()	Get Document microversion ID of the document containing the part
String	getDocumentVersion()	Get Version ID of document containing the part, if reached through one or more version references
String	getElementId()	Get Element ID
Boolean	getIsStandardContent()	Get Indicates whether the part is Standard Content.
Map[]	getMateConnectors()	Get Array of part mate connectors
String	getPartId()	Get Deterministic part ID.
String	getPartNumber()	Get The part number, if from a revision
String	getRevision()	Get The revision this part was inserted from, if any
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

documentId

public String documentId

Document ID of the document containing the part

documentMicroversion

public String documentMicroversion

Document microversion ID of the document containing the part

documentVersion

public String documentVersion

Version ID of document containing the part, if reached through one or more version references

elementId

public String elementId

Element ID

partId

public String partId

Deterministic part ID. If the part cannot be resolved, the value will be the empty string. This can happen if a change in the source part studio causes the part that was originally referenced to be missing.

configuration

public String configuration

Configuration of the Part studio element.

bodyType

public String bodyType

Type of part body. Current values that are possible are solid, sheet. Others may be added in the future.

isStandardContent

public Boolean isStandardContent

Indicates whether the part is Standard Content.

revision

public String revision

The revision this part was inserted from, if any

partNumber

public String partNumber

The part number, if from a revision

mateConnectors

public Map[] mateConnectors

Array of part mate connectors

Constructor Detail

AssembliesGetAssemblyDefinitionResponseParts

public AssembliesGetAssemblyDefinitionResponseParts()

Method Detail

getDocumentId

public final String getDocumentId()

Get Document ID of the document containing the part

Returns:

Document ID of the document containing the part

getDocumentMicroversion

public final String getDocumentMicroversion()

Get Document microversion ID of the document containing the part

Returns:

Document microversion ID of the document containing the part

getDocumentVersion

public final String getDocumentVersion()

Get Version ID of document containing the part, if reached through one or more version references

Returns:

Version ID of document containing the part, if reached through one or more version references

getElementId

public final String getElementId()

Get Element ID

Returns:

Element ID

getPartId

public final String getPartId()

Get Deterministic part ID. If the part cannot be resolved, the value will be the empty string. This can happen if a change in the source part studio causes the part that was originally referenced to be missing.

Returns:

Deterministic part ID. If the part cannot be resolved, the value will be the empty string. This can happen if a change in the source part studio causes the part that was originally referenced to be missing.

getConfiguration

public final String getConfiguration()

Get Configuration of the Part studio element.

Returns:

Configuration of the Part studio element.

getBodyType

public final String getBodyType()

Get Type of part body. Current values that are possible are solid, sheet. Others may be added in the future.

Returns:

Type of part body. Current values that are possible are solid, sheet. Others may be added in the future.

getIsStandardContent

public final Boolean getIsStandardContent()

Get Indicates whether the part is Standard Content.

Returns:

Indicates whether the part is Standard Content.

getRevision

public final String getRevision()

Get The revision this part was inserted from, if any

Returns:

The revision this part was inserted from, if any

getPartNumber

public final String getPartNumber()

Get The part number, if from a revision

Returns:

The part number, if from a revision

getMateConnectors

public final Map[] getMateConnectors()

Get Array of part mate connectors

Returns:

Array of part mate connectors

getDocument

public final OnshapeDocument getDocument()

Returns an OnshapeDocument object that can be used in subsequent calls to the related document

Specified by:

getDocument in interface ResponseWithDocument

Returns:

The OnshapeDocument object.

toString

public String toString()

Overrides:

toString in class Object