Skip to main content
POST
/
api
/
agent
/
recon
/
v1
/
yaml
/
parse
ParseYaml
curl --request POST \
  --url https://developer.synq.io/api/agent/recon/v1/yaml/parse \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "yaml": "<string>"
}
'
import requests

url = "https://developer.synq.io/api/agent/recon/v1/yaml/parse"

payload = { "yaml": "<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({yaml: '<string>'})
};

fetch('https://developer.synq.io/api/agent/recon/v1/yaml/parse', 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/agent/recon/v1/yaml/parse",
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([
'yaml' => '<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/agent/recon/v1/yaml/parse"

payload := strings.NewReader("{\n \"yaml\": \"<string>\"\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/agent/recon/v1/yaml/parse")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"yaml\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/agent/recon/v1/yaml/parse")

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 \"yaml\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "suite": {
    "name": "<string>",
    "title": "<string>",
    "description": "<string>",
    "reconciliations": [
      {
        "name": "<string>",
        "source": {
          "connection": "<string>",
          "query": "<string>",
          "asOf": "<string>"
        },
        "target": {
          "connection": "<string>",
          "query": "<string>",
          "asOf": "<string>"
        },
        "title": "<string>",
        "description": "<string>",
        "keyColumn": "<string>",
        "keyColumns": [
          "<string>"
        ],
        "columnMapping": [
          {
            "source": "<string>",
            "target": "<string>"
          }
        ],
        "caseInsensitive": true,
        "bisection": {
          "enabled": true,
          "factor": 513,
          "threshold": 2,
          "timeColumn": "<string>"
        },
        "reporting": {
          "sampleLimit": 2,
          "consentAcknowledged": true
        },
        "aggregate": {
          "measures": [
            {
              "column": "<string>",
              "functions": []
            }
          ],
          "thresholds": {
            "absolute": 1,
            "percentage": 1,
            "perColumn": [
              {
                "column": "<string>",
                "thresholds": "<unknown>"
              }
            ],
            "perMeasure": [
              {
                "column": "<string>",
                "thresholds": "<unknown>"
              }
            ]
          },
          "groupColumns": [
            "<string>"
          ]
        },
        "errorHandling": {
          "queryTimeout": "<string>",
          "maxRetries": 5,
          "retryInitialDelay": "<string>",
          "retryBackoffFactor": 2
        },
        "window": {
          "lookback": "<string>",
          "column": "<string>"
        },
        "setup": [
          {
            "connection": "<string>",
            "queries": [
              "<string>"
            ]
          }
        ],
        "teardown": [
          {
            "connection": "<string>",
            "queries": [
              "<string>"
            ]
          }
        ],
        "teardownOnFailure": true,
        "ignoreSetupErrors": true,
        "cutoff": {
          "source": {
            "column": "<string>",
            "query": "<string>"
          },
          "target": {
            "column": "<string>",
            "query": "<string>"
          },
          "offset": "<string>",
          "applySource": {
            "column": "<string>",
            "operator": "<string>"
          },
          "applyTarget": {
            "column": "<string>",
            "operator": "<string>"
          }
        },
        "annotations": [
          {
            "name": "<string>",
            "values": [
              "<string>"
            ]
          }
        ]
      }
    ],
    "setup": [
      {
        "connection": "<string>",
        "queries": [
          "<string>"
        ]
      }
    ],
    "teardown": [
      {
        "connection": "<string>",
        "queries": [
          "<string>"
        ]
      }
    ],
    "teardownOnFailure": true,
    "ignoreSetupErrors": true,
    "variables": {},
    "strictTimeReferences": true,
    "annotations": [
      {
        "name": "<string>",
        "values": [
          "<string>"
        ]
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
yaml
string

YAML config string to parse.

Response

200 - application/json

Success

suite
ReconcilationSuite · object

The parsed suite configuration.