Skip to navigation
Sigma REST APITemplates

Swap template data sources

View as Markdown

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

Usage notes

  • Retrieve the templateId by calling the /v2/templates endpoint.

  • Retrieve the connectionId to use as the toId 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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

templateIdstringRequired
Template ID

Request

The request body.
sourceMappinglist of objectsOptional
connectionMappinglist of objectsOptional
copyInputTableDatabooleanOptional

Response

The response body.
unswappedSourceslist of strings
IDs of sources in the workbook that were not swapped.
unswappedConnectionslist of strings
IDs of custom SQL connections in the workbook that were not swapped.