Download Contents of Managed Directory
Obtains the contents of a directory of a specific Managed File ID (or Name) from the File Store.
Request takes no content, and on success returns a response containing the file or directory data (as zipped file).
Request
Method Type: |
GET |
---|---|
URI: | |
Content: | – |
Content Type: |
– |
Add. Headers: |
If server security settings are enabled, then one of the following:
|
Parameters
Path
Name | Required | Type | Default Value | Description |
---|---|---|---|---|
fileId |
Yes |
String |
– |
The Managed File ID (or Name) of the file or directory in File Store |
relPath |
Yes |
String |
– |
The relative path to the specific contents (file or directory) within directory |
Query
Name | Required | Type | Default Value | Description |
---|---|---|---|---|
output |
No |
String |
– |
The output method to be used for the file |
Response
Success
The following lists status codes indicative of a successful response:
Status Code | Content | Content-Type | Add. Headers | Description |
---|---|---|---|---|
200 OK |
File |
application/octet-stream |
Content-Disposition – Filename of the specific file within directory E.g. "attachment; filename=pps-box.jpg" OL-Original-Filename - The original file name, if available. E.g. "pps-box.jpg" |
File successfully downloaded from File Store |
200 |
File (Base64 Encoded) |
application/octet-stream |
Content-Disposition – File name of the specific file within directory E.g. "attachment; filename=a5ada9e3-dba7-46ef-ab7c-637e82170d56.html" OL-Original-Filename - The original file name, if available. E.g. "Webpage-1.html" |
File successfully downloaded from File Store. Response when the parameters specified contain an output value of base64 |
200 |
Directory (Zipped) |
application/zip |
Content-Disposition – File name of the specific directory (zipped) within directory E.g. "attachment; filename=Letter.zip" OL-Original-Filename - The original file name, if available. E.g. "Letter.OL-template" |
Directory successfully downloaded from File Store. |
Error
The following lists status codes indicative of a failed or error response:
Status Code | Content | Content-Type | Add. Headers | Description |
---|---|---|---|---|
401 Unauthorized |
JSON Error specifying error message |
application/json |
WWW-Authenticate – BASIC (Basic Authentication credentials are accepted) |
Server authentication has failed. Response when either:
|
403 Forbidden |
JSON Error specifying error message |
application/json |
– |
Server authentication has succeeded, but user authorization for this specific method has failed. Response when authentication of the credentials or the authorization token specified in the request headers has succeeded, but the user associated with the credentials or the authorization token specified has insufficient role assignment/privileges. |
404 Not Found |
JSON Error specifying error message |
application/json |
– |
Directory not found in File Store. |