Package com.onshape.api.requests

Class AssembliesCreateInstanceRequest

java.lang.Object

com.onshape.api.requests.AssembliesCreateInstanceRequest

public final class AssembliesCreateInstanceRequest
extends Object

Request object for createInstance API endpoint. © 2018-Present Onshape Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AssembliesCreateInstanceRequest.Builder

Method Summary

Modifier and Type	Method	Description
static AssembliesCreateInstanceRequest.Builder	builder(Onshape onshape)
String	getConfiguration()	Get Configuration of the source element, valid only if the referenced element is a Part Studio.
String	getDocumentId()	Get The id of the content document containing the parts or assemblies to be inserted.
String	getElementId()	Get The id of the element containing the part(s), feature or assemblies to be inserted.
String	getFeatureId()	Get If isAssembly and isWholePartStudio are false, then this is the id of the feature to be inserted.
String[]	getIncludePartTypes()	Get The part types to include.
Boolean	getIsAssembly()	Get If true then the source element must be an assembly and whole assembly is inserted.
Boolean	getIsHidden()	Get If true add the instance as hidden
Boolean	getIsSuppressed()	Get If true add the instance as suppressed
Boolean	getIsWholePartStudio()	Get If true then the source element must be a partStudio and all parts are inserted.
String	getMicroversionId()	Get The document microversionId in which the elementId and partId will be resolved.
String	getPartId()	Get If isAssembly and isWholePartStudio are false, then this is the id of the part or surface to be inserted.
String	getPartNumber()	Get The part number identifying the part or assembly in the release that is to be inserted.
String	getRevision()	Get The revision containing the released part or assembly to be inserted.
String	getVersionId()	Get The document versionId from which the parts or assembly to be inserted will be taken.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getDocumentId

public final String getDocumentId()

Get The id of the content document containing the parts or assemblies to be inserted.

Returns:

The id of the content document containing the parts or assemblies to be inserted.

getElementId

public final String getElementId()

Get The id of the element containing the part(s), feature or assemblies to be inserted.

Returns:

The id of the element containing the part(s), feature or assemblies to be inserted.

getVersionId

public final String getVersionId()

Get The document versionId from which the parts or assembly to be inserted will be taken. If documentId references a different document than did, this must be set to a valid version.

Returns:

The document versionId from which the parts or assembly to be inserted will be taken. If documentId references a different document than did, this must be set to a valid version.

getMicroversionId

public final String getMicroversionId()

Get The document microversionId in which the elementId and partId will be resolved. This is valid only if no versionId is specified. When a versionId is specified, the partId must be obtained from the specified version.

Returns:

The document microversionId in which the elementId and partId will be resolved. This is valid only if no versionId is specified. When a versionId is specified, the partId must be obtained from the specified version.

getIsSuppressed

public final Boolean getIsSuppressed()

Get If true add the instance as suppressed

Returns:

If true add the instance as suppressed

getIsHidden

public final Boolean getIsHidden()

Get If true add the instance as hidden

Returns:

If true add the instance as hidden

getIsAssembly

public final Boolean getIsAssembly()

Get If true then the source element must be an assembly and whole assembly is inserted.

Returns:

If true then the source element must be an assembly and whole assembly is inserted.

getIsWholePartStudio

public final Boolean getIsWholePartStudio()

Get If true then the source element must be a partStudio and all parts are inserted.

Returns:

If true then the source element must be a partStudio and all parts are inserted.

getPartId

public final String getPartId()

Get If isAssembly and isWholePartStudio are false, then this is the id of the part or surface to be inserted. Must be left blank if featureId is set.

Returns:

If isAssembly and isWholePartStudio are false, then this is the id of the part or surface to be inserted. Must be left blank if featureId is set.

getFeatureId

public final String getFeatureId()

Get If isAssembly and isWholePartStudio are false, then this is the id of the feature to be inserted. Currently, only sketch features are valid. Must be left blank if partId is set.

Returns:

If isAssembly and isWholePartStudio are false, then this is the id of the feature to be inserted. Currently, only sketch features are valid. Must be left blank if partId is set.

getConfiguration

public final String getConfiguration()

Get Configuration of the source element, valid only if the referenced element is a Part Studio.

Returns:

Configuration of the source element, valid only if the referenced element is a Part Studio.

getRevision

public final String getRevision()

Get The revision containing the released part or assembly to be inserted.

Returns:

The revision containing the released part or assembly to be inserted.

getPartNumber

public final String getPartNumber()

Get The part number identifying the part or assembly in the release that is to be inserted.

Returns:

The part number identifying the part or assembly in the release that is to be inserted.

getIncludePartTypes

public final String[] getIncludePartTypes()

Get The part types to include. used only if "isWholePartStudio" is "true". Can be: {"PARTS", "SKETCHES","SURFACES","FLATTENED_PARTS", "COMPOSITE_PARTS", "PART_STUDIOS", "WIRES", "UNKNOWN"}.

Returns:

The part types to include. used only if "isWholePartStudio" is "true". Can be: {"PARTS", "SKETCHES","SURFACES","FLATTENED_PARTS", "COMPOSITE_PARTS", "PART_STUDIOS", "WIRES", "UNKNOWN"}.

toString

public String toString()

Overrides:

toString in class Object

builder

public static final AssembliesCreateInstanceRequest.Builder builder(Onshape onshape)