Download a file

download

URL

/api/v1/download

Description

Gets the file, creates a compressed archive file in ZIP file format and downloads it.

Method

GET

Request query parameters

  • filePath

    String. Mandatory.

    Valid filePath.

  • type

    String. Optional.

    Valid values are "pdf" or "" (by Default creates a zip file and downloads it.)

Example request 

https://user1.XYZ.com/api/v1/download?type=pdf&
filePath=/data/IR/data/IR_Org/download/pdf/3bf2ffb3-c55e-4da8-819e-f51a6957ad66/
IR42_AmpliSeq Colon Lung v2 with RNA Lung Fusion single sample_oct1.pdf"

Request headers

Content-Type: application/x-www-form-urlencoded

Authorization:API Token

Returns

Downloads the file that is located at the file path that is specified.

Response fields

Status code

Response message

200

Successful response

400

Bad request

404

Not found

401

User is not authenticated

500

Error occurred

Curl command

curl -O -v -k -X GET "https://<server name>/api/v1/download?filePath=/data/IR/data/IR_Org/data/IRU_Uploads/2016-7-26_23_8_42/v2/report.pdf" -H "Content-Type:application/x-www-form-urlencoded" -H "Authorization:NDliYmU0OWE4MzA3YmE2MWVmMjhlZTlhOTEyMmE5ODM0NzU3NjQ4OGM5NzVjODU3YjdlMWM4Mjk3OGYzODE4Yw"