Sustema

ENTITY developer reference

RefreshLimits

Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.

This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.

This is the public candidate schema reading view. Read it with the operation that uses it; a representable field does not establish enabled coverage or entitlement.

Qualified configuration, not production defaults. Canonical subject/target/evidence-policy scope and cumulative controls apply across keys, protocols, retries and batches.

Declared type: "object"

Declared fields

This list shows only properties declared directly in this schema. Required labels refer only to this schema’s own required array. Referenced, composed and conditional rules can add constraints; a field not listed as required here is not guaranteed to be optional.

minimum_interval_seconds

Listed in this schema’s required array.

Declared type
"integer"
Reading definition for minimum_interval_seconds
{
  "type": "integer",
  "minimum": 1
}

clock_requirements

Listed in this schema’s required array.

Declared type
"array"
Reading definition for clock_requirements
{
  "type": "array",
  "items": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "clock": {
        "type": "string",
        "enum": [
          "source_published_at",
          "source_observed_at",
          "source_checked_at"
        ],
        "x-profile-maxLength": "string_characters_max"
      },
      "maximum_age_seconds": {
        "type": "integer",
        "minimum": 1
      }
    },
    "required": [
      "clock",
      "maximum_age_seconds"
    ]
  },
  "minItems": 1,
  "maxItems": 3,
  "x-profile-maxItems": "collection_items_max"
}

maximum_assessment_age_seconds

Listed in this schema’s required array.

Declared type
"integer"
Reading definition for maximum_assessment_age_seconds
{
  "type": "integer",
  "minimum": 1
}

cadence_policy

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for cadence_policy
{
  "$ref": "#/components/schemas/PolicyPin"
}

event_exception_policy

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for event_exception_policy
{
  "anyOf": [
    {
      "$ref": "#/components/schemas/PolicyPin"
    },
    {
      "type": "null"
    }
  ]
}

Schema reading view

Read all retained constraints, including any allOf, oneOf, anyOf, conditional and additional-property constraints. The field list does not combine branches. Explicitly marked private-only omissions mean this view is not an executable substitute for the original schema or a released contract.

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "minimum_interval_seconds": {
      "type": "integer",
      "minimum": 1
    },
    "clock_requirements": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "clock": {
            "type": "string",
            "enum": [
              "source_published_at",
              "source_observed_at",
              "source_checked_at"
            ],
            "x-profile-maxLength": "string_characters_max"
          },
          "maximum_age_seconds": {
            "type": "integer",
            "minimum": 1
          }
        },
        "required": [
          "clock",
          "maximum_age_seconds"
        ]
      },
      "minItems": 1,
      "maxItems": 3,
      "x-profile-maxItems": "collection_items_max"
    },
    "maximum_assessment_age_seconds": {
      "type": "integer",
      "minimum": 1
    },
    "cadence_policy": {
      "$ref": "#/components/schemas/PolicyPin"
    },
    "event_exception_policy": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/PolicyPin"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "minimum_interval_seconds",
    "clock_requirements",
    "maximum_assessment_age_seconds",
    "cadence_policy",
    "event_exception_policy"
  ],
  "description": "Qualified configuration, not production defaults. Canonical subject/target/evidence-policy scope and cumulative controls apply across keys, protocols, retries and batches."
}

Related schemas

All API operations