Update results (soft update)
curl --request PATCH \
--url {protocol}://{host}:{port}/pl/results/{result_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"evaluator_role": "<string>",
"recommendation": "<string>",
"intro": "<string>",
"directions": "<string>",
"output_format": "<string>",
"meta_data": {}
}
'import requests
url = "{protocol}://{host}:{port}/pl/results/{result_id}"
payload = {
"name": "<string>",
"evaluator_role": "<string>",
"recommendation": "<string>",
"intro": "<string>",
"directions": "<string>",
"output_format": "<string>",
"meta_data": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
evaluator_role: '<string>',
recommendation: '<string>',
intro: '<string>',
directions: '<string>',
output_format: '<string>',
meta_data: {}
})
};
fetch('{protocol}://{host}:{port}/pl/results/{result_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_PORT => "62437",
CURLOPT_URL => "{protocol}://{host}:{port}/pl/results/{result_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'evaluator_role' => '<string>',
'recommendation' => '<string>',
'intro' => '<string>',
'directions' => '<string>',
'output_format' => '<string>',
'meta_data' => [
]
]),
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 := "{protocol}://{host}:{port}/pl/results/{result_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"evaluator_role\": \"<string>\",\n \"recommendation\": \"<string>\",\n \"intro\": \"<string>\",\n \"directions\": \"<string>\",\n \"output_format\": \"<string>\",\n \"meta_data\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("{protocol}://{host}:{port}/pl/results/{result_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"evaluator_role\": \"<string>\",\n \"recommendation\": \"<string>\",\n \"intro\": \"<string>\",\n \"directions\": \"<string>\",\n \"output_format\": \"<string>\",\n \"meta_data\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("{protocol}://{host}:{port}/pl/results/{result_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"evaluator_role\": \"<string>\",\n \"recommendation\": \"<string>\",\n \"intro\": \"<string>\",\n \"directions\": \"<string>\",\n \"output_format\": \"<string>\",\n \"meta_data\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"active": true,
"version": 123,
"evaluator_role": "<string>",
"recommendation": "<string>",
"output_format": "<string>",
"sage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"meta_data": {},
"intro": "<string>",
"directions": "<string>"
}
Results
Update results (soft update)
Creates a new version of the results template.
PATCH
/
pl
/
results
/
{result_id}
Update results (soft update)
curl --request PATCH \
--url {protocol}://{host}:{port}/pl/results/{result_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"evaluator_role": "<string>",
"recommendation": "<string>",
"intro": "<string>",
"directions": "<string>",
"output_format": "<string>",
"meta_data": {}
}
'import requests
url = "{protocol}://{host}:{port}/pl/results/{result_id}"
payload = {
"name": "<string>",
"evaluator_role": "<string>",
"recommendation": "<string>",
"intro": "<string>",
"directions": "<string>",
"output_format": "<string>",
"meta_data": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
evaluator_role: '<string>',
recommendation: '<string>',
intro: '<string>',
directions: '<string>',
output_format: '<string>',
meta_data: {}
})
};
fetch('{protocol}://{host}:{port}/pl/results/{result_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_PORT => "62437",
CURLOPT_URL => "{protocol}://{host}:{port}/pl/results/{result_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'evaluator_role' => '<string>',
'recommendation' => '<string>',
'intro' => '<string>',
'directions' => '<string>',
'output_format' => '<string>',
'meta_data' => [
]
]),
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 := "{protocol}://{host}:{port}/pl/results/{result_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"evaluator_role\": \"<string>\",\n \"recommendation\": \"<string>\",\n \"intro\": \"<string>\",\n \"directions\": \"<string>\",\n \"output_format\": \"<string>\",\n \"meta_data\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("{protocol}://{host}:{port}/pl/results/{result_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"evaluator_role\": \"<string>\",\n \"recommendation\": \"<string>\",\n \"intro\": \"<string>\",\n \"directions\": \"<string>\",\n \"output_format\": \"<string>\",\n \"meta_data\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("{protocol}://{host}:{port}/pl/results/{result_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"evaluator_role\": \"<string>\",\n \"recommendation\": \"<string>\",\n \"intro\": \"<string>\",\n \"directions\": \"<string>\",\n \"output_format\": \"<string>\",\n \"meta_data\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"active": true,
"version": 123,
"evaluator_role": "<string>",
"recommendation": "<string>",
"output_format": "<string>",
"sage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"meta_data": {},
"intro": "<string>",
"directions": "<string>"
}
Authorizations
User JWT token passed in Authorization header
Headers
Required JWT permission: council_screen (informational only -- enforced server-side)
Path Parameters
UUID of the results record
Body
application/json