Overview

Use APIs to perform the following tasks in Connected Insights:

• Retrieve, edit, and delete case information including disease and case metadata. For more information, refer to Case APIs.

• For Connected Insights - Cloud, ingest cloud analysis data. For more information, refer to Ingest Cloud Analysis Data API (ConnectedInsights - Cloud Only).

• Pull report information, including PDF report drafts and case data. For more information, refer to Report APIs.

Prerequisites

Before using the APIs, make sure that the following prerequisites are met:

• Access to the Swagger site. This sites use the host URL and can be accessed using the following URL:

  • https://{ici-host-url}/api-docs

• Know the following authorizations. Instructions for finding this information are below:

  • Authorization (apiKey or psToken)

  • X-ILMN-Domain

  • X-ILMN-Workgroup

Authorization (apiKey or psToken) (Connected Insights - Cloud) An API key or psToken may be used. Consider the following before proceeding:

• Regenerating an API key will break Data Uploaders using it until API key in the uploader config file is updated.

• If using the maximum number of API keys, consider using the psToken instead of regenerating an API key or deleting then creating a new API key.

• If using a global API key, API actions will be limited to the workgroup used for the X-ILMN-Workgroup authorization.

If using an API key, it is retrieved from the Manage API Keys section of Connected Insights. Retrieve the API key as follows.

1. In Connected Insights, select the user icon next to Configuration, then select Manage API Keys.

2. In the Available authorizations window, enter the ApiKey prefix followed by the API key in the Value field (for example, ApiKey {APIkey value}), and then select Authorize.

If using a psToken, it is retrieved as follows:

1. In Connected Insights, right-click and select Inspect.

2. From the Inspect pane, navigate to the top toolbar and select Application.

3. In the Storage section, select Cookies, then select the menu option with the same name as the Connected Insights URL.

4. In the Name column, select psToken.

5. Copy the psToken value that displays at the bottom of the pane.

6. In another tab or window, go to the Swagger site. Select Authorize, then in the Available authorizations window, paste the psToken value in the Authorization (apiKey) field. No prefix is required before the psToken value.

7. Select Authorize.

Authorization (apiKey) (Connected Insights - Local) Connected Insights - Local uses an access token instead of an API key. This token is found in the metadata of the Connected Insights browser. Retrieve the access token as follows.

1. In Connected Insights, right-click and select Inspect.

2. From the Inspect pane, navigate to the top toolbar and select Application.

3. In the Storage section, select Local Storage.

4. In the Key column, select ias-access-token.

5. Copy the token value that displays at the bottom of the pane.

6. In the Available authorizations window, paste the token value in the Value field, and then select Authorize.

X-ILMN-Domain The domain name is retrieved from the URL.

For Connected Insights - Cloud, retrieve the domain name as follows:

1. Copy the domain name from the URL for Connected Insights (for example, https://{domain}.connectedinsights.illumina.com/). Note that only the domain name is needed, not the entire URL.

2. In the Available authorizations window, enter the domain name into the Value field, and then select Authorize.

For Connected Insights - Local, copy the DRAGEN server name from the Connected Insights URL (for example, https://{DRAGENHOSTNAME}.domainname).

X-ILMN-Workgroup The workgroup ID is found in the metadata of the Connected Insights browser. Retrieve the workgroup ID as follows.

1. In Connected Insights, right-click and select Inspect

2. On the Inspect pane at the right of the screen, navigate to the top ribbon and select Application. A pane opens to the left of the Inspect pane.

3. Navigate to the Storage section and select Cookies.

4. From the Name Column, select olympia-current-workgroup and copy the Cookie Value that displays at the bottom of the pane (for example, a1bc2efg-h3i4-567j-8901-k23l45mno6p7).

5. In the Available authorizations window, enter the workgroup ID into the Value field, and then select Authorize.