Synchronize/Upload Managed File (Internal Only)

Synchronizes/uploads an existing file of a specific Managed File ID (or Name) from a Server Extension File Store, to the Server's File Store and is used exclusively in a clustered environment.

Request takes binary file data as content, and on success returns a response containing the Managed File ID (or Name) of the file.

This method is strictly used internally by OL Connect.

Request

Method Type:

POST

URI:

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

Content: 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

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
Managed File ID (or Name) text/plain File successfully synchronized/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

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.

405 Not Allowed

JSON Error specifying error message

application/json

File already exists in File Store