Update a alert item
curl --request PATCH \
--url https://api.artu.ai/alerts/{alertId}/items/{itemId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Environment: <api-key>' \
--data '
{
"data": {
"scopeData": {
"MX": {
"actividadVulnerable": {
"alertDescription": "<string>",
"ARI": {},
"AVI": {},
"INM": {},
"JYS": {},
"MJR": {},
"MPC": {},
"TSC": {},
"VEH": {}
},
"cnbv": {
"TRANSMISOR": {
"fechaDeteccion": "2023-11-07T05:31:56Z",
"descripcionOperacion": "<string>",
"razones": "<string>"
}
}
},
"US": "<unknown>"
},
"metadata": {}
}
}
'import requests
url = "https://api.artu.ai/alerts/{alertId}/items/{itemId}"
payload = { "data": {
"scopeData": {
"MX": {
"actividadVulnerable": {
"alertDescription": "<string>",
"ARI": {},
"AVI": {},
"INM": {},
"JYS": {},
"MJR": {},
"MPC": {},
"TSC": {},
"VEH": {}
},
"cnbv": { "TRANSMISOR": {
"fechaDeteccion": "2023-11-07T05:31:56Z",
"descripcionOperacion": "<string>",
"razones": "<string>"
} }
},
"US": "<unknown>"
},
"metadata": {}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Environment": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Environment': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
scopeData: {
MX: {
actividadVulnerable: {
alertDescription: '<string>',
ARI: {},
AVI: {},
INM: {},
JYS: {},
MJR: {},
MPC: {},
TSC: {},
VEH: {}
},
cnbv: {
TRANSMISOR: {
fechaDeteccion: '2023-11-07T05:31:56Z',
descripcionOperacion: '<string>',
razones: '<string>'
}
}
},
US: '<unknown>'
},
metadata: {}
}
})
};
fetch('https://api.artu.ai/alerts/{alertId}/items/{itemId}', 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://api.artu.ai/alerts/{alertId}/items/{itemId}",
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([
'data' => [
'scopeData' => [
'MX' => [
'actividadVulnerable' => [
'alertDescription' => '<string>',
'ARI' => [
],
'AVI' => [
],
'INM' => [
],
'JYS' => [
],
'MJR' => [
],
'MPC' => [
],
'TSC' => [
],
'VEH' => [
]
],
'cnbv' => [
'TRANSMISOR' => [
'fechaDeteccion' => '2023-11-07T05:31:56Z',
'descripcionOperacion' => '<string>',
'razones' => '<string>'
]
]
],
'US' => '<unknown>'
],
'metadata' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Environment: <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://api.artu.ai/alerts/{alertId}/items/{itemId}"
payload := strings.NewReader("{\n \"data\": {\n \"scopeData\": {\n \"MX\": {\n \"actividadVulnerable\": {\n \"alertDescription\": \"<string>\",\n \"ARI\": {},\n \"AVI\": {},\n \"INM\": {},\n \"JYS\": {},\n \"MJR\": {},\n \"MPC\": {},\n \"TSC\": {},\n \"VEH\": {}\n },\n \"cnbv\": {\n \"TRANSMISOR\": {\n \"fechaDeteccion\": \"2023-11-07T05:31:56Z\",\n \"descripcionOperacion\": \"<string>\",\n \"razones\": \"<string>\"\n }\n }\n },\n \"US\": \"<unknown>\"\n },\n \"metadata\": {}\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Environment", "<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.patch("https://api.artu.ai/alerts/{alertId}/items/{itemId}")
.header("Authorization", "Bearer <token>")
.header("X-Environment", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"scopeData\": {\n \"MX\": {\n \"actividadVulnerable\": {\n \"alertDescription\": \"<string>\",\n \"ARI\": {},\n \"AVI\": {},\n \"INM\": {},\n \"JYS\": {},\n \"MJR\": {},\n \"MPC\": {},\n \"TSC\": {},\n \"VEH\": {}\n },\n \"cnbv\": {\n \"TRANSMISOR\": {\n \"fechaDeteccion\": \"2023-11-07T05:31:56Z\",\n \"descripcionOperacion\": \"<string>\",\n \"razones\": \"<string>\"\n }\n }\n },\n \"US\": \"<unknown>\"\n },\n \"metadata\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artu.ai/alerts/{alertId}/items/{itemId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Environment"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"scopeData\": {\n \"MX\": {\n \"actividadVulnerable\": {\n \"alertDescription\": \"<string>\",\n \"ARI\": {},\n \"AVI\": {},\n \"INM\": {},\n \"JYS\": {},\n \"MJR\": {},\n \"MPC\": {},\n \"TSC\": {},\n \"VEH\": {}\n },\n \"cnbv\": {\n \"TRANSMISOR\": {\n \"fechaDeteccion\": \"2023-11-07T05:31:56Z\",\n \"descripcionOperacion\": \"<string>\",\n \"razones\": \"<string>\"\n }\n }\n },\n \"US\": \"<unknown>\"\n },\n \"metadata\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alertId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": "base",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"scopeData": {
"MX": {
"actividadVulnerable": {
"alertDescription": "<string>",
"amendment": {
"originalReference": "<string>",
"reason": "<string>"
},
"ARI": {
"alertType": "100"
},
"AVI": {
"alertType": "100"
},
"INM": {
"alertType": "100"
},
"JYS": {
"alertType": "100"
},
"MJR": {
"alertType": "100"
},
"MPC": {
"alertType": "100"
},
"TSC": {
"alertType": "100"
},
"VEH": {
"alertType": "100"
}
},
"cnbv": {
"TRANSMISOR": {
"fechaDeteccion": "2023-11-07T05:31:56Z",
"descripcionOperacion": "<string>",
"razones": "<string>"
}
}
},
"US": "<unknown>"
},
"clientNames": [
"<string>"
],
"transactionAmount": 123,
"transactionCurrency": "<string>",
"transactionDate": "<string>",
"validationErrors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>",
"severity": "error",
"resource": "alert",
"resourceId": "<string>",
"label": "<string>",
"sdkField": "<string>",
"parentClientId": "<string>"
}
]
}Alerts
Update a alert item
PATCH
/
alerts
/
{alertId}
/
items
/
{itemId}
Update a alert item
curl --request PATCH \
--url https://api.artu.ai/alerts/{alertId}/items/{itemId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Environment: <api-key>' \
--data '
{
"data": {
"scopeData": {
"MX": {
"actividadVulnerable": {
"alertDescription": "<string>",
"ARI": {},
"AVI": {},
"INM": {},
"JYS": {},
"MJR": {},
"MPC": {},
"TSC": {},
"VEH": {}
},
"cnbv": {
"TRANSMISOR": {
"fechaDeteccion": "2023-11-07T05:31:56Z",
"descripcionOperacion": "<string>",
"razones": "<string>"
}
}
},
"US": "<unknown>"
},
"metadata": {}
}
}
'import requests
url = "https://api.artu.ai/alerts/{alertId}/items/{itemId}"
payload = { "data": {
"scopeData": {
"MX": {
"actividadVulnerable": {
"alertDescription": "<string>",
"ARI": {},
"AVI": {},
"INM": {},
"JYS": {},
"MJR": {},
"MPC": {},
"TSC": {},
"VEH": {}
},
"cnbv": { "TRANSMISOR": {
"fechaDeteccion": "2023-11-07T05:31:56Z",
"descripcionOperacion": "<string>",
"razones": "<string>"
} }
},
"US": "<unknown>"
},
"metadata": {}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Environment": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Environment': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
scopeData: {
MX: {
actividadVulnerable: {
alertDescription: '<string>',
ARI: {},
AVI: {},
INM: {},
JYS: {},
MJR: {},
MPC: {},
TSC: {},
VEH: {}
},
cnbv: {
TRANSMISOR: {
fechaDeteccion: '2023-11-07T05:31:56Z',
descripcionOperacion: '<string>',
razones: '<string>'
}
}
},
US: '<unknown>'
},
metadata: {}
}
})
};
fetch('https://api.artu.ai/alerts/{alertId}/items/{itemId}', 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://api.artu.ai/alerts/{alertId}/items/{itemId}",
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([
'data' => [
'scopeData' => [
'MX' => [
'actividadVulnerable' => [
'alertDescription' => '<string>',
'ARI' => [
],
'AVI' => [
],
'INM' => [
],
'JYS' => [
],
'MJR' => [
],
'MPC' => [
],
'TSC' => [
],
'VEH' => [
]
],
'cnbv' => [
'TRANSMISOR' => [
'fechaDeteccion' => '2023-11-07T05:31:56Z',
'descripcionOperacion' => '<string>',
'razones' => '<string>'
]
]
],
'US' => '<unknown>'
],
'metadata' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Environment: <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://api.artu.ai/alerts/{alertId}/items/{itemId}"
payload := strings.NewReader("{\n \"data\": {\n \"scopeData\": {\n \"MX\": {\n \"actividadVulnerable\": {\n \"alertDescription\": \"<string>\",\n \"ARI\": {},\n \"AVI\": {},\n \"INM\": {},\n \"JYS\": {},\n \"MJR\": {},\n \"MPC\": {},\n \"TSC\": {},\n \"VEH\": {}\n },\n \"cnbv\": {\n \"TRANSMISOR\": {\n \"fechaDeteccion\": \"2023-11-07T05:31:56Z\",\n \"descripcionOperacion\": \"<string>\",\n \"razones\": \"<string>\"\n }\n }\n },\n \"US\": \"<unknown>\"\n },\n \"metadata\": {}\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Environment", "<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.patch("https://api.artu.ai/alerts/{alertId}/items/{itemId}")
.header("Authorization", "Bearer <token>")
.header("X-Environment", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"scopeData\": {\n \"MX\": {\n \"actividadVulnerable\": {\n \"alertDescription\": \"<string>\",\n \"ARI\": {},\n \"AVI\": {},\n \"INM\": {},\n \"JYS\": {},\n \"MJR\": {},\n \"MPC\": {},\n \"TSC\": {},\n \"VEH\": {}\n },\n \"cnbv\": {\n \"TRANSMISOR\": {\n \"fechaDeteccion\": \"2023-11-07T05:31:56Z\",\n \"descripcionOperacion\": \"<string>\",\n \"razones\": \"<string>\"\n }\n }\n },\n \"US\": \"<unknown>\"\n },\n \"metadata\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artu.ai/alerts/{alertId}/items/{itemId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Environment"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"scopeData\": {\n \"MX\": {\n \"actividadVulnerable\": {\n \"alertDescription\": \"<string>\",\n \"ARI\": {},\n \"AVI\": {},\n \"INM\": {},\n \"JYS\": {},\n \"MJR\": {},\n \"MPC\": {},\n \"TSC\": {},\n \"VEH\": {}\n },\n \"cnbv\": {\n \"TRANSMISOR\": {\n \"fechaDeteccion\": \"2023-11-07T05:31:56Z\",\n \"descripcionOperacion\": \"<string>\",\n \"razones\": \"<string>\"\n }\n }\n },\n \"US\": \"<unknown>\"\n },\n \"metadata\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alertId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": "base",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"scopeData": {
"MX": {
"actividadVulnerable": {
"alertDescription": "<string>",
"amendment": {
"originalReference": "<string>",
"reason": "<string>"
},
"ARI": {
"alertType": "100"
},
"AVI": {
"alertType": "100"
},
"INM": {
"alertType": "100"
},
"JYS": {
"alertType": "100"
},
"MJR": {
"alertType": "100"
},
"MPC": {
"alertType": "100"
},
"TSC": {
"alertType": "100"
},
"VEH": {
"alertType": "100"
}
},
"cnbv": {
"TRANSMISOR": {
"fechaDeteccion": "2023-11-07T05:31:56Z",
"descripcionOperacion": "<string>",
"razones": "<string>"
}
}
},
"US": "<unknown>"
},
"clientNames": [
"<string>"
],
"transactionAmount": 123,
"transactionCurrency": "<string>",
"transactionDate": "<string>",
"validationErrors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>",
"severity": "error",
"resource": "alert",
"resourceId": "<string>",
"label": "<string>",
"sdkField": "<string>",
"parentClientId": "<string>"
}
]
}Authorizations
API key authentication. Obtain your API key from the dashboard.
Target environment for the request. Must be "test" or "live".
Body
application/json
Show child attributes
Show child attributes
Response
200 - application/json
OK
Available options:
base, MX:AV, MX:AV:ARI, MX:AV:AVI, MX:AV:INM, MX:AV:JYS, MX:AV:MJR, MX:AV:MPC, MX:AV:TSC, MX:AV:VEH, MX:CNBV, MX:CNBV:TRANSMISOR, MX Transaction ID
Client ID
Metadata
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
