Rename Unpublished Document by File ID
POST /ws/rest/service/v1/dm/node/rename/unpublished/{file_id}
Purpose
Provide a web service to rename an unpublished document based on file id.
Input
Path Parameter
- file_id(Required) : The unpublished document file_id which needs to be renamed.
- Form Data (content Type: application/x-www-form-urlencoded)
- data:
[{"new_node_name":"rename.json","forceful":"yes" }]
- data:
Output
JSON object containing 'status', 'data', 'message'
Example:
To rename an unpublished document with file_id 219 give URL as below:
URL: http://<host>:<port>/ws/rest/service/v1/dm/node/rename/unpublished/219
data: [{"new_node_name":"renamefile.dwg","forceful":"yes" }]
Response in case of success:
{
"data": [ {
"Path": "",
"forceful": "yes",
"node_name_input": "renamefile.dwg",
"Name": "renamefile(1).dwg"
}],
"message": [{"message": "Renamed unpublished document successfully"}],
"status": 200
}
Response in case of error:
{
"data": [ {
"Path": "",
"forceful": "yes",
"node_name_input": "rename.dwg",
"Name": "rename.dwg"
}],
"message": [{"message": "New file name and old file name are same"}],
"status": 505
}
}
Related Topics
Search Document or Folder Properties
Get Node Permissions by Node Path and Project Number
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
Set Permissions in Document Manager
Last Published Tuesday, July 1, 2025