API

/web_api/project/get/text_document_structure

/web_api/project/get/text_document_structure ​

This page is built from the JSON Schema snapshot in the documentation repository. The snapshot is updated by a separate command from the main app catalog and is not rewritten when the site is built.

Request ​

main-app://schemas/api_elements/project/get-text_document_structure.request.json

POST /web_api/project/get/text_document_structure body

NameTypeRequiredConstraint
project_idintegerYesminimum 1

Other top-level fields are allowed.

Response ​

main-app://schemas/api_elements/project/get-text_document_structure.response.json

POST /web_api/project/get/text_document_structure success

NameTypeRequiredConstraint
api_codeintegerYesconst 200
api_resultobject | booleanYes-
emptybooleanNo-

Other top-level fields are not allowed.

Source schema ​

The files below are copied from the snapshot unchanged. A $ref fragment is a separate block. The schemas are not merged.

Request: main-app://schemas/api_elements/project/get-text_document_structure.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/project/get-text_document_structure.request.json",
  "title": "POST /web_api/project/get/text_document_structure body",
  "type": "object",
  "required": [
    "project_id"
  ],
  "additionalProperties": true,
  "properties": {
    "project_id": {
      "type": "integer",
      "minimum": 1
    }
  }
}
Response: main-app://schemas/api_elements/project/get-text_document_structure.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/project/get-text_document_structure.response.json",
  "title": "POST /web_api/project/get/text_document_structure success",
  "allOf": [
    {
      "$ref": "main-app://schemas/_shared/envelope-success.json"
    },
    {
      "type": "object",
      "properties": {
        "api_result": {
          "anyOf": [
            {
              "type": "object",
              "additionalProperties": true
            },
            {
              "const": false
            }
          ]
        }
      }
    }
  ]
}
Fragment: 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
}

Version 1.0.0 · Last updated 2026-10-07

Did this page help?