ONonshape
Document

Export document by document ID, workspace or version ID, and tab ID.

post/documents/d/{did}/{wv}/{wvid}/e/{eid}/export

Request

Path parameters

didstring required

The id of the document in which to perform the operation.

wv'w' | 'v' required

Indicates which of workspace (w) or version (v) id is specified below.

wvidstring required

The id of the workspace, version in which the operation should be performed.

eidstring required

The id of the element in which to perform the operation.

Query parameters

linkDocumentIdstring

The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both.

Request body

angleTolerancenumber double
batchAllFlatPatternsboolean
batchFlatPatternsboolean
chordTolerancenumber double
cloudObjectIdstring
cloudStorageAccountIdstring
configurationstring
destinationNamestring
documentIdstring required
documentVersionIdstring
elementIdstring
elementIdsstring
emailLinkboolean
emailMessagestring
emailSubjectstring
emailTostring

Base64-encoded email address. When sending an email, the fromUserId parameter is also required.

excludeHiddenEntitiesboolean

If true, the exported file won't have any parts and assemblies marked as hidden

featureIdsstring
flatPatternAsyncboolean

If true, flat pattern export being called via async

flattenboolean
formatstring required
fromUserIdstring

Your user ID. Required when providing the emailTo parameter.

groupingstring
ignoreExportRulesForContentsboolean
includeBendCenterlinesboolean
includeBendLinesboolean
includeCboreCsinkboolean
includeExportIdsboolean
includeFormedCentermarksboolean
includeFormedOutlinesboolean
includeSketchesboolean
isPartingOutboolean
linkDocumentIdstring
linkDocumentWorkspaceIdstring
maxFacetWidthnumber double
microversionstring
minFacetWidthnumber double
modestring
occurrencesToExportstring
partIdsstring
partQuerystring
passwordstring
passwordRequiredboolean
resolutionstring
scalenumber double
sendCopyToMeboolean
sheetMetalFlatboolean
splinesAsPolylinesboolean
storeInDocumentboolean
triggerAutoDownloadboolean
unitsstring
useYAxisAsUpboolean

If true, the exported file will have all the parts and assemblies reoriented such that the Z-axis within Onshape becomes the Y-axis in the exported file.

userIdstring
validForDaysinteger
versionstring
viewstring
workspaceIdstring
zipSingleFileOutputboolean

Response

default response

object required

Changes

No recorded changes to this operation across all 13 revisions of this API.