Create Dataset Source

Create a new DatasetSource.

  • dataset_id (str): Required, ID of the dataset. The dataset must already exist.
  • source_id (UUID): Required, 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.
  • created_at (datetime or None): Optional, Timestamp when the data source was created.
  • updated_at (datetime or None): Optional, Timestamp when the data source was last updated.
  • 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…

Creates a dataset source, the link that tells SUPERWISE which data to pull from a source into a dataset. The dataset and the source must already exist. Set a bucket folder or a query to choose the data, and an ingest_type of insert, the default, or update.

When to use it

Use it after you create a source and a dataset, to start pulling data from that source into the dataset.

Required parameters

  • dataset_id (body): the ID of the dataset. The dataset must already exist.
  • source_id (body): the ID of the source. The source must already exist.

Optional body fields: folder, query, created_at, updated_at, ingest_type, increment_field_type, increment_field_name, table_name, data_retrieval_cron_expression, increment_field_last_value.

Response

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

Related: Create a source, Create a dataset, List dataset sources, Update a dataset source

Body Params
string
required
uuid
required
string
enum
Defaults to insert
Allowed:
IncrementFieldType | null
Responses

422

Unprocessable Entity

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