Translation

Import or upload a CAD file into Onshape, and translate the data into parts or assemblies.

The API call may complete before the translation is finished. If requestState = ACTIVE, the translation can be polled until the state is either DONE or FAILED. Alternatively, a webhook callback can be registered for notification of translation completion (requires Write scope if storeInDocument is true).

See API Guide: Import & Export for examples.

post/translations/d/{did}/w/{wid}

Request

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

Path parameters

didstring required
widstring required

Request body multipart/form-data

allowFaultyPartsboolean
createCompositeboolean
createDrawingIfPossibleboolean
encodedFilenamestring
extractAssemblyHierarchyboolean
filestring binary

The file to upload.

flattenAssembliesboolean
formatNamestring
importAppearancesboolean
importMaterialDensityboolean
importWithinDocumentboolean
joinAdjacentSurfacesboolean
locationElementIdstring
locationGroupIdstring
locationPositioninteger
makePublicboolean
notifyUserboolean
onePartPerDocboolean
ownerIdstring
parentIdstring
projectIdstring
repointAppElementVersionRefsboolean
splitAssembliesIntoMultipleDocumentsboolean
storeInDocumentboolean
translateboolean
unitstring
uploadIdstring
useIGESImportPostProcessingboolean
versionStringstring
yAxisIsUpboolean

Response

default response

Changes

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