/
ON
onshape
/
Onshape REST API
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 17h ago · Updated 6d ago
Details
Filter operations
Account
4
Alias
6
APIApplication
7
AppAssociativeData
4
AppElement
27
Assembly
27
Billing
1
BlobElement
5
Comment
10
Company
9
Document
37
get
Get a list of documents that meet the criteria you specify.
post
Create and upload a document.
get
Download external data file(s) associated with the document.
get
Retrieve versions by document ID.
post
Create version by document ID.
get
Retrieve version by document ID and version ID.
post
Update external references to latest by document ID, workspace ID, and tab ID.
post
Move tab by document ID and workspace ID.
post
/documents/d/{did}/w/{wid}/revertunchangedtorevisions
post
/documents/d/{did}/w/{wid}/syncAppElements
get
Retrieve workspaces by document ID.
post
Create workspace by document ID.
delete
Delete workspace by document ID and workspace ID.
get
Retrieve document history by document ID and workspace or microversion ID.
get
Retrieve tabs and folders by document ID and workspace or version or microversion ID.
get
Retrieve tabs by document ID and workspace or version or microversion ID.
get
Get the selected units and precision by document ID and workspace or version or microversion ID.
get
Retrieve current microversion by document ID and workspace or version ID.
post
Export document by document ID, workspace or version ID, and tab ID.
get
Retrieve insertables by document ID and workspace or version ID.
post
Search document.
get
Retrieve document by document ID.
post
Update document attributes by document ID.
delete
Delete document by document ID.
get
Retrieve access control list by document ID.
post
Allow or deny anonymous access to a document or publication.
post
Make a document public or private.
post
Update document notes by document ID.
get
Retrieve Document permissions by document ID.
post
Share document by document ID.
delete
Remove document View permissions from a user or other entity.
post
Share document by document ID with Onshape support.
delete
Unshare document with support.
get
Merge preview of changes that will occur based on document ID, workspace ID and source workspace/version ID
post
Restore version or microversion to workspace by document ID, workspace ID, and version or microversion ID.
post
Copy workspace by document ID and workspace ID.
post
Merge into workspace by document ID and workspace ID.
Drawing
7
Element
8
ExportRule
1
FeatureStudio
4
Folder
3
Insertable
1
Item
5
Material
2
Metadata
11
MetadataCategory
1
NumberingScheme
1
OpenApi
2
Part
12
PartNumber
1
PartStudio
27
ProductStructure
1
PropertiesTableTemplate
5
Publication
7
ReleasePackage
4
Revision
9
Sketch
3
StandardContent
3
Task
5
Team
3
Thumbnail
11
Translation
5
User
4
Variables
7
Version
1
Webhook
6
Workflow
5
Document
Retrieve document by document ID.
get
/documents/{did}
Path parameters
did
string
required
Response
Success!
Changes