LogoLogo
Illumina KnowledgeIllumina SupportSign In
  • Home
  • Overview
    • Welcome
    • What's New
      • Cloud Software Update
      • Local Software Update
  • Configure
    • Configuration
      • Custom Case Data
      • Pipeline and QC Configuration
      • Preferred Transcripts
      • Custom Annotations
      • Disease Configuration
      • Variant Filters
      • Variant Flag Groups
      • Actionability Classifications
      • Report Templates
        • Customizations
      • Report Automation
      • Test Definitions
      • Data Upload
        • Data Upload from User Storage (Connected Insights - Cloud and Connected Insights - Local)
        • Data Upload from ICA or BSSH (Connected Insights - Cloud)
        • Supported Pipelines
          • DRAGEN TruSight Oncology 500 Analysis Software v2.6.0 (with HRD)
          • DRAGEN TruSight Oncology 500 Analysis Software v2.6.0
          • DRAGEN TruSight Oncology 500 Analysis Software v2.5.3 (with HRD)
          • DRAGEN TruSight Oncology 500 Analysis Software v2.5.3
          • DRAGEN TruSight Oncology 500 Analysis Software v2.5.2 (with HRD)
          • DRAGEN TruSight Oncology 500 Analysis Software v2.5.2
          • DRAGEN TruSight Oncology 500 Analysis Software v2.1.1 (with HRD)
          • DRAGEN TruSight Oncology 500 Analysis Software v2.1.1
          • DRAGEN TruSight Oncology 500 ctDNA Analysis Software v2.6.1
          • DRAGEN TruSight Oncology 500 ctDNA Analysis Software v2.6.0
          • DRAGEN TruSight Oncology 500 ctDNA Analysis Software v2.5.0
          • DRAGEN TruSight Oncology 500 ctDNA Analysis Software v2.1.1
          • DRAGEN Amplicon v4.3
          • DRAGEN Amplicon v4.2
          • DRAGEN Amplicon v4.1
          • DRAGEN RNA v4.3
          • DRAGEN RNA v4.2
          • DRAGEN RNA v4.1
          • DRAGEN Enrichment v4.3
          • DRAGEN Enrichment v4.2
          • DRAGEN Enrichment v4.1
          • DRAGEN for Illumina cfDNA Prep with Enrichment v4.0.3
          • DRAGEN Somatic Whole Genome v4.3
          • DRAGEN Somatic Whole Genome v4.2
          • DRAGEN Somatic Whole Genome v4.1
          • TruSight Tumor 170 Local App v2.0.1
          • Local Run Manager TruSight Tumor 15 Analysis Module v2.1
        • Custom Pipeline Configuration
          • VCF Input Requirement
          • TMB, MSI, GIS Input Requirement
        • Custom Case Data Upload
    • Upload Assertions
    • Local Installation Guide
      • Overview
      • Prerequisites
      • Download Connected Insights Package
      • Install Connected Insights Software
      • Install License File
      • Sign In to Connected Insights
      • Installation Status Messages
      • Local Configurations
      • Administration Console (Connected Insights - Local)
      • Configure External Storage (Connected Insights - Local)
  • Manage cases
    • Cases Page
    • Cases List
      • Case Metadata Upload
  • Interpret and report
    • Case Page
    • Case Details
      • Merge Cases
    • Overview Tab
      • Classification & Risk Stratification Prediction
    • Visualize Tab
    • Variants Tab
      • Modify Columns
      • Apply Variant Filters
        • Filter by Variant Category
        • Variant Details Filters
        • Variant Quality Filters
        • Functional Impact Filters
        • Disease Association Filters
        • Variant Frequency Filters
        • Flags Filter
        • Filtering Logic
      • IGV Visualizations
    • Lab QC Tab
    • Report Tab
    • View Biomarker Details
      • Biological Classification
      • Actionability
      • Clinical Trials
      • Oncogenicity Prediction
      • Visualize
      • Variant Overview
      • Gene Overview
      • Cancer Datasets
      • Computer Predictors
      • Population
    • Interpret a Biomarker
      • Create Clinical Trials
      • Create Gene Descriptions
      • Manage Assertions
    • Variant Transcripts
    • Add Variant
  • Resources and References
    • Glossary
    • APIs
      • Ingest Cloud Analysis Data API (Connected Insights - Cloud Only)
      • Case APIs
      • Report APIs
      • Audit Log APIs
    • Troubleshooting
      • Overview
      • Audit Log
      • Data Backup (Connected Insights - Local)
      • Software Errors and Corrective Actions
      • How To
      • Technical Assistance
    • Pricing and Usage
    • Security and Compliance
    • Release Notes
Powered by GitBook
On this page
  • Get Case ID
  • Add or Update the Disease for a Case
  • Delete Cases
  • Search Case
  • Upload Metadata files via an API

Was this helpful?

Export as PDF
  1. Resources and References
  2. APIs

Case APIs

Use APIs to perform the following tasks in Connected Insights:

  • Get the case ID

  • Add or update the disease for a case

  • Search cases

  • Delete cases

  • Upload Case Metadata files

❗Do not use the Update Case Information or Patch Case APIs. These APIs can significantly alter case data and are only used by Illumina TechnicalSupport.

Get Case ID

  1. On the API page, navigate to the Cases section.

  2. Select GET /crs/api/v2/cases/{caseId}.

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

    • caseId — The ID for the case. To retrieve this ID, select the applicable case in Connected Insights and copy the ID from the URL (for example, https://{domain}.connectedinsights.illumina.com/interpretation/{caseId}/reports/{reportId}/overview).

    • directIdentifiers — This parameter includes or ignores direct identifiers. Select true or false from the drop-down list. The default value is false.

    • includeQcOverviewMetrics — This parameter includes or ignores the QC metrics for the case. Select true or false from the drop-down list. The default value is false.

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

  4. Select Execute.

Add or Update the Disease for a Case

  1. On the API page, navigate to the Cases section.

  2. Select PUT /crs/api/v1/cases/{caseId}/diseases.

    ❗ This API puts the case in a processing state. Then, it moves to the Ready for Interpretation state. Navigate to the Case List page to check the status of the case.

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

    • caseId — The ID for the case. To retrieve this ID, select the applicable case in Connected Insights and copy the ID from the URL (for example, https://{domain}.connectedinsights.illumina.com/interpretation/{caseId}/reports/{reportId}/overview).

  4. For the Request body, enter the disease name you want to add or update. Refer to the following example: { "externalid": "255032005", "ontologytype": "SNOMEDCT", "name": "Medullary thyroid carcinoma" }

  5. Select Execute.

Delete Cases

Use an API to delete cases as follows.\

  1. On the API page, navigate to the Cases section.

  2. Select DELETE /crs/api/v1/cases/{id}

  3. In the Parameters table, enter the applicable case ID.

  4. [Optional] Enter the applicable language in the Description field.

  5. Select Execute.

Search Case

Use an API to search for cases based on one or multiple parameters. If you are using multiple parameters, the search is completed with the AND condition for each parameter.\

  1. On the API page, navigate to the Cases section.

  2. Select GET /crs/api/v1/cases/search.

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

    • status — The case status. Enter the applicable status in the field. The available statuses are listed in the Description column.

    • isExactMatch — This parameter is used with displayId and determines if the result is an exact match. Select true or false from the drop-down list. The default value is false.

    • displayId — The displayed case ID ( for example, ILM-ABC-234 ). This parameter is an exact search when isExactMatch is set to true.

    • id — The caseId ( for example, dc25cd92-78e0-11e8-adc0-fa7ae01bbebc ). This parameter is also used to search for a partial ID.For example, if you search for 11e8, then dc25cd92-78e0-11e8-adc0-fa7ae01bbebc displays in the results.

    • externalSampleId — The external sample ID for a case ( for example, ILM-ABC-234 ). This parameter is also used to search for a partial ID. For example, if you search ABC or 234, then ILM-ABC-234 displays in the results.

    • analysisId — The specific or custom analysisId.

    • tags — The tags associated with the case. Select Add string item to add a tag. This parameter is also used to search for partial tags. For example, if you search for onc, then both oncogenic and oncology display in the results.

    • diseaseName — The disease name associated with the case.

    • creationDateBefore — The date before the data is created. This date is in the yyyy-MM-dd'T'HH:mm:ss'Z' format ( for example,2021-01-30T08:30:00Z ).

    • creationDateAfter — The date after the data is created. This date is in the yyyy-MM-dd'T'HH:mm:ss'Z' format ( for example, 2021-01-30T08:30:00Z ).

    • pageNumber — The specific page number of the API response.

    • pageSize — The size of each page in the API response.

    • orderBy — This parameter is used by id, displayId, and status to sort results. Results are sorted in ascending or descending order.Enter ASC to sort in ascending order, and enter DESC for descending order.

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

  4. Select Execute.

Upload Metadata files via an API

Use an API to upload a Case Metadata file as follows.\

  1. On the API page, navigate to the Cases section.

  2. Select POST /crs/api/v2/custom-case-data/files

  3. In the Parameters table, select Add string item, then Choose File to select the Case Metadata file from local storage.

  4. [Optional] To upload multiple files, select Add strong item and Choose File again. Upload up to 5 files. Accepted file types: CSV. Each file should not exceed 10MB in size, with a combined files limit of 50MB.

  5. [Optional] Enter the applicable language in the Description field.

  6. Select Execute.

PreviousIngest Cloud Analysis Data API (Connected Insights - Cloud Only)NextReport APIs

Last updated 19 hours ago

Was this helpful?

❗ For more details about Case Metadata files including error messages, downloading, editing, uploading, and tracking upload progress, see .

Custom Case Data Upload