Skip to main content
POST
/
api
/
datawarehouse
/
v1
/
connection
/
{connection_id}
/
upload
/
{upload_id}
/
table-constraints
IngestTableConstraints
curl --request POST \
  --url https://developer.synq.io/api/datawarehouse/v1/connection/{connection_id}/upload/{upload_id}/table-constraints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "stateAt": "2023-11-07T05:31:56Z",
  "tableConstraints": [
    {
      "constraints": [
        {
          "name": "<string>",
          "type": "<string>",
          "columns": [
            "<string>"
          ],
          "foreignKeyTarget": {
            "objectName": "<string>",
            "instanceName": "<string>",
            "databaseName": "<string>",
            "schemaName": "<string>"
          },
          "foreignKeyTargetColumns": [
            "<string>"
          ],
          "indexType": "<string>",
          "expression": "<string>",
          "isUnique": true,
          "isEnforced": true
        }
      ]
    }
  ]
}
'
import requests

url = "https://developer.synq.io/api/datawarehouse/v1/connection/{connection_id}/upload/{upload_id}/table-constraints"

payload = {
    "stateAt": "2023-11-07T05:31:56Z",
    "tableConstraints": [{ "constraints": [
                {
                    "name": "<string>",
                    "type": "<string>",
                    "columns": ["<string>"],
                    "foreignKeyTarget": {
                        "objectName": "<string>",
                        "instanceName": "<string>",
                        "databaseName": "<string>",
                        "schemaName": "<string>"
                    },
                    "foreignKeyTargetColumns": ["<string>"],
                    "indexType": "<string>",
                    "expression": "<string>",
                    "isUnique": True,
                    "isEnforced": True
                }
            ] }]
}
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({
    stateAt: '2023-11-07T05:31:56Z',
    tableConstraints: [
      {
        constraints: [
          {
            name: '<string>',
            type: '<string>',
            columns: ['<string>'],
            foreignKeyTarget: {
              objectName: '<string>',
              instanceName: '<string>',
              databaseName: '<string>',
              schemaName: '<string>'
            },
            foreignKeyTargetColumns: ['<string>'],
            indexType: '<string>',
            expression: '<string>',
            isUnique: true,
            isEnforced: true
          }
        ]
      }
    ]
  })
};

fetch('https://developer.synq.io/api/datawarehouse/v1/connection/{connection_id}/upload/{upload_id}/table-constraints', 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/datawarehouse/v1/connection/{connection_id}/upload/{upload_id}/table-constraints",
  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([
    'stateAt' => '2023-11-07T05:31:56Z',
    'tableConstraints' => [
        [
                'constraints' => [
                                [
                                                                'name' => '<string>',
                                                                'type' => '<string>',
                                                                'columns' => [
                                                                                                                                '<string>'
                                                                ],
                                                                'foreignKeyTarget' => [
                                                                                                                                'objectName' => '<string>',
                                                                                                                                'instanceName' => '<string>',
                                                                                                                                'databaseName' => '<string>',
                                                                                                                                'schemaName' => '<string>'
                                                                ],
                                                                'foreignKeyTargetColumns' => [
                                                                                                                                '<string>'
                                                                ],
                                                                'indexType' => '<string>',
                                                                'expression' => '<string>',
                                                                'isUnique' => true,
                                                                'isEnforced' => 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://developer.synq.io/api/datawarehouse/v1/connection/{connection_id}/upload/{upload_id}/table-constraints"

	payload := strings.NewReader("{\n  \"stateAt\": \"2023-11-07T05:31:56Z\",\n  \"tableConstraints\": [\n    {\n      \"constraints\": [\n        {\n          \"name\": \"<string>\",\n          \"type\": \"<string>\",\n          \"columns\": [\n            \"<string>\"\n          ],\n          \"foreignKeyTarget\": {\n            \"objectName\": \"<string>\",\n            \"instanceName\": \"<string>\",\n            \"databaseName\": \"<string>\",\n            \"schemaName\": \"<string>\"\n          },\n          \"foreignKeyTargetColumns\": [\n            \"<string>\"\n          ],\n          \"indexType\": \"<string>\",\n          \"expression\": \"<string>\",\n          \"isUnique\": true,\n          \"isEnforced\": true\n        }\n      ]\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/datawarehouse/v1/connection/{connection_id}/upload/{upload_id}/table-constraints")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"stateAt\": \"2023-11-07T05:31:56Z\",\n  \"tableConstraints\": [\n    {\n      \"constraints\": [\n        {\n          \"name\": \"<string>\",\n          \"type\": \"<string>\",\n          \"columns\": [\n            \"<string>\"\n          ],\n          \"foreignKeyTarget\": {\n            \"objectName\": \"<string>\",\n            \"instanceName\": \"<string>\",\n            \"databaseName\": \"<string>\",\n            \"schemaName\": \"<string>\"\n          },\n          \"foreignKeyTargetColumns\": [\n            \"<string>\"\n          ],\n          \"indexType\": \"<string>\",\n          \"expression\": \"<string>\",\n          \"isUnique\": true,\n          \"isEnforced\": true\n        }\n      ]\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/datawarehouse/v1/connection/{connection_id}/upload/{upload_id}/table-constraints")

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  \"stateAt\": \"2023-11-07T05:31:56Z\",\n  \"tableConstraints\": [\n    {\n      \"constraints\": [\n        {\n          \"name\": \"<string>\",\n          \"type\": \"<string>\",\n          \"columns\": [\n            \"<string>\"\n          ],\n          \"foreignKeyTarget\": {\n            \"objectName\": \"<string>\",\n            \"instanceName\": \"<string>\",\n            \"databaseName\": \"<string>\",\n            \"schemaName\": \"<string>\"\n          },\n          \"foreignKeyTargetColumns\": [\n            \"<string>\"\n          ],\n          \"indexType\": \"<string>\",\n          \"expression\": \"<string>\",\n          \"isUnique\": true,\n          \"isEnforced\": true\n        }\n      ]\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.

Path Parameters

​
connection_id
string
required
​
upload_id
string<uuid>
required

Body

application/json
​
stateAt
string<date-time>
required

Time at which state was collected timestamp.gt = 2022-01-01T00:00:00Z timestamp.gt_lt = 2022-01-01T00:00:00Z timestamp.gt_lt_exclusive = 2022-01-01T00:00:00Z timestamp.gt_lte = 2022-01-01T00:00:00Z timestamp.gt_lte_exclusive = 2022-01-01T00:00:00Z timestamp.lt_now = true

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"

​
tableConstraints
TableConstraints · object[]

Response

200 - application/json

Success

The response is of type IngestTableConstraintsResponse · object.