/

/Onshape REST API

Changes Docs Sign in

APIs
Generators
Stacks
Projects

Docs
History
Schema

Checked 19h ago · Updated 4d ago

Filter operations

Account4

Alias6

APIApplication7

AppAssociativeData4

AppElement27

Assembly27

Billing1

BlobElement5

Comment10

Company9

Document37

getGet a list of documents that meet the criteria you specify.
postCreate and upload a document.
getDownload external data file(s) associated with the document.
getRetrieve versions by document ID.
postCreate version by document ID.
getRetrieve version by document ID and version ID.
postUpdate external references to latest by document ID, workspace ID, and tab ID.
postMove tab by document ID and workspace ID.
post/documents/d/{did}/w/{wid}/revertunchangedtorevisions
post/documents/d/{did}/w/{wid}/syncAppElements
getRetrieve workspaces by document ID.
postCreate workspace by document ID.
deleteDelete workspace by document ID and workspace ID.
getRetrieve document history by document ID and workspace or microversion ID.
getRetrieve tabs and folders by document ID and workspace or version or microversion ID.
getRetrieve tabs by document ID and workspace or version or microversion ID.
getGet the selected units and precision by document ID and workspace or version or microversion ID.
getRetrieve current microversion by document ID and workspace or version ID.
postExport document by document ID, workspace or version ID, and tab ID.
getRetrieve insertables by document ID and workspace or version ID.
postSearch document.
getRetrieve document by document ID.
postUpdate document attributes by document ID.
deleteDelete document by document ID.
getRetrieve access control list by document ID.
postAllow or deny anonymous access to a document or publication.
postMake a document public or private.
postUpdate document notes by document ID.
getRetrieve Document permissions by document ID.
postShare document by document ID.
deleteRemove document View permissions from a user or other entity.
postShare document by document ID with Onshape support.
deleteUnshare document with support.
getMerge preview of changes that will occur based on document ID, workspace ID and source workspace/version ID
postRestore version or microversion to workspace by document ID, workspace ID, and version or microversion ID.
postCopy workspace by document ID and workspace ID.
postMerge into workspace by document ID and workspace ID.

Drawing7

Element8

ExportRule1

FeatureStudio4

Folder3

Insertable1

Item5

Material2

Metadata11

MetadataCategory1

NumberingScheme1

OpenApi2

Part12

PartNumber1

PartStudio27

ProductStructure1

PropertiesTableTemplate5

Publication7

ReleasePackage4

Revision9

Sketch3

StandardContent3

Task5

Team3

Thumbnail11

Translation5

User4

Variables7

Version1

Webhook6

Workflow5

Document

Create and upload a document.

The name field is required in the BTDocumentParams schema when creating a new document.

post/documents

Response

default response

Changes