Data management API allows to store and manage files in the CAD Exchanger Cloud service from your application. There are three entities defined: file, file-revision, folder.

file is CAD model uploaded by user. When new file is uploaded, the first revision of the file is automatically created.
file-revision is specific version of the file. It can be either one CAD file (e.g. step or stl file) or zip archive with multiple files (e.g. many jt files as model with external references)).
folder is a logical organization of entities. Folders form hierarchy like filesystem folders. Every folder can have many sub-folders and files and also have parent folder. The root of the hierarchy is user's root folder which has no parent.

Files

Files in CAD Exchanger Cloud Service is organized as files collection. Every member of collection has next fields:

Field	Type	Description
`id`read-only	String	Unique file id
`name`	String	File name
`type`read-only	String	Type of the file
`size`read-only	Number	Total size of all file revisions
`owner`read-only	String	Id of the owner (user) of the file
`parentFolder`	String	Id of the folder contains this file
`activeRevision`	String	Id of the active revision. Only active revision of the file is accessible for users file shared with.
`revisions`read-only	Array<String>	Array of all file revisions
`public`read-only	Boolean	Indicates public file or not
`createdAt`read-only	String	Timestamp when file has been created
`updatedAt`read-only	String	Timestamp when file has been updated

File Revisions

File revisions in CAD Exchanger Cloud Service is organized as file-revisions collection. Every member of collection has next fields:

Field	Type	Description
`id`read-only	String	Unique file id
`name`read-only	String	Revision (file) name
`file`read-only	String	Id of the file
`size`read-only	Number	File size in bytes
`status`read-only	String	Status of the revision Allowed values: `"ready"`, `"processing"`, `"error"`
`createdAt`read-only	String	Timestamp when file-revision has been created
`updatedAt`read-only	String	Timestamp when file-revision has been updated
`thumbnail`read-only	String	Relative path to the thumbnail

Folders

Folders in CAD Exchanger Cloud Service is organized as folders collection. Every member of collection has next fields:

Field	Type	Description
`id`read-only	String	Unique file id
`name`	String	File name
`owner`read-only	String	Id of the owner (user) of the folder
`parentFolder`	String	Id of the folder contains this folder
`files`read-only	Array<String>	Array of files in the folder
`folders`read-only	Array<String>	Array of sub-folders in the folder
`createdAt`read-only	String	Timestamp when folder has been created
`updatedAt`read-only	String	Timestamp when folder has been updated

Note: All files and sub-folders in the folders have unique names.

Authentication and Scopes

Data management API requires to use of OAuth2 bearer token.

HTTP GET requests require the data:read scope.
HTTP POST requests require the data:create or data:write scope.
HTTP DELETE and PUT requests require the data:write 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:write scope is required, the HTTP 403 (Forbidden) response will be return with next payload:

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