Skip to main content

Documents and folders

RouteWhat it does
GET /documents?q=&folderId=&recursive=&includeArchived=List or search documents. folderId can be unfiled
POST /documentsCreate: { name, kind, number?, description?, folderId? }. Starts with a main branch and an empty draft
GET /documents/:idA document with its branches, drafts, versions, revisions and reservations
PATCH /documents/:idName, description
DELETE /documents/:idDelete, if it was never released and nothing uses it
POST /documents/:id/archive, /unarchiveArchive, bring back
POST /documents/:id/copyAn independent copy: { name?, number?, versionId? }
POST /documents/moveMove several: { ids, folderId }, null for Unfiled
GET /documents/:id/where-usedThe assemblies that use it
GET /documents/:id/thumbnailIts newest picture
GET /documents/:id/auditEverything that was done to it
GET /foldersAll folders, with their parents and how many documents each holds
POST /folders, PATCH /folders/:id, DELETE /folders/:idCreate, rename or move, delete an empty one