Create new Connection Type
curl --request POST \
--url http://10.2.4.166:8080/composer/api/connection/types \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/vnd.composer.v3+json' \
--data '
{
"connectorId": "<string>",
"enabled": true,
"disabledMessage": "<string>",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>",
"subStorageType": "<string>",
"minSupportedVersion": "<string>",
"maxSupportedVersion": "<string>",
"onPremise": true,
"parameters": [
{
"userAttribute": true,
"key": "<string>",
"label": "<string>",
"valueType": "<string>",
"required": true,
"helper": "<string>",
"visible": true,
"values": [
"<string>"
],
"sequenceNumber": 123,
"requireValidation": true
}
],
"createdByUserID": "<string>",
"lastModifiedByUserID": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"lastModifiedDate": "2023-11-07T05:31:56Z"
}
'import requests
url = "http://10.2.4.166:8080/composer/api/connection/types"
payload = {
"connectorId": "<string>",
"enabled": True,
"disabledMessage": "<string>",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>",
"subStorageType": "<string>",
"minSupportedVersion": "<string>",
"maxSupportedVersion": "<string>",
"onPremise": True,
"parameters": [
{
"userAttribute": True,
"key": "<string>",
"label": "<string>",
"valueType": "<string>",
"required": True,
"helper": "<string>",
"visible": True,
"values": ["<string>"],
"sequenceNumber": 123,
"requireValidation": True
}
],
"createdByUserID": "<string>",
"lastModifiedByUserID": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"lastModifiedDate": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/vnd.composer.v3+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/vnd.composer.v3+json'
},
body: JSON.stringify({
connectorId: '<string>',
enabled: true,
disabledMessage: '<string>',
id: '<string>',
name: '<string>',
description: '<string>',
type: '<string>',
subStorageType: '<string>',
minSupportedVersion: '<string>',
maxSupportedVersion: '<string>',
onPremise: true,
parameters: [
{
userAttribute: true,
key: '<string>',
label: '<string>',
valueType: '<string>',
required: true,
helper: '<string>',
visible: true,
values: ['<string>'],
sequenceNumber: 123,
requireValidation: true
}
],
createdByUserID: '<string>',
lastModifiedByUserID: '<string>',
createdDate: '2023-11-07T05:31:56Z',
lastModifiedDate: '2023-11-07T05:31:56Z'
})
};
fetch('http://10.2.4.166:8080/composer/api/connection/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_PORT => "8080",
CURLOPT_URL => "http://10.2.4.166:8080/composer/api/connection/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([
'connectorId' => '<string>',
'enabled' => true,
'disabledMessage' => '<string>',
'id' => '<string>',
'name' => '<string>',
'description' => '<string>',
'type' => '<string>',
'subStorageType' => '<string>',
'minSupportedVersion' => '<string>',
'maxSupportedVersion' => '<string>',
'onPremise' => true,
'parameters' => [
[
'userAttribute' => true,
'key' => '<string>',
'label' => '<string>',
'valueType' => '<string>',
'required' => true,
'helper' => '<string>',
'visible' => true,
'values' => [
'<string>'
],
'sequenceNumber' => 123,
'requireValidation' => true
]
],
'createdByUserID' => '<string>',
'lastModifiedByUserID' => '<string>',
'createdDate' => '2023-11-07T05:31:56Z',
'lastModifiedDate' => '2023-11-07T05:31:56Z'
]),
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/connection/types"
payload := strings.NewReader("{\n \"connectorId\": \"<string>\",\n \"enabled\": true,\n \"disabledMessage\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"subStorageType\": \"<string>\",\n \"minSupportedVersion\": \"<string>\",\n \"maxSupportedVersion\": \"<string>\",\n \"onPremise\": true,\n \"parameters\": [\n {\n \"userAttribute\": true,\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"valueType\": \"<string>\",\n \"required\": true,\n \"helper\": \"<string>\",\n \"visible\": true,\n \"values\": [\n \"<string>\"\n ],\n \"sequenceNumber\": 123,\n \"requireValidation\": true\n }\n ],\n \"createdByUserID\": \"<string>\",\n \"lastModifiedByUserID\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedDate\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", 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.post("http://10.2.4.166:8080/composer/api/connection/types")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/vnd.composer.v3+json")
.body("{\n \"connectorId\": \"<string>\",\n \"enabled\": true,\n \"disabledMessage\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"subStorageType\": \"<string>\",\n \"minSupportedVersion\": \"<string>\",\n \"maxSupportedVersion\": \"<string>\",\n \"onPremise\": true,\n \"parameters\": [\n {\n \"userAttribute\": true,\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"valueType\": \"<string>\",\n \"required\": true,\n \"helper\": \"<string>\",\n \"visible\": true,\n \"values\": [\n \"<string>\"\n ],\n \"sequenceNumber\": 123,\n \"requireValidation\": true\n }\n ],\n \"createdByUserID\": \"<string>\",\n \"lastModifiedByUserID\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedDate\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/connection/types")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n \"connectorId\": \"<string>\",\n \"enabled\": true,\n \"disabledMessage\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"subStorageType\": \"<string>\",\n \"minSupportedVersion\": \"<string>\",\n \"maxSupportedVersion\": \"<string>\",\n \"onPremise\": true,\n \"parameters\": [\n {\n \"userAttribute\": true,\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"valueType\": \"<string>\",\n \"required\": true,\n \"helper\": \"<string>\",\n \"visible\": true,\n \"values\": [\n \"<string>\"\n ],\n \"sequenceNumber\": 123,\n \"requireValidation\": true\n }\n ],\n \"createdByUserID\": \"<string>\",\n \"lastModifiedByUserID\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedDate\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"connectorId": "<string>",
"enabled": true,
"disabledMessage": "<string>",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>",
"subStorageType": "<string>",
"minSupportedVersion": "<string>",
"maxSupportedVersion": "<string>",
"onPremise": true,
"parameters": [
{
"userAttribute": true,
"key": "<string>",
"label": "<string>",
"valueType": "<string>",
"required": true,
"helper": "<string>",
"visible": true,
"values": [
"<string>"
],
"sequenceNumber": 123,
"requireValidation": true
}
],
"createdByUserID": "<string>",
"lastModifiedByUserID": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"lastModifiedDate": "2023-11-07T05:31:56Z"
}Create new Connection Type
Supervisor authority is required to access this endpoint
Create new Connection Type
curl --request POST \
--url http://10.2.4.166:8080/composer/api/connection/types \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/vnd.composer.v3+json' \
--data '
{
"connectorId": "<string>",
"enabled": true,
"disabledMessage": "<string>",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>",
"subStorageType": "<string>",
"minSupportedVersion": "<string>",
"maxSupportedVersion": "<string>",
"onPremise": true,
"parameters": [
{
"userAttribute": true,
"key": "<string>",
"label": "<string>",
"valueType": "<string>",
"required": true,
"helper": "<string>",
"visible": true,
"values": [
"<string>"
],
"sequenceNumber": 123,
"requireValidation": true
}
],
"createdByUserID": "<string>",
"lastModifiedByUserID": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"lastModifiedDate": "2023-11-07T05:31:56Z"
}
'import requests
url = "http://10.2.4.166:8080/composer/api/connection/types"
payload = {
"connectorId": "<string>",
"enabled": True,
"disabledMessage": "<string>",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>",
"subStorageType": "<string>",
"minSupportedVersion": "<string>",
"maxSupportedVersion": "<string>",
"onPremise": True,
"parameters": [
{
"userAttribute": True,
"key": "<string>",
"label": "<string>",
"valueType": "<string>",
"required": True,
"helper": "<string>",
"visible": True,
"values": ["<string>"],
"sequenceNumber": 123,
"requireValidation": True
}
],
"createdByUserID": "<string>",
"lastModifiedByUserID": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"lastModifiedDate": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/vnd.composer.v3+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/vnd.composer.v3+json'
},
body: JSON.stringify({
connectorId: '<string>',
enabled: true,
disabledMessage: '<string>',
id: '<string>',
name: '<string>',
description: '<string>',
type: '<string>',
subStorageType: '<string>',
minSupportedVersion: '<string>',
maxSupportedVersion: '<string>',
onPremise: true,
parameters: [
{
userAttribute: true,
key: '<string>',
label: '<string>',
valueType: '<string>',
required: true,
helper: '<string>',
visible: true,
values: ['<string>'],
sequenceNumber: 123,
requireValidation: true
}
],
createdByUserID: '<string>',
lastModifiedByUserID: '<string>',
createdDate: '2023-11-07T05:31:56Z',
lastModifiedDate: '2023-11-07T05:31:56Z'
})
};
fetch('http://10.2.4.166:8080/composer/api/connection/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_PORT => "8080",
CURLOPT_URL => "http://10.2.4.166:8080/composer/api/connection/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([
'connectorId' => '<string>',
'enabled' => true,
'disabledMessage' => '<string>',
'id' => '<string>',
'name' => '<string>',
'description' => '<string>',
'type' => '<string>',
'subStorageType' => '<string>',
'minSupportedVersion' => '<string>',
'maxSupportedVersion' => '<string>',
'onPremise' => true,
'parameters' => [
[
'userAttribute' => true,
'key' => '<string>',
'label' => '<string>',
'valueType' => '<string>',
'required' => true,
'helper' => '<string>',
'visible' => true,
'values' => [
'<string>'
],
'sequenceNumber' => 123,
'requireValidation' => true
]
],
'createdByUserID' => '<string>',
'lastModifiedByUserID' => '<string>',
'createdDate' => '2023-11-07T05:31:56Z',
'lastModifiedDate' => '2023-11-07T05:31:56Z'
]),
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/connection/types"
payload := strings.NewReader("{\n \"connectorId\": \"<string>\",\n \"enabled\": true,\n \"disabledMessage\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"subStorageType\": \"<string>\",\n \"minSupportedVersion\": \"<string>\",\n \"maxSupportedVersion\": \"<string>\",\n \"onPremise\": true,\n \"parameters\": [\n {\n \"userAttribute\": true,\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"valueType\": \"<string>\",\n \"required\": true,\n \"helper\": \"<string>\",\n \"visible\": true,\n \"values\": [\n \"<string>\"\n ],\n \"sequenceNumber\": 123,\n \"requireValidation\": true\n }\n ],\n \"createdByUserID\": \"<string>\",\n \"lastModifiedByUserID\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedDate\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", 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.post("http://10.2.4.166:8080/composer/api/connection/types")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/vnd.composer.v3+json")
.body("{\n \"connectorId\": \"<string>\",\n \"enabled\": true,\n \"disabledMessage\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"subStorageType\": \"<string>\",\n \"minSupportedVersion\": \"<string>\",\n \"maxSupportedVersion\": \"<string>\",\n \"onPremise\": true,\n \"parameters\": [\n {\n \"userAttribute\": true,\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"valueType\": \"<string>\",\n \"required\": true,\n \"helper\": \"<string>\",\n \"visible\": true,\n \"values\": [\n \"<string>\"\n ],\n \"sequenceNumber\": 123,\n \"requireValidation\": true\n }\n ],\n \"createdByUserID\": \"<string>\",\n \"lastModifiedByUserID\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedDate\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/connection/types")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n \"connectorId\": \"<string>\",\n \"enabled\": true,\n \"disabledMessage\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"subStorageType\": \"<string>\",\n \"minSupportedVersion\": \"<string>\",\n \"maxSupportedVersion\": \"<string>\",\n \"onPremise\": true,\n \"parameters\": [\n {\n \"userAttribute\": true,\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"valueType\": \"<string>\",\n \"required\": true,\n \"helper\": \"<string>\",\n \"visible\": true,\n \"values\": [\n \"<string>\"\n ],\n \"sequenceNumber\": 123,\n \"requireValidation\": true\n }\n ],\n \"createdByUserID\": \"<string>\",\n \"lastModifiedByUserID\": \"<string>\",\n \"createdDate\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedDate\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"connectorId": "<string>",
"enabled": true,
"disabledMessage": "<string>",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>",
"subStorageType": "<string>",
"minSupportedVersion": "<string>",
"maxSupportedVersion": "<string>",
"onPremise": true,
"parameters": [
{
"userAttribute": true,
"key": "<string>",
"label": "<string>",
"valueType": "<string>",
"required": true,
"helper": "<string>",
"visible": true,
"values": [
"<string>"
],
"sequenceNumber": 123,
"requireValidation": true
}
],
"createdByUserID": "<string>",
"lastModifiedByUserID": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"lastModifiedDate": "2023-11-07T05:31:56Z"
}Authorizations
HTTP Basic authentication using global administrator credentials (username and password).
Body
application/vnd.composer.v3+json
Connection Type Resource
Show child attributes
Show child attributes
Response
200 - application/vnd.composer.v3+json
OK
Connection Type Resource
Show child attributes
Show child attributes
Was this page helpful?