Update Config Definition - Tartarus

Update Config Definition

curl --request PUT \
  --url http://localhost:8000/api/v1/config_definition/{config_definition_key} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "indexes": [
    "setting_object.first_key"
  ]
}
'

import requests

url = "http://localhost:8000/api/v1/config_definition/{config_definition_key}"

payload = { "indexes": ["setting_object.first_key"] }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({indexes: ['setting_object.first_key']})
};

fetch('http://localhost:8000/api/v1/config_definition/{config_definition_key}', 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 => "8000",
  CURLOPT_URL => "http://localhost:8000/api/v1/config_definition/{config_definition_key}",
  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([
    'indexes' => [
        'setting_object.first_key'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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 := "http://localhost:8000/api/v1/config_definition/{config_definition_key}"

	payload := strings.NewReader("{\n  \"indexes\": [\n    \"setting_object.first_key\"\n  ]\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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.put("http://localhost:8000/api/v1/config_definition/{config_definition_key}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"indexes\": [\n    \"setting_object.first_key\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8000/api/v1/config_definition/{config_definition_key}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"indexes\": [\n    \"setting_object.first_key\"\n  ]\n}"

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

{
  "data": {
    "indexes": [
      "setting_object.first_key"
    ]
  },
  "status": "SUCCESS",
  "message": "<string>",
  "errors": "<unknown>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

PUT

/

api

/

v1

/

config_definition

/

{config_definition_key}

Update Config Definition

curl --request PUT \
  --url http://localhost:8000/api/v1/config_definition/{config_definition_key} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "indexes": [
    "setting_object.first_key"
  ]
}
'

import requests

url = "http://localhost:8000/api/v1/config_definition/{config_definition_key}"

payload = { "indexes": ["setting_object.first_key"] }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({indexes: ['setting_object.first_key']})
};

fetch('http://localhost:8000/api/v1/config_definition/{config_definition_key}', 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 => "8000",
  CURLOPT_URL => "http://localhost:8000/api/v1/config_definition/{config_definition_key}",
  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([
    'indexes' => [
        'setting_object.first_key'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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 := "http://localhost:8000/api/v1/config_definition/{config_definition_key}"

	payload := strings.NewReader("{\n  \"indexes\": [\n    \"setting_object.first_key\"\n  ]\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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.put("http://localhost:8000/api/v1/config_definition/{config_definition_key}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"indexes\": [\n    \"setting_object.first_key\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8000/api/v1/config_definition/{config_definition_key}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"indexes\": [\n    \"setting_object.first_key\"\n  ]\n}"

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

{
  "data": {
    "indexes": [
      "setting_object.first_key"
    ]
  },
  "status": "SUCCESS",
  "message": "<string>",
  "errors": "<unknown>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

config_definition_key

string

required

Body

application/json

Represents an existing configuration definition to be updated in the internal table.

indexes

string[]

List of field names to be indexed. Each must exist in the schema properties.

Response

Successful Response

Represents the response for updating a configuration definition.

data

ConfigDefinitionEditable · object

required

Represents an existing configuration definition to be updated in the internal table.

Show child attributes

Example:

{ "indexes": ["setting_object.first_key"] }

status

enum<string>

default:SUCCESS

The status of the response.

Available options:

SUCCESS,

FAILURE

message

string | null

The message for the response.

errors

any | null

The errors for the response.

Get Config Definition Delete Config Definition