Migrate a dashboards to a new connection

Retrieve the dashboard ID

The first step is to retrieve the dashboard’s unique ID. You can do this by:

Using the dashboard’s URL. The string after /dashboards is the dashboard’s ID; for example: https://blobsrus.omniapp.co/dashboards/1c5e3040
Opening the document settings. Navigate to File > Document settings. The Identifier field contains the dashboard ID:

Export the dashboard

Next, you’ll use the Export a dashboard API to export the dashboard you want to migrate. Use the following as a template for your GET request:

Template for GET /api/unstable/documents/:dashboardId/export

curl -L 'https://<YOUR_OMNI_ORG>.omniapp.co/api/unstable/documents/<DASHBOARD_ID>/export' \
-H 'Authorization: Bearer <YOUR_API_TOKEN>' \
-H 'Content-Type: application/json'

For example, the following request is for the blobsrus organization and exports the 1c5e3040 dashboard:

GET /api/unstable/documents/:dashboardId/export

curl -L 'https://blobsrus.omniapp.co/api/unstable/documents/1c5e3040/export' \
-H 'Authorization: Bearer <TOKEN>' \
-H 'Content-Type: application/json'

A successful request will return a JSON object with the following structure:

Successful response

{
  "dashboard": {...},           // Contains details about the dashboard; truncated for simplicity
  "document": {...},
  "exportVersion": "0.1",
  "workbookModel": {...},
  "fileUploads": [...]          // Spreadsheet file data, if the dashboard contains spreadsheet tiles
}

If the dashboard contains spreadsheet tiles, the response will include a fileUploads array with the spreadsheet file data. This data is automatically included in the export and is restored when you import the dashboard.Copy the response into a text editor, as you’ll be editing it in the next step.

Retrieve the new model ID

The next step is to retrieve the ID for the model that the new dashboard should be built on.

In Omni, navigate to Settings > Model and click the model to open it in the IDE.
Locate the string between /models/ and /ide in the URL:
https://blobsrus.omniapp.co/models/d37d0698-4558-41aa-b7f7-66ff85e89e9d/ide
In this example, the model ID is d37d0698-4558-41aa-b7f7-66ff85e89e9d.

Add a baseModelId property to the response body from step 2 of this guide. Replace the value with the ID of the new model:

"baseModelId": "<NEW_MODEL_ID>",

The updated JSON should have the following structure:

Example model ID

{
  "baseModelId": "d37d0698-4558-41aa-b7f7-66ff85e89e9d",
  "dashboard": {...},
  "document": {...},
  "exportVersion": "0.1",
  "workbookModel": {...}
}

Import the new dashboard

The last step is to use the API to import the dashboard . Start by using the following template to set up the API request:

Template for POST /api/unstable/documents/import

curl -L -X POST 'https://<YOUR_OMNI_ORG>.omniapp.co/api/unstable/documents/import' \
-H 'Authorization: Bearer <YOUR_API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
   <UPDATED_JSON_FROM_STEP_3>
}'

Replace <UPDATED_JSON_FROM_STEP_3> with the modified JSON from the previous step. Your request should look something like this:

POST /api/unstable/documents/import

curl -L -X POST 'https://blobsrus.omniapp.co/api/unstable/documents/import' \
-H 'Authorization: Bearer <TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
  "baseModelId": "d37d0698-4558-41aa-b7f7-66ff85e89e9d",
  "dashboard": {...},
  "document": {...},
  "exportVersion": "0.1",
  "workbookModel": {...},
  "fileUploads": [...]
}'

If the export response includes a fileUploads array, include it in your import request to restore any spreadsheet tiles. The spreadsheet file data will be uploaded and linked to the imported dashboard automatically.A successful request will return a JSON object similar to the following: