Skip to main content
POST
/
api
/
query
/
migration
/
federated
/
v1
/
to
/
v2
/
{datasource-id}
/
accounts
/
{account-id}
cURL
curl 'https://{domo-domain}/api/query/migration/federated/v1/to/v2/{datasource-id}/accounts/{account-id}' \
  -X POST \
  -H 'content-type: application/json' \
  -H 'accept: application/json,*/*;q=0.8' \
  -H 'accept-language: en-US,en;q=0.9' \
  -H 'cache-control: max-age=0' \
  -H 'X-DOMO-Developer-Token: {developer-token}' \
  -d '{"catalog":"{catalog-name}","schema":"{schema-name}","table":"{table-name}"}'
{
  "toe": "DM4X9GT6H5-5ERQX-MPDO6",
  "datasourceId": "495e28ec-6c07-41fc-99ed-b2dce9a5f569",
  "direction": "V1_TO_V2",
  "startTime": "2024-04-15T19:48:00.073+00:00",
  "state": "COMPLETE",
  "errorMessage": null,
  "endTime": "2024-04-15T19:48:02.410+00:00"
}

Authorizations

​
X-DOMO-Developer-Token
string
header
required

Domo access token that you can generate in the admin panel from within your Domo instance.

Path Parameters

​
datasource-id
string
required

The unique ID of one of the Federated V1 datasources returned from the List Federated V1 Migration CandidateDatasources by Account API.

​
account-id
string
required

The unique ID of one of the Federated V2 accounts returned from the List Federated V2 Accounts by Integration Type API.

Body

application/json
​
catalog
string
required

Case-sensitive name of the catalog/database of the database table the Federated V1 datasource is referencing.

​
schema
string
required

Case-sensitive name of the schema of the database table the Federated V1 datasource is referencing. May be the literal 'NULL' if the database does not utilize schemas.

​
table
string
required

Case-sensitive name of the database table the Federated V1 datasource is referencing.

Response

200 - application/json

Successful response

​
toe
string

Unique identifier of the migration request.

​
datasourceId
string

Unique identifier of the datasource migration was requested for.

​
direction
enum<string>

Direction of the migration. Will be 'V1_TO_V2'.

Available options:
V1_TO_V2
​
startTime
string<date-time>

Starting date and time of the migration.

​
state
enum<string>

Final state of the migration, one of ["COMPLETE", "INCOMPLETE", "ABORTED"].

  • COMPLETE: Migration has completed successfully.
  • INCOMPLETE: Migration failed after some changes to the datasource were made. Domo content powered by the datasource may remain unavailable and/or non-functional until the migration is re-attempted and completes successfully. More information can be found in the 'errorMessage' property.
  • ABORTED: Migration was aborted prior to any changes being made to the datasource. More information can be found in the 'errorMessage' property.
Available options:
COMPLETE,
INCOMPLETE,
ABORTED
​
errorMessage
string | null

Message populated with additional details when a migration fails to complete normally or is aborted prior to starting.

​
endTime
string<date-time>

Timestamp indicating the end time of the migration.