Edit Schedule In Datasource - This is marked as Uncomplete

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

resourceSlug

string

required

The resourceSlug is a url parameter of the teamId associated with the user. Anywhere the resourceSlug is used can be interpreted as a teamId Mongodb Object id, unique identifier, length of 24 characters fitting the following regex; [a-f0-9]{24}

Query Parameters

datasource

object

required

Datasource object that was created when testDatasourceApi is run, must include datasourceId. Represents a data source configuration within the system, including connection details, status, chunking configurations, and record counts.

Show child attributes

datasource.name

string

required

The name of the datasource.

datasource.originalName

string

required

The original name of the datasource.

datasource.sourceType

string

required

The type of source for the datasource.

datasource.sourceId

string

required

The identifier of the data source.

datasource.destinationId

string

required

The identifier of the data destination.

datasource.workspaceId

string

required

The identifier of the workspace associated with the datasource.

datasource.connectionId

string

required

The identifier of the connection associated with the datasource.

datasource.createdDate

string<date-time>

required

The date and time when the datasource was created.

datasource._id

string

Unique identifier for the datasource.

datasource.orgId

string

Identifier of the organization to which the datasource belongs.

datasource.teamId

string

Identifier of the team to which the datasource belongs.

datasource.description

string

Optional description of the datasource.

datasource.filename

string | null

The name of the file associated with the datasource, if applicable.

datasource.recordCount

object

The record count details for the datasource, including total, successful, and failed records.

Show child attributes

datasource.recordCount.total

integer<int32>

The total number of records processed.

datasource.recordCount.success

integer<int32>

The number of successfully processed records.

datasource.recordCount.failure

integer<int32>

The number of records that failed to process.

datasource.connectionSettings

object

Configuration settings for the datasource connection.

Show child attributes

datasource.connectionSettings.prefix

string | null

required

Optional prefix to be added to the destination's namespace. Can be null.

datasource.connectionSettings.name

string

required

The name of the datasource connection.

datasource.connectionSettings.sourceId

string

required

The identifier of the data source.

datasource.connectionSettings.destinationId

string

required

The identifier of the data destination.

datasource.connectionSettings.status

string

required

The status of the datasource connection. This should match the enum values defined by the Airbyte API and should allow creation in a paused state.

datasource.connectionSettings.configurations

object

required

Configuration settings for the datasource connection. Structure is dependent on the datasource type.

datasource.connectionSettings.nonBreakingSchemaUpdatesBehavior

string

required

Specifies the behavior for handling non-breaking schema updates.

datasource.connectionSettings.schedule

object

Scheduling information for the datasource connection.

Show child attributes

datasource.connectionSettings.schedule.scheduleType

enum<string>

The type of schedule for the datasource connection.

Available options:

cron,

manual

datasource.connectionSettings.schedule.cronExpression

string | null

The CRON expression for scheduling, required if the schedule type is 'cron'.

datasource.connectionSettings.dataResidency

string | null

Specifies where the data should be stored geographically.

datasource.connectionSettings.namespaceDefinition

string | null

Defines how the namespace should be determined for the data.

datasource.connectionSettings.namespaceFormat

string | null

The format of the namespace, can be null if not applicable.

datasource.lastSyncedDate

string<date-time> | null

The date and time when the datasource was last synced. Null indicates it has never been synced.

datasource.status

enum<string>

The current status of the datasource.

Available options:

draft,

processing,

embedding,

ready

datasource.discoveredSchema

object

Schema discovered during the data source connection. The structure depends on the source type.

datasource.chunkingConfig

object

Configuration settings for chunking unstructured data, including partitioning and chunking strategies, character limits, and similarity thresholds.

Show child attributes

datasource.chunkingConfig.partitioning

enum<string>

required

The partitioning strategy used for unstructured data.

Available options:

auto,

fast,

hi_res,

ocr_only

datasource.chunkingConfig.strategy

enum<string>

required

The chunking strategy used for unstructured data.

Available options:

basic,

by_title,

by_page,

by_similarity

datasource.chunkingConfig.max_characters

integer<int32>

required

The maximum number of characters allowed per chunk.

datasource.chunkingConfig.new_after_n_chars

integer<int32>

required

The number of characters after which a new chunk is created.

datasource.chunkingConfig.overlap

integer<int32>

required

The number of characters to overlap between chunks.

datasource.chunkingConfig.similarity_threshold

number<float>

required

Threshold for similarity when chunking by similarity, with a value between 0.0 and 1.0.

Required range: 0 <= x <= 1

datasource.chunkingConfig.overlap_all

boolean

required

Indicates whether to apply overlap to all chunks or only between adjacent chunks.

datasource.embeddingField

string

The field used for embedding within the datasource.

datasource.timeWeightField

string

The field used to apply time weighting within the datasource.

datasource.modelId

string

Identifier of the embedding model used, if applicable.

datasource.hidden

boolean

Indicates whether the datasource is hidden from standard views.

datasource.streamConfig

object

Configuration settings for processing streams of data, breaking them into smaller chunks for more manageable processing.

Show child attributes

datasource.streamConfig.{key}

object

Configuration settings for a specific stream, used to break down large volumes of data into smaller, manageable chunks for processing.

Show child attributes

datasource.streamConfig.{key}.checkedChildren

string[]

required

List of child stream identifiers that are checked for inclusion in the sync.

datasource.streamConfig.{key}.primaryKey

string[]

required

List of fields that make up the primary key for the stream.

datasource.streamConfig.{key}.syncMode

string

required

The synchronization mode used for the stream.

datasource.streamConfig.{key}.cursorField

string[]

required

List of fields that act as the cursor for incremental syncs.

datasource.streamConfig.{key}.descriptionsMap

object

required

A map of field names to their descriptions.

Show child attributes

datasource.streamConfig.{key}.descriptionsMap.{key}

object

Provides details about a specific field, including its description and type.

Show child attributes

datasource.streamConfig.{key}.descriptionsMap.{key}.description

string

required

A textual description of the field.

datasource.streamConfig.{key}.descriptionsMap.{key}.type

string

required

The data type of the field.

datasource.timeUnit

string

A temporary field to limit CRON frequency based on the plan. This will be replaced with a more robust solution in the future.

Response

Successful operation, redirect to '/{resourceSlug}/datasources'. Returns added toolId in return body

Server response after successsfully adding a new object

_id

string

The unique Mongo id of the newly inserted object.

redirect

string

a string containing the redirect link to get all objects after a successful insertion.

Reference

Authorizations

Path Parameters

Query Parameters

Response