Upload Data File

Submits a data file to the File Store.

Request takes binary file data as content, and on success returns a response containing the new Managed File ID for the data file.

Request

Method Type:

POST

URI:

/rest/serverengine/filestore/DataFile

Content: Data File (File)
Content Type:

application/octet-stream

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

Query

Name Required Type Default Value Description
filename

The file name of the data file to be uploaded

persistent

false

Whether the data file to be uploaded will be persistent 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
Managed File ID (or Name) text/plain Data file successfully uploaded to 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.