Программный интерфейс

/web_api/text_document/load_body

/web_api/text_document/load_body ​

Страница собрана из снимка JSON Schema в репозитории документации. Снимок обновляется отдельной командой из каталога основного приложения и при сборке сайта не переписывается.

Запрос ​

main-app://schemas/api_text_document/text_document/load_body.request.json

GET /web_api/text_document/load_body query

ИмяТипОбязательноеОграничение
text_document_idintegerДаminimum 1

Другие поля верхнего уровня допустимы.

Ответ ​

main-app://schemas/api_text_document/text_document/load_body.response.json

GET load_body success

ИмяТипОбязательноеОграничение
api_codeintegerДаconst 200
api_resultobject | booleanДа-
emptybooleanНет-

Другие поля верхнего уровня запрещены.

Исходная схема ​

Файлы ниже скопированы из снимка без изменений. Фрагмент по $ref приведён отдельным блоком, схемы не сливаются.

Запрос: main-app://schemas/api_text_document/text_document/load_body.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_text_document/text_document/load_body.request.json",
  "title": "GET /web_api/text_document/load_body query",
  "type": "object",
  "required": [
    "text_document_id"
  ],
  "additionalProperties": true,
  "properties": {
    "text_document_id": {
      "type": "integer",
      "minimum": 1
    }
  }
}
Ответ: main-app://schemas/api_text_document/text_document/load_body.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_text_document/text_document/load_body.response.json",
  "title": "GET load_body success",
  "allOf": [
    {
      "$ref": "main-app://schemas/_shared/envelope-success.json"
    },
    {
      "type": "object",
      "properties": {
        "api_result": {
          "anyOf": [
            {
              "type": "object",
              "additionalProperties": true
            },
            {
              "const": false
            }
          ]
        }
      }
    }
  ]
}
Фрагмент: main-app://schemas/_shared/envelope-success.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/_shared/envelope-success.json",
  "title": "Canonical success envelope",
  "type": "object",
  "required": ["api_code", "api_result"],
  "properties": {
    "api_code": { "const": 200 },
    "api_result": true,
    "empty": { "type": "boolean" }
  },
  "additionalProperties": false
}

Версия 1.0.0 · Последнее изменение 2026-10-07

Страница не помогла?