Post project workflow test

cURL

curl --request POST \
  --url https://app.teable.ai/api/base/%7BbaseId%7D/workflow/%7BworkflowId%7D/test/%7BnodeId%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"recordId":"string","sideEffect":true,"withDependency":true,"property1":null,"property2":null}'

const url = 'https://app.teable.ai/api/base/%7BbaseId%7D/workflow/%7BworkflowId%7D/test/%7BnodeId%7D';
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer REPLACE_BEARER_TOKEN',
    'content-type': 'application/json'
  },
  body: '{"recordId":"string","sideEffect":true,"withDependency":true,"property1":null,"property2":null}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

const http = require('https');

const options = {
  method: 'POST',
  hostname: 'app.teable.ai',
  port: null,
  path: '/api/base/%7BbaseId%7D/workflow/%7BworkflowId%7D/test/%7BnodeId%7D',
  headers: {
    Authorization: 'Bearer REPLACE_BEARER_TOKEN',
    'content-type': 'application/json'
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on('data', function (chunk) {
    chunks.push(chunk);
  });

  res.on('end', function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  recordId: 'string',
  sideEffect: true,
  withDependency: true,
  property1: null,
  property2: null
}));
req.end();

import http.client

conn = http.client.HTTPSConnection("app.teable.ai")

payload = "{\"recordId\":\"string\",\"sideEffect\":true,\"withDependency\":true,\"property1\":null,\"property2\":null}"

headers = {
    'Authorization': "Bearer REPLACE_BEARER_TOKEN",
    'content-type': "application/json"
}

conn.request("POST", "/api/base/%7BbaseId%7D/workflow/%7BworkflowId%7D/test/%7BnodeId%7D", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.teable.ai/api/base/{baseId}/workflow/{workflowId}/test/{nodeId}",
  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([
    'recordId' => '<string>',
    'sideEffect' => true,
    'withDependency' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://app.teable.ai/api/base/{baseId}/workflow/{workflowId}/test/{nodeId}"

	payload := strings.NewReader("{\n  \"recordId\": \"<string>\",\n  \"sideEffect\": true,\n  \"withDependency\": true\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://app.teable.ai/api/base/{baseId}/workflow/{workflowId}/test/{nodeId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recordId\": \"<string>\",\n  \"sideEffect\": true,\n  \"withDependency\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.teable.ai/api/base/{baseId}/workflow/{workflowId}/test/{nodeId}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"recordId\": \"<string>\",\n  \"sideEffect\": true,\n  \"withDependency\": true\n}"

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

{
  "createdTime": "<string>",
  "spent": 123,
  "inputRaw": null,
  "outputRaw": null,
  "inputVariables": {},
  "outputVariables": {},
  "errorMsg": "<string>"
}

POST

base

{baseId}

workflow

{workflowId}

test

{nodeId}

cURL

curl --request POST \
  --url https://app.teable.ai/api/base/%7BbaseId%7D/workflow/%7BworkflowId%7D/test/%7BnodeId%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"recordId":"string","sideEffect":true,"withDependency":true,"property1":null,"property2":null}'

const url = 'https://app.teable.ai/api/base/%7BbaseId%7D/workflow/%7BworkflowId%7D/test/%7BnodeId%7D';
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer REPLACE_BEARER_TOKEN',
    'content-type': 'application/json'
  },
  body: '{"recordId":"string","sideEffect":true,"withDependency":true,"property1":null,"property2":null}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

const http = require('https');

const options = {
  method: 'POST',
  hostname: 'app.teable.ai',
  port: null,
  path: '/api/base/%7BbaseId%7D/workflow/%7BworkflowId%7D/test/%7BnodeId%7D',
  headers: {
    Authorization: 'Bearer REPLACE_BEARER_TOKEN',
    'content-type': 'application/json'
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on('data', function (chunk) {
    chunks.push(chunk);
  });

  res.on('end', function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  recordId: 'string',
  sideEffect: true,
  withDependency: true,
  property1: null,
  property2: null
}));
req.end();

import http.client

conn = http.client.HTTPSConnection("app.teable.ai")

payload = "{\"recordId\":\"string\",\"sideEffect\":true,\"withDependency\":true,\"property1\":null,\"property2\":null}"

headers = {
    'Authorization': "Bearer REPLACE_BEARER_TOKEN",
    'content-type': "application/json"
}

conn.request("POST", "/api/base/%7BbaseId%7D/workflow/%7BworkflowId%7D/test/%7BnodeId%7D", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.teable.ai/api/base/{baseId}/workflow/{workflowId}/test/{nodeId}",
  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([
    'recordId' => '<string>',
    'sideEffect' => true,
    'withDependency' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://app.teable.ai/api/base/{baseId}/workflow/{workflowId}/test/{nodeId}"

	payload := strings.NewReader("{\n  \"recordId\": \"<string>\",\n  \"sideEffect\": true,\n  \"withDependency\": true\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://app.teable.ai/api/base/{baseId}/workflow/{workflowId}/test/{nodeId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recordId\": \"<string>\",\n  \"sideEffect\": true,\n  \"withDependency\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.teable.ai/api/base/{baseId}/workflow/{workflowId}/test/{nodeId}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"recordId\": \"<string>\",\n  \"sideEffect\": true,\n  \"withDependency\": true\n}"

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

{
  "createdTime": "<string>",
  "spent": 123,
  "inputRaw": null,
  "outputRaw": null,
  "inputVariables": {},
  "outputVariables": {},
  "errorMsg": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

baseId

string

required

workflowId

string

required

nodeId

string

required

Body

application/json

recordId

string

the record id to test

sideEffect

boolean

whether to test with side effect

withDependency

boolean

whether to test with dependency

{key}

unknown

Response

200 - application/json

Successful updated

createdTime

string

required

spent

number

spent time

inputRaw

unknown

outputRaw

unknown

inputVariables

object

The variables snapshot when executed

outputVariables

object

The variables snapshot when executed

errorMsg

string

Getting Started

Records

API Reference

Post project workflow test

Authorizations

Path Parameters

Body

Response