Guardar un caso
curl --request PUT \
--url https://app.blockgence.com/v1/cases/{token} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"notes": "<string>",
"data": {},
"removed_base": [
"<unknown>"
],
"outcome": "<string>",
"analyst_minutes": 262800
}
'import requests
url = "https://app.blockgence.com/v1/cases/{token}"
payload = {
"name": "<string>",
"notes": "<string>",
"data": {},
"removed_base": ["<unknown>"],
"outcome": "<string>",
"analyst_minutes": 262800
}
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({
name: '<string>',
notes: '<string>',
data: {},
removed_base: ['<unknown>'],
outcome: '<string>',
analyst_minutes: 262800
})
};
fetch('https://app.blockgence.com/v1/cases/{token}', 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.blockgence.com/v1/cases/{token}",
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([
'name' => '<string>',
'notes' => '<string>',
'data' => [
],
'removed_base' => [
'<unknown>'
],
'outcome' => '<string>',
'analyst_minutes' => 262800
]),
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.blockgence.com/v1/cases/{token}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"data\": {},\n \"removed_base\": [\n \"<unknown>\"\n ],\n \"outcome\": \"<string>\",\n \"analyst_minutes\": 262800\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.blockgence.com/v1/cases/{token}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"data\": {},\n \"removed_base\": [\n \"<unknown>\"\n ],\n \"outcome\": \"<string>\",\n \"analyst_minutes\": 262800\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blockgence.com/v1/cases/{token}")
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 \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"data\": {},\n \"removed_base\": [\n \"<unknown>\"\n ],\n \"outcome\": \"<string>\",\n \"analyst_minutes\": 262800\n}"
response = http.request(request)
puts response.read_body{
"detail": "<string>",
"error": "<string>"
}{
"detail": "<string>",
"error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>",
"error": "<string>"
}Casos
Guardar un caso
Guarda o actualiza un caso.
El cuerpo es {name?, notes?, data?, outcome?, analyst_minutes?, removed_base?}. Un campo que no se envía no se modifica.
data: el snapshot de la investigación. Lo que escribe el servidor (las anotaciones, el origen de un expediente importado, el playbook de incidente, el post-mortem y la alerta de Guard) se conserva aunque no se envíe. Las anotaciones y el origen de importación que envíe el cliente se descartan.outcome: el resultado declarado por quien trabaja el caso:goal_reached(se alcanzó el objetivo),out_of_coverage(quedó fuera de cobertura) o""para quitarlo. Otro valor responde400. blockgence no lo deduce.analyst_minutes: los minutos de trabajo del analista, un entero de 0 a 525,600, onullpara quitarlos. Fuera de rango responde422.removed_base: los nodos quitados de la vista que el cliente sabía guardados. El cambio dedata.removedNodesse calcula contra esa base, de modo que una pantalla desactualizada no deshace lo que quitó o restauró otra. No se guarda.
Quitar un nodo de la vista no borra evidencia: el grafo se guarda entero, y la evidencia y los off-ramps declaran lo quitado.
La respuesta es {"ok": true, "token":...}. Requiere permiso de edición (dueño o compartido para editar). Un
caso compartido para ver, o un rol o una clave de API de solo lectura, recibe 403 con
error: "case_read_only". Un caso que quien pide no puede ver responde 404. Cada cambio queda en el registro
de cambios del caso.
Costo: sin cargo.
PUT
/
v1
/
cases
/
{token}
Guardar un caso
curl --request PUT \
--url https://app.blockgence.com/v1/cases/{token} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"notes": "<string>",
"data": {},
"removed_base": [
"<unknown>"
],
"outcome": "<string>",
"analyst_minutes": 262800
}
'import requests
url = "https://app.blockgence.com/v1/cases/{token}"
payload = {
"name": "<string>",
"notes": "<string>",
"data": {},
"removed_base": ["<unknown>"],
"outcome": "<string>",
"analyst_minutes": 262800
}
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({
name: '<string>',
notes: '<string>',
data: {},
removed_base: ['<unknown>'],
outcome: '<string>',
analyst_minutes: 262800
})
};
fetch('https://app.blockgence.com/v1/cases/{token}', 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.blockgence.com/v1/cases/{token}",
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([
'name' => '<string>',
'notes' => '<string>',
'data' => [
],
'removed_base' => [
'<unknown>'
],
'outcome' => '<string>',
'analyst_minutes' => 262800
]),
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.blockgence.com/v1/cases/{token}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"data\": {},\n \"removed_base\": [\n \"<unknown>\"\n ],\n \"outcome\": \"<string>\",\n \"analyst_minutes\": 262800\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.blockgence.com/v1/cases/{token}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"data\": {},\n \"removed_base\": [\n \"<unknown>\"\n ],\n \"outcome\": \"<string>\",\n \"analyst_minutes\": 262800\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blockgence.com/v1/cases/{token}")
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 \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"data\": {},\n \"removed_base\": [\n \"<unknown>\"\n ],\n \"outcome\": \"<string>\",\n \"analyst_minutes\": 262800\n}"
response = http.request(request)
puts response.read_body{
"detail": "<string>",
"error": "<string>"
}{
"detail": "<string>",
"error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>",
"error": "<string>"
}Autorizaciones
APIKeyHeaderBearerAuth
Encabezados
Parámetros de ruta
Cuerpo
application/json
Respuesta
Respuesta correcta.