Get current results TSV file

getcurrentResultTsv

URL

api/v1/currentResultTsv?parameters

Description

Returns the Current Results TSV file path in the same column order as shown in the analysis results in Ion Reporter™ Software.

Method

GET

Request 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.

  • format=json

  • name=NAME OF THE ANALYSIS

If there are two analyses with the same name for two different versions of Ion Reporter™ Software, then the request returns two file paths for the TSV files. If the analysis is not found, the software returns an error with an explanation that the analysis was not found.

Example request

http://dev.ionreporter.thermofisher.com/api/v1/currentResultTsv?format=json&name=xyzsampletest

Request headers

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

Authorization:API Token

Returns

[
    {
        "report_published": "",
        "workflow": "Low-pass whole-genome aneuploidy w1.0",
        "data_links": {
            "current_result_tsv": "https://localhost:443/api/v1/download?filePath=/data/IR/data/IR_Org/ion.reporter@lifetech.com/Demo_Aneuploidy/Demo_Aneuploidy_20180419122112036/analysis_downloads/currentTsv/Demo_Aneuploidy_c1531_2018-04-19-12-26-20-867-2018-07-10-16-04-13-869.tsv"
        },
        "samples": {
            "PROBAND": "Demo Aneuploidy"
        },
        "variants_saved": "",
        "shared_with": [],
        "stage": "Send for Report Generation",
        "flagged": false,
        "name": "Demo Aneuploidy_c1531_2018-04-19-12-26-20-867",
        "id": "ff80818162dca67d0162dcabdd6b0001",
        "ion_reporter_version": "5.10",
        "started_by": "Ion User",
        "start_date": "April 19, 2018",
        "status": "SUCCESSFUL"
    }
]

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/currentResultTsv?format=json&name=BRCA_Plus_RR_jul29" -H "Content-Type:application/x-www-form-urlencoded" -H "A