Download Managed File or Directory

Obtains an existing file or 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:

/rest/serverengine/filestore/file/{fileId}

Content: –
Content Type:

–

Add. Headers:

If server security settings are enabled, then one of the following:

  • Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded)
  • auth_token – Authorization Token

Parameters

Path

Name Required Type Default Value Description
fileId

–

–

–

The Managed File ID (or Name) of the file or directory in File Store

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 Managed File

Example: "attachment; filename=Promo-EN.OL-datamapper"

OL-Original-Filename - The original file name, if available.

E.g. "Default Print Settings.OL-jobpreset"

 File successfully downloaded from File Store.

200
OK

Directory (zipped)

application/zip

Content-Disposition – Filename of the Managed Directory

Example: "attachment; filename=letter-ol.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:

  • basic authentication credentials nor an authorization token have been specified in the request headers

  • the basic authentication credentials or the authorization token specified in the request headers are invalid

  • the authorization token specified in the request headers has now expired

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

–
  • File or directory not found in File Store
    		•