Package com.onshape.api.responses

Class AssembliesGetAssemblyDefinitionResponseSubAssemblies

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.AssembliesGetAssemblyDefinitionResponseSubAssemblies

All Implemented Interfaces:

ResponseWithDocument

public final class AssembliesGetAssemblyDefinitionResponseSubAssemblies
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	documentId	Document ID for the document containing the sub-assembly
String	documentMicroversion	Document microversion ID for the document containing the sub-assembly
String	documentVersion	Version ID of document containing the subAssembly, if reached through one or more version references
String	elementId	Element ID of the sub-assembly
AssembliesGetAssemblyDefinitionResponseSubAssembliesInstances[]	instances	Instances within the sub-assembly
String	partNumber	The part number of the assembly, if from a revision
String	revision	The revision this assembly was inserted from, if any

Constructor Summary

Constructors

Constructor	Description
AssembliesGetAssemblyDefinitionResponseSubAssemblies()

Method Summary

Modifier and Type	Method	Description
OnshapeDocument	getDocument()	Returns an OnshapeDocument object that can be used in subsequent calls to the related document
String	getDocumentId()	Get Document ID for the document containing the sub-assembly
String	getDocumentMicroversion()	Get Document microversion ID for the document containing the sub-assembly
String	getDocumentVersion()	Get Version ID of document containing the subAssembly, if reached through one or more version references
String	getElementId()	Get Element ID of the sub-assembly
AssembliesGetAssemblyDefinitionResponseSubAssembliesInstances[]	getInstances()	Get Instances within the sub-assembly
String	getPartNumber()	Get The part number of the assembly, if from a revision
String	getRevision()	Get The revision this assembly 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 for the document containing the sub-assembly

documentMicroversion

public String documentMicroversion

Document microversion ID for the document containing the sub-assembly

documentVersion

public String documentVersion

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

elementId

public String elementId

Element ID of the sub-assembly

revision

public String revision

The revision this assembly was inserted from, if any

partNumber

public String partNumber

The part number of the assembly, if from a revision

instances

public AssembliesGetAssemblyDefinitionResponseSubAssembliesInstances[] instances

Instances within the sub-assembly

Constructor Detail

AssembliesGetAssemblyDefinitionResponseSubAssemblies

public AssembliesGetAssemblyDefinitionResponseSubAssemblies()

Method Detail

getDocumentId

public final String getDocumentId()

Get Document ID for the document containing the sub-assembly

Returns:

Document ID for the document containing the sub-assembly

getDocumentMicroversion

public final String getDocumentMicroversion()

Get Document microversion ID for the document containing the sub-assembly

Returns:

Document microversion ID for the document containing the sub-assembly

getDocumentVersion

public final String getDocumentVersion()

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

Returns:

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

getElementId

public final String getElementId()

Get Element ID of the sub-assembly

Returns:

Element ID of the sub-assembly

getRevision

public final String getRevision()

Get The revision this assembly was inserted from, if any

Returns:

The revision this assembly was inserted from, if any

getPartNumber

public final String getPartNumber()

Get The part number of the assembly, if from a revision

Returns:

The part number of the assembly, if from a revision

getInstances

public final AssembliesGetAssemblyDefinitionResponseSubAssembliesInstances[] getInstances()

Get Instances within the sub-assembly

Returns:

Instances within the sub-assembly

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