PlanRadar DMS API
Document Management System: browse, manage and copy DMS nodes, ticket attachments and form-field attachments
Operations 44
GET
/api/v2/{customer_id}/projects/{project_id}/dms/nodes
Retrieves All nodes [folder|files] for a specific projects
#
POST
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/ticket_attachments/{ticket_uuid}
Create New Ticket Attachment
#
POST
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/form_field_attachments/{ticket_uuid}
Create New Form Field Attachment
#
PATCH
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/form_field_attachments/{id}
Update a Form Field Attachment
#
GET
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/ticket_attachments
Retrieves All ticket attachments files for a specific projects
#
GET
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/form_field_attachments
Retrieves all form field attachments for a specific project
#
DELETE
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/ticket_attachments/delete
Delete Ticket Attachment
#
DELETE
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/form_field_attachments/delete
Delete Form Field Attachment
#
GET
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/attachments
Retrieves all attachments (ticket + form field) for a specific project
#
DELETE
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/attachments/delete
Delete attachments (ticket or form field)
#
GET
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}
show node[folder] or file details
#
DELETE
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}
mark node[folder] or file as deleted
#
POST
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}/copy
create another copy under different folder for a file/folder
#
PUT
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}/trash
move file or folder to the trash bin
#
PUT
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}/restore
restore file/folder from trash bin
#
POST
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/copy
execute a bulk copy , this is only works with files !
#
PATCH
/api/v2/:customer_id/projects/:project_id/dms/nodes/:id/toggle
toggle the control access switch
#
PATCH
/api/v2/:customer_id/projects/:project_id/dms/nodes/:id/restore_permissions
restore permissions
#
POST
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/copy_to_tickets_validation
validate before copying files to tickets
#
POST
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/copy_attachments_to_dms_validation
validate before copying ticket attachments to DMS
#
POST
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/copy_attachments_to_dms
copy ticket attachments to DMS
#
POST
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/copy_to_tickets
validate before copying files to tickets
#
GET
/api/v2/{customer_id}/projects/{project_id}/dms/bookmarks
Retrieves All the bookmarks for a user
#
GET
/api/v2/{customer_id}/projects/{project_id}/dms/logs/{item_type}/{item_id}
Retrieves DMS activity logs
#
GET
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/files_size
Retrieves DMS files size for a specific project
#
POST
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}/versions
upload new version of the file attachment
#
GET
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}/versions
load the file attachment version
#
DELETE
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}/versions/{id}
delete file attachment version
#
GET
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}/versions/{id}
load file attachment version details
#
POST
/api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}/versions/{id}/restore
Restore file attachment version
#
GET
/api/v2/:customer_id/projects/:project_id/dms/nodes/:node_id/permissions
Retrieves All permissions for a specific node
#
POST
/api/v2/:customer_id/projects/:project_id/dms/nodes/:node_id/permissions
create a permission entry for a specific role|user to access specific node
#
DELETE
/api/v2/:customer_id/projects/:project_id/dms/nodes/:node_id/permissions/:id
delete access permission for the list
#
PUT
/api/v2/:customer_id/projects/:project_id/dms/nodes/:node_id/permissions/:id
update access|permission type for a permission
#