Update a lookup table in the draft
Replace a lookup table’s definition. Edits the table’s draft version, or starts the next version and pins it in the draft when the pinned version is published. A table the draft doesn’t pin is pinned again, starting from its newest version.
curl --request PUT \
--url https://app.herondata.io/api/policy_version/draft/lookup_tables/{heron_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"definition": {},
"change_description": "<string>"
}
'import requests
url = "https://app.herondata.io/api/policy_version/draft/lookup_tables/{heron_id}"
payload = {
"definition": {},
"change_description": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({definition: {}, change_description: '<string>'})
};
fetch('https://app.herondata.io/api/policy_version/draft/lookup_tables/{heron_id}', 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://app.herondata.io/api/policy_version/draft/lookup_tables/{heron_id}",
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([
'definition' => [
],
'change_description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://app.herondata.io/api/policy_version/draft/lookup_tables/{heron_id}"
payload := strings.NewReader("{\n \"definition\": {},\n \"change_description\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<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("https://app.herondata.io/api/policy_version/draft/lookup_tables/{heron_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"definition\": {},\n \"change_description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/policy_version/draft/lookup_tables/{heron_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"definition\": {},\n \"change_description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"lookup_table": {
"definition": "<unknown>",
"heron_id": "<string>",
"is_draft": true,
"key": {
"label": "<string>",
"parameters": {}
},
"key_value_set": "us_state",
"name": "<string>",
"version": 123
}
}Body
The whole table, replacing the current one: key (the variable the table is looked up by, as its label or as {"label": ..., "parameters": {...}} with its settings), columns (may be empty for a plain list), rows (each with keys and values) and unlisted (behaviour and values for a key not in the table). Each column has an id, name and type: years, money, number, list or month_window. A month_window column's cells are chosen from its value set (complete_months, fixed in code). A threshold cannot read it
Show child attributes
Show child attributes
Was this page helpful?
curl --request PUT \
--url https://app.herondata.io/api/policy_version/draft/lookup_tables/{heron_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"definition": {},
"change_description": "<string>"
}
'import requests
url = "https://app.herondata.io/api/policy_version/draft/lookup_tables/{heron_id}"
payload = {
"definition": {},
"change_description": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({definition: {}, change_description: '<string>'})
};
fetch('https://app.herondata.io/api/policy_version/draft/lookup_tables/{heron_id}', 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://app.herondata.io/api/policy_version/draft/lookup_tables/{heron_id}",
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([
'definition' => [
],
'change_description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://app.herondata.io/api/policy_version/draft/lookup_tables/{heron_id}"
payload := strings.NewReader("{\n \"definition\": {},\n \"change_description\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<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("https://app.herondata.io/api/policy_version/draft/lookup_tables/{heron_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"definition\": {},\n \"change_description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/policy_version/draft/lookup_tables/{heron_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"definition\": {},\n \"change_description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"lookup_table": {
"definition": "<unknown>",
"heron_id": "<string>",
"is_draft": true,
"key": {
"label": "<string>",
"parameters": {}
},
"key_value_set": "us_state",
"name": "<string>",
"version": 123
}
}