patch
Overview
This endpoint is used for updating information about a dataset's tables.
HTTP Request
PATCH /api/v1/workflows/:workflowReference/dataSources/:dataSourceReference
Path parameters
workflowReference
A qualified reference to the workflow. See referencing resources for more information.
dataSourceReference
A qualified reference to the dataSource's current source dataset or workflow.
Alternatively, can provide the id
of the dataSource.
Request body
Provide a JSON object with information about the dataSource.
sourceDataset
string
A qualified reference to the (new) source dataset for this dataSource.
Include version / sample information in the reference to update a dataSource's version or sample status.
Either a sourceDataset or sourceWorkflow must be provided, but not both.
sourceWorkflow
string
A qualified reference to the (new) source workflow for this dataSource.
Either a sourceDataset or sourceWorkflow must be provided, but not both.
mappedTables
object
An object whose keys represent the current tables that are referenced on the dataSource, and whose values represent the corresponding tables in the new source dataset or workflow. E.g.,
# Reference id suffixes are optional, but take precedence over names
{ "old_table:xje9": "new_table:a842" }
In many circumstances, tables can be automatically mapped based on their name and identifier, and this parameter isn't needed. However, if a previously-referenced table doesn't exist under the new data source – e.g., a table is deleted in subsequent versions – you'll need to provide information so that any downstream notebooks or transforms can be updates. It is only necessary to map tables that are referenced by a downstream node, not all tables associated with the dataSource.
Authorization
Edit access to the corresponding dataset is required. Your access token must have the following scope:
workflow.write
Learn more about authorization.
Response body
Returns the JSON-encoded "get" representation of a dataSource resource.
Last updated
Was this helpful?