GET /ws/rest/service/v1/dm/document/<parent_node_id>
Purpose
Provide a web service to retrieve all the documents (files) and meta data under a folder using the parent folder node id.
Input
Path Parameter
- parent_folder_id : Parent folder's node id from which to get the documents.
- Use “Get Folder or Document meta data by path” REST Service to get the node_id value for the folder.
Query Parameter
- iszip (String) Optional: "yes" to get all the files in a single zip file. "no" to get individual files. Default is "yes"
Output
Output will be a multi-part response.
- If iszip option is yes then the response file part will be a zip file containing all the documents.
- If iszip option is no then the output will be individual documents in the file part parameter.
Example:
To get the documents under parent_node_id 55889 request URL should be as below:
URL: http://<host>:<port>/ws/rest/service/v1/dm/document/55889
There are 2 files b.txt (content is test test) and ucm_migration_issue.txt (content is 1. Most of the cases the wrong file referenced is a report ) under the selected directory.
iszip = no
Response Header
Content-Type = multipart/form-data; boundary=QXL6HDrSIJF1imDRjdgUC8bTbHIq1z4PUZ
Response Body
--5MJDL8Wb3f7FtknE7iXUzMYy-W1KqjuFfd6bye
Content-Disposition: form-data; name="response"
Content-Type: application/octet-stream
Content-Transfer-Encoding: 8bit
{"status":200,"data":[],"message": ""}
--5MJDL8Wb3f7FtknE7iXUzMYy-W1KqjuFfd6bye
Content-Disposition: form-data; name="b.txt"; filename="b.txt"
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary
test test
--5MJDL8Wb3f7FtknE7iXUzMYy-W1KqjuFfd6bye
Content-Disposition: form-data; name="ucm_migration_issue.txt"; filename="ucm_migration_issue.txt"
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary
1. Most of the cases the wrong file referenced is a report
--5MJDL8Wb3f7FtknE7iXUzMYy-W1KqjuFfd6bye--
{ "data": [ ], "message": [ ], "status":200 }
iszip = yes
Response Header
Content-Type = application/octet-stream
Response Body
zip file binary data
In case of error:
Output:
{
"data":
[
],
"message":
[
{
"message":"Parent path or node id is invalid or does not exists."
}
],
"status":1039
}