Customer Applicability API
Recompute customer impacts from pack change events
POST
/
api
/
v1
/
customer-change-impacts
/
recompute
Recompute customer impacts from pack change events
curl --request POST \
--url https://api.esheria.ai/api/v1/customer-change-impacts/recompute \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"customer_profile_id": "11111111-1111-1111-1111-111111111111",
"domain_pack_id": "UK-DATA-PROTECTION-PRIVACY",
"status": "open"
}
'import requests
url = "https://api.esheria.ai/api/v1/customer-change-impacts/recompute"
payload = {
"customer_profile_id": "11111111-1111-1111-1111-111111111111",
"domain_pack_id": "UK-DATA-PROTECTION-PRIVACY",
"status": "open"
}
headers = {
"idempotency-key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'idempotency-key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
customer_profile_id: '11111111-1111-1111-1111-111111111111',
domain_pack_id: 'UK-DATA-PROTECTION-PRIVACY',
status: 'open'
})
};
fetch('https://api.esheria.ai/api/v1/customer-change-impacts/recompute', 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.esheria.ai/api/v1/customer-change-impacts/recompute",
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([
'customer_profile_id' => '11111111-1111-1111-1111-111111111111',
'domain_pack_id' => 'UK-DATA-PROTECTION-PRIVACY',
'status' => 'open'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"idempotency-key: <idempotency-key>",
"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://api.esheria.ai/api/v1/customer-change-impacts/recompute"
payload := strings.NewReader("{\n \"customer_profile_id\": \"11111111-1111-1111-1111-111111111111\",\n \"domain_pack_id\": \"UK-DATA-PROTECTION-PRIVACY\",\n \"status\": \"open\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("idempotency-key", "<idempotency-key>")
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.post("https://api.esheria.ai/api/v1/customer-change-impacts/recompute")
.header("idempotency-key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_profile_id\": \"11111111-1111-1111-1111-111111111111\",\n \"domain_pack_id\": \"UK-DATA-PROTECTION-PRIVACY\",\n \"status\": \"open\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.esheria.ai/api/v1/customer-change-impacts/recompute")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_profile_id\": \"11111111-1111-1111-1111-111111111111\",\n \"domain_pack_id\": \"UK-DATA-PROTECTION-PRIVACY\",\n \"status\": \"open\"\n}"
response = http.request(request)
puts response.read_body{
"status": "error",
"errors": [
{
"code": "unauthorized",
"message": "Invalid API key"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "credits_exhausted",
"message": "API credits exhausted"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "duplicate_token_name",
"message": "An active data token already uses that name."
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "validation_error",
"message": "Invalid payload",
"field": "body.name"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "billing_unavailable",
"message": "Billing ledger is unavailable"
}
],
"trace_id": "trace-123"
}Authorizations
Client API key issued by Esheria.
Headers
Unique key for mutating request replay protection.
Body
application/json
Response
Successful Response
Update tenant-owned lifecycle state for a customer obligation instance
Previous
List workspace customer change impacts
Next
⌘I
Recompute customer impacts from pack change events
curl --request POST \
--url https://api.esheria.ai/api/v1/customer-change-impacts/recompute \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"customer_profile_id": "11111111-1111-1111-1111-111111111111",
"domain_pack_id": "UK-DATA-PROTECTION-PRIVACY",
"status": "open"
}
'import requests
url = "https://api.esheria.ai/api/v1/customer-change-impacts/recompute"
payload = {
"customer_profile_id": "11111111-1111-1111-1111-111111111111",
"domain_pack_id": "UK-DATA-PROTECTION-PRIVACY",
"status": "open"
}
headers = {
"idempotency-key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'idempotency-key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
customer_profile_id: '11111111-1111-1111-1111-111111111111',
domain_pack_id: 'UK-DATA-PROTECTION-PRIVACY',
status: 'open'
})
};
fetch('https://api.esheria.ai/api/v1/customer-change-impacts/recompute', 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.esheria.ai/api/v1/customer-change-impacts/recompute",
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([
'customer_profile_id' => '11111111-1111-1111-1111-111111111111',
'domain_pack_id' => 'UK-DATA-PROTECTION-PRIVACY',
'status' => 'open'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"idempotency-key: <idempotency-key>",
"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://api.esheria.ai/api/v1/customer-change-impacts/recompute"
payload := strings.NewReader("{\n \"customer_profile_id\": \"11111111-1111-1111-1111-111111111111\",\n \"domain_pack_id\": \"UK-DATA-PROTECTION-PRIVACY\",\n \"status\": \"open\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("idempotency-key", "<idempotency-key>")
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.post("https://api.esheria.ai/api/v1/customer-change-impacts/recompute")
.header("idempotency-key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_profile_id\": \"11111111-1111-1111-1111-111111111111\",\n \"domain_pack_id\": \"UK-DATA-PROTECTION-PRIVACY\",\n \"status\": \"open\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.esheria.ai/api/v1/customer-change-impacts/recompute")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_profile_id\": \"11111111-1111-1111-1111-111111111111\",\n \"domain_pack_id\": \"UK-DATA-PROTECTION-PRIVACY\",\n \"status\": \"open\"\n}"
response = http.request(request)
puts response.read_body{
"status": "error",
"errors": [
{
"code": "unauthorized",
"message": "Invalid API key"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "credits_exhausted",
"message": "API credits exhausted"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "duplicate_token_name",
"message": "An active data token already uses that name."
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "validation_error",
"message": "Invalid payload",
"field": "body.name"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "billing_unavailable",
"message": "Billing ledger is unavailable"
}
],
"trace_id": "trace-123"
}