Get link to a final report

finalreport

URL

/api/v1/finalreport

Description

Gets the analysis details and returns links to the final report. Returns a JSON object that contains 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 by default. If type is sample, this corresponds to the sample id.

  • start_date

    String, Optional.

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

  • end_date

    String, Optional.

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

Example request

https://ionreporter.thermofisher.com/api/v1/finalreport?fomat=json&type=analysis
&name=IR42_AmpliSeq Colon Lung v2 with RNA Lung Fusion single sample_oct1
&start_date=2014-01-30&end_date=2016-04-12

Request headers

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

Authorization:API Token

Authorization

API Token

Returns

[
  {
    "summary": "",
    "final_report_template": "Default Final Report Template",
    "report_pdf": "http://ionreporter.thermofisher.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",
    "created_on": "2016-03-24T03:11:16.000-07:00",
    "name": "IR42_AmpliSeq Colon Lung v2 with RNA Lung Fusion single sample_oct1",
    "id": "ff80818148c803530148cdb524020071",
    "variants": [
      {
        "{\"_id\":[\"com.mongodb.BasicDBObject\",
            {\"c\":1,\"p\":115252204}],\"GT\":\"0/0\"}": {
          "comments": "",
          "gene": "NRAS",
          "annotations": "",
          "locus": "chr1:115252204",
          "classification": "UNCLASSIFIED",
          "exon": "4",
          "sample": [
            {
              "Auto_user_PG1-10-140127__ColonLung_v3_test_627_279_IonXpress_003_v1": {
                "mutation": "",
                "protein": ""
              }
            }
          ]
        }
      }
    ],
    "analysis": "http://ionreporter.thermofisher.com/api/v1/analysis?id=
                        ff80818148c803530148cdb524020071",
    "ion_reporter_version": "4.2",
    "created_by": "Report User"
  }
]

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/finalreport?format=json&name=BRCA_Plus_RR_jul29&type=analysis&start_date=2016-07-25&end_date=2016-07-31" -H "Content-Type:application/x-www-form-urlencoded" -H "Authorization:NDliYmU0OWE4MzA3YmE2MWVmMjhlZTlhOTEyMmE5ODM0NzU3NjQ4OGM5NzVjODU3YjdlMWM4Mjk3OGYzODE4Yw"