Set relationship

Set relationships between models within a connector dataset, or between native object models within the native dataset. Native unify models are not supported.

POST /storage/relationships

Set relationship

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/storage/relationships \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "datasetUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "relationships": [
    {
      "fromModelUuid": "<string>",
      "fromColumnSlug": "<string>",
      "fromPropertySlug": "<string>",
      "toModelUuid": "<string>",
      "toColumnSlug": "<string>",
      "toPropertySlug": "<string>",
      "fromSelectedColumnSlugs": [
        "<string>"
      ],
      "toSelectedColumnSlugs": [
        "<string>"
      ],
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}
'

import requests

url = "https://api.getcargo.io/v1/storage/relationships"

payload = {
    "datasetUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "relationships": [
        {
            "fromModelUuid": "<string>",
            "fromColumnSlug": "<string>",
            "fromPropertySlug": "<string>",
            "toModelUuid": "<string>",
            "toColumnSlug": "<string>",
            "toPropertySlug": "<string>",
            "fromSelectedColumnSlugs": ["<string>"],
            "toSelectedColumnSlugs": ["<string>"],
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
    ]
}
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({
    datasetUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    relationships: [
      {
        fromModelUuid: '<string>',
        fromColumnSlug: '<string>',
        fromPropertySlug: '<string>',
        toModelUuid: '<string>',
        toColumnSlug: '<string>',
        toPropertySlug: '<string>',
        fromSelectedColumnSlugs: ['<string>'],
        toSelectedColumnSlugs: ['<string>'],
        uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
      }
    ]
  })
};

fetch('https://api.getcargo.io/v1/storage/relationships', 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://api.getcargo.io/v1/storage/relationships",
  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([
    'datasetUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'relationships' => [
        [
                'fromModelUuid' => '<string>',
                'fromColumnSlug' => '<string>',
                'fromPropertySlug' => '<string>',
                'toModelUuid' => '<string>',
                'toColumnSlug' => '<string>',
                'toPropertySlug' => '<string>',
                'fromSelectedColumnSlugs' => [
                                '<string>'
                ],
                'toSelectedColumnSlugs' => [
                                '<string>'
                ],
                'uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ]
  ]),
  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://api.getcargo.io/v1/storage/relationships"

	payload := strings.NewReader("{\n  \"datasetUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"relationships\": [\n    {\n      \"fromModelUuid\": \"<string>\",\n      \"fromColumnSlug\": \"<string>\",\n      \"fromPropertySlug\": \"<string>\",\n      \"toModelUuid\": \"<string>\",\n      \"toColumnSlug\": \"<string>\",\n      \"toPropertySlug\": \"<string>\",\n      \"fromSelectedColumnSlugs\": [\n        \"<string>\"\n      ],\n      \"toSelectedColumnSlugs\": [\n        \"<string>\"\n      ],\n      \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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://api.getcargo.io/v1/storage/relationships")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"datasetUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"relationships\": [\n    {\n      \"fromModelUuid\": \"<string>\",\n      \"fromColumnSlug\": \"<string>\",\n      \"fromPropertySlug\": \"<string>\",\n      \"toModelUuid\": \"<string>\",\n      \"toColumnSlug\": \"<string>\",\n      \"toPropertySlug\": \"<string>\",\n      \"fromSelectedColumnSlugs\": [\n        \"<string>\"\n      ],\n      \"toSelectedColumnSlugs\": [\n        \"<string>\"\n      ],\n      \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/storage/relationships")

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  \"datasetUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"relationships\": [\n    {\n      \"fromModelUuid\": \"<string>\",\n      \"fromColumnSlug\": \"<string>\",\n      \"fromPropertySlug\": \"<string>\",\n      \"toModelUuid\": \"<string>\",\n      \"toColumnSlug\": \"<string>\",\n      \"toPropertySlug\": \"<string>\",\n      \"fromSelectedColumnSlugs\": [\n        \"<string>\"\n      ],\n      \"toSelectedColumnSlugs\": [\n        \"<string>\"\n      ],\n      \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ]\n}"

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

200

{
  "relationships": [
    {
      "uuid": "<string>",
      "workspaceUuid": "<string>",
      "fromDatasetUuid": "<string>",
      "fromModelUuid": "<string>",
      "fromColumnSlug": "<string>",
      "fromPropertySlug": "<string>",
      "toDatasetUuid": "<string>",
      "toModelUuid": "<string>",
      "toColumnSlug": "<string>",
      "toPropertySlug": "<string>",
      "fromSelectedColumnSlugs": [
        "<string>"
      ],
      "toSelectedColumnSlugs": [
        "<string>"
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Body

application/json

Request body schema.

datasetUuid · string<uuid> · required

Dataset identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

relationships · Relationships · object[] · required

Relationships to create or update.

Show child attributes

Response

200

application/json

Successful response

relationships · Relationships · object[] · required

Updated relationships.

Show child attributes