Connections

Validate transformation

Validate the provided transformation query and the parameters.

post/_api/transformations/validate

Request

Request body

collectionstring

Name of the GDN collection.

typestring

Connection type (source or target).

querystring

Transformation query.

Example request

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

Response

Successfully validated the transformation

errorboolean required
codeinteger
reasonstring

If invalid, reason for marking resource as invalid.

transformationstring

Funtional stream worker created to execute the query provided in the input.

transformationNamestring

Name of the stream worker for the transformation. This stream worker is created as a system stream worker.

temporaryCollectionstring

Name of the temporary collection to be used with the transformation. This collection is created as a system collection.

Example response

{
  "reason": "Incorrect username/password",
  "outputSchema": {
    "attributes": [
      {
        "name": "Name",
        "type": "string"
      }
    ]
  }
}

Changes

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