Create a project variable

Create a new project variable

POST /v1/projects/{projectId}/variables

Create a project variable

cURL

curl --request POST \
  --url https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/variables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "name": "<string>",
  "supportsDoubleResolution": true,
  "value": "<unknown>"
}
'

import requests

url = "https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/variables"

payload = {
    "description": "<string>",
    "name": "<string>",
    "supportsDoubleResolution": True,
    "value": "<unknown>"
}
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({
    description: '<string>',
    name: '<string>',
    supportsDoubleResolution: true,
    value: '<unknown>'
  })
};

fetch('https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/variables', 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://eu1.api.matillion.com/dpc/v1/projects/{projectId}/variables",
  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([
    'description' => '<string>',
    'name' => '<string>',
    'supportsDoubleResolution' => true,
    'value' => '<unknown>'
  ]),
  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://eu1.api.matillion.com/dpc/v1/projects/{projectId}/variables"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"supportsDoubleResolution\": true,\n  \"value\": \"<unknown>\"\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://eu1.api.matillion.com/dpc/v1/projects/{projectId}/variables")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"supportsDoubleResolution\": true,\n  \"value\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/variables")

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  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"supportsDoubleResolution\": true,\n  \"value\": \"<unknown>\"\n}"

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

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "value": "<unknown>"
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

a valid bearer token

Path Parameters

projectId · string<uuid> · required

Body

application/json

behaviour · enum<string> · required

Available options: COPIED, SHARED

type · enum<string> · required

Available options: NUMBER, TEXT, DATETIME

description · string

Maximum string length: 255

name · string

supportsDoubleResolution · boolean

value · any

Response

201

application/json

Project variable has been created

id · string<uuid>

name · string

value · any