Apply ops to a subject's record
curl --request POST \
--url https://api.example.com/api/states/{name}/records/{target_kind}/{target_name}/{kind}/{key}/deltas \
--header 'x-api-key: <api-key>'import requests
url = "https://api.example.com/api/states/{name}/records/{target_kind}/{target_name}/{kind}/{key}/deltas"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.example.com/api/states/{name}/records/{target_kind}/{target_name}/{kind}/{key}/deltas', 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.example.com/api/states/{name}/records/{target_kind}/{target_name}/{kind}/{key}/deltas",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/states/{name}/records/{target_kind}/{target_name}/{kind}/{key}/deltas"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.example.com/api/states/{name}/records/{target_kind}/{target_name}/{kind}/{key}/deltas")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/states/{name}/records/{target_kind}/{target_name}/{kind}/{key}/deltas")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"applied": true,
"data": {},
"seq": 123,
"skipped": [
{}
]
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}states
Apply ops to a subject's record
Apply an ordered op batch to a subject’s document — refused if a whole-path write
violates an attached path’s regime; idempotent on a replayed op_id.
POST
/
api
/
states
/
{name}
/
records
/
{target_kind}
/
{target_name}
/
{kind}
/
{key}
/
deltas
Apply ops to a subject's record
curl --request POST \
--url https://api.example.com/api/states/{name}/records/{target_kind}/{target_name}/{kind}/{key}/deltas \
--header 'x-api-key: <api-key>'import requests
url = "https://api.example.com/api/states/{name}/records/{target_kind}/{target_name}/{kind}/{key}/deltas"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.example.com/api/states/{name}/records/{target_kind}/{target_name}/{kind}/{key}/deltas', 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.example.com/api/states/{name}/records/{target_kind}/{target_name}/{kind}/{key}/deltas",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/states/{name}/records/{target_kind}/{target_name}/{kind}/{key}/deltas"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.example.com/api/states/{name}/records/{target_kind}/{target_name}/{kind}/{key}/deltas")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/states/{name}/records/{target_kind}/{target_name}/{kind}/{key}/deltas")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"applied": true,
"data": {},
"seq": 123,
"skipped": [
{}
]
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Path Parameters
Response
Success.
The outcome of an apply: whether it applied (a replayed op-id or an
empty batch is False; a batch whose every op guard-skips still reports
applied=True with the ops in skipped), the resulting data and seq
when it did, and the skipped ops (each a reason record) a guard held back.
Show child attributes
Show child attributes

