Report APIs

Use APIs to pull reports (signed-off and draft) and case data, including the subject, sample, and report details. The reports are in a PDF output, and case data is in a JSON output.

Pull Signed-off and Draft Report PDFs

Use this API to pull a PDF of the report for a case. If the report is a draft (e.g., case status is not "Report(s) Signed-Off"), the PDF will include a watermark stating "DRAFT".

1. From the API page, navigate to the DrsPullController section.

2. Select GET /drs/{apiVersion}/draftreport/case/{caseId}/reports/{reportId}/pdf

3. In the Parameters table, update the description for the following required parameters:

   • apiVersion — This value should be v1.

   • caseId — The case ID for the case. To get this information, open the case in Connected Insights and copy the case ID from the URL (for example, https://{domain}.connectedinsights.illumina.com/interpretation/{caseId}/reports/{reportId}/draft-report).

   • reportId — The ID associated with the report. To get this information, open the case in Connected Insights, go to the Report page, and copy the report ID from the URL (for example, https://{domain}.connectedinsights.illumina.com/interpretation/{caseId}/reports/{reportId}/draft-report).

4. [Optional]Update the description for the following optional parameters:

   • Accept-Language — The applicable language for the data.

   • reportLanguage — The applicable language for the generated report.

5. Select Execute.

Pull Case Data

Use this API to pull case data in JSON format. Case data includes subject, sample, and report details. If the report is a draft (e.g., case status is not "Report(s) Signed-Off"), the JSON will include the information in the draft report.

1. From the API page, navigate to the DrsPullController section.

2. Select GET /drs/{apiVersion}/draftreport/case/{caseId}/reportjson.

3. In the Parameters table, update the description for the following required parameters:

   • apiVersion — This value should be v1.

   • caseId — The case ID for the case. To get this information, open the case in Connected Insights and copy the case ID from the URL (for example, https://{domain}.connectedinsights.illumina.com/interpretation/{caseId}/reports/{reportId}/draft-report).

4. [Optional] Update the description for Accept-Language with the applicable language for the data.

   • Accept-Language — The applicable language for the data.

5. Select Execute.