Программный интерфейс
/web_api/checklist_result_item/update_property
/web_api/checklist_result_item/update_property
Страница собрана из снимка JSON Schema в репозитории документации. Снимок обновляется отдельной командой из каталога основного приложения и при сборке сайта не переписывается.
Запрос
main-app://schemas/api_checklist/checklist_result_item/update_property.request.json
REQUEST /web_api/checklist_result_item/update_property
| Имя | Тип | Обязательное | Ограничение |
|---|---|---|---|
key | string | Да | minLength 1 |
value | any | Нет | - |
Другие поля верхнего уровня допустимы.
Ответ
main-app://schemas/api_checklist/checklist_result_item/update_property.response.json
RESPONSE /web_api/checklist_result_item/update_property
| Имя | Тип | Обязательное | Ограничение |
|---|---|---|---|
api_code | integer | Да | const 200 |
api_result | object | Да | другие поля допустимы |
empty | boolean | Нет | - |
Другие поля верхнего уровня запрещены.
Исходная схема
Файлы ниже скопированы из снимка без изменений. Фрагмент по $ref приведён отдельным блоком, схемы не сливаются.
Запрос: main-app://schemas/api_checklist/checklist_result_item/update_property.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_checklist/checklist_result_item/update_property.request.json",
"title": "REQUEST /web_api/checklist_result_item/update_property",
"$ref": "main-app://schemas/_shared/update-property.request.json"
}Фрагмент: main-app://schemas/_shared/update-property.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/_shared/update-property.request.json",
"type": "object",
"required": ["key"],
"additionalProperties": true,
"properties": {
"key": { "type": "string", "minLength": 1 },
"value": true
}
}Ответ: main-app://schemas/api_checklist/checklist_result_item/update_property.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_checklist/checklist_result_item/update_property.response.json",
"title": "RESPONSE /web_api/checklist_result_item/update_property",
"$ref": "main-app://schemas/_shared/entity-row.response.json"
}Фрагмент: main-app://schemas/_shared/entity-row.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/_shared/entity-row.response.json",
"title": "create / clone / update_property success: find_for_response row",
"allOf": [
{ "$ref": "main-app://schemas/_shared/envelope-success.json" },
{
"type": "object",
"properties": {
"api_result": {
"type": "object",
"additionalProperties": true
}
}
}
]
}Фрагмент: 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
}Страница не помогла?