Document REST Endpoints
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: postPath:
/api/restapi/document/assignUser
- Batch Delete Files
- Method: deletePath:
/api/restapi/document/batch/files
- Batch Delete Folders
- Method: deletePath:
/api/restapi/document/batch/folders
- Batch Rescan Files
- Method: postPath:
/api/restapi/document/file/rescan/batch
- Check in a File
- Method: postPath:
/api/restapi/document/file/{id}/checkin
- Check out a File
- Method: getPath:
/api/restapi/document/file/{id}/checkout
- Copy a Template to a Folder
- Method: postPath:
/api/restapi/document/templateCopy/sourceTemplate/{id}/targetFolder/{folderId}
- Create a Folder
- Method: postPath:
/api/restapi/document/folder
- Create Zip for the List of Files under a Scope
- Method: postPath:
/api/restapi/document/file/zip/files
- Delete a File
- Method: deletePath:
/api/restapi/document/file/{id}
- Delete a Folder
- Method: deletePath:
/api/restapi/document/folder/{id}
- Download a File
- Method: getPath:
/api/restapi/document/file/{id}/download
- Download the Zip File
- Method: getPath:
/api/restapi/document/file/zip/zipRequest/{zipRequestId}
- Link a File to another Object
- Method: getPath:
/api/restapi/document/{id}/scope/{scope}/scopeId/{scopeId}/linkDocument
- Rescan a File
- Method: postPath:
/api/restapi/document/file/rescan
- Unlink a File
- Method: getPath:
/api/restapi/document/{id}/scope/{scope}/scopeId/{scopeId}/unlinkDocument
- Update a File
- Method: putPath:
/api/restapi/document/file
- Update a Folder
- Method: putPath:
/api/restapi/document/folder
- Upload a File
- Method: postPath:
/api/restapi/document/uploadFile/parent/{folderId}/fileName/{fileName}
- View a File
- Method: getPath:
/api/restapi/document/file/{id}
- View a Folder
- Method: getPath:
/api/restapi/document/folder/{id}
- View a Folder by Name and Template
- Method: getPath:
/api/restapi/document/{name}/folderTemplate/{id}
- View all File Versions
- Method: getPath:
/api/restapi/document/file/{id}/version
- View all Files and Folders under a Folder
- Method: getPath:
/api/restapi/document/folder/{id}/allChildren
- View all Files and Folders under a Template
- Method: getPath:
/api/restapi/document/template/{id}/allChildren
- View all Files of a Folder
- Method: getPath:
/api/restapi/document/folder/{id}/files
- View all Files of a Template
- Method: getPath:
/api/restapi/document/template/{id}/files
- View all Folders of a Template
- Method: getPath:
/api/restapi/document/template/{id}/childFolders
- View all Folders under a Folder
- Method: getPath:
/api/restapi/document/folder/{id}/childFolders
- View all References of a File
- Method: getPath:
/api/restapi/document/file/{id}/references
- View Annotations of a Version of a File
- Method: getPath:
/api/restapi/document/file/{id}/version/{version}/annotations
- View the ID for a File or Folder by Path
- Method: getPath:
/api/restapi/document/workspace/{workspaceCode}/{type}/search
- View the Root Folder of a Portfolio
- Method: getPath:
/api/restapi/document/portfolio/{portfolioId}/root
- View the Root Folder of a Project
- Method: getPath:
/api/restapi/document/project/{projectId}/root
- View the Root Folder of a Template
- Method: getPath:
/api/restapi/document/template/{id}/root
- View the Zip Request Details by Zip Request ID
- Method: getPath:
/api/restapi/document/file/zip/status/zipRequest/{zipRequestId}
- View User Permission Sets for File
- Method: getPath:
/api/restapi/document/permissionSets