Sustema

ENTITY developer reference

ICQuoteTarget

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.

Availability, estimates, progress, publication state and visible revisions use this customer's acquisitions/admitted commitment and currently lawful public corpus/capacity facts only. Private jobs, another tenant's evidence or unpublished shared completion cannot change the view. Coalescing preserves a distinct owned progress projection and may not expose shared job IDs/timing; it does not create another charged acquisition. Reuse/publication requires separately qualified sharing rights.

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.

target

Listed in this schema’s required array.

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

availability

Listed in this schema’s required array.

Declared type
"string"
Reading definition for availability
{
  "type": "string",
  "enum": [
    "already_acquired",
    "available_to_acquire",
    "requires_preparation",
    "unavailable"
  ],
  "x-profile-maxLength": "string_characters_max"
}

single_result_units

Listed in this schema’s required array.

Declared type
"string"
Reading definition for single_result_units
{
  "type": "string",
  "pattern": "^(0|[1-9][0-9]*)$",
  "maxLength": 30,
  "x-profile-maxLength": "string_characters_max"
}

success_rule

Listed in this schema’s required array.

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

existing_acquisition_id

Listed in this schema’s required array.

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

reason_codes

Listed in this schema’s required array.

Declared type
"array"
Reading definition for reason_codes
{
  "type": "array",
  "items": {
    "type": "string",
    "minLength": 1,
    "maxLength": 80,
    "x-profile-maxLength": "string_characters_max"
  },
  "minItems": 0,
  "maxItems": 12,
  "x-profile-maxItems": "collection_items_max"
}

assessment_plan

Listed in this schema’s required array.

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

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": {
    "target": {
      "$ref": "#/components/schemas/ICTarget"
    },
    "availability": {
      "type": "string",
      "enum": [
        "already_acquired",
        "available_to_acquire",
        "requires_preparation",
        "unavailable"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "single_result_units": {
      "type": "string",
      "pattern": "^(0|[1-9][0-9]*)$",
      "maxLength": 30,
      "x-profile-maxLength": "string_characters_max"
    },
    "success_rule": {
      "$ref": "#/components/schemas/ICSuccessRule"
    },
    "existing_acquisition_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "reason_codes": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80,
        "x-profile-maxLength": "string_characters_max"
      },
      "minItems": 0,
      "maxItems": 12,
      "x-profile-maxItems": "collection_items_max"
    },
    "assessment_plan": {
      "$ref": "#/components/schemas/AssessmentPlan"
    }
  },
  "required": [
    "target",
    "availability",
    "single_result_units",
    "success_rule",
    "existing_acquisition_id",
    "reason_codes",
    "assessment_plan"
  ],
  "additionalProperties": false,
  "allOf": [
    {
      "if": {
        "properties": {
          "availability": {
            "const": "already_acquired"
          }
        },
        "required": [
          "availability"
        ]
      },
      "then": {
        "properties": {
          "existing_acquisition_id": {
            "type": "string",
            "format": "uuid",
            "x-profile-maxLength": "string_characters_max"
          },
          "assessment_plan": {
            "properties": {
              "reuse_existing_owned": {
                "const": true
              }
            }
          }
        }
      }
    }
  ],
  "description": "Availability, estimates, progress, publication state and visible revisions use this customer's acquisitions/admitted commitment and currently lawful public corpus/capacity facts only. Private jobs, another tenant's evidence or unpublished shared completion cannot change the view. Coalescing preserves a distinct owned progress projection and may not expose shared job IDs/timing; it does not create another charged acquisition. Reuse/publication requires separately qualified sharing rights."
}

Related schemas

All API operations