Программный интерфейс
/web_api/tag_relation/create_mass
/web_api/tag_relation/create_mass
Страница собрана из снимка JSON Schema в репозитории документации. Снимок обновляется отдельной командой из каталога основного приложения и при сборке сайта не переписывается.
Запрос
main-app://schemas/api_elements/tag_relation/create_mass.request.json
REQUEST /web_api/tag_relation/create_mass
| Имя | Тип | Обязательное | Ограничение |
|---|---|---|---|
items | array of object | Да | minItems 1; maxItems 50 |
Другие поля верхнего уровня запрещены.
items[]
| Имя | Тип | Обязательное | Ограничение |
|---|---|---|---|
tag_id | integer | Да | minimum 0 |
element_type | enum | Да | "test_suite_id", "test_case_id", "test_run_id", "test_run_result_id", "test_account_id", "bug_id", "task_id", "text_document_id", "text_document_folder_id", "execution_context_id", "autotest_case_id", "autotest_run_id", "autotest_suite_id", "object_repository_page", "object_repository_element", "object_repository_folder", "checklist_id", "checklist_result_id" |
element_id | integer | Да | - |
Ответ
main-app://schemas/api_elements/tag_relation/create_mass.response.json
RESPONSE /web_api/tag_relation/create_mass
| Имя | Тип | Обязательное | Ограничение |
|---|---|---|---|
api_code | integer | Да | const 200 |
api_result | object | Да | другие поля запрещены |
empty | boolean | Нет | - |
Другие поля верхнего уровня запрещены.
api_result
| Имя | Тип | Обязательное | Ограничение |
|---|---|---|---|
created | array of object | Да | - |
failed | array of object | Да | - |
created_count | integer | Да | minimum 0 |
failed_count | integer | Да | minimum 0 |
api_result.created[]
| Имя | Тип | Обязательное | Ограничение |
|---|---|---|---|
item | integer | Да | minimum 1 |
tag_relation_id | integer | Да | minimum 1 |
api_result.failed[]
| Имя | Тип | Обязательное | Ограничение |
|---|---|---|---|
item | integer | Да | minimum 1 |
message | string | Да | - |
Исходная схема
Файлы ниже скопированы из снимка без изменений. Фрагмент по $ref приведён отдельным блоком, схемы не сливаются.
Запрос: main-app://schemas/api_elements/tag_relation/create_mass.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/tag_relation/create_mass.request.json",
"title": "REQUEST /web_api/tag_relation/create_mass",
"$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
"type": "object",
"additionalProperties": false,
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"minItems": 1,
"maxItems": 50,
"items": {
"$ref": "main-app://schemas/api_elements/tag_relation/create.request.json"
}
}
}
}Фрагмент: main-app://schemas/api_elements/tag_relation/create.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/tag_relation/create.request.json",
"title": "REQUEST /web_api/tag_relation/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": {
"tag_id": {
"type": "integer",
"minimum": 0
},
"element_type": {
"type": "string",
"enum": [
"test_suite_id",
"test_case_id",
"test_run_id",
"test_run_result_id",
"test_account_id",
"bug_id",
"task_id",
"text_document_id",
"text_document_folder_id",
"execution_context_id",
"autotest_case_id",
"autotest_run_id",
"autotest_suite_id",
"object_repository_page",
"object_repository_element",
"object_repository_folder",
"checklist_id",
"checklist_result_id"
]
},
"element_id": {
"type": "integer"
}
},
"required": [
"tag_id",
"element_type",
"element_id"
]
}Ответ: main-app://schemas/api_elements/tag_relation/create_mass.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/tag_relation/create_mass.response.json",
"title": "RESPONSE /web_api/tag_relation/create_mass",
"$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": {
"type": "object",
"additionalProperties": false,
"required": [
"created",
"failed",
"created_count",
"failed_count"
],
"properties": {
"created": {
"type": "array",
"items": {
"type": "object",
"required": [
"item",
"tag_relation_id"
],
"additionalProperties": true,
"properties": {
"item": {
"type": "integer",
"minimum": 1
},
"tag_relation_id": {
"type": "integer",
"minimum": 1
}
}
}
},
"failed": {
"type": "array",
"items": {
"type": "object",
"required": [
"item",
"message"
],
"additionalProperties": true,
"properties": {
"item": {
"type": "integer",
"minimum": 1
},
"message": {
"type": "string"
}
}
}
},
"created_count": {
"type": "integer",
"minimum": 0
},
"failed_count": {
"type": "integer",
"minimum": 0
}
}
}
}
}
]
}Фрагмент: 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
}Страница не помогла?