annotations
Create annotations control link
Requires scopes: eval:write
POST
/
api
/
annotations
/
tasks
/
{id}
/
items
/
{itemId}
/
control-link
Create annotations control link
curl --request POST \
--url https://evalgate.com/api/annotations/tasks/{id}/items/{itemId}/control-link \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"limitations": "<string>",
"controlId": 123,
"relation": "supports",
"addressesCriterion": "<string>",
"environment": "<string>",
"periodStart": "<string>",
"periodEnd": "<string>",
"controlSource": "risk_control",
"environmentEstablished": false,
"periodEstablished": false
}
'import requests
url = "https://evalgate.com/api/annotations/tasks/{id}/items/{itemId}/control-link"
payload = {
"limitations": "<string>",
"controlId": 123,
"relation": "supports",
"addressesCriterion": "<string>",
"environment": "<string>",
"periodStart": "<string>",
"periodEnd": "<string>",
"controlSource": "risk_control",
"environmentEstablished": False,
"periodEstablished": False
}
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({
limitations: '<string>',
controlId: 123,
relation: 'supports',
addressesCriterion: '<string>',
environment: '<string>',
periodStart: '<string>',
periodEnd: '<string>',
controlSource: 'risk_control',
environmentEstablished: false,
periodEstablished: false
})
};
fetch('https://evalgate.com/api/annotations/tasks/{id}/items/{itemId}/control-link', 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://evalgate.com/api/annotations/tasks/{id}/items/{itemId}/control-link",
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([
'limitations' => '<string>',
'controlId' => 123,
'relation' => 'supports',
'addressesCriterion' => '<string>',
'environment' => '<string>',
'periodStart' => '<string>',
'periodEnd' => '<string>',
'controlSource' => 'risk_control',
'environmentEstablished' => false,
'periodEstablished' => false
]),
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://evalgate.com/api/annotations/tasks/{id}/items/{itemId}/control-link"
payload := strings.NewReader("{\n \"limitations\": \"<string>\",\n \"controlId\": 123,\n \"relation\": \"supports\",\n \"addressesCriterion\": \"<string>\",\n \"environment\": \"<string>\",\n \"periodStart\": \"<string>\",\n \"periodEnd\": \"<string>\",\n \"controlSource\": \"risk_control\",\n \"environmentEstablished\": false,\n \"periodEstablished\": false\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://evalgate.com/api/annotations/tasks/{id}/items/{itemId}/control-link")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"limitations\": \"<string>\",\n \"controlId\": 123,\n \"relation\": \"supports\",\n \"addressesCriterion\": \"<string>\",\n \"environment\": \"<string>\",\n \"periodStart\": \"<string>\",\n \"periodEnd\": \"<string>\",\n \"controlSource\": \"risk_control\",\n \"environmentEstablished\": false,\n \"periodEstablished\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://evalgate.com/api/annotations/tasks/{id}/items/{itemId}/control-link")
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 \"limitations\": \"<string>\",\n \"controlId\": 123,\n \"relation\": \"supports\",\n \"addressesCriterion\": \"<string>\",\n \"environment\": \"<string>\",\n \"periodStart\": \"<string>\",\n \"periodEnd\": \"<string>\",\n \"controlSource\": \"risk_control\",\n \"environmentEstablished\": false,\n \"periodEstablished\": false\n}"
response = http.request(request)
puts response.read_body{
"evidenceItemId": 123,
"controlId": 123,
"controlSource": "risk_control",
"controlTitle": "<string>",
"assuranceControlId": 123,
"relation": "<string>",
"planHash": "<string>",
"redactionState": "<string>",
"contentHash": "<string>",
"href": "<string>",
"scope": {
"environment": "<string>",
"periodStart": "<string>",
"periodEnd": "<string>",
"limitations": "<string>",
"environmentEstablished": true,
"periodEstablished": true
},
"note": "<string>"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}Authorizations
Organization-scoped EvalGate API key. Discover the supported agent scopes at /.well-known/oauth-protected-resource. Per-operation grants are listed in x-evalgate-required-scopes; OpenAPI bearer security requirement arrays remain empty as required for non-OAuth schemes.
Body
application/json
relation
Option 1 · enum<string>Option 2 · enum<string>Option 3 · enum<string>Option 4 · enum<string>
required
Available options:
supports Available options:
risk_control Available options:
false Available options:
false Response
Successful response
Available options:
risk_control Show child attributes
Show child attributes
⌘I
Create annotations control link
curl --request POST \
--url https://evalgate.com/api/annotations/tasks/{id}/items/{itemId}/control-link \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"limitations": "<string>",
"controlId": 123,
"relation": "supports",
"addressesCriterion": "<string>",
"environment": "<string>",
"periodStart": "<string>",
"periodEnd": "<string>",
"controlSource": "risk_control",
"environmentEstablished": false,
"periodEstablished": false
}
'import requests
url = "https://evalgate.com/api/annotations/tasks/{id}/items/{itemId}/control-link"
payload = {
"limitations": "<string>",
"controlId": 123,
"relation": "supports",
"addressesCriterion": "<string>",
"environment": "<string>",
"periodStart": "<string>",
"periodEnd": "<string>",
"controlSource": "risk_control",
"environmentEstablished": False,
"periodEstablished": False
}
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({
limitations: '<string>',
controlId: 123,
relation: 'supports',
addressesCriterion: '<string>',
environment: '<string>',
periodStart: '<string>',
periodEnd: '<string>',
controlSource: 'risk_control',
environmentEstablished: false,
periodEstablished: false
})
};
fetch('https://evalgate.com/api/annotations/tasks/{id}/items/{itemId}/control-link', 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://evalgate.com/api/annotations/tasks/{id}/items/{itemId}/control-link",
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([
'limitations' => '<string>',
'controlId' => 123,
'relation' => 'supports',
'addressesCriterion' => '<string>',
'environment' => '<string>',
'periodStart' => '<string>',
'periodEnd' => '<string>',
'controlSource' => 'risk_control',
'environmentEstablished' => false,
'periodEstablished' => false
]),
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://evalgate.com/api/annotations/tasks/{id}/items/{itemId}/control-link"
payload := strings.NewReader("{\n \"limitations\": \"<string>\",\n \"controlId\": 123,\n \"relation\": \"supports\",\n \"addressesCriterion\": \"<string>\",\n \"environment\": \"<string>\",\n \"periodStart\": \"<string>\",\n \"periodEnd\": \"<string>\",\n \"controlSource\": \"risk_control\",\n \"environmentEstablished\": false,\n \"periodEstablished\": false\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://evalgate.com/api/annotations/tasks/{id}/items/{itemId}/control-link")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"limitations\": \"<string>\",\n \"controlId\": 123,\n \"relation\": \"supports\",\n \"addressesCriterion\": \"<string>\",\n \"environment\": \"<string>\",\n \"periodStart\": \"<string>\",\n \"periodEnd\": \"<string>\",\n \"controlSource\": \"risk_control\",\n \"environmentEstablished\": false,\n \"periodEstablished\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://evalgate.com/api/annotations/tasks/{id}/items/{itemId}/control-link")
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 \"limitations\": \"<string>\",\n \"controlId\": 123,\n \"relation\": \"supports\",\n \"addressesCriterion\": \"<string>\",\n \"environment\": \"<string>\",\n \"periodStart\": \"<string>\",\n \"periodEnd\": \"<string>\",\n \"controlSource\": \"risk_control\",\n \"environmentEstablished\": false,\n \"periodEstablished\": false\n}"
response = http.request(request)
puts response.read_body{
"evidenceItemId": 123,
"controlId": 123,
"controlSource": "risk_control",
"controlTitle": "<string>",
"assuranceControlId": 123,
"relation": "<string>",
"planHash": "<string>",
"redactionState": "<string>",
"contentHash": "<string>",
"href": "<string>",
"scope": {
"environment": "<string>",
"periodStart": "<string>",
"periodEnd": "<string>",
"limitations": "<string>",
"environmentEstablished": true,
"periodEstablished": true
},
"note": "<string>"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}