Connections

Generate transformed data preview

Generate a preview of the data after the transformation. The preview is generated based on a sample data set from the data source. You can use get connector sample API to retrieve a sample dataset from the data source.

post/_api/transformations/preview

Request

Request body

querystring

Transformation query.

dataobject[]

Sample dataset from the data source.

Example request

{
  "inputSchema": {
    "attributes": [
      {
        "name": "Name",
        "type": "string"
      }
    ]
  },
  "outputSchema": {
    "attributes": [
      {
        "name": "Name",
        "type": "string"
      }
    ]
  }
}

Response

Successfully generated the transformation preview.

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.