Get Node Permissions by Node Path and Project Number
GET /ws/rest/service/v1/dm/permission/{projectNumber}/node/{node_path}
Purpose
Retrieves permissions of a node by node_path and project number.
Prerequisites
Ensure the following:
- Configure the Document Manager in the shell where the document is to be retrieved.
- You must have Full permissions to use this REST service of Document Manager.
Path Parameters
projectnumber: (Optional) project number(if not given, default is company workspace).
node_path: (Path parameter) full node_path of the required node.
Response Format
A JSON object is returned containing permissions data.
Sample Request
To get the permissions of node "test3" under path "/tes2" of projectnumber b1, give the URL as follows:
http://<host>:port>/ws/rest/service/v1/dm/permission/b1/node/test2/test3
Sample Success Response
{
"Inheritance": false,
"ApplyToAllSubFolders": false,
"UserPermission": [{
"Type": "PG",
"GroupName": "Asset Managers",
"FullName": "Asset Managers",
"DocumentPermission": {
"View": 1,
"Move": 1,
"Copy": 1,
"Delete": 1,
"Download": 1,
"ModifyProperties": 1,
"ModifyPermissions": 1,
"AddComments": 1,
"Revise": 1
},
"FolderPermission": {
"View": 1,
"Move": 1,
"Copy": 1,
"Delete": 1,
"ModifyProperties": 1,
"ModifyPermissions": 1,
"CreateSubFolders": 1,
"AddDocuments": 1
},
{
"Type": "U",
"LoginName": "coadmin",
"FullName": "Company Administrator",
"DocumentPermission": {
"View": 1,
"Move": 0,
"Copy": 0,
"Delete": 0,
"Download": 0,
"ModifyProperties": 0,
"ModifyPermissions": 0,
"AddComments": 0,
"Revise": 0
}
"FolderPermission": {
"View": 1,
"Move": 0,
"Copy": 1,
"Delete": 1,
"ModifyProperties": 1,
"ModifyPermissions": 1,
"CreateSubFolders": 1,
"AddDocuments": 1
}
}
]
}
Sample Failed Response
A failed response returns an error message with a status code.
{
"message": ["Invalid Node Path"],
"status": 1075
}
Related Topics
Set Permissions in Document Manager
Get Node Permissions by Node Path, Project Number, and User or Group
Add Node Permissions by Node Path and Project Number
Update Node Permissions by Node Path and Project Number
Remove Node Permissions by Node Path and Project Number
Remove Node Permissions by Node Path, Project Number, and User or Group
Granting, Inheriting, and Pushing permissions to files or folders
Removing Permissions to Files or Folders
Last Published Tuesday, July 1, 2025