Hide menu
Overview

Data conversion API allows convert CAD data across wide range of supported formats using CAD Exchanger Cloud service from your application.

Supported CAD formats

Conversions

Conversion operations in CAD Exchanger Cloud Service are organized as conversions collection. Every member of collection has next fields:

FieldTypeDescription
idread-onlyString

Unique file conversion id

fileNameread-only
optional
String

Name of uploaded CAD model for conversion.

sizeread-only
optional
Number

Size of uploaded CAD model for conversion.

fileread-only
optional
String

Id of the member of files collection which conversion has been made for

fileRevisionread-onlyoptionalString

Id of the member of file revisions collection which conversion has been made for

ownerread-onlyString

Id of the owner (user) which has started this conversion

formatread-onlyString

Target format name.

statusread-onlyString

Status of the conversion

Allowed values: "ready", "processing", "error", "internalError"

expiresInread-onlyString

Timestamp when conversion will be expired and result will be cleaned up (resulted file is stored 1 day).

createdAtread-onlyString

Timestamp when conversion has been created

updatedAtread-onlyString

Timestamp when conversion has been updated

Authentication and Scopes

Data conversion API requires to use of OAuth2 bearer token.

  • HTTP GET requests require the data:convert scope.
  • HTTP POST requests require the data:convert scope.
  • HTTP DELETE requests require the data:convert scope.

See OAuth documentation for more information about authentication

Errors

If request failed the response body contains an errors property with array of errors.

For example, if request authorization has only data:read scope, but data:convert scope is required, the HTTP 403 (Forbidden) response will be return with next payload:

{
"errors": [{
"message": "no-access",
"attributes": { "scope": "insufficient" }
}]
}