Sustema

ENTITY developer reference

ModuleState

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.

module

Listed in this schema’s required array.

Declared type
"string"
Reading definition for module
{
  "type": "string",
  "x-profile-maxLength": "string_characters_max"
}

release

Listed in this schema’s required array.

Declared type
"string"
Reading definition for release
{
  "type": "string",
  "enum": [
    "released",
    "not_released",
    "withdrawn"
  ],
  "x-profile-maxLength": "string_characters_max"
}

entitlement

Listed in this schema’s required array.

Declared type
"string"
Reading definition for entitlement
{
  "type": "string",
  "enum": [
    "permitted",
    "denied"
  ],
  "x-profile-maxLength": "string_characters_max"
}

operation

Listed in this schema’s required array.

Declared type
"string"
Reading definition for operation
{
  "type": "string",
  "enum": [
    "available",
    "degraded",
    "unavailable"
  ],
  "x-profile-maxLength": "string_characters_max"
}

data

Listed in this schema’s required array.

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

reason

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for reason
{
  "anyOf": [
    {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "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",
  "properties": {
    "module": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "release": {
      "type": "string",
      "enum": [
        "released",
        "not_released",
        "withdrawn"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "entitlement": {
      "type": "string",
      "enum": [
        "permitted",
        "denied"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "operation": {
      "type": "string",
      "enum": [
        "available",
        "degraded",
        "unavailable"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "data": {
      "$ref": "#/components/schemas/Availability"
    },
    "reason": {
      "anyOf": [
        {
          "type": "string",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "module",
    "release",
    "entitlement",
    "operation",
    "data",
    "reason"
  ],
  "additionalProperties": false
}

Related schemas

All API operations