Preview schema change

curl --request POST \
  --url https://api.kadoa.com/v4/templates/{templateId}/preview-schema-change \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "workflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "targetVersion": 4503599627370496
}
'

import requests

url = "https://api.kadoa.com/v4/templates/{templateId}/preview-schema-change"

payload = {
    "workflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "targetVersion": 4503599627370496
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workflowId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    targetVersion: 4503599627370496
  })
};

fetch('https://api.kadoa.com/v4/templates/{templateId}/preview-schema-change', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kadoa.com/v4/templates/{templateId}/preview-schema-change",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'workflowId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'targetVersion' => 4503599627370496
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kadoa.com/v4/templates/{templateId}/preview-schema-change"

	payload := strings.NewReader("{\n  \"workflowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"targetVersion\": 4503599627370496\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.kadoa.com/v4/templates/{templateId}/preview-schema-change")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workflowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"targetVersion\": 4503599627370496\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kadoa.com/v4/templates/{templateId}/preview-schema-change")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workflowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"targetVersion\": 4503599627370496\n}"

response = http.request(request)
puts response.read_body

{
  "error": false,
  "data": {
    "workflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflowName": "<string>",
    "currentVersion": 4503599627370496,
    "targetVersion": 4503599627370496,
    "basis": "existing_data",
    "columns": [
      {
        "name": "<string>",
        "label": "<string>",
        "dataType": "<string>",
        "previousDataType": "<string>",
        "beforeValueSource": "observed",
        "afterValueSource": "observed",
        "status": "unchanged",
        "truncated": true
      }
    ],
    "beforeRows": [
      {}
    ],
    "rows": [
      {}
    ],
    "truncated": true
  }
}

{
  "error": true,
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": true,
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": true,
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": true,
  "message": "<string>",
  "details": "<unknown>"
}

POST

templates

{templateId}

preview-schema-change

Preview schema change

curl --request POST \
  --url https://api.kadoa.com/v4/templates/{templateId}/preview-schema-change \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "workflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "targetVersion": 4503599627370496
}
'

import requests

url = "https://api.kadoa.com/v4/templates/{templateId}/preview-schema-change"

payload = {
    "workflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "targetVersion": 4503599627370496
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workflowId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    targetVersion: 4503599627370496
  })
};

fetch('https://api.kadoa.com/v4/templates/{templateId}/preview-schema-change', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kadoa.com/v4/templates/{templateId}/preview-schema-change",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'workflowId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'targetVersion' => 4503599627370496
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kadoa.com/v4/templates/{templateId}/preview-schema-change"

	payload := strings.NewReader("{\n  \"workflowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"targetVersion\": 4503599627370496\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.kadoa.com/v4/templates/{templateId}/preview-schema-change")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workflowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"targetVersion\": 4503599627370496\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kadoa.com/v4/templates/{templateId}/preview-schema-change")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workflowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"targetVersion\": 4503599627370496\n}"

response = http.request(request)
puts response.read_body

{
  "error": false,
  "data": {
    "workflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflowName": "<string>",
    "currentVersion": 4503599627370496,
    "targetVersion": 4503599627370496,
    "basis": "existing_data",
    "columns": [
      {
        "name": "<string>",
        "label": "<string>",
        "dataType": "<string>",
        "previousDataType": "<string>",
        "beforeValueSource": "observed",
        "afterValueSource": "observed",
        "status": "unchanged",
        "truncated": true
      }
    ],
    "beforeRows": [
      {}
    ],
    "rows": [
      {}
    ],
    "truncated": true
  }
}

{
  "error": true,
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": true,
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": true,
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": true,
  "message": "<string>",
  "details": "<unknown>"
}

Authorizations

x-api-key

string

header

required

API key for authentication

Path Parameters

templateId

string<uuid>

required

Template ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Body

application/json

Body

Request body for previewing a schema change without applying it

workflowId

string<uuid>

required

Linked workflow to preview

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

targetVersion

integer

required

Template version to preview

Required range: 1 <= x <= 9007199254740991

Response

Read-only AI-generated preview of how a schema change affects one linked workflow's data

error

enum<boolean>

required

Error flag (always false on success)

Available options:

false

data

object

required

Show child attributes