Test A Datasource To Be Added
Test a new datasource. This is required to gather the datasource schema, tables and values to continue to the next stage of addition. This MUST be executed first when adding a new datasource
Path Parameters
The resourceSlug is a url parameter of the teamId associated with the user. Anywhere the resourceSlug is used can be interpreted as a teamId
Body
Task object to be added with at minimum all required fields, _id must be ommited, this will be generated by the api and returned upon successful completion.
The type of datasource being pulled from, the full list of supported sources and their corresponding in JSON format can be found at: 'https://connectors.airbyte.com/files/generated_reports/connector_registry_report.json'. One of these connectors must be selected as the type of datasource to pull from. Insert the Id of the connector in this field
Arbitary name for the datasource, this doesn't need to follow any specific convention, can simply be any name to identify it.
Description for the datasource, this is used when fetching the datasources on 'datasourcesJson' to briefly describe what each datasource is from/contains.
sourceConfig is defined by Airbyte to determine the config required to set up the datasource with Airbyte. See the docs at: 'https://reference.airbyte.com/reference/createsource' for more information. See the 'configuration' body params and find the source that you are using.
Used to indicate howoften the datasource is synced, this syncing is to ensure the data within Agent Cloud is synchronised with the data within the datasource. This is the period between each synchronisation. The specific number of each period is set later in the addition process (i.e. when using addDatasourceApi).
minute, hour, day, week, month Response
Server response
Error message to provide more detail
the error code
This return is mainly used for front end operations of Agent Cloud, it is an Airbyte object found here: 'https://airbyte-public-api-docs.s3.us-east-2.amazonaws.com/rapidoc-api-docs.html#post-/v1/sources/discover_schema'
This is an Airbyte object used to describe the stream between the datasource and Agent Cloud, it holds the properties of it, more information can be found on the Airbyte Reference here: 'https://reference.airbyte.com/reference/getstreamproperties'
When Airbyte creates the new source it creates a unique UUID for it for within Airbyte, this UUID is returned form Airbyte and also returned from this API call.