curl --request GET \
--url https://api.example.com/api/states/{name}/records/check \
--header 'x-api-key: <api-key>'import requests
url = "https://api.example.com/api/states/{name}/records/check"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.example.com/api/states/{name}/records/check', 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/check",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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/check"
req, _ := http.NewRequest("GET", 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.get("https://api.example.com/api/states/{name}/records/check")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/states/{name}/records/check")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"checked": 123,
"held": [
{
"held_by": "<string>",
"save_id": "<string>",
"subjects": [
{
"key": "<string>",
"kind": "<string>",
"target_kind": "agent",
"target_name": "<string>"
}
]
}
],
"items": [
{
"subject": {
"key": "<string>",
"kind": "<string>",
"target_kind": "agent",
"target_name": "<string>"
},
"updated_at": 123,
"reasons": [
{
"message": "<string>",
"path": "<string>"
}
]
}
],
"next_cursor": "<string>"
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Check a state's stored records against its schema
A keyset page of the stored records that do NOT fit the state’s current effective schema.
checked reports how many records the page read; items are only the misfits, each with
every reason. Pages like the subjects listing (optionally one kind); held names the
saves held by a failed pending save that the page skipped.
curl --request GET \
--url https://api.example.com/api/states/{name}/records/check \
--header 'x-api-key: <api-key>'import requests
url = "https://api.example.com/api/states/{name}/records/check"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.example.com/api/states/{name}/records/check', 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/check",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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/check"
req, _ := http.NewRequest("GET", 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.get("https://api.example.com/api/states/{name}/records/check")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/states/{name}/records/check")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"checked": 123,
"held": [
{
"held_by": "<string>",
"save_id": "<string>",
"subjects": [
{
"key": "<string>",
"kind": "<string>",
"target_kind": "agent",
"target_name": "<string>"
}
]
}
],
"items": [
{
"subject": {
"key": "<string>",
"kind": "<string>",
"target_kind": "agent",
"target_name": "<string>"
},
"updated_at": 123,
"reasons": [
{
"message": "<string>",
"path": "<string>"
}
]
}
],
"next_cursor": "<string>"
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Path Parameters
Response
Success.
One keyset page of a state's records checked against its current effective schema.
checked is how many records the page read; items are ONLY the records that do not fit
(each a :class:~tai42_contract.states.RecordCheckItem), so a fully-fitting page has an empty
items and a non-zero checked. next_cursor is the cursor the next page reads from
(None on the last page), paging like list_subjects/search; held names the saves
held by a failed pending save whose subjects the page did not read over their uncommitted
writes. Beside :class:PruneResult and :class:StateDeclarationSaved: a scan answer that
names the held saves it skipped.
Show child attributes
Show child attributes

