REST API Reference

Back Next

File transfer

Use the following commands to transfer an HTTPS file to or from a server:

upload: Use this command to transfer a file to the server. The request must be a multipart POST request and only one file is uploaded per request. A file is a required part of the multipart request, but any parameter name given to the file part is ignored.
For example,
https://10.60.40.11:15400/fileservers/upload

The request includes the following parameters:

Request Type
Parameters

POST/Multipart

to: The relative or absolute path of the destination file.
file: The file being uploaded as part of the multipart request.
generateUniqueId. Optional. Set to true to generate and return a unique ID for the file transfer task. Default is false.
fileMetadata. Optional. Metadata related to the file in JSON format.

If you include the optional request parameters, the response includes the following return parameters, respectively:
fileUniqueId. Unique ID generated for the file transfer task.
fileMetadata. Metadata related to the file in JSON format.

Request Type	Parameters
POST/Multipart	to: The relative or absolute path of the destination file. file: The file being uploaded as part of the multipart request. generateUniqueId. Optional. Set to true to generate and return a unique ID for the file transfer task. Default is false. fileMetadata. Optional. Metadata related to the file in JSON format.

upload2: Use this command to transfer a file to the server. The request must be a multipart POST request and only one file is uploaded per request. A file is a required part of the multipart request, but any parameter name given to the file part is ignored.
For example,
https://10.60.40.11:15400/fileservers/upload2

The response includes the following parameters:

Request Type
Parameters

POST/Multipart

to: The relative or absolute path of the destination file.
append: Optional. If the file exists on the target directory, set this parameter to
true
to append the new file to the existing one.
transferMode: Use B for binary transfers or A for ascii transfers. Default is B.
file: The file being uploaded as part of the multipart request.

Request Type	Parameters
POST/Multipart	to: The relative or absolute path of the destination file. append: Optional. If the file exists on the target directory, set this parameter to true to append the new file to the existing one. transferMode: Use B for binary transfers or A for ascii transfers. Default is B. file: The file being uploaded as part of the multipart request.

upload3: Use this command to transfer a file to the server. The request must be a multipart POST request and only one file is uploaded per request. A file is a required part of the multipart request, but any parameter name given to the file part is ignored.
For example,
https://10.60.40.11:15400/fileservers/upload3

You must provide the fileserver username and password for basic authorization.
The response includes the following parameters:

Request Type
Parameters

POST/Multipart

to: The relative or absolute path of the destination file.
append: Optional. If the file exists on the target directory, set this parameter to
true
to append the new file to the existing one.
transferMode: Use B for binary transfers or A for ascii transfers. Default is B.
file: The file being uploaded as part of the multipart request.

Request Type	Parameters
POST/Multipart	to: The relative or absolute path of the destination file. append: Optional. If the file exists on the target directory, set this parameter to true to append the new file to the existing one. transferMode: Use B for binary transfers or A for ascii transfers. Default is B. file: The file being uploaded as part of the multipart request.

uploadRawData: Use this command to upload data directly to the server where the data is the content of the request body. The request must be a POST request. The name of the file is automatically derived and returned as part of the X-GDX-Reply header message. This is a special command where the request body must contain the file data being uploaded.
For example,
https://10.60.40.11:15400/fileservers/uploadRawData

uploadRawData2: Use this command to upload data directly to the server where the data is the content of the request body. The request must be a POST request. The name of the file is automatically derived and returned as part of the X-GDX-Reply header message. This is a special command where the request body must contain the file data being uploaded.
For example,
https://10.60.40.11:15400/fileservers/uploadRawData2

You must provide the fileserver username and password for basic authorization.

download: Use this command to download a file from the server. The file is returned as the response body. The content type is always an application or force download, along with the content disposition field containing the name of the file. The content-length header is also included in the response indicating the size of the file.
For example,
https://10.60.40.11:15400/fileservers/download?file=/test&downloadReleased=true&transferMode=b

The response includes the following parameters:

Request Type
Parameters

GET or POST

file: Required. The file to download. This can be a path relative to the current working directory, or an absolute path to the file.
offset: For downloading partial files. Enter the starting position from where the file must begin to download.
transferMode: Use B for binary transfers or A for ascii transfers. Default is B.

Request Type	Parameters
GET or POST	file: Required. The file to download. This can be a path relative to the current working directory, or an absolute path to the file. offset: For downloading partial files. Enter the starting position from where the file must begin to download. transferMode: Use B for binary transfers or A for ascii transfers. Default is B.