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

On the API page, navigate to the Cases section.
Select GET /crs/api/v2/cases/{caseId}.
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.
Select Execute.

Add or Update the Disease for a Case

On the API page, navigate to the Cases section.
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.
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).
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" }
Select Execute.

Delete Cases

Use an API to delete cases as follows.

On the API page, navigate to the Cases section.
Select DELETE /crs/api/v1/cases/{id}
In the Parameters table, enter the applicable case ID.
[Optional] Enter the applicable language in the Description field.
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.

On the API page, navigate to the Cases section.
Select GET /crs/api/v1/cases/search.
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.
Select Execute.

Upload Metadata files via an API

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

On the API page, navigate to the Cases section.
Select POST /crs/api/v2/custom-case-data/files
In the Parameters table, select Add string item, then Choose File to select the Case Metadata file from local storage.
[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.
[Optional] Enter the applicable language in the Description field.
Select Execute.
❗ For more details about Case Metadata files including error messages, downloading, editing, uploading, and tracking upload progress, see Custom Case Data Upload.

PreviousOverview NextIngest Cloud Analysis Data API (Connected Insights - Cloud Only)

Last updated 1 year ago

Was this helpful?

Get Case ID

On the API page, navigate to the Cases section.

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

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.

Select Execute.

Add or Update the Disease for a Case

On the API page, navigate to the Cases section.

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.

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

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" }

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.

On the API page, navigate to the Cases section.

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

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.

Select Execute.

Upload Metadata files via an API

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

On the API page, navigate to the Cases section.

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

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

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

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

Select Execute.

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