Sustema

ENTITY developer reference

AssessmentPlan

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.

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.

purpose

Listed in this schema’s required array.

Declared type
"string"
Reading definition for purpose
{
  "type": "string",
  "enum": [
    "acquisition",
    "refresh"
  ],
  "x-profile-maxLength": "string_characters_max"
}

prior_acquisition_id

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for prior_acquisition_id
{
  "anyOf": [
    {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

freshness_policy

Listed in this schema’s required array.

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

scope_digest

Listed in this schema’s required array.

Declared type
"string"
Reading definition for scope_digest
{
  "type": "string",
  "pattern": "^[a-f0-9]{64}$",
  "x-profile-maxLength": "string_characters_max"
}

reuse_existing_owned

Listed in this schema’s required array.

Declared type
"boolean"
Reading definition for reuse_existing_owned
{
  "type": "boolean"
}

next_eligible_at

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for next_eligible_at
{
  "anyOf": [
    {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

minimum_interval_seconds

Listed in this schema’s required array.

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

work_limits

Listed in this schema’s required array.

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

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": {
    "purpose": {
      "type": "string",
      "enum": [
        "acquisition",
        "refresh"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "prior_acquisition_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "freshness_policy": {
      "$ref": "#/components/schemas/PolicyPin"
    },
    "scope_digest": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$",
      "x-profile-maxLength": "string_characters_max"
    },
    "reuse_existing_owned": {
      "type": "boolean"
    },
    "next_eligible_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "minimum_interval_seconds": {
      "type": "integer",
      "minimum": 1
    },
    "work_limits": {
      "$ref": "#/components/schemas/CustomerWorkLimits"
    }
  },
  "required": [
    "purpose",
    "prior_acquisition_id",
    "freshness_policy",
    "scope_digest",
    "reuse_existing_owned",
    "next_eligible_at",
    "minimum_interval_seconds",
    "work_limits"
  ],
  "allOf": [
    {
      "if": {
        "properties": {
          "purpose": {
            "const": "refresh"
          }
        },
        "required": [
          "purpose"
        ]
      },
      "then": {
        "properties": {
          "prior_acquisition_id": {
            "type": "string",
            "format": "uuid",
            "x-profile-maxLength": "string_characters_max"
          }
        }
      }
    }
  ]
}

Related schemas

All API operations