MAmacrometa
Connections

Retrieve sample data from the data source

Retrieve sample data from the data source by supplying the connector configuration. The response includes both the schema and sample data.

post/_api/connectors/{connector-name}/sample

Request

Path parameters

connector-namestring required

Name of the connector.

Request body

typestring

Connector type. source or target.

configobject

Contains the connector configurations. Key-value pairs should be provided to configure the connection to the respective data source or target.

Example request

{
  "type": "source",
  "config": {
    "host": "db.postgres.com",
    "port": 5432,
    "username": "postgres",
    "password": "password"
  }
}

Response

Successfully retrieved the connnector sample.

errorboolean required
codeinteger

Example response

{
  "result": [
    {
      "schema": {
        "attributes": [
          {
            "name": "Name",
            "type": "string"
          }
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.