Updates or creates a connection schema configuration

curl --request PUT \
  --url http://10.2.4.166:8080/composer/api/connections/{connectionId}/schema/{schemaName}/configuration \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "relations": [
    {
      "source": "<string>",
      "sourceKey": "<string>",
      "target": "<string>",
      "targetKey": "<string>"
    }
  ],
  "positionConfiguration": {}
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/connections/{connectionId}/schema/{schemaName}/configuration"

payload = {
    "relations": [
        {
            "source": "<string>",
            "sourceKey": "<string>",
            "target": "<string>",
            "targetKey": "<string>"
        }
    ],
    "positionConfiguration": {}
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({
    relations: [
      {
        source: '<string>',
        sourceKey: '<string>',
        target: '<string>',
        targetKey: '<string>'
      }
    ],
    positionConfiguration: {}
  })
};

fetch('http://10.2.4.166:8080/composer/api/connections/{connectionId}/schema/{schemaName}/configuration', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/connections/{connectionId}/schema/{schemaName}/configuration",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'relations' => [
        [
                'source' => '<string>',
                'sourceKey' => '<string>',
                'target' => '<string>',
                'targetKey' => '<string>'
        ]
    ],
    'positionConfiguration' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+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 := "http://10.2.4.166:8080/composer/api/connections/{connectionId}/schema/{schemaName}/configuration"

	payload := strings.NewReader("{\n  \"relations\": [\n    {\n      \"source\": \"<string>\",\n      \"sourceKey\": \"<string>\",\n      \"target\": \"<string>\",\n      \"targetKey\": \"<string>\"\n    }\n  ],\n  \"positionConfiguration\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/vnd.composer.v3+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("http://10.2.4.166:8080/composer/api/connections/{connectionId}/schema/{schemaName}/configuration")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"relations\": [\n    {\n      \"source\": \"<string>\",\n      \"sourceKey\": \"<string>\",\n      \"target\": \"<string>\",\n      \"targetKey\": \"<string>\"\n    }\n  ],\n  \"positionConfiguration\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/connections/{connectionId}/schema/{schemaName}/configuration")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"relations\": [\n    {\n      \"source\": \"<string>\",\n      \"sourceKey\": \"<string>\",\n      \"target\": \"<string>\",\n      \"targetKey\": \"<string>\"\n    }\n  ],\n  \"positionConfiguration\": {}\n}"

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

{
  "relations": [
    {
      "source": "<string>",
      "sourceKey": "<string>",
      "target": "<string>",
      "targetKey": "<string>",
      "type": "RELATION"
    }
  ],
  "positionConfiguration": {}
}

{
  "relations": [
    {
      "source": "<string>",
      "sourceKey": "<string>",
      "target": "<string>",
      "targetKey": "<string>",
      "type": "RELATION"
    }
  ],
  "positionConfiguration": {}
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "relations": [
    {
      "source": "<string>",
      "sourceKey": "<string>",
      "target": "<string>",
      "targetKey": "<string>",
      "type": "RELATION"
    }
  ],
  "positionConfiguration": {}
}

Updates or creates a connection schema configuration

curl --request PUT \
  --url http://10.2.4.166:8080/composer/api/connections/{connectionId}/schema/{schemaName}/configuration \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "relations": [
    {
      "source": "<string>",
      "sourceKey": "<string>",
      "target": "<string>",
      "targetKey": "<string>"
    }
  ],
  "positionConfiguration": {}
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/connections/{connectionId}/schema/{schemaName}/configuration"

payload = {
    "relations": [
        {
            "source": "<string>",
            "sourceKey": "<string>",
            "target": "<string>",
            "targetKey": "<string>"
        }
    ],
    "positionConfiguration": {}
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({
    relations: [
      {
        source: '<string>',
        sourceKey: '<string>',
        target: '<string>',
        targetKey: '<string>'
      }
    ],
    positionConfiguration: {}
  })
};

fetch('http://10.2.4.166:8080/composer/api/connections/{connectionId}/schema/{schemaName}/configuration', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/connections/{connectionId}/schema/{schemaName}/configuration",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'relations' => [
        [
                'source' => '<string>',
                'sourceKey' => '<string>',
                'target' => '<string>',
                'targetKey' => '<string>'
        ]
    ],
    'positionConfiguration' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+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 := "http://10.2.4.166:8080/composer/api/connections/{connectionId}/schema/{schemaName}/configuration"

	payload := strings.NewReader("{\n  \"relations\": [\n    {\n      \"source\": \"<string>\",\n      \"sourceKey\": \"<string>\",\n      \"target\": \"<string>\",\n      \"targetKey\": \"<string>\"\n    }\n  ],\n  \"positionConfiguration\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/vnd.composer.v3+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("http://10.2.4.166:8080/composer/api/connections/{connectionId}/schema/{schemaName}/configuration")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"relations\": [\n    {\n      \"source\": \"<string>\",\n      \"sourceKey\": \"<string>\",\n      \"target\": \"<string>\",\n      \"targetKey\": \"<string>\"\n    }\n  ],\n  \"positionConfiguration\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/connections/{connectionId}/schema/{schemaName}/configuration")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"relations\": [\n    {\n      \"source\": \"<string>\",\n      \"sourceKey\": \"<string>\",\n      \"target\": \"<string>\",\n      \"targetKey\": \"<string>\"\n    }\n  ],\n  \"positionConfiguration\": {}\n}"

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

{
  "relations": [
    {
      "source": "<string>",
      "sourceKey": "<string>",
      "target": "<string>",
      "targetKey": "<string>",
      "type": "RELATION"
    }
  ],
  "positionConfiguration": {}
}

{
  "relations": [
    {
      "source": "<string>",
      "sourceKey": "<string>",
      "target": "<string>",
      "targetKey": "<string>",
      "type": "RELATION"
    }
  ],
  "positionConfiguration": {}
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "relations": [
    {
      "source": "<string>",
      "sourceKey": "<string>",
      "target": "<string>",
      "targetKey": "<string>",
      "type": "RELATION"
    }
  ],
  "positionConfiguration": {}
}

Authorizations

Authorization

string

header

required

HTTP Basic authentication using global administrator credentials (username and password).

Path Parameters

connectionId

string

required

schemaName

string

required

Body

application/vnd.composer.v3+json

Defines a connection schema payload

relations

object[]

Defines list of relations

Show child attributes

positionConfiguration

object

Defines position configuration of collections in canvas

Show child attributes

Response

The connection schema configuration was updated

Defines a connection schema payload

relations

object[]

Defines list of relations

Show child attributes

positionConfiguration

object

Defines position configuration of collections in canvas

Show child attributes

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

Updates or creates a connection schema configuration

Authorizations

Path Parameters

Body

Response