Swap workbook data sources

Swap the data sources used by a workbook. You can swap from one connection to another, and/or from one dataset to another.

Usage notes

  • Retrieve the workbookId by calling the /v2/workbooks endpoint.

  • Retrieve the connectionId by calling the /v2/connections endpoint.

  • To map the sources of a specific element, you can use the table or dataset ID:

    • Retrieve the fromId for a specific data element by calling the /v2/workbooks/{workbookId}/lineage/elements/{elementId} endpoint and using the source key from the response, which looks like inode-2PBoXx3UabchxF1F3l07kE. The ID is everything after inode-.
    • Retrieve table and dataset IDs by calling the /v2/files endpoint. Use the typeFilters option to filter for table and dataset files. Use id field in the response as the fromId or toId, as relevant.

Usage scenarios

  • Workbook development: Use a test data source while developing a workbook, then swap the source to the a production database when ready to share the workbook for production use.
Language
Authorization
OAuth2
URL
Click Try It! to start a request and see the response here!