Skip to main content
GET
/
api
/
query
/
migration
/
candidates
/
federated
/
to
/
amplifier
/
integrations
/
{integration-id}
cURL
curl 'https://{domo-domain}/api/query/migration/candidates/federated/to/amplifier/integrations/{integration-id}' \
  -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}'
[
  {
    "id": "8c487fef-b62d-486f-af7a-90c7d6ee0347",
    "name": "Federated BigQuery fifty_row_table",
    "type": "bigquery-federated",
    "catalogName": "my-project",
    "schemaName": "my-schema",
    "tableName": "fifty_row_table",
    "collision": false,
    "collidingDatasourceId": null,
    "collidingDatasourceName": null,
    "migrated": false,
    "migrationDate": null
  }
]

Authorizations

X-DOMO-Developer-Token
string
header
required

Domo access token generated from the admin panel

Path Parameters

integration-id
string<uuid>
required

The unique ID of the Cloud Amplifier integration to list migration candidates for.

Response

200 - application/json

Successful response

id
string<uuid>

Unique identifier of the datasource.

name
string

Readable name of the datasource.

type
string

Type of the datasource.

catalogName
string

Name of the catalog (or equivalent) of the datasource in the system external to Domo.

schemaName
string

Name of the schema (or equivalent) of the datasource in the system external to Domo.

tableName
string

Name of the table (or equivalent) of the datasource in the system external to Domo.

collision
boolean

Boolean indicating whether a different datasource matching this candidate's catalog/schema/table name combination already exists in the destination Cloud Amplifier integration. If true, this indicates that attempting to migrate the candidate datasource will fail and that Domo content associated with the candidate datasource need to be migrated to the colliding datasource.

collidingDatasourceId
string<uuid> | null

Unique identifier of the datasource colliding with this candidate datasource. Usually null.

collidingDatasourceName
string | null

Readable name of the datasource colliding with this candidate datasource. Usually null.

migrated
boolean

Boolean indicating whether the datasource has been previously migrated to the Cloud Amplifier integration.

migrationDate
string<date-time> | null

Date indicating when the datasource was previously migrated to the Cloud Amplifier integration.