UpsertType

Create or update an entity. If the entity does not exist, it will be created, otherwise it will be updated. Entities are identified and deduplicated by their Identifier in a scope of a given customer workspace.

POST /api/entities/custom/v1/types

UpsertType

cURL

curl --request POST \
  --url https://developer.synq.io/api/entities/custom/v1/types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": {
    "typeId": 500,
    "name": "<string>",
    "svgIcon": "aSDinaTvuI8gbWludGxpZnk=",
    "workspace": "<string>",
    "svgIconId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "traits": {
      "isModel": true,
      "isSource": true,
      "isBiLike": true,
      "isTestType": true,
      "isIgnoredInLineage": true
    }
  }
}
'

import requests

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

payload = { "type": {
        "typeId": 500,
        "name": "<string>",
        "svgIcon": "aSDinaTvuI8gbWludGxpZnk=",
        "workspace": "<string>",
        "svgIconId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "traits": {
            "isModel": True,
            "isSource": True,
            "isBiLike": True,
            "isTestType": True,
            "isIgnoredInLineage": 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({
    type: {
      typeId: 500,
      name: '<string>',
      svgIcon: 'aSDinaTvuI8gbWludGxpZnk=',
      workspace: '<string>',
      svgIconId: '<string>',
      createdAt: '2023-11-07T05:31:56Z',
      updatedAt: '2023-11-07T05:31:56Z',
      deletedAt: '2023-11-07T05:31:56Z',
      traits: {
        isModel: true,
        isSource: true,
        isBiLike: true,
        isTestType: true,
        isIgnoredInLineage: true
      }
    }
  })
};

fetch('https://developer.synq.io/api/entities/custom/v1/types', 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/types",
  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([
    'type' => [
        'typeId' => 500,
        'name' => '<string>',
        'svgIcon' => 'aSDinaTvuI8gbWludGxpZnk=',
        'workspace' => '<string>',
        'svgIconId' => '<string>',
        'createdAt' => '2023-11-07T05:31:56Z',
        'updatedAt' => '2023-11-07T05:31:56Z',
        'deletedAt' => '2023-11-07T05:31:56Z',
        'traits' => [
                'isModel' => true,
                'isSource' => true,
                'isBiLike' => true,
                'isTestType' => true,
                'isIgnoredInLineage' => 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/types"

	payload := strings.NewReader("{\n  \"type\": {\n    \"typeId\": 500,\n    \"name\": \"<string>\",\n    \"svgIcon\": \"aSDinaTvuI8gbWludGxpZnk=\",\n    \"workspace\": \"<string>\",\n    \"svgIconId\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"updatedAt\": \"2023-11-07T05:31:56Z\",\n    \"deletedAt\": \"2023-11-07T05:31:56Z\",\n    \"traits\": {\n      \"isModel\": true,\n      \"isSource\": true,\n      \"isBiLike\": true,\n      \"isTestType\": true,\n      \"isIgnoredInLineage\": true\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/entities/custom/v1/types")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": {\n    \"typeId\": 500,\n    \"name\": \"<string>\",\n    \"svgIcon\": \"aSDinaTvuI8gbWludGxpZnk=\",\n    \"workspace\": \"<string>\",\n    \"svgIconId\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"updatedAt\": \"2023-11-07T05:31:56Z\",\n    \"deletedAt\": \"2023-11-07T05:31:56Z\",\n    \"traits\": {\n      \"isModel\": true,\n      \"isSource\": true,\n      \"isBiLike\": true,\n      \"isTestType\": true,\n      \"isIgnoredInLineage\": true\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"type\": {\n    \"typeId\": 500,\n    \"name\": \"<string>\",\n    \"svgIcon\": \"aSDinaTvuI8gbWludGxpZnk=\",\n    \"workspace\": \"<string>\",\n    \"svgIconId\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"updatedAt\": \"2023-11-07T05:31:56Z\",\n    \"deletedAt\": \"2023-11-07T05:31:56Z\",\n    \"traits\": {\n      \"isModel\": true,\n      \"isSource\": true,\n      \"isBiLike\": true,\n      \"isTestType\": true,\n      \"isIgnoredInLineage\": true\n    }\n  }\n}"

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

200

{}

Authorizations

Authorization · string · header · required

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

Body

application/json

type · Type · object · required

Entity to create or update.

Show child attributes

Response

200 - application/json

Success

The response is of type UpsertTypeResponse · object.