Document REST Endpoints

Sort by

Task Path Method

Document

Use the Document service to create, view, update, and delete documents. Documents are drawings, submittals, RFIs, or other files that support your organization's goals. Update Keys : 'id'

Assign Permission Profiles To User

Method: post

Path: /api/restapi/document/assignUser

Batch Delete Files

Method: delete

Path: /api/restapi/document/batch/files

Batch Delete Folders

Method: delete

Path: /api/restapi/document/batch/folders

Batch Rescan Files

Method: post

Path: /api/restapi/document/file/rescan/batch

Check in a File

Method: post

Path: /api/restapi/document/file/{id}/checkin

Check out a File

Method: get

Path: /api/restapi/document/file/{id}/checkout

Copy a Template to a Folder

Method: post

Path: /api/restapi/document/templateCopy/sourceTemplate/{id}/targetFolder/{folderId}

Create a Folder

Method: post

Path: /api/restapi/document/folder

Create Zip for the List of Files under a Scope

Method: post

Path: /api/restapi/document/file/zip/files

Delete a File

Method: delete

Path: /api/restapi/document/file/{id}

Delete a Folder

Method: delete

Path: /api/restapi/document/folder/{id}

Download a File

Method: get

Path: /api/restapi/document/file/{id}/download

Download the Zip File

Method: get

Path: /api/restapi/document/file/zip/zipRequest/{zipRequestId}

Link a File to another Object

Method: get

Path: /api/restapi/document/{id}/scope/{scope}/scopeId/{scopeId}/linkDocument

Rescan a File

Method: post

Path: /api/restapi/document/file/rescan

Unlink a File

Method: get

Path: /api/restapi/document/{id}/scope/{scope}/scopeId/{scopeId}/unlinkDocument

Update a File

Method: put

Path: /api/restapi/document/file

Update a Folder

Method: put

Path: /api/restapi/document/folder

Upload a File

Method: post

Path: /api/restapi/document/uploadFile/parent/{folderId}/fileName/{fileName}

View a File

Method: get

Path: /api/restapi/document/file/{id}

View a Folder

Method: get

Path: /api/restapi/document/folder/{id}

View a Folder by Name and Template

Method: get

Path: /api/restapi/document/{name}/folderTemplate/{id}

View all File Versions

Method: get

Path: /api/restapi/document/file/{id}/version

View all Files and Folders under a Folder

Method: get

Path: /api/restapi/document/folder/{id}/allChildren

View all Files and Folders under a Template

Method: get

Path: /api/restapi/document/template/{id}/allChildren

View all Files of a Folder

Method: get

Path: /api/restapi/document/folder/{id}/files

View all Files of a Template

Method: get

Path: /api/restapi/document/template/{id}/files

View all Folders of a Template

Method: get

Path: /api/restapi/document/template/{id}/childFolders

View all Folders under a Folder

Method: get

Path: /api/restapi/document/folder/{id}/childFolders

View all References of a File

Method: get

Path: /api/restapi/document/file/{id}/references

View Annotations of a Version of a File

Method: get

Path: /api/restapi/document/file/{id}/version/{version}/annotations

View Available Permission Sets for File

Method: get

Path: /api/restapi/document/permissionSets

View the ID for a File or Folder by Path

Method: get

Path: /api/restapi/document/workspace/{workspaceCode}/{type}/search

View the Root Folder of a Portfolio

Method: get

Path: /api/restapi/document/portfolio/{portfolioId}/root

View the Root Folder of a Project

Method: get

Path: /api/restapi/document/project/{projectId}/root

View the Root Folder of a Template

Method: get

Path: /api/restapi/document/template/{id}/root

View the Zip Request Details by Zip Request ID

Method: get

Path: /api/restapi/document/file/zip/status/zipRequest/{zipRequestId}