Skip to main content
POST
/
api
/
datachecks
/
testsuggestions
/
v1
BatchCreateTestSuggestions
curl --request POST \
  --url https://developer.synq.io/api/datachecks/testsuggestions/v1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "suggestions": [
    {
      "identifier": {
        "airflowDag": {
          "integrationId": "<string>",
          "dagId": "<string>"
        }
      },
      "explanation": "<string>",
      "acceptedValuesTest": {
        "columnName": "<string>",
        "acceptedValues": [
          "<string>"
        ]
      },
      "entitySynqPath": "<string>",
      "id": "<string>"
    }
  ]
}
'
import requests

url = "https://developer.synq.io/api/datachecks/testsuggestions/v1"

payload = { "suggestions": [
{
"identifier": { "airflowDag": {
"integrationId": "<string>",
"dagId": "<string>"
} },
"explanation": "<string>",
"acceptedValuesTest": {
"columnName": "<string>",
"acceptedValues": ["<string>"]
},
"entitySynqPath": "<string>",
"id": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
suggestions: [
{
identifier: {airflowDag: {integrationId: '<string>', dagId: '<string>'}},
explanation: '<string>',
acceptedValuesTest: {columnName: '<string>', acceptedValues: ['<string>']},
entitySynqPath: '<string>',
id: '<string>'
}
]
})
};

fetch('https://developer.synq.io/api/datachecks/testsuggestions/v1', 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://developer.synq.io/api/datachecks/testsuggestions/v1",
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([
'suggestions' => [
[
'identifier' => [
'airflowDag' => [
'integrationId' => '<string>',
'dagId' => '<string>'
]
],
'explanation' => '<string>',
'acceptedValuesTest' => [
'columnName' => '<string>',
'acceptedValues' => [
'<string>'
]
],
'entitySynqPath' => '<string>',
'id' => '<string>'
]
]
]),
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://developer.synq.io/api/datachecks/testsuggestions/v1"

payload := strings.NewReader("{\n \"suggestions\": [\n {\n \"identifier\": {\n \"airflowDag\": {\n \"integrationId\": \"<string>\",\n \"dagId\": \"<string>\"\n }\n },\n \"explanation\": \"<string>\",\n \"acceptedValuesTest\": {\n \"columnName\": \"<string>\",\n \"acceptedValues\": [\n \"<string>\"\n ]\n },\n \"entitySynqPath\": \"<string>\",\n \"id\": \"<string>\"\n }\n ]\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://developer.synq.io/api/datachecks/testsuggestions/v1")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"suggestions\": [\n {\n \"identifier\": {\n \"airflowDag\": {\n \"integrationId\": \"<string>\",\n \"dagId\": \"<string>\"\n }\n },\n \"explanation\": \"<string>\",\n \"acceptedValuesTest\": {\n \"columnName\": \"<string>\",\n \"acceptedValues\": [\n \"<string>\"\n ]\n },\n \"entitySynqPath\": \"<string>\",\n \"id\": \"<string>\"\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/datachecks/testsuggestions/v1")

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 \"suggestions\": [\n {\n \"identifier\": {\n \"airflowDag\": {\n \"integrationId\": \"<string>\",\n \"dagId\": \"<string>\"\n }\n },\n \"explanation\": \"<string>\",\n \"acceptedValuesTest\": {\n \"columnName\": \"<string>\",\n \"acceptedValues\": [\n \"<string>\"\n ]\n },\n \"entitySynqPath\": \"<string>\",\n \"id\": \"<string>\"\n }\n ]\n}"

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

Authorizations

Authorization
string
header
required

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

Body

application/json
suggestions
TestSuggestion · object[]

Test types that can be suggested

Response

200 - application/json

Success

The response is of type BatchCreateTestSuggestionsResponse · object.