Package com.onshape.api.requests

Class DocumentsExportElementPostJsonRequest

java.lang.Object

com.onshape.api.requests.DocumentsExportElementPostJsonRequest

public final class DocumentsExportElementPostJsonRequest
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentsExportElementPostJsonRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentsExportElementPostJsonRequest.Builder	builder(Onshape onshape)
Number	getAngleTolerance()	Get Angle tolerance (must be < pi/2) (STL)
Number	getChordTolerance()	Get Chord tolerance (STL)
String	getFormat()	Get Export format: STL, PS
Boolean	getGrouping()	Get Whether parts should be exported as a group or individually in a .zip file (STL)
String	getLinkDocumentWorkspaceId()	Get The id of the workspace in which the result should be stored if storeInDocument is true and linkDocumentId is set.
Number	getMaxFacetWidth()	Get Maximum facet width (STL)
String	getMicroversion()	Get Specified microversion for operation
Number	getMinFacetWidth()	Get Minimum facet width (must be < maximumFacetWidth) (STL)
String	getMode()	Get Type of file: text, binary (STL)
String	getPartIds()	Get Comma-separated list of part IDs to export
Number	getScale()	Get Scale for measurements (STL)
Boolean	getStoreInDocument()	Get whether the output should be stored as a new element
String	getUnits()	Get Name of base unit: meter, centimeter, millimeter, inch, foot, yard (STL)
Number	getVersion()	Get Parasolid version (PS)
Boolean	getZipSingleFileOutput()	Get Whether single file output should be returned as a .zip file (STL, grouping==true)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getFormat

public final String getFormat()

Get Export format: STL, PS

Returns:

Export format: STL, PS

getStoreInDocument

public final Boolean getStoreInDocument()

Get whether the output should be stored as a new element

Returns:

whether the output should be stored as a new element

getLinkDocumentWorkspaceId

public final String getLinkDocumentWorkspaceId()

Get The id of the workspace in which the result should be stored if storeInDocument is true and linkDocumentId is set.

Returns:

The id of the workspace in which the result should be stored if storeInDocument is true and linkDocumentId is set.

getPartIds

public final String getPartIds()

Get Comma-separated list of part IDs to export

Returns:

Comma-separated list of part IDs to export

getMicroversion

public final String getMicroversion()

Get Specified microversion for operation

Returns:

Specified microversion for operation

getGrouping

public final Boolean getGrouping()

Get Whether parts should be exported as a group or individually in a .zip file (STL)

Returns:

Whether parts should be exported as a group or individually in a .zip file (STL)

getZipSingleFileOutput

public final Boolean getZipSingleFileOutput()

Get Whether single file output should be returned as a .zip file (STL, grouping==true)

Returns:

Whether single file output should be returned as a .zip file (STL, grouping==true)

getScale

public final Number getScale()

Get Scale for measurements (STL)

Returns:

Scale for measurements (STL)

getUnits

public final String getUnits()

Get Name of base unit: meter, centimeter, millimeter, inch, foot, yard (STL)

Returns:

Name of base unit: meter, centimeter, millimeter, inch, foot, yard (STL)

getAngleTolerance

public final Number getAngleTolerance()

Get Angle tolerance (must be < pi/2) (STL)

Returns:

Angle tolerance (must be < pi/2) (STL)

getChordTolerance

public final Number getChordTolerance()

Get Chord tolerance (STL)

Returns:

Chord tolerance (STL)

getMaxFacetWidth

public final Number getMaxFacetWidth()

Get Maximum facet width (STL)

Returns:

Maximum facet width (STL)

getMinFacetWidth

public final Number getMinFacetWidth()

Get Minimum facet width (must be < maximumFacetWidth) (STL)

Returns:

Minimum facet width (must be < maximumFacetWidth) (STL)

getMode

public final String getMode()

Get Type of file: text, binary (STL)

Returns:

Type of file: text, binary (STL)

getVersion

public final Number getVersion()

Get Parasolid version (PS)

Returns:

Parasolid version (PS)

toString

public String toString()

Overrides:

toString in class Object

builder

public static final DocumentsExportElementPostJsonRequest.Builder builder(Onshape onshape)