Oracle Prime Projects REST API

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'

Batch Delete Files: Method: delete
Path: /primeapi/restapi/document/batch/files
Batch Delete Folders: Method: delete
Path: /primeapi/restapi/document/batch/folders
Check-in a Document: Method: post
Path: /primeapi/restapi/document/file/{id}/checkin
Check-out a Document: Method: get
Path: /primeapi/restapi/document/file/{id}/checkout
Copy a Template to a Folder: Method: post
Path: /primeapi/restapi/document/templateCopy/sourceTemplate/{id}/targetFolder/{targetId}
Create a Document: Method: post
Path: /primeapi/restapi/document/folder
Delete a File: Method: delete
Path: /primeapi/restapi/document/file/{id}
Delete a Folder: Method: delete
Path: /primeapi/restapi/document/folder/{id}
Download a File: Method: get
Path: /primeapi/restapi/document/file/{id}/download
Download a Specific Version of a File: Method: get
Path: /primeapi/restapi/document/file/{id}/version/{ver}/download
Link a document to another object: Method: get
Path: /primeapi/restapi/document/{docId}/scope/{type}/scopeId/{id}/linkDocument
Unlink a Document: Method: get
Path: /primeapi/restapi/document/{docId}/scope/{type}/scopeId/{id}/unlinkDocument
Update a File: Method: put
Path: /primeapi/restapi/document/file
Update a Folder: Method: put
Path: /primeapi/restapi/document/folder
Upload a Document: Method: post
Path: /primeapi/restapi/document/uploadFile/parent/{folderId}/fileName/{fileName}
View a Child Folder: Method: get
Path: /primeapi/restapi/document/folder/{id}/childFolders
View a Document by Path: Method: get
Path: /primeapi/restapi/document/workspace/{code}/{type}/search?path={path}
View a File: Method: get
Path: /primeapi/restapi/document/file/{id}
View a File by Folder: Method: get
Path: /primeapi/restapi/document/folder/{id}/files
View a Folder: Method: get
Path: /primeapi/restapi/document/folder/{id}
View a Folder by Name: Method: get
Path: /primeapi/restapi/document/{name}/folderTemplate/{id}
View all Children by Template: Method: get
Path: /primeapi/restapi/document/template/{id}/allChildren
View all Children of a Folder: Method: get
Path: /primeapi/restapi/document/folder/{id}/allChildren
View all Document References: Method: get
Path: /primeapi/restapi/document/file/{id}/references
View File Annotations: Method: get
Path: /primeapi/restapi/document/file/{id}/version/{ver}/annotations
View File Versions: Method: get
Path: /primeapi/restapi/document/file/{id}/version
View Files by Template: Method: get
Path: /primeapi/restapi/document/template/{id}/files
View Folders by Template: Method: get
Path: /primeapi/restapi/document/template/{id}/childFolders
View the Root Folder by Template: Method: get
Path: /primeapi/restapi/document/template/{id}/root
View the Root Folder of a Portfolio: Method: get
Path: /primeapi/restapi/document/portfolio/{id}/root
View the Root Folder of a Project: Method: get
Path: /primeapi/restapi/document/project/{id}/root