Get whole genome view PNG

genomeView

URL

/api/v1/genomeView

Description

Gets the whole genome view PNG image file of the sample or analysis.

Method

GET

Request query parameters

  • name

    String. Mandatory.

    Name of a sample or analysis.

    • If both id and name are given as input, then the genome-view PNG is displayed for id, and name is not be considered.

    • Whole Genome View image will be displayed as part of the response, along with analysis and sample name as the header.

    • If no PNG file is available in the /outputs folder, then the response is 200 with the following message: "Genome View PNG not found." [with analysis name and sample name]

  • id

    String. Optional.

    Id of an analysis.

  • version

    String. Mandatory.

    Application version on which the analysis is launched. For and analysis with older application versions, provide "Version=<IR version>" as a parameter, along with name.

Example request 

https://user1.XYZ.com/api/v1/genomeView?name=Demo Aneuploidy_1752920408115&Version=IR522&id=ff808181982214ca01982235013c05e9

Request headers

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

Authorization:API Token

Returns

Returns the PNG image file for a whole genome view of the analysis.

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://<server name>/api/v1/genomeView?name=GVRTestSample2&Version=IR54"-H "Content-Type:application/x-www-form-urlencoded" -H "Authorization:YmZkM2YxYjEzMDBmZTI4MDgwMmM5YjIzMGY1MjEyZDMyMGI3ZTU5MmQyZGY4ZmIxZWI5M2ViYzIxZWNhOWU3NQ"