BlobElement

Export a blob element to another format.

Changed on
  • Use formatName in the JSON request body to specify the export file type. Use [Translations/getAllTranslatorFormats]#/Translation/getAllTranslatorFormats) to get a list of valid export file formats.
  • Set storeInDocument to false to export to a data file. Set to true to export to a blob element in the same document.
  • See API Guide: Model Translation for more details.
post/blobelements/d/{did}/{wv}/{wvid}/e/{eid}/translations

Request

  • Base URL
    https://api.onshape.com/api/v17
  • URL
    https://api.onshape.com/api/v17/blobelements/d/{did}/{wv}/{wvid}/e/{eid}/translations
  • Auth
    OAuth 2 and HTTP basic
    Authorization code: /oauth/authorize
    Token URL: /oauth/token scopes: OAuth2Read

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

allowFaultyPartsboolean

If true, parts with faults are imported. If false, faulty parts are omitted.

angularTolerancenumber double

Determines the maximum angular deviation, between the analytical surface and its triangulation. Lower values result in a finer geometry and higher values result in coarser geometry.

annotationsFontHeightInMillimetersnumber double

Determines the font size in workspace units used for the MBD annotations text export

blobElementIdstring
blobMicroversionIdstring
cloudObjectIdstring

Folder id where to store the exported model.

cloudStorageAccountIdstring

Account id to access the cloud storage.

colorMethodstring
configurationstring

URL-encoded string of configuration values (separated by ;). See the Configurations API Guide for details.

connectionIdstring
correlationIdstring

User specified identifier that can be used as a correlation id across api calls.

createCompositeboolean
currentSheetOnlyboolean
destinationNamestring

The name of the exported file.

distanceTolerancenumber double

Determines the maximum distance deviation, between the analytical surface and its triangulation. Lower values result in a finer geometry and higher values result in coarser geometry.

dxfVersionstring
elementIdstring

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

elementIdsstring[]

An array of element ids for multi-element export.

emailLinkboolean

Use true if a link in an email should be sent.

emailMessagestring

Message to send in the email body along with the download link.

emailSubjectstring

Subject to send the email with.

emailTostring[]

List of email addresses to send the email to.

evaluateExportRuleboolean

Set to true to evaluate the export rule for the given formatName and to include an exportRuleFileName value in the response.

excludeHiddenEntitiesboolean

Whether or not to exclude hidden parts from export.

excludeOffSheetContentboolean
exportCompositeConstituentsWithOriginalBodyIdsboolean
extractAssemblyHierarchyboolean
flatPatternAsyncboolean
flattenboolean
flattenAssembliesboolean
foreignIdstring
formatNamestring required

The name of the file format.

fromUserIdstring

Id of the user who does the export.

getyAxisIsUpboolean
groupingboolean

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

hideInspectionItemsboolean
ignoreExportRulesForContentsboolean

For multiple elements export, use true if export rule shouldn't be applied for all elements.

imageHeightinteger
imageWidthinteger
importAppearancesboolean
importInBackgroundboolean
importMaterialDensityboolean
importWithinDocumentboolean
includeBendCenterlinesboolean
includeBendLinesboolean
includeCboreCsinkboolean
includeDerivedTolerancesboolean
includeExportIdsboolean

Whether topology ids should be exported as parasolid attributes.

includeFormedCentermarksboolean
includeFormedOutlinesboolean
includeSketchesboolean
joinAdjacentSurfacesboolean
levelstring
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.

linkDocumentWorkspaceIdstring

The id of the workspace 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.

maximumChordLengthnumber double

Determines the maximum of a triangle edge length. Lower values result in a finer geometry and higher values result in coarser geometry.

notifyUserboolean

Send notification to the user client.

occurrencesToExportstring

IDs of the occurrences to retrieve. Use comma-separated IDs for multiple instances (example: occurrencesToExport=JHK,JHD).

onePartPerDocboolean
originalForeignIdstring
parasolidMode'TEXT' | 'BINARY' | 'UNKNOWN'

Export Parasolid in BINARY (.x_b) or TEXT (.x_t) mode.

parentIdstring
partIdsstring

IDs of the parts to retrieve. Use comma-separated IDs for multiple parts (example: partIds=JHK,JHD).

passwordstring

A password to protect the email with.

passwordRequiredboolean

Use true if the email should be protected with a password.

pdfVersionstring
processedForeignIdstring
projectIdstring
proxyDocumentIdstring
proxyElementIdstring
proxyWorkspaceVersionstring
proxyWorkspaceVersionIdstring
resolution'fine' | 'medium' | 'coarse'

Determines export resolution of fine, medium, or coarse

rhinoVersion'V2' | 'V3' | 'V4' | 'V5' | 'V6' | 'V7' | 'V8' | 'UNKNOWN'
selectablePdfTextboolean
sendCopyToMeboolean

Use true if email copy should be sent to the user who does the export.

sheetIndicesinteger[]
sheetMetalFlatboolean
showOverriddenDimensionsboolean
skipBodyshopboolean
sourceNamestring
specifyMaterialDataboolean
specifyUnitsboolean
splinesAsPolylinesboolean
splitAssembliesIntoMultipleDocumentsboolean
stepParasolidPreprocessingOption'NO_PRE_PROCESSING' | 'USE_BODYSHOP_PRE_PROCESSING_ADVANCED' | 'USE_TRANSLATOR_PRE_PROCESSING' | 'USE_BODYSHOP_PRE_PROCESSING' | 'USE_BODYSHOP_PRE_PROCESSING_ADVANCED_WITH_SURFS_TO_BSURFS_CONVERTING' | 'UNKNOWN'

Original geometry processing mode to improve results of translation to STEP.

stepVersionStringstring

Export STEP in version: AP242 | AP203 | AP214

stlMode'TEXT' | 'BINARY' | 'UNKNOWN'

STL encoding type, TEXT | BINARY

storeInDocumentboolean

Create a blob with exported file in the source document.

textAsGeometryboolean
textOptionstring
triggerAutoDownloadboolean

Automatically download a translated file.

unitstring
uploadIdstring
urdfMeshFormat'STL' | 'GLTF' | 'OBJ' | 'GLB' | 'UNKNOWN'
urdfStlEncoding'TEXT' | 'BINARY' | 'UNKNOWN'

STL encoding type, TEXT | BINARY

useFileNameToSetSinglePartNameboolean
useGlbCompressionboolean
useGltfCompressionboolean
useIGESImportPostProcessingboolean
useIgesCompatibilityModeboolean
validForDaysinteger

Number of days to keep the link valid for.

versionStringstring

Parasolid version number as string. Use '0' for the latest.

Example request

{
  "angularTolerance": 0.001,
  "annotationsFontHeightInMillimeters": 4,
  "distanceTolerance": 0.001,
  "maximumChordLength": 0.01,
  "resolution": "fine"
}

Response

default response

Changes

  • 5fa7a57a26ddRevision changes
    • info

      added the new optional request property

    • info

      added the new GLB enum value to the request property