Skip to main content
POST
/
api
/
entities
/
custom
/
v1
/
entities
UpsertEntity
curl --request POST \
  --url https://developer.synq.io/api/entities/custom/v1/entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity": {
    "id": {
      "airflowDag": {
        "integrationId": "<string>",
        "dagId": "<string>"
      }
    },
    "name": "<string>",
    "workspace": "<string>",
    "typeId": 500,
    "description": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "synqPath": "<string>",
    "synqCatalogUrl": "<string>",
    "ids": [
      {
        "airflowDag": {
          "integrationId": "<string>",
          "dagId": "<string>"
        }
      }
    ],
    "synqPaths": [
      "<string>"
    ],
    "annotations": [
      {
        "name": "<string>",
        "values": [
          "<string>"
        ]
      }
    ],
    "isDwhTable": true,
    "isDwhView": true
  }
}
'
import requests

url = "https://developer.synq.io/api/entities/custom/v1/entities"

payload = { "entity": {
        "id": { "airflowDag": {
                "integrationId": "<string>",
                "dagId": "<string>"
            } },
        "name": "<string>",
        "workspace": "<string>",
        "typeId": 500,
        "description": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "synqPath": "<string>",
        "synqCatalogUrl": "<string>",
        "ids": [{ "airflowDag": {
                    "integrationId": "<string>",
                    "dagId": "<string>"
                } }],
        "synqPaths": ["<string>"],
        "annotations": [
            {
                "name": "<string>",
                "values": ["<string>"]
            }
        ],
        "isDwhTable": True,
        "isDwhView": 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({
    entity: {
      id: {airflowDag: {integrationId: '<string>', dagId: '<string>'}},
      name: '<string>',
      workspace: '<string>',
      typeId: 500,
      description: '<string>',
      createdAt: '2023-11-07T05:31:56Z',
      updatedAt: '2023-11-07T05:31:56Z',
      deletedAt: '2023-11-07T05:31:56Z',
      synqPath: '<string>',
      synqCatalogUrl: '<string>',
      ids: [{airflowDag: {integrationId: '<string>', dagId: '<string>'}}],
      synqPaths: ['<string>'],
      annotations: [{name: '<string>', values: ['<string>']}],
      isDwhTable: true,
      isDwhView: true
    }
  })
};

fetch('https://developer.synq.io/api/entities/custom/v1/entities', 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/entities/custom/v1/entities",
  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([
    'entity' => [
        'id' => [
                'airflowDag' => [
                                'integrationId' => '<string>',
                                'dagId' => '<string>'
                ]
        ],
        'name' => '<string>',
        'workspace' => '<string>',
        'typeId' => 500,
        'description' => '<string>',
        'createdAt' => '2023-11-07T05:31:56Z',
        'updatedAt' => '2023-11-07T05:31:56Z',
        'deletedAt' => '2023-11-07T05:31:56Z',
        'synqPath' => '<string>',
        'synqCatalogUrl' => '<string>',
        'ids' => [
                [
                                'airflowDag' => [
                                                                'integrationId' => '<string>',
                                                                'dagId' => '<string>'
                                ]
                ]
        ],
        'synqPaths' => [
                '<string>'
        ],
        'annotations' => [
                [
                                'name' => '<string>',
                                'values' => [
                                                                '<string>'
                                ]
                ]
        ],
        'isDwhTable' => true,
        'isDwhView' => 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/entities/custom/v1/entities"

	payload := strings.NewReader("{\n  \"entity\": {\n    \"id\": {\n      \"airflowDag\": {\n        \"integrationId\": \"<string>\",\n        \"dagId\": \"<string>\"\n      }\n    },\n    \"name\": \"<string>\",\n    \"workspace\": \"<string>\",\n    \"typeId\": 500,\n    \"description\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"updatedAt\": \"2023-11-07T05:31:56Z\",\n    \"deletedAt\": \"2023-11-07T05:31:56Z\",\n    \"synqPath\": \"<string>\",\n    \"synqCatalogUrl\": \"<string>\",\n    \"ids\": [\n      {\n        \"airflowDag\": {\n          \"integrationId\": \"<string>\",\n          \"dagId\": \"<string>\"\n        }\n      }\n    ],\n    \"synqPaths\": [\n      \"<string>\"\n    ],\n    \"annotations\": [\n      {\n        \"name\": \"<string>\",\n        \"values\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"isDwhTable\": true,\n    \"isDwhView\": true\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/entities/custom/v1/entities")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entity\": {\n    \"id\": {\n      \"airflowDag\": {\n        \"integrationId\": \"<string>\",\n        \"dagId\": \"<string>\"\n      }\n    },\n    \"name\": \"<string>\",\n    \"workspace\": \"<string>\",\n    \"typeId\": 500,\n    \"description\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"updatedAt\": \"2023-11-07T05:31:56Z\",\n    \"deletedAt\": \"2023-11-07T05:31:56Z\",\n    \"synqPath\": \"<string>\",\n    \"synqCatalogUrl\": \"<string>\",\n    \"ids\": [\n      {\n        \"airflowDag\": {\n          \"integrationId\": \"<string>\",\n          \"dagId\": \"<string>\"\n        }\n      }\n    ],\n    \"synqPaths\": [\n      \"<string>\"\n    ],\n    \"annotations\": [\n      {\n        \"name\": \"<string>\",\n        \"values\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"isDwhTable\": true,\n    \"isDwhView\": true\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/entities/custom/v1/entities")

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  \"entity\": {\n    \"id\": {\n      \"airflowDag\": {\n        \"integrationId\": \"<string>\",\n        \"dagId\": \"<string>\"\n      }\n    },\n    \"name\": \"<string>\",\n    \"workspace\": \"<string>\",\n    \"typeId\": 500,\n    \"description\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"updatedAt\": \"2023-11-07T05:31:56Z\",\n    \"deletedAt\": \"2023-11-07T05:31:56Z\",\n    \"synqPath\": \"<string>\",\n    \"synqCatalogUrl\": \"<string>\",\n    \"ids\": [\n      {\n        \"airflowDag\": {\n          \"integrationId\": \"<string>\",\n          \"dagId\": \"<string>\"\n        }\n      }\n    ],\n    \"synqPaths\": [\n      \"<string>\"\n    ],\n    \"annotations\": [\n      {\n        \"name\": \"<string>\",\n        \"values\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"isDwhTable\": true,\n    \"isDwhView\": true\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

UpsertEntityRequest is the request message for the UpsertEntity method.

​
entity
Entity · object
required

The entity to create or update.

Response

200 - application/json

Success

UpsertEntityResponse is the response message for the UpsertEntity method.