Update Dataset Source

Update an existing DatasetSource.

  • id (str): Optional, ID of the dataset source.
  • dataset_id (str): Optional, ID of the dataset. The dataset must already exist.
  • source_id (UUID): Optional, Unique Identifier(UUID) of the source data. The source must already exist.
  • folder (str or None): Optional, Path within the bucket to ingest data from.
  • query (str or None): Optional, Query statement to retrieve data.
  • ingest_type (IngestType): Optional, Type of data ingestion. Default is IngestType.INSERT.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Updates an existing dataset source. You can change its dataset, source, bucket folder, query, or ingest_type. The dataset and source you name must already exist.

When to use it

Use it to point a dataset at a different folder or query, or to switch between insert and update ingestion.

Required parameters

  • dataset_source_id (path): the ID of the dataset source.

Optional body fields: id, dataset_id, source_id, folder, query, ingest_type, created_by, increment_field_last_value.

Response

A successful call returns 200 OK with the DatasetSourceResponse object: id, source_id, internal_dataset_id, ingest_type, folder or query, and the incremental and schedule settings.

Related: Get a dataset source, Create a dataset source, Delete a dataset source

Path Params
uuid
required
Body Params
IngestType | null
Responses

404

Not Found

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json