Get VCF files

getvcf

URL

/api/v1/getvcf

Description

Gets the links to download VCF files. Returns a JSON object that contains the download information.

Method

GET

Request query parameters

  • format

    String. Optional.

    Response type, current version supports only json.

  • type

    String. Optional.

    Valid values are "sample" or "analysis".

  • name

    String. Conditional.

    If type parameter is "sample" then name is Mandatory.

  • id

    String. Optional.

    Id of an Analysis.

  • start_date

    String. Optional.

    Parameter to filter the results by date boundary. Date format should be in yyyy-MM-dd.

  • end_date

    String. Optional.

    Parameter to filter the results by date boundary. Date format should be in yyyy-MM-dd.

  • duration

    String. Optional. Parameter to filter the results by days/months.

    Valid value starts with "-" followed by numeric value and ends with "d" or "m"

  • exclude

    String. Optional. Parameter to filter the response.

    Valid values are unfilteredvariants or filteredvariants.

Example request

https://ionreporter.thermofisher.com/api/v1/getvcf?format=json&name=xyzsampletest
&start_date=2016-01-01&end_date=2016-02-01

Request headers

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

Authorization:API Token

Returns


[
  {
    "data_links": "http://ionreporter.thermofisher.com/api/v1/download?
      filePath=/data/IR/data/IR_Org/ion.reporter@lifetech.com/JohnSmithSample
      /JohnSmithSample_20160429014705727/JohnSmithSample_c150_2016-04-29-14-16-534.zip",
    "name": "JohnSmithSample_c150_2016-04-29-14-16-534",
    "id": "ff808181545d90790154613336be0008"
  }
]

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 -v -k -X GET "https://<your server name>/api/v1/getvcf?format=json&name=BRCA_Plus_RR_jul29&start_date=2016-07-25&end_date=2016-07-31" -H "Content-Type:application/x-www-form-urlencoded" -H "Authorization:NDliYmU0OWE4MzA3YmE2MWVmMjhlZTlhOTEyMmE5ODM0NzU3NjQ4OGM5NzVjODU3YjdlMWM4Mjk3OGYzODE4Yw"