Get analysis details

analysis

URL

/api/v1/analysis

Description

Gets the analysis details and links to download a Quality Control (QC) report, final report, and compressed archive (ZIP format) of unfiltered and filtered variants 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. Use date format: yyyy-MM-dd.

  • end_date.

    String. Optional.

    Parameter to filter the results by date boundary. Use date format: 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 any single or comma-separated combination of values "reports, unfilteredvariants, filteredvariants"

  • view

    String. Optional.

    Valid values are "summary" or "".

Example request

https://ionreporter.thermofisher.com/api/v1/analysis?format=json&name=xyzsampletest
&exclude=reports,filteredvariants,unfilteredvariants&start_date=2016-01-01
&end_date=2016-02-01

Request headers

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

Authorization:API Token

Returns

[

  {
    "reports": {
      "qc": {
        "link": "http://dev.ionreporter.thermofisher.com/api/v1/download?type=pdf&
                filePath=/data/IR/data/IR_Org/download/pdf/
                30cf8ff3-fe3d-4cac-8f7d-ce45aa7d34e1/
                    ff80818153ed40a401540716785a081a_QC.pdf"
      },
      "final": {}
    },
    "report_published": "",
    "workflow": "Annotate variants single sample",
    "data_links": {
      "filtered_variants": "http://dev.ionreporter.thermofisher.com/api/v1/download?    
                            filePath=/data/IR/data/IR_Org/ion.reporter@lifetech.com/
                            Demo_AmpliSeq_Exome_VCF/
                            Demo_AmpliSeq_Exome_VCF_20160411134952720/
                            Demo_AmpliSeq_Exome_VCF_1460407585676.zip",
      "unfiltered_variants": "http://dev.ionreporter.thermofisher.com/api/v1/download?
                            filePath=/data/IR/data/IR_Org/ion.reporter@lifetech.com/
                            Demo_AmpliSeq_Exome_VCF/
                            Demo_AmpliSeq_Exome_VCF_20160411134952720/
                            Demo_AmpliSeq_Exome_VCF_1460407585676.zip"
    },
    "variants_saved": "",
    "samples": {
      "PROBAND": "Demo AmpliSeq Exome VCF"
    },
    "shared_with": [],
    "stage": "Review Variants"
    "flagged": false,
    "name": "Demo AmpliSeq Exome VCF_1460407585676",
    "id": "ff80818153ed40a401540716785a081a",
    "ion_reporter_version": "5.2",
    "started_by": "Ion User",
    "start_date": "April 11, 2016",
    "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 "http://<your server name>/api/v1/analysis?format=json&name=xyzsampletest
&exclude=reports,filteredvariants,unfilteredvariants&start_date=2016-01-01
&end_date=2016-02-01" -H "Content-Type:application/x-www-form-urlencoded" -H
"Authorization:NDliYmU0OWE4MzA3YmE2MWVmMjhlZTlhOTEyMmE5ODM0NzU3NjQ4GM5NzVjODU3YjdlMWM4Mjk3OGYzODE4Yw"