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" |
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" |
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=images.zip" |
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 |
– |
– |
WWW-Authenticate – BASIC (Basic Authentication credentials are accepted) |
Server authentication is required. Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. |
401 Unauthorized |
Error message |
– |
– |
Server authentication has failed. Response when the authorization token specified in the request headers has now expired. |
403 Forbidden |
Error message |
– |
– |
Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid. |
404 |
JSON Error specifying error message |
application/json |
– |
Directory not found in File Store. |