Package com.onshape.api.responses

Class AssembliesGetAssemblyDefinitionResponseRootAssemblyInstances

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.AssembliesGetAssemblyDefinitionResponseRootAssemblyInstances

All Implemented Interfaces:

ResponseWithDocument

public final class AssembliesGetAssemblyDefinitionResponseRootAssemblyInstances
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	configuration	Configuration of the Part studio element if the instance references a Part studio.
String	documentId	Document ID for the document containing the included instance
String	documentMicroversion	Microversion ID of document containing the included instance
String	documentVersion	Version ID of document containing the included instance, if reached through one or more version references
String	elementId	Element ID of the part/assembly instance
String	id	Instance ID
Boolean	isStandardContent	If type is Part this field indicates whether the part is Standard Content.
String	name	Part/feature/assembly name
String	partId	Deterministic part ID if type is Part.
String	partNumber	The identifying part number of the instance, if inserted from a revision
String	revision	The revision this instance was inserted from, if any
Boolean	suppressed	Instance suppressed or not
String	type	Instance type.

Constructor Summary

Constructors

Constructor	Description
AssembliesGetAssemblyDefinitionResponseRootAssemblyInstances()

Method Summary

Modifier and Type	Method	Description
String	getConfiguration()	Get Configuration of the Part studio element if the instance references a Part studio.
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 included instance
String	getDocumentMicroversion()	Get Microversion ID of document containing the included instance
String	getDocumentVersion()	Get Version ID of document containing the included instance, if reached through one or more version references
String	getElementId()	Get Element ID of the part/assembly instance
String	getId()	Get Instance ID
Boolean	getIsStandardContent()	Get If type is Part this field indicates whether the part is Standard Content.
String	getName()	Get Part/feature/assembly name
String	getPartId()	Get Deterministic part ID if type is Part.
String	getPartNumber()	Get The identifying part number of the instance, if inserted from a revision
String	getRevision()	Get The revision this instance was inserted from, if any
Boolean	getSuppressed()	Get Instance suppressed or not
String	getType()	Get Instance type.
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

id

public String id

Instance ID

name

public String name

Part/feature/assembly name

type

public String type

Instance type. Current valid values are Part, Assembly, Feature. Other values may be added in the future. Note that "Part" may mean a reference to a surface or a solid and that "Feature" currently means a reference to a Sketch, but support for other feature types may be added in the future. For Part, a specific bodyType is included in the parts information and for Feature, a specific featureType is included in the partStudioFeatures information.

suppressed

public Boolean suppressed

Instance suppressed or not

documentId

public String documentId

Document ID for the document containing the included instance

documentMicroversion

public String documentMicroversion

Microversion ID of document containing the included instance

documentVersion

public String documentVersion

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

elementId

public String elementId

Element ID of the part/assembly instance

partId

public String partId

Deterministic part ID if type is Part. 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.

isStandardContent

public Boolean isStandardContent

If type is Part this field indicates whether the part is Standard Content.

configuration

public String configuration

Configuration of the Part studio element if the instance references a Part studio.

revision

public String revision

The revision this instance was inserted from, if any

partNumber

public String partNumber

The identifying part number of the instance, if inserted from a revision

Constructor Detail

AssembliesGetAssemblyDefinitionResponseRootAssemblyInstances

public AssembliesGetAssemblyDefinitionResponseRootAssemblyInstances()

Method Detail

getId

public final String getId()

Get Instance ID

Returns:

Instance ID

getName

public final String getName()

Get Part/feature/assembly name

Returns:

Part/feature/assembly name

getType

public final String getType()

Get Instance type. Current valid values are Part, Assembly, Feature. Other values may be added in the future. Note that "Part" may mean a reference to a surface or a solid and that "Feature" currently means a reference to a Sketch, but support for other feature types may be added in the future. For Part, a specific bodyType is included in the parts information and for Feature, a specific featureType is included in the partStudioFeatures information.

Returns:

Instance type. Current valid values are Part, Assembly, Feature. Other values may be added in the future. Note that "Part" may mean a reference to a surface or a solid and that "Feature" currently means a reference to a Sketch, but support for other feature types may be added in the future. For Part, a specific bodyType is included in the parts information and for Feature, a specific featureType is included in the partStudioFeatures information.

getSuppressed

public final Boolean getSuppressed()

Get Instance suppressed or not

Returns:

Instance suppressed or not

getDocumentId

public final String getDocumentId()

Get Document ID for the document containing the included instance

Returns:

Document ID for the document containing the included instance

getDocumentMicroversion

public final String getDocumentMicroversion()

Get Microversion ID of document containing the included instance

Returns:

Microversion ID of document containing the included instance

getDocumentVersion

public final String getDocumentVersion()

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

Returns:

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

getElementId

public final String getElementId()

Get Element ID of the part/assembly instance

Returns:

Element ID of the part/assembly instance

getPartId

public final String getPartId()

Get Deterministic part ID if type is Part. 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 type is Part. 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.

getIsStandardContent

public final Boolean getIsStandardContent()

Get If type is Part this field indicates whether the part is Standard Content.

Returns:

If type is Part this field indicates whether the part is Standard Content.

getConfiguration

public final String getConfiguration()

Get Configuration of the Part studio element if the instance references a Part studio.

Returns:

Configuration of the Part studio element if the instance references a Part studio.

getRevision

public final String getRevision()

Get The revision this instance was inserted from, if any

Returns:

The revision this instance was inserted from, if any

getPartNumber

public final String getPartNumber()

Get The identifying part number of the instance, if inserted from a revision

Returns:

The identifying part number of the instance, if inserted from a revision

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