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

/web_api/execution_context/create

/web_api/execution_context/create ​

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

Запрос ​

main-app://schemas/api_elements/execution_context/create.request.json

REQUEST /web_api/execution_context/create

ИмяТипОбязательноеОграничение
project_idintegerДаminimum 0
team_idintegerДаminimum 0
context_titlestring | nullНет-
context_descriptionstring | nullНет-
browser_context_idinteger | nullНетminimum 0
os_context_idinteger | nullНетminimum 0
screen_resolution_context_idinteger | nullНетminimum 0
device_context_idinteger | nullНетminimum 0
locale_context_idinteger | nullНетminimum 0
deployment_target_context_idinteger | nullНетminimum 0
user_agent_context_idinteger | nullНетminimum 0
protocolenum | nullНет-
hoststring | nullНетmaxLength 255
base_urlstring | nullНетmaxLength 2048
build_versionstring | nullНетmaxLength 128
context_snapshotstring | nullНет-
custom_field_valuesstring | nullНет-
created_atstringНет-
updated_atstringНет-

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

Ответ ​

main-app://schemas/api_elements/execution_context/create.response.json

RESPONSE /web_api/execution_context/create

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

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

api_result ​

ИмяТипОбязательноеОграничение
execution_context_idintegerНетminimum 0
project_idintegerНетminimum 0
team_idintegerНетminimum 0
context_titlestring | nullНет-
context_descriptionstring | nullНет-
browser_context_idinteger | nullНетminimum 0
os_context_idinteger | nullНетminimum 0
screen_resolution_context_idinteger | nullНетminimum 0
device_context_idinteger | nullНетminimum 0
locale_context_idinteger | nullНетminimum 0
deployment_target_context_idinteger | nullНетminimum 0
user_agent_context_idinteger | nullНетminimum 0
protocolenum | nullНет-
hoststring | nullНетmaxLength 255
base_urlstring | nullНетmaxLength 2048
build_versionstring | nullНетmaxLength 128
context_snapshotstring | nullНет-
custom_field_valuesstring | nullНет-
created_atstringНет-
updated_atstringНет-

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

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

Запрос: main-app://schemas/api_elements/execution_context/create.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/execution_context/create.request.json",
  "title": "REQUEST /web_api/execution_context/create",
  "$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "project_id": {
      "type": "integer",
      "minimum": 0
    },
    "team_id": {
      "type": "integer",
      "minimum": 0
    },
    "context_title": {
      "type": [
        "string",
        "null"
      ]
    },
    "context_description": {
      "type": [
        "string",
        "null"
      ]
    },
    "browser_context_id": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "os_context_id": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "screen_resolution_context_id": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "device_context_id": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "locale_context_id": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "deployment_target_context_id": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "user_agent_context_id": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "protocol": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "HTTP",
            "HTTPS"
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "host": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 255
    },
    "base_url": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 2048
    },
    "build_version": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 128
    },
    "context_snapshot": {
      "type": [
        "string",
        "null"
      ]
    },
    "custom_field_values": {
      "type": [
        "string",
        "null"
      ]
    },
    "created_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    },
    "updated_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    }
  },
  "required": [
    "project_id",
    "team_id"
  ]
}
Ответ: main-app://schemas/api_elements/execution_context/create.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/execution_context/create.response.json",
  "title": "RESPONSE /web_api/execution_context/create",
  "$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
  "allOf": [
    {
      "$ref": "main-app://schemas/_shared/envelope-success.json"
    },
    {
      "type": "object",
      "properties": {
        "api_result": {
          "$ref": "main-app://schemas/api_elements/execution_context/row.json"
        }
      }
    }
  ]
}
Фрагмент: 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
}
Фрагмент: main-app://schemas/api_elements/execution_context/row.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/execution_context/row.json",
  "title": "Row execution_context",
  "$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "execution_context_id": {
      "type": "integer",
      "minimum": 0
    },
    "project_id": {
      "type": "integer",
      "minimum": 0
    },
    "team_id": {
      "type": "integer",
      "minimum": 0
    },
    "context_title": {
      "type": [
        "string",
        "null"
      ]
    },
    "context_description": {
      "type": [
        "string",
        "null"
      ]
    },
    "browser_context_id": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "os_context_id": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "screen_resolution_context_id": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "device_context_id": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "locale_context_id": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "deployment_target_context_id": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "user_agent_context_id": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "protocol": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "HTTP",
            "HTTPS"
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "host": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 255
    },
    "base_url": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 2048
    },
    "build_version": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 128
    },
    "context_snapshot": {
      "type": [
        "string",
        "null"
      ]
    },
    "custom_field_values": {
      "type": [
        "string",
        "null"
      ]
    },
    "created_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    },
    "updated_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    }
  }
}

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

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