/
andreynepo
/
mcp-swtr
Обзор
Документация
Войти
/
andreynepo
/
mcp-swtr
Код
Запросы
1
Задачи
Вики
Пакеты
0
Релизы
0
Аналитика
Безопасность
master
api-docs.json
107 393 строки
5 MB
Nepomnyashchiy.A.I
Исправление зависимостей
07 авг 2026, 10:15
07 авг 2026, 10:15
35cbfd9
Код
Авторство
О чём код?
{ "openapi": "3.1.0", "info": { "title": "sbertrack", "description": "Система управление элементами производственного процесса", "contact": { "name": "sbertrack", "email": "sbertrack@sbertech.ru" }, "license": { "name": "Apache 2.0", "url": "http://springdoc.org" }, "version": "36.1.3-070768d665" }, "servers": [ { "url": "https://portal.works.prod.sbt/swtr", "description": "local" } ], "tags": [ { "name": "EntityRankMutation", "description": "API изменения ранга сущности" }, { "name": "PdfExportRest", "description": "API для генерации PDF экспорта из вики-единиц" }, { "name": "SafeData API", "description": "Операции с генерацией тестовых данных в SafeData" }, { "name": "API Производственный календарь", "description": "API Производственный календарь" } ], "paths": { "/rest/api/user/management/v1/sync": { "description": "Запускает синхронизацию пользователей с внешним источником", "put": { "tags": [ "API управление синхронизацией пользователей с внешним источником" ], "summary": "Запускает синхронизацию пользователей с внешним источником", "operationId": "sync", "requestBody": { "description": "Запрос на синхронизацию пользователей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserManagementSyncRq", "description": "Запрос на синхронизацию пользователей", "example": null }, "examples": { "simple_users_creation": { "description": "Запрос на синхронизацию пользователей" } } } }, "required": true }, "responses": { "201": { "description": "Успешный запуск задачи по синхронизации пользователей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "id": "200002" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/user/group/v1/sync": { "description": "Запускает синхронизацию групп с внешним источником", "put": { "tags": [ "API создания/изменения группы пользователей" ], "summary": "Запускает синхронизацию групп с внешним источником", "operationId": "sync_1", "requestBody": { "description": "Запрос на синхронизацию групп пользователей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncUserGroupRq", "description": "Запрос на синхронизацию групп пользователей", "example": null }, "examples": { "simple_user_group_creation": { "description": "Запрос на синхронизацию групп пользователей" } } } }, "required": true }, "responses": { "201": { "description": "Успешный запуск задачи по синхронизации групп пользователей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "id": "readers_group" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/taxonomy/v1/{attribute}/put": { "description": "Изменяет значение в таксономическом справочнике по названию атрибута", "put": { "tags": [ "API создания/изменения таксономических справочников" ], "summary": "Добавляет значение в таксономическом справочнике по названию атрибута", "operationId": "putAttributeValue", "parameters": [ { "name": "attribute", "in": "path", "description": "Атрибут", "required": true, "schema": { "type": "string", "format": "String", "description": "Атрибут", "examples": [ "color" ], "maxLength": 2147483647, "pattern": ".*" }, "example": "color" } ], "requestBody": { "description": "Успешный ответ с записью таксономического справочника", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomyValueRq", "description": "Тело ответа с записью таксономического справочника", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Структура ответа в случае успеха", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "description": "Структура ответа в случае успеха", "example": null }, "example": null } } } } }, "patch": { "tags": [ "API создания/изменения таксономических справочников" ], "summary": "Изменяет значение в таксономическом справочнике по названию атрибута", "description": "Изменяет значение в таксономическом справочнике по названию атрибута", "operationId": "patchAttributeValue", "parameters": [ { "name": "attribute", "in": "path", "description": "Атрибут", "required": true, "schema": { "type": "string", "format": "String", "description": "Атрибут", "examples": [ "color" ], "maxLength": 2147483647, "pattern": ".*" }, "example": "color" } ], "requestBody": { "description": "Тело запроса на изменение значения в таксономическом справочнике по названию атрибута", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxonomyValueRq", "additionalProperties": false, "description": "Запрос на изменение значения в таксономическом справочнике по названию атрибута", "example": null }, "examples": { "example": { "description": "Запрос на изменение значения в таксономическом справочнике по названию атрибута", "value": { "code": "purple", "name": "пурпурный", "description": "пурпурный цвет", "position": "1" } } } } }, "required": true }, "responses": { "200": { "description": "Успешное изменение значения в таксономическом справочнике по названию атрибута", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение значения в таксономическом справочнике по названию атрибута", "example": null }, "examples": { "success": { "description": "Успешное изменение значения в таксономическом справочнике по названию атрибута", "value": { "id": "color::purple" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/run/create": { "description": "Создание прогона тест-кейса", "put": { "tags": [ "Test Management System" ], "summary": "Создание прогона тест-кейса", "operationId": "createTestCaseRun", "requestBody": { "description": "Запрос создания прогона", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTestCaseRunRq", "example": null }, "examples": { "Запрос создания прогона": { "description": "Запрос создания прогона", "value": { "testCaseId": { "code": "TMS-12" }, "testCycleId": { "code": "TMS-15" } } } } } }, "required": true }, "responses": { "200": { "description": "Прогон тест-кейса создан", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id", "additionalProperties": false, "description": "Код созданного прогона", "example": null }, "examples": { "success": { "description": "Код созданного прогона", "value": { "code": "TMS-3440" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_task_tracker_plugin/v1/version/update": { "description": "Изменить версию (атрибут).", "put": { "tags": [ "Task Tracker Plugin" ], "summary": "Изменить версию (атрибут).", "operationId": "updateVersion", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionDto", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionDto", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/sber_migration_plugin/v1/configuration": { "description": "Обновить конфигурацию плагина.", "put": { "tags": [ "Migration Plugin" ], "summary": "Обновить конфигурацию плагина.", "operationId": "createOrUpdatePluginConfiguration", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePluginConfigurationRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePluginConfigurationRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/sber_migration_plugin/v1/configuration/spaces/{spaceCode}": { "description": "Обновить конфигурацию для space.", "put": { "tags": [ "Migration Plugin" ], "summary": "Обновить конфигурацию для space.", "operationId": "updateSpaceConfiguration", "parameters": [ { "name": "spaceCode", "in": "path", "description": "spaceCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSpaceConfigurationRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSpaceConfigurationRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/sber_components_plugin/v1/component/update": { "description": "Изменить компонент.", "put": { "tags": [ "Sber Components Plugin @TT0" ], "summary": "Изменить компонент.", "operationId": "updateComponent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComponentDto", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComponentDto", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/jira/rest/api/2/issue/{issueIdOrKey}": { "description": "`https://docs.atlassian.com/software/jira/docs/api/REST/9.13.0/#api/2/issue-getIssue`\n", "get": { "tags": [ "SBER JIRA Api" ], "summary": "Returns a full representation of the issue for the given issue key.", "description": "`https://docs.atlassian.com/software/jira/docs/api/REST/9.13.0/#api/2/issue-getIssue`\n", "operationId": "get", "parameters": [ { "name": "issueIdOrKey", "in": "path", "description": "issueIdOrKey", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "fields", "in": "query", "description": "fields", "required": true, "schema": { "type": "string", "default": "*all", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "expand", "in": "query", "description": "expand", "required": false, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "properties", "in": "query", "description": "properties", "required": true, "schema": { "type": "string", "default": "*all", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "updateHistory", "in": "query", "description": "updateHistory", "required": true, "schema": { "type": "boolean", "default": false, "example": true }, "example": "true" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SberJiraGetIssueRs", "example": null }, "example": null } } } } }, "put": { "tags": [ "SBER JIRA Api" ], "summary": "Edits an issue from a JSON representation.", "description": "`https://docs.atlassian.com/software/jira/docs/api/REST/9.13.0/#api/2/issue-editIssue`\n", "operationId": "update", "parameters": [ { "name": "issueIdOrKey", "in": "path", "description": "issueIdOrKey", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "notifyUsers", "in": "query", "description": "notifyUsers", "required": true, "schema": { "type": "boolean", "default": false, "example": true }, "example": "true" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SberJiraUpdateIssueRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SberJiraCreateIssueRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/jira/rest/api/2/issue/{issueIdOrKey}/remotelink/{linkId}": { "description": "`https://docs.atlassian.com/software/jira/docs/api/REST/9.13.0/#api/2/issue-getRemoteIssueLinkById`\n", "get": { "tags": [ "SBER JIRA Api" ], "summary": "Get the remote issue link with the given id on the issue", "description": "`https://docs.atlassian.com/software/jira/docs/api/REST/9.13.0/#api/2/issue-getRemoteIssueLinkById`\n", "operationId": "getRemoteLink", "parameters": [ { "name": "issueIdOrKey", "in": "path", "description": "Issue id or key", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "issue id or key": { "description": "issue id or key", "value": "ISSUE-123" } } }, { "name": "linkId", "in": "path", "description": "Remote link id", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "remote link id": { "description": "remote link id", "value": 123 } } } ], "responses": { "200": { "description": "Успех", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrJiraIssueRemoteLinkDto", "description": "Remote issue link", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "id": 12345, "self": "https://your-jira-instance.com/rest/api/2/issue/PROJ-123/remotelink/12345", "globalId": "system=https://mycompany.com/support&id=1", "application": { "type": "com.mycompany.myapp", "name": "My Company Application" }, "relationship": "causes", "object": { "url": "https://mycompany.com/support/DEV-1234", "title": "DEV-1234: Fix critical bug in authentication", "summary": "This issue is blocking the login functionality for premium users", "icon": { "url16x16": "https://mycompany.com/support/images/icons/bug.png", "title": "Bug", "link": "https://mycompany.com/support" }, "status": { "resolved": false, "icon": { "url16x16": "https://mycompany.com/support/images/icons/open.png", "title": "Open", "link": "https://mycompany.com/support/status/open" } } } } } } } } } } }, "put": { "tags": [ "SBER JIRA Api" ], "summary": "Updates a remote issue link from a JSON representation, аny fields not provided are set to null.", "description": "`https://docs.atlassian.com/software/jira/docs/api/REST/9.13.0/#api/2/issue-updateRemoteIssueLink`\n", "operationId": "updateIssueRemoteLink", "parameters": [ { "name": "issueIdOrKey", "in": "path", "description": "Номер задачи", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "Номер задачи": { "description": "Номер задачи", "value": "ISSUE-123" } } }, { "name": "linkId", "in": "path", "description": "Link id", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "Link id": { "description": "Link id", "value": 1234567890 } } } ], "requestBody": { "description": "Update link request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrJiraUpdateRemoteLinkRq", "description": "Update link request", "example": null }, "examples": { "Sample": { "description": "Sample", "value": { "application": { "name": "My Acme Tracker", "type": "com.acme.tracker" }, "globalId": "system=http://www.mycompany.com/support&id=1", "object": { "icon": { "title": "Support Ticket", "url16x16": "http://www.mycompany.com/support/ticket.png" }, "status": { "icon": { "link": "http://www.mycompany.com/support?id=1&details=closed", "title": "Case Closed", "url16x16": "http://www.mycompany.com/support/resolved.png" }, "resolved": true }, "summary": "Customer support issue", "title": "TSTSUP-112", "url": "http://www.mycompany.com/support?id=1" }, "relationship": "causes" } } } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "description": "Successful Response", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "No content": { "description": "No content", "value": "No content" } } } } } } }, "delete": { "tags": [ "SBER JIRA Api" ], "summary": "Delete the remote issue link with the given id on the issue.", "description": "`https://docs.atlassian.com/software/jira/docs/api/REST/9.13.0/#api/2/issue-deleteRemoteIssueLinkById`\n", "operationId": "deleteRemoteLink", "parameters": [ { "name": "issueIdOrKey", "in": "path", "description": "Issue id or key", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "issue id or key": { "description": "issue id or key", "value": "ISSUE-123" } } }, { "name": "linkId", "in": "path", "description": "Link id", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "Link id": { "description": "Link id", "value": 1234567890 } } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "description": "Successful Response", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "No content": { "description": "No content", "value": "No content" } } } } } } } }, "/extension/plugin/v2/rest/api/jira/rest/api/2/issue/{issueIdOrKey}/comment/{id}": { "description": "`https://docs.atlassian.com/software/jira/docs/api/REST/9.13.0/#api/2/issue-getComment`\n", "get": { "tags": [ "SBER JIRA Api" ], "summary": "Returns a single comment.", "description": "`https://docs.atlassian.com/software/jira/docs/api/REST/9.13.0/#api/2/issue-getComment`\n", "operationId": "getComment", "parameters": [ { "name": "issueIdOrKey", "in": "path", "description": "issueIdOrKey", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "expand", "in": "query", "description": "expand", "required": false, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrJiraComment", "example": null }, "example": null } } } } }, "put": { "tags": [ "SBER JIRA Api" ], "summary": "Updates an existing comment using its JSON representation.", "description": "`https://docs.atlassian.com/software/jira/docs/api/REST/9.13.0/#api/2/issue-updateComment`\n", "operationId": "updateComment", "parameters": [ { "name": "issueIdOrKey", "in": "path", "description": "issueIdOrKey", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "expand", "in": "query", "description": "expand", "required": false, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrJiraUpdateCommentRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrJiraUpdateCommentRs", "example": null }, "example": null } } } } }, "delete": { "tags": [ "SBER JIRA Api" ], "summary": "Updates an existing comment using its JSON representation.", "description": "`https://docs.atlassian.com/software/jira/docs/api/REST/9.13.0/#api/2/issue-deleteComment`\n", "operationId": "deleteComment", "parameters": [ { "name": "issueIdOrKey", "in": "path", "description": "issueIdOrKey", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "responses": { "200": { "description": "OK" } } } }, "/rest/api/workflow/v2/create": { "description": "Создать схему", "post": { "tags": [ "API справочника workflow" ], "summary": "Создать схему", "operationId": "create", "requestBody": { "description": "Запрос на создание схемы воркфлоу", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WfRepresentationForSaveDto", "additionalProperties": false, "description": "Представление dto для создания схемы воркфлоу", "example": null }, "example": null } }, "required": true }, "responses": { "201": { "description": "Успешный ответ на запрос создания схемы", "headers": { "Location": { "description": "URL для получения созданного ресурса", "schema": { "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "description": "Идентификатор созданного объекта", "example": null }, "example": null } } } } } }, "/rest/api/workflow/v1/workflow/list": { "description": "Получить список workflow", "get": { "tags": [ "API справочника workflow" ], "summary": "Получить список workflow", "operationId": "getWorkflowNames", "responses": { "200": { "description": "Успешный ответ на запрос списка workflow по фильтрам", "content": { "application/json": { "schema": { "type": "string", "description": "Список workflow по фильтрам", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } } } } }, "post": { "tags": [ "API справочника workflow" ], "summary": "Получить список workflow по фильтрам", "operationId": "getWorkflowNamesByFilter", "requestBody": { "description": "Запрос на получение списка workflow по фильтрам", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WfSchemaFilterDto", "additionalProperties": false, "description": "Запрос на получение списка workflow по фильтрам", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Успешный ответ на запрос списка workflow по фильтрам", "content": { "application/json": { "schema": { "type": "string", "description": "Список workflow по фильтрам", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } } } } } }, "/rest/api/workflow/v1/usage/suit/list": { "description": "Получение списка типов юнитов использующих процесс", "post": { "tags": [ "API использования workflow" ], "summary": "Получение списка типов юнитов использующих процесс", "operationId": "getSuitList", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "Список кодов процессов", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SuitInfo" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "workflow_code_1": [ { "code": "task", "name": "Task", "icon": "task" }, { "code": "idea", "name": "Idea", "icon": "idea" } ] } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/workflow/v1/usage/space-type/list": { "description": "Получение списка типов спейсов использующих процесс", "post": { "tags": [ "API использования workflow" ], "summary": "Получение списка типов спейсов использующих процесс", "operationId": "getSpaceTypeList", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "Список кодов процессов", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SpaceTypeInfoDto" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "examples": { "Пример": { "description": "Пример", "value": [ { "workflow_code_1": [ { "code": "CHANGE", "name": "Change-команда" }, { "code": "RUN", "name": "Run-команда" } ] } ] } } } } } } } }, "/rest/api/workflow/v1/usage-check": { "description": "Проверить используется ли схема воркфлоу в бизнес функционале", "post": { "tags": [ "API справочника workflow" ], "summary": "Проверить используется ли схема воркфлоу в бизнес функционале", "operationId": "areInUse", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WfActivityDto" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } } } } } }, "/rest/api/workflow/v1/units/groupedBy/workflows": { "description": "Получить список уникальных workflows для набора юнитов", "post": { "tags": [ "API по workflow для бизнес сущностей коры" ], "summary": "Получить список уникальных workflows для набора юнитов", "description": "Получить список уникальных workflows для набора юнитов", "operationId": "getWorkflowGroups", "requestBody": { "description": "Запрос на workflows для набора юнитов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkFlowWithUnitsRq", "additionalProperties": false, "description": "Запрос на workflows для набора юнитов", "example": null }, "examples": { "simple": { "description": "Запрос на workflows для набора юнитов", "value": { "unitCodes": [ "UNIT_CODE1" ], "workflows": [ { "workflowCode": "WORKFLOW_1", "pageDtoRq": { "page": 0, "size": 10 } } ] } } } } }, "required": true }, "responses": { "200": { "description": "Список уникальных workflows для набора юнитов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowUnitsAndStatusesDto", "description": "Workflow для набора юнитов", "example": null }, "examples": { "simple": { "description": "Список уникальных workflows для набора юнитов", "value": [ { "workflowDefinition": { "wfName": "wfName_c45ca0d0ccd7", "wfCode": "55dd6912-3f2f-4192-af78-2ceb06591137" }, "unitsInfo": [ { "unitCode": "unitCode_ed272b7ea1d5", "unitSummary": "Таска интересная", "unitCurrentWfStatusName": "В работе" } ], "wfStatuses": [ { "wfStatusName": "Простой", "wfStatusCode": "default_workflow" } ], "pageSize": 10, "totalUnits": 1 } ] } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/workflow/v1/suit/list/create": { "description": "Группировка воркфлоу по типам задачи в рамках тенанта", "post": { "tags": [ "Admin API по workflow", "API админки workflow" ], "summary": "Группировка воркфлоу по типам задачи в рамках тенанта", "description": "Группировка воркфлоу по типам задачи в рамках тенанта", "operationId": "createWorkflowsForSuit", "requestBody": { "description": "Запрос на создание воркфлоу для типа задачи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuitWorkflowRq", "additionalProperties": false, "description": "Запрос на создание воркфлоу для типа задачи", "required": [ "code", "wfCodes" ], "example": null }, "examples": { "Пример": { "description": "Запрос на создание воркфлоу для типа задачи", "value": { "code": "epic", "wfCodes": [ "SPR_WF_vbpTjGjVMxPTQ" ] } } } } }, "required": true }, "responses": { "200": { "description": "Идентификатор созданного объекта", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Идентификатор созданного объекта", "required": [ "id" ], "example": null }, "examples": { "success": { "description": "Пустой идентификатор", "value": { "id": null } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/workflow/v1/status/usage-check": { "description": "Проверяет, используется ли статус workflow", "post": { "tags": [ "API статусов workflow" ], "summary": "Проверяет, используется ли статус workflow", "operationId": "areInUse_1", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WfStatusActivityDto" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } } } } } }, "/rest/api/workflow/v1/status/save": { "description": "Сохранение статуса workflow", "post": { "tags": [ "API статусов workflow" ], "summary": "Сохранение статуса workflow", "operationId": "save", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WfStatusForSaveDto", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "example": null }, "example": null } } } } } }, "/rest/api/workflow/v1/space/type/suit/list/create": { "description": "Наполнение типа пространства доступными в рамках него воркфлоу", "post": { "tags": [ "Admin API по workflow", "API админки workflow" ], "summary": "Наполнение типа пространства доступными в рамках него воркфлоу", "description": "Наполнение типа пространства доступными в рамках него воркфлоу", "operationId": "createWorkflowsForSpaceTypeAndSuit", "requestBody": { "description": "Запрос на создание воркфлоу", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSpaceTypeWithSuitWorkflowRq", "additionalProperties": false, "description": "Запрос на создание воркфлоу", "required": [ "code", "suit", "workflows" ], "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "code": "PERSONAL", "suit": "task", "workflows": [ { "code": "approcess_bug_flow_v.1.2", "default": "true" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Детали атрибута", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Объект ответа", "required": [ "id" ], "example": null }, "examples": { "success": { "description": "Пустой идентификатор", "value": { "id": null } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/workflow/v1/create": { "description": "Создать схему", "post": { "tags": [ "API справочника workflow" ], "summary": "Создать схему", "operationId": "create_1", "requestBody": { "description": "Запрос на создание схемы воркфлоу", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WfRepresentationForSaveDto", "additionalProperties": false, "description": "Представление dto для создания схемы воркфлоу", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Успешный ответ на запрос создания схемы", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "description": "Идентификатор созданного объекта", "example": null }, "example": null } } } }, "deprecated": true } }, "/rest/api/workflow/v1/convert": { "description": "Преобразовать схему из файла в наш формат", "post": { "tags": [ "API справочника workflow" ], "summary": "Преобразовать схему из файла в наш формат", "operationId": "convert", "parameters": [ { "name": "file", "in": "query", "description": "Путь к файлу", "required": true, "schema": { "type": "string", "format": "binary", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "/some/path/to/file" } ], "responses": { "200": { "description": "Успешный ответ на запрос преобразования схемы из файла в наш формат", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WfRepresentationDto", "description": "Объект представления воркфлоу", "example": null }, "example": null } } } } } }, "/rest/api/workflow/v1/action/usage-check": { "description": "Проверяет, используется ли действие workflow", "post": { "tags": [ "API действий workflow" ], "summary": "Проверяет, используется ли действие workflow", "operationId": "areInUse_2", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WfActionActivityDto" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } } } } } }, "/rest/api/workflow/v1/action/save": { "description": "Сохранение действия workflow", "post": { "tags": [ "API действий workflow" ], "summary": "Сохранение действия workflow", "operationId": "save_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WfActionForSaveDto", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "example": null }, "example": null } } } } } }, "/rest/api/validator/v0/create": { "description": "Добавление валидатора", "post": { "tags": [ "API управления валидаторами" ], "summary": "Добавление валидатора", "operationId": "createValidator", "requestBody": { "description": "Данные для создания валидатора", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrCreateValidatorDto", "description": "Данные для создания валидатора", "example": null }, "examples": { "createValidator": { "description": "Запрос создания валидатора", "value": { } } } } }, "required": true }, "responses": { "200": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "201": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "204": { "description": "Успешное удаление объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное удаление объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное удаление объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } } } } }, "/rest/api/v1/structure/{structure}/level/{level}/unit/find": { "description": "Позволяет получить список юнитов или групп в структуре по заданному уровню и фильтрам", "post": { "tags": [ "API поиска юнитов в структуре" ], "summary": "Поиск юнитов в структуре по уровням", "description": "Позволяет получить список юнитов или групп в структуре по заданному уровню и фильтрам", "operationId": "find", "parameters": [ { "name": "structure", "in": "path", "description": "Идентификатор структуры", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "structure": { "description": "Идентификатор структуры", "value": 1 } } }, { "name": "level", "in": "path", "description": "Уровень иерархии структуры", "required": true, "schema": { "type": "integer", "format": "int32", "example": 1, "maximum": 2147483647, "minimum": -2147483648 }, "examples": { "level": { "description": "Уровень иерархии структуры", "value": 1 } } } ], "requestBody": { "description": "Параметры фильтрации и пагинации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrStructureUnitSearchRequestDto", "description": "Параметры поиска юнитов в структуре", "example": null }, "example": null } }, "required": false }, "responses": { "201": { "description": "Список юнитов или групп в структуре", "headers": { "Location": { "description": "URL для получения созданного ресурса", "schema": { "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrStructureUnitPageRs", "description": "Результат поиска юнитов или групп", "example": null }, "examples": { "success": { "description": "success", "value": { "groups": { "attribute": { "code": "priority", "name": "Приоритет", "type": "taxonomy", "description": "Приоритет" }, "values": { "content": [ { "value": null, "childrenCount": 4 }, { "value": { "code": "high", "name": "Высокий" }, "childrenCount": 3 } ], "hasNext": true, "after": { "priority": "high" } } }, "units": null } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/v1/rating/stat/unit/votedUsers": { "description": "Выдаёт расширенную статистику о проголосовавших за задачу", "post": { "tags": [ "API для получения статистики по голосованию за задачу" ], "summary": "Выдаёт расширенную статистику о проголосовавших за задачу", "description": "Выдаёт расширенную статистику о проголосовавших за задачу", "operationId": "getExtStat", "requestBody": { "description": "Запрос на получение расширенной статистики о проголосовавших", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RatingExtStatRqDto", "additionalProperties": false, "description": "Запрос на получение расширенной статистики о проголосовавщих", "example": null }, "examples": { "Пример": { "description": "Пример тела запроса", "value": { "entityCode": "string", "page": { "page": 1, "size": 10 } } } } } }, "required": true }, "responses": { "201": { "description": "Успушное получение расширенной статистики о проголосовавших", "headers": { "Location": { "description": "URL для получения созданного ресурса", "schema": { "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RatingExtStatRs", "example": null }, "examples": { "RatingExtStatRs": { "description": "Пример ответа расширенной статистики о проголосовавших", "value": { "entityCode": "string", "ratingStat": { "rating": 10, "up": 15, "down": 5 }, "users": [ { "firstName": "Иван", "middleName": "Иванович", "lastName": "Иванов", "login": "ivan123", "email": "ivan@example.com", "createdAt": "2025-05-26T10:15:30Z", "action": "UP" }, { "firstName": "Мария", "middleName": "Петровна", "lastName": "Петрова", "login": "maria456", "email": "maria@example.com", "createdAt": "2025-05-25T08:45:00Z", "action": "DOWN" } ], "pageSize": 20, "hasNext": true, "pageNumber": 1, "totalElements": 100 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/v1/rating/action/unit": { "description": "Ставит лайк на задачу", "post": { "tags": [ "API добавления/удаления лайка задачи" ], "summary": "Ставит лайк на задачу", "description": "Ставит лайк на задачу", "operationId": "createUpVoteForUnit", "requestBody": { "description": "Запрос на постановку голоса", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RatingCreateRqDto", "additionalProperties": false, "description": "Запрос на постановку голоса", "example": null }, "examples": { "Пример": { "description": "Пример тела запроса", "value": { "entityCode": "18pE95Ic93", "action": "UP" } } } } }, "required": true }, "responses": { "201": { "description": "Успешное проставление лайка за задачу", "headers": { "Location": { "description": "URL для получения созданного ресурса", "schema": { "format": "uri" } } } }, "570": { "description": "Ошибка голосования", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "example": null }, "examples": { "errorDto": { "description": "Невозможно повторно проголосовать за одну и ту же задачу", "value": "{\n \"exceptionUUID\": \"qytqZxlZx\",\n \"uiErrorMessage\": \"Невозможно повторно проголосовать за одну и ту же задачу | Можно только ставить голос \"За\",\n \"errorType\": \"SWTR_BASIC_ERROR\"\n}\n" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/v1/menu": { "description": "Получить все группы 1W меню целиком в формате JSON", "get": { "tags": [ "API для работы с простой реализацией 1W меню" ], "summary": "Получить все группы 1W меню целиком в формате JSON", "operationId": "getFullOneWorkMenuAsJson", "parameters": [ { "name": "plugin_qualifier", "in": "query", "description": "Идентификатор плагина", "required": false, "schema": { "type": "string", "default": "core", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "core" } ], "responses": { "200": { "description": "Список групп 1W меню", "content": { "application/json": { "schema": { "type": "string", "description": "Строка с меню с формате JSON", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } } } } }, "post": { "tags": [ "API для работы с простой реализацией 1W меню" ], "summary": "Обновить все 1W меню целиком. Передаваемый JSON полностью перезаписывает уже существующий в базе", "operationId": "update_1", "requestBody": { "description": "Обновить (полностью перезаписать) JSON с 1W меню", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOneWorkMenuRq", "additionalProperties": false, "description": "Меню в формате JSON, идентификатор плагина (опционально)", "example": null }, "examples": { "Пример запроса с меню в формате JSON и явно указанным плагином": { "description": "Пример меню", "value": "{\n \"menuJson\": [\n {\n \"key\": \"tasks\",\n \"domain\": [\"tasks\"],\n \"title\": \"Задачи\",\n \"iconCode\": \"swtrTasks\",\n \"elements\": [\n {\n \"key\": \"all_units\",\n \"title\": \"Задачи\",\n \"link\": \"/units/all\",\n \"spaceDependant\": true,\n \"dataTestId\": \"link.units\",\n \"checkPower\": [\"unit:read\"]\n },\n {\n \"key\": \"board\",\n \"title\": \"Доски\",\n \"link\": \"/board\",\n \"spaceDependant\": true,\n \"dataTestId\": \"link.boards.board\",\n \"checkPower\": [\"board:read\"]\n }\n ]\n },\n {\n \"key\": \"tests\",\n \"domain\": [\"tests\"],\n \"title\": \"Тесты\",\n \"iconCode\": \"swtrTests\",\n \"elements\": [\n {\n \"key\": \"test-cases\",\n \"title\": \"Кейсы\",\n \"link\": \"/tms/all\",\n \"spaceDependant\": true,\n \"dataTestId\": \"link.tms.cases\",\n \"checkPower\": [\"unit:read\"]\n },\n ],\n \"extensionPointKey\": \"TestCasesTreeExtensionPoint\"\n },\n {\n \"key\": \"pages\",\n \"domain\": [\"pages\"],\n \"title\": \"Страницы\",\n \"iconCode\": \"swtrPages\",\n \"elements\": [\n {\n \"key\": \"wiki\",\n \"title\": \"Страницы\",\n \"link\": \"/wiki\",\n \"spaceDependant\": true,\n \"dataTestId\": \"link.wiki\",\n \"checkPower\": [\"unit:read\"]\n },\n ],\n \"extensionPointKey\": \"PagesTreeExtensionPoint\"\n },\n {\n \"key\": \"main\",\n \"domain\": [\"tasks\", \"tests\", \"pages\"],\n \"elements\": [\n {\n \"key\": \"spaces\",\n \"title\": \"Проекты\",\n \"iconCode\": \"swtrSpaces\",\n \"link\": \"/spaces/all\",\n \"dataTestId\": \"link.spaces\",\n \"checkPower\": [\"space:read\"]\n }\n ]\n },\n {\n \"key\": \"admin\",\n \"domain\": [\"tasks\", \"tests\", \"pages\"],\n \"title\": \"Администрирование\",\n \"iconCode\": \"swtrAdmin\",\n \"expandable\": true,\n \"defaultExpandable\": false,\n \"elements\": [\n {\n \"key\": \"spaces-types\",\n \"title\": \"Типы пространств\",\n \"link\": \"/spaces/types\",\n \"dataTestId\": \"link.space.types\",\n \"checkPower\": [\"space_type:write\"]\n }\n ]\n }\n ]\n }\n" } } } }, "required": true }, "responses": { "201": { "description": "Только что сохраненный список групп 1W меню", "headers": { "Location": { "description": "URL для получения созданного ресурса", "schema": { "format": "uri" } } }, "content": { "application/json": { "schema": { "type": "string", "description": "Строка с меню с формате JSON", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } } } } } }, "/rest/api/v1/import/csv/proceed/{fileCode}": { "description": "Для сохранённого файла запускает процесс импорта", "post": { "tags": [ "API по работе с csv импортом" ], "summary": "Для сохранённого файла запускает процесс импорта", "operationId": "proceedImport", "parameters": [ { "name": "fileCode", "in": "path", "description": "fileCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProceedImportRq", "example": null }, "example": null } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } } } } } }, "/rest/api/v1/import/csv/details/{fileCode}": { "description": "Возвращает детальный отчёт об импорте", "post": { "tags": [ "API по работе с csv импортом" ], "summary": "Возвращает детальный отчёт об импорте", "operationId": "getImportStatusDetails", "parameters": [ { "name": "fileCode", "in": "path", "description": "fileCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "status", "in": "query", "description": "status", "required": false, "schema": { "type": "string", "enum": [ "FATAL", "ERROR", "WARNING", "SUCCESS", "ALL" ], "example": "Пример" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStatusDetailsRs", "example": null }, "example": null } } } } } }, "/rest/api/v1/import/csv/data/upload/{space}": { "description": "Загружает в хранилище файл с юнитами", "post": { "tags": [ "API по работе с csv импортом" ], "summary": "Загружает в хранилище файл с юнитами", "operationId": "upload", "parameters": [ { "name": "space", "in": "path", "description": "space", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "additionalProperties": false, "properties": { "file": { "type": "string", "format": "binary", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "config": { "type": "string", "format": "binary", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" } }, "required": [ "config", "file" ], "example": null }, "example": null } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CsvUploadResultRs", "example": null }, "example": null } } } } } }, "/rest/api/user/v1/upload/avatar": { "description": "загружает и сохраняет аватар пользователя", "post": { "tags": [ "API для загрузки и отображения аватара пользователя" ], "summary": "загружает и сохраняет аватар пользователя", "operationId": "uploadUserAvatar", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "fileName": { "type": "string", "description": "Имя файла", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "file": { "type": "string", "format": "binary", "description": "Имя файла", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" } }, "required": [ "file" ], "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Информация о загруженном файле аватара", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvatarInfoDto", "description": "Информация о загруженном файле аватара", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "externalId": "100003", "avatarId": "d360601b-07f2-489e-9175-2431662b113a" } } } } } } } } }, "/rest/api/user/v1/search": { "description": "Ищет пользователей по фильтру", "post": { "tags": [ "API поиска пользователей @TT0" ], "summary": "Ищет пользователей по фильтру", "operationId": "searchUsers", "requestBody": { "description": "Запрос на поиск пользователей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSearchRequest", "description": "Запрос на поиск пользователя", "example": null }, "examples": { "simple_user_search_request": { "description": "Пример запроса на поиск пользователей", "value": { "searchString": "Иванов", "paging": { "page": 0, "size": 20 } } } } } }, "required": true }, "responses": { "200": { "description": "Список пользователей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRsUserBasicInfo", "description": "Список пользователей", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "content": [ { "code": "user123", "firstName": "Иван", "lastName": "Иванов", "middleName": "Иванович", "login": "ivanov", "userDetails": [ { "type": { "code": "email", "name": "Email", "visible": true, "properties": { "format": "email" } }, "value": "ivanov@example.com" } ] } ], "pageSize": 1, "hasNext": true, "pageNumber": 0, "totalElements": 13 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/user/v1/search/by_units": { "description": "Поиск пользователей в пространствах по списку задач. Находятся пользователи, которые есть в каждом пространстве (пересечение)", "post": { "tags": [ "API поиска пользователей @TT0" ], "summary": "Поиск пользователей в пространствах по списку задач. Находятся пользователи, которые есть в каждом пространстве (пересечение)", "operationId": "searchByUnitsInSpaces", "requestBody": { "description": "Запрос на поиск пользователей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSearchInSpacesByUnitsRq", "additionalProperties": false, "description": "Запрос на получение постраничного списка пользователей", "example": null }, "examples": { "Пример": { "description": "Пример с запросом на поиск пользователей", "value": { "searchString": "Иванов", "units": [ "SWTR-1", "SVTR-1", "SBTR-1" ], "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Список пользователей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRsUserBasicInfo", "description": "Список пользователей", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "content": [ { "code": "user123", "firstName": "Иван", "lastName": "Иванов", "middleName": "Иванович", "login": "ivanov", "userDetails": [ { "type": { "code": "email", "name": "Email", "visible": true, "properties": { "format": "email" } }, "value": "ivanov@example.com" } ] } ], "pageSize": 1, "hasNext": true, "pageNumber": 0, "totalElements": 13 } } } } } } } } }, "/rest/api/user/v1/search/by_groups": { "description": "Поиск списка пользователей по пространству и группам привилегий в нем", "post": { "tags": [ "API поиска пользователей @TT0" ], "summary": "Поиск списка пользователей по пространству и группам привилегий в нем", "operationId": "searchByPermissionGroups", "requestBody": { "description": "Запрос на поиск пользователей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSearchRequestByGroups", "additionalProperties": false, "description": "Запрос на получение постраничного списка пользователей", "example": null }, "examples": { "Пример c группами": { "description": "Пример c группами", "value": { "searchString": "", "spaces": [ "SPACE1", "SPACE2", "SPACE3" ], "groups": [ "SPACE_CONTRIBUTOR", "SPACE_READER" ], "page": { "page": 0, "size": 10 } } }, "Пример без групп": { "description": "Пример без групп", "value": { "searchString": "", "spaces": [ "SPACE1", "SPACE2", "SPACE3" ], "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Список пользователей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRsUserBasicInfo", "description": "Список пользователей", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "content": [ { "code": "user123", "firstName": "Иван", "lastName": "Иванов", "middleName": "Иванович", "login": "ivanov", "userDetails": [ { "type": { "code": "email", "name": "Email", "visible": true, "properties": { "format": "email" } }, "value": "ivanov@example.com" } ] } ], "pageSize": 1, "hasNext": true, "pageNumber": 0, "totalElements": 13 } } } } } } } } }, "/rest/api/user/v1/find": { "description": "Ищем пользователей по их кодам", "post": { "tags": [ "API поиска пользователей @TT0" ], "summary": "Ищем пользователей по их кодам", "operationId": "findByCodes", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "Коды пользователей", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Список пользователей", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserBasicInfo" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "examples": { "Пример": { "description": "Пример", "value": [ { "code": "100000", "firstName": "Иван", "lastName": "Иванов", "middleName": "Иванович", "login": "ivanov", "userDetails": [ { "type": { "code": "email", "name": "Email", "visible": true, "properties": { "format": "email" } }, "value": "ivanov@example.com" } ] } ] } } } } } } } }, "/rest/api/user/v1/fileId/avatars": { "description": "Отдаёт соответствие externalId и fileId аватара", "post": { "tags": [ "API для загрузки и отображения аватара пользователя" ], "summary": "Отдаёт соответствие externalId и fileId аватара", "operationId": "avatarsFileId", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "Список externalId пользователей", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Соответствие externalId и fileId аватара", "content": { "application/json": { "schema": { "type": "string", "description": "Множество оответствий externalId и fileId аватара", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "Пример": { "description": "Пример", "value": { "100003": "d360601b-07f2-489e-9175-2431662b113a" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/user/group/v1/find": { "description": "Ищет группы пользователей по фильтрам", "post": { "tags": [ "API поиска группы пользователей @TT0" ], "summary": "Ищет группы пользователей по фильтрам", "operationId": "find_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupPageRq", "example": null }, "example": null } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRsUserGroupInfoDto", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "content": [ { "code": "developers", "name": "Разработчики", "description": "BE Разработчики", "meta": { "mutable": "true" } } ], "pageSize": 1, "hasNext": true, "pageNumber": 0, "totalElements": 5 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/user/group/v1/create": { "description": "Создает группу пользователей", "post": { "tags": [ "API создания/изменения группы пользователей" ], "summary": "Создает группу пользователей", "operationId": "create_2", "requestBody": { "description": "Запрос на создание группы пользователей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserGroupRq", "description": "Запрос на создание группы пользователей", "example": null }, "examples": { "simple_user_group_creation": { "description": "Запрос на создание группы пользователей \"читатели\"", "value": { "code": "readers_group", "name": "Читатели", "description": "Группа пользователей, которые могут только читать", "users": [ { "externalId": "100001" }, { "externalId": "100002" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Успешное создание группы пользователей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "id": "readers_group" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/user/configuration/v1/display/save": { "description": "Сохранение конфигурации отображения экрана пользователя", "post": { "tags": [ "API редактирования конфигурации отображения экрана пользователя" ], "summary": "Сохранение конфигурации отображения экрана пользователя", "operationId": "saveUserDisplayConfig", "requestBody": { "description": "Запрос на сохранение конфигурации отображения экрана пользователя", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDisplayConfigRq", "additionalProperties": false, "description": "Запрос на сохранение конфигурации отображения экрана пользователя", "example": null }, "examples": { "success": { "description": "Запрос на сохранение конфигурации отображения экрана пользователя", "value": { "screen": "tasks", "columns": [ { "code": "createdBy", "position": 0 }, { "code": "unit", "position": 1 } ] } } } } }, "required": true }, "responses": { "204": { "description": "Успешное сохранение конфигурации отображения экрана пользователя", "headers": { "Location": { "description": "URL с сохраненной конфигурацией отображения экрана пользователя", "style": "simple", "schema": { "type": "string", "format": "uri" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit_template/v1/find": { "description": "Поиск шаблонов задач с фильтром", "post": { "tags": [ "API поиска шаблона задачи" ], "summary": "Поиск шаблонов задач с фильтром", "description": "Поиск шаблонов задач с фильтром", "operationId": "find_2", "requestBody": { "description": "Постраничный запрос шаблонов задач", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitTemplatePageDto", "additionalProperties": false, "description": "Запрос на получение постраничного списка шаблонов задач", "required": [ "filter", "page", "sort" ], "example": null }, "examples": { "Пример": { "description": "Запрос на получение постраничного списка шаблонов задач", "value": { "filter": { "spaces": [ "ANYSPC" ], "name": "" }, "sort": [ { "field": "deleted", "sortDirection": "ASC" }, { "field": "name", "sortDirection": "ASC" } ], "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Поиск шаблонов задач с фильтром", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoUnitTemplateInfoDto", "additionalProperties": false, "description": "Поиск шаблонов задач с фильтром", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница с одним шаблоном", "value": { "content": [ { "id": "00000000-0000-0000-0000-000000000000", "name": "Шаблон задачи", "scope": "SPACE", "deleted": false, "suit": { "code": "task", "name": "Задача", "icon": "task" }, "attributeValues": [ { "code": "watchers", "value": [ "100002" ] }, { "code": "story_points", "value": 42 } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] } } ], "pageSize": 10, "hasNext": false, "pageNumber": 0, "totalElements": 1 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit_template/v1/find/authors": { "description": "Получение авторов шаблонов задач", "post": { "tags": [ "API поиска шаблона задачи" ], "summary": "Получение авторов шаблонов задач", "description": "Получение авторов шаблонов задач", "operationId": "getUnitTemplateAuthors", "requestBody": { "description": "Запрос на поиск авторов шаблонов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitHistoryPageDto", "additionalProperties": false, "description": "Запрос на поиск авторов шаблонов", "required": [ "filter", "page", "sort", "unit" ], "example": null }, "examples": { "Пример": { "description": "Запрос на поиск авторов шаблонов", "value": { "spaces": [ "ANYSPC", "SWTR" ] } } } } }, "required": true }, "responses": { "200": { "description": "Создатели шаблонов задач в пространствах", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitTemplateAuthorsRsDto", "additionalProperties": false, "description": "Создатели шаблонов задач в пространствах", "required": [ "authors" ], "example": null }, "examples": { "success": { "description": "Автор шаблонов задач", "value": { "authors": [ { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] } ] } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit_template/v1/create": { "description": "Создание нового шаблона", "post": { "tags": [ "API изменения шаблона задачи" ], "summary": "Создание нового шаблона", "description": "Создание нового шаблона", "operationId": "create_3", "requestBody": { "description": "Запрос создания шаблона задачи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitTemplateChangeRqDto", "additionalProperties": false, "description": "Запрос с параметрами нового шаблона задач", "required": [ "attributeValues", "deleted", "name", "scope", "scopeEntityId", "suit" ], "example": null }, "examples": { "Пример": { "description": "Запрос создания шаблона задачи", "value": { "scopeEntityId": "ANYSPC", "name": "Шаблон типового бага для пространства ANYSPC", "suit": "bug", "deleted": false, "scope": "SPACE", "attributeValues": [ { "code": "description", "value": "Описание типового бага" }, { "code": "summary", "value": "Название типового бага" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Успешное создание шаблона задачи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "ИД шаблона задачи", "required": [ "id" ], "example": null }, "examples": { "Пример": { "description": "ИД шаблона задачи", "value": { "id": "00000000-0000-0000-0000-000000000000" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit_template/v1/copy/{template_id}": { "description": "Копирование шаблона", "post": { "tags": [ "API изменения шаблона задачи" ], "summary": "Копирование шаблона", "description": "Копирование шаблона", "operationId": "copy", "parameters": [ { "name": "template_id", "in": "path", "description": "ИД шаблона задачи", "required": true, "schema": { "type": "string", "format": "uuid", "description": "ИД шаблона задачи", "example": "00000000-0000-0000-0000-000000000000", "maxLength": 36, "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "example": "00000000-0000-0000-0000-000000000000" } ], "requestBody": { "description": "Запрос копирования шаблона задачи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitTemplateCopyRqDto", "additionalProperties": false, "description": "Запрос с параметрами копируемого шаблона задачи", "required": [ "name", "scope", "scopeEntityId" ], "example": null }, "examples": { "Пример": { "description": "Запрос копирования шаблона задачи", "value": { "scopeEntityId": "ANYSPC", "name": "Копия шаблон типового бага для пространства ANYSPC", "scope": "SPACE" } } } } }, "required": true }, "responses": { "200": { "description": "Успешное копирование шаблона задачи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "ИД шаблона задачи", "required": [ "id" ], "example": null }, "examples": { "Пример": { "description": "ИД шаблона задачи", "value": { "id": "00000000-0000-0000-0000-000000000000" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit/v4:find": { "description": "Поиск с фильтром расширенной информации по юниту. Не поддерживает не пагинированные запросы.", "post": { "tags": [ "API поиска юнита" ], "summary": "Поиск с фильтром расширенной информации по юниту. Не поддерживает не пагинированные запросы.", "operationId": "findV4", "requestBody": { "description": "Постраничный запрос на поиск юнитов без вычисления кол-ва записей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLRequestDto", "additionalProperties": false, "description": "Запрос на получение постраничного списка юнитов", "example": { "filters": { "spaces": [ "ANYSPC" ] }, "page": { "page": 0, "size": 10 } } }, "examples": { "simple": { "description": "Запрос первой страницы с 10 юнитами", "value": { "filters": { "spaces": [ "ANYSPC" ] }, "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный запрос на поиск юнитов без вычисления кол-ва записей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLResponseDtoSliceV3", "additionalProperties": false, "description": "Страница результатов поиска юнитов", "example": { "content": [ { "unit": { "code": "DEVK4ABQX-10", "summary": "Сделать все хорошо", "description": "Нужно сделать лучше, чем сейчас и побыстрее", "suit": { "code": "task", "name": "Поменяем название пользовательской истории", "icon": "super_idea" }, "space": { "code": "DEVK4ABQX", "name": "Демо спейс" }, "spaces": [ { "code": "DEVK4ABQX", "name": "Демо спейс" } ], "createdBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "createdAt": "2025-01-28T09:13:31.682855Z", "updatedBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "updatedAt": "2025-01-28T09:13:31.682855Z", "isFavorite": false }, "attributes": [ { "attribute": { "code": "assigned_to", "name": "Исполнитель", "type": "user", "description": "Исполнитель" }, "value": { "externalId": "100000", "firstName": "Василий_ROLE_TENANT_CONFIG", "lastName": "Кузякин", "middleName": "Егорович", "login": "vasiakuzyakin", "userDetails": [ ] } } ] } ], "pageSize": 100, "hasNext": false, "pageNumber": 0 }, "required": [ "content", "hasNext", "pageNumber", "pageSize" ] }, "examples": { "Пример": { "description": "Пример", "value": { "content": [ { "unit": { "code": "DEVK4ABQX-10", "summary": "Сделать все хорошо", "description": "Нужно сделать лучше, чем сейчас и побыстрее", "suit": { "code": "task", "name": "Поменяем название пользовательской истории", "icon": "super_idea" }, "space": { "code": "DEVK4ABQX", "name": "Демо спейс" }, "spaces": [ { "code": "DEVK4ABQX", "name": "Демо спейс" } ], "createdBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "createdAt": "2025-01-28T09:13:31.682855Z", "updatedBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "updatedAt": "2025-01-28T09:13:31.682855Z", "isFavorite": false }, "attributes": [ { "attribute": { "code": "assigned_to", "name": "Исполнитель", "type": "user", "description": "Исполнитель" }, "value": { "externalId": "100000", "firstName": "Василий_ROLE_TENANT_CONFIG", "lastName": "Кузякин", "middleName": "Егорович", "login": "vasiakuzyakin", "userDetails": [ ] } } ] } ], "pageSize": 100, "hasNext": false, "pageNumber": 0 } } } } } } } } }, "/rest/api/unit/v4:findByTql": { "description": "Постраничный запрос на поиск юнитов с помощью TQL без вычисления кол-ва записей", "post": { "tags": [ "API поиска юнита" ], "summary": "Постраничный запрос на поиск юнитов с помощью TQL без вычисления кол-ва записей", "operationId": "findWithTqlV4", "requestBody": { "description": "Запрос на постраничный поиск юнитов с помощью TQL", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TqlRq", "additionalProperties": false, "description": "Запрос на постраничный поиск юнитов с помощью TQL", "example": { "query": "space = \"SWTR\"", "page": { "page": 0, "size": 10 } }, "required": [ "query" ] }, "examples": { "simple": { "description": "Запрос на постраничный поиск юнитов с помощью TQL", "value": { "query": "space = \"SWTR\"", "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Список юнитов, полученный с помощью TQL без вычисления кол-ва записей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLResponseDtoSliceV3", "additionalProperties": false, "description": "Список юнитов, полученный с помощью TQL без вычисления кол-ва записей", "example": { "content": [ { "unit": { "code": "DEVK4ABQX-10", "summary": "Заголовок задачи", "description": "Описание задачи", "suit": { "code": "task", "name": "Поменяем название пользовательской истории", "icon": "super_idea" }, "space": { "code": "DEVK4ABQX", "name": "Демо спейс" }, "spaces": [ { "code": "DEVK4ABQX", "name": "Демо спейс" } ], "createdBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "createdAt": "2025-01-28T09:13:31.682855Z", "updatedBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "updatedAt": "2025-01-28T09:13:31.682855Z", "isFavorite": false }, "attributes": [ { "attribute": { "code": "assigned_to", "name": "Исполнитель", "type": "user", "description": "Исполнитель" }, "value": { "externalId": "100000", "firstName": "Василий_ROLE_TENANT_CONFIG", "lastName": "Кузякин", "middleName": "Егорович", "login": "vasiakuzyakin", "userDetails": [ ] } } ] } ], "pageSize": 100, "hasNext": false, "pageNumber": 0 }, "required": [ "content", "hasNext", "pageNumber", "pageSize" ] }, "examples": { "success": { "description": "Список юнитов, полученный с помощью TQL без вычисления кол-ва записей", "value": { "content": [ { "unit": { "code": "DEVK4ABQX-10", "summary": "Заголовок задачи", "description": "Описание задачи", "suit": { "code": "task", "name": "Поменяем название пользовательской истории", "icon": "super_idea" }, "space": { "code": "DEVK4ABQX", "name": "Демо спейс" }, "spaces": [ { "code": "DEVK4ABQX", "name": "Демо спейс" } ], "createdBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "createdAt": "2025-01-28T09:13:31.682855Z", "updatedBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "updatedAt": "2025-01-28T09:13:31.682855Z", "isFavorite": false }, "attributes": [ { "attribute": { "code": "assigned_to", "name": "Исполнитель", "type": "user", "description": "Исполнитель" }, "value": { "externalId": "100000", "firstName": "Василий_ROLE_TENANT_CONFIG", "lastName": "Кузякин", "middleName": "Егорович", "login": "vasiakuzyakin", "userDetails": [ ] } } ] } ], "pageSize": 100, "hasNext": false, "pageNumber": 0 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit/v3/{filter}/find": { "description": "Поиск с фильтром расширенной информации по юниту", "post": { "tags": [ "API поиска юнита" ], "summary": "Поиск с фильтром расширенной информации по юниту", "operationId": "fastFilter", "parameters": [ { "name": "filter", "in": "path", "description": "Идентификатор фильтра", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "my-unit" } ], "requestBody": { "description": "Постраничный запрос на поиск юнитов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLRequestDto", "additionalProperties": false, "description": "Запрос на получение постраничного списка юнитов", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 10 юнитами", "value": { "filters": { "spaces": [ "ANYSPC" ] }, "page": { "page": 0, "size": 10 } } } } } }, "required": false }, "responses": { "200": { "description": "Постраничный запрос на поиск юнитов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLResponseDtoPage", "additionalProperties": false, "description": "Постраничный вывод результатов поиска юнитов", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница с одним юнитом", "value": { "content": [ { "unit": { "code": "DEVK4ABQX-10", "summary": "демо 1509", "description": "демо 1509", "suit": { "code": "task", "name": "Поменяем название пользовательской истории", "icon": "super_idea" }, "space": { "code": "DEVK4ABQX", "name": "Демо спейс" }, "spaces": [ { "code": "DEVK4ABQX", "name": "Демо спейс" } ], "createdBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "createdAt": "2025-01-28T09:13:31.682855Z", "updatedBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "updatedAt": "2025-01-28T09:13:31.682855Z", "isFavorite": false }, "attributes": [ { "attribute": { "code": "assigned_to", "name": "Исполнитель", "type": "user", "description": "Исполнитель" }, "value": { "externalId": "100000", "firstName": "Василий_ROLE_TENANT_CONFIG", "lastName": "Кузякин", "middleName": "Егорович", "login": "vasiakuzyakin", "userDetails": [ ] } } ] } ], "pageSize": 100, "hasNext": false, "pageNumber": 0, "totalElements": 10 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit/v3/{filter}/find/composite": { "description": "Фильтрация внутри избранных юнитов", "post": { "tags": [ "API поиска юнита" ], "summary": "Фильтрация внутри избранных юнитов", "operationId": "fastFilterComposite", "parameters": [ { "name": "filter", "in": "path", "description": "Идентификатор фильтра", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "my-unit" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLCompositeRequestDto", "example": null }, "example": null } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLResponseDtoSliceV3", "example": null }, "example": null } } } } } }, "/rest/api/unit/v3/find": { "description": "Поиск с фильтром расширенной информации по юниту", "post": { "tags": [ "API поиска юнита" ], "summary": "Поиск с фильтром расширенной информации по юниту", "operationId": "findV3", "requestBody": { "description": "Постраничный запрос на поиск юнитов без вычисления кол-ва записей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLRequestDto", "additionalProperties": false, "description": "Запрос на получение постраничного списка юнитов", "example": { "filters": { "spaces": [ "ANYSPC" ] }, "page": { "page": 0, "size": 10 } } }, "examples": { "simple": { "description": "Запрос первой страницы с 10 юнитами", "value": { "filters": { "spaces": [ "ANYSPC" ] }, "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный запрос на поиск юнитов без вычисления кол-ва записей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLResponseDtoSliceV3", "additionalProperties": false, "description": "Страница результатов поиска юнитов", "example": { "content": [ { "unit": { "code": "DEVK4ABQX-10", "summary": "Сделать все хорошо", "description": "Нужно сделать лучше, чем сейчас и побыстрее", "suit": { "code": "task", "name": "Поменяем название пользовательской истории", "icon": "super_idea" }, "space": { "code": "DEVK4ABQX", "name": "Демо спейс" }, "spaces": [ { "code": "DEVK4ABQX", "name": "Демо спейс" } ], "createdBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "createdAt": "2025-01-28T09:13:31.682855Z", "updatedBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "updatedAt": "2025-01-28T09:13:31.682855Z", "isFavorite": false }, "attributes": [ { "attribute": { "code": "assigned_to", "name": "Исполнитель", "type": "user", "description": "Исполнитель" }, "value": { "externalId": "100000", "firstName": "Василий_ROLE_TENANT_CONFIG", "lastName": "Кузякин", "middleName": "Егорович", "login": "vasiakuzyakin", "userDetails": [ ] } } ] } ], "pageSize": 100, "hasNext": false, "pageNumber": 0 }, "required": [ "content", "hasNext", "pageNumber", "pageSize" ] }, "examples": { "Пример": { "description": "Пример", "value": { "content": [ { "unit": { "code": "DEVK4ABQX-10", "summary": "Сделать все хорошо", "description": "Нужно сделать лучше, чем сейчас и побыстрее", "suit": { "code": "task", "name": "Поменяем название пользовательской истории", "icon": "super_idea" }, "space": { "code": "DEVK4ABQX", "name": "Демо спейс" }, "spaces": [ { "code": "DEVK4ABQX", "name": "Демо спейс" } ], "createdBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "createdAt": "2025-01-28T09:13:31.682855Z", "updatedBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "updatedAt": "2025-01-28T09:13:31.682855Z", "isFavorite": false }, "attributes": [ { "attribute": { "code": "assigned_to", "name": "Исполнитель", "type": "user", "description": "Исполнитель" }, "value": { "externalId": "100000", "firstName": "Василий_ROLE_TENANT_CONFIG", "lastName": "Кузякин", "middleName": "Егорович", "login": "vasiakuzyakin", "userDetails": [ ] } } ] } ], "pageSize": 100, "hasNext": false, "pageNumber": 0 } } } } } } }, "deprecated": true } }, "/rest/api/unit/v3/find/tql": { "description": "Постраничный запрос на поиск юнитов с помощью TQL без вычисления кол-ва записей", "post": { "tags": [ "API поиска юнита" ], "summary": "Постраничный запрос на поиск юнитов с помощью TQL без вычисления кол-ва записей", "operationId": "findWithTqlV3", "requestBody": { "description": "Запрос на постраничный поиск юнитов с помощью TQL", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TqlRq", "additionalProperties": false, "description": "Запрос на постраничный поиск юнитов с помощью TQL", "example": { "query": "space = \"SWTR\"", "page": { "page": 0, "size": 10 } }, "required": [ "query" ] }, "examples": { "simple": { "description": "Запрос на постраничный поиск юнитов с помощью TQL", "value": { "query": "space = \"SWTR\"", "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Список юнитов, полученный с помощью TQL без вычисления кол-ва записей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLResponseDtoSliceV3", "additionalProperties": false, "description": "Список юнитов, полученный с помощью TQL без вычисления кол-ва записей", "example": { "content": [ { "unit": { "code": "DEVK4ABQX-10", "summary": "Заголовок задачи", "description": "Описание задачи", "suit": { "code": "task", "name": "Поменяем название пользовательской истории", "icon": "super_idea" }, "space": { "code": "DEVK4ABQX", "name": "Демо спейс" }, "spaces": [ { "code": "DEVK4ABQX", "name": "Демо спейс" } ], "createdBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "createdAt": "2025-01-28T09:13:31.682855Z", "updatedBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "updatedAt": "2025-01-28T09:13:31.682855Z", "isFavorite": false }, "attributes": [ { "attribute": { "code": "assigned_to", "name": "Исполнитель", "type": "user", "description": "Исполнитель" }, "value": { "externalId": "100000", "firstName": "Василий_ROLE_TENANT_CONFIG", "lastName": "Кузякин", "middleName": "Егорович", "login": "vasiakuzyakin", "userDetails": [ ] } } ] } ], "pageSize": 100, "hasNext": false, "pageNumber": 0 }, "required": [ "content", "hasNext", "pageNumber", "pageSize" ] }, "examples": { "success": { "description": "Список юнитов, полученный с помощью TQL без вычисления кол-ва записей", "value": { "content": [ { "unit": { "code": "DEVK4ABQX-10", "summary": "Заголовок задачи", "description": "Описание задачи", "suit": { "code": "task", "name": "Поменяем название пользовательской истории", "icon": "super_idea" }, "space": { "code": "DEVK4ABQX", "name": "Демо спейс" }, "spaces": [ { "code": "DEVK4ABQX", "name": "Демо спейс" } ], "createdBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "createdAt": "2025-01-28T09:13:31.682855Z", "updatedBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "updatedAt": "2025-01-28T09:13:31.682855Z", "isFavorite": false }, "attributes": [ { "attribute": { "code": "assigned_to", "name": "Исполнитель", "type": "user", "description": "Исполнитель" }, "value": { "externalId": "100000", "firstName": "Василий_ROLE_TENANT_CONFIG", "lastName": "Кузякин", "middleName": "Егорович", "login": "vasiakuzyakin", "userDetails": [ ] } } ] } ], "pageSize": 100, "hasNext": false, "pageNumber": 0 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/unit/v3/find/composite": { "description": "Фильтрация с помощью быстрых и TQL фильтров", "post": { "tags": [ "API поиска юнита" ], "summary": "Фильтрация с помощью быстрых и TQL фильтров", "operationId": "findComposite", "requestBody": { "description": "Постраничный запрос на поиск юнитов с помощью быстрых и TQL фильтров без вычисления кол-ва записей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLCompositeRequestDto", "additionalProperties": false, "description": "Запрос на получение постраничного списка юнитов", "example": { "filters": { "spaces": [ "ANYSPC" ] }, "page": { "page": 0, "size": 10 } } }, "examples": { "simple": { "description": "Запрос первой страницы с 10 юнитами", "value": { "filters": { "spaces": [ "ANYSPC" ] }, "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный запрос на поиск юнитов с комбинацией быстрых и tql фильтров без вычисления кол-ва записей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLResponseDtoSliceV3", "additionalProperties": false, "description": "Страница результатов поиска юнитов", "example": { "content": [ { "unit": { "code": "DEVK4ABQX-10", "summary": "Сделать все хорошо", "description": "Нужно сделать лучше, чем сейчас и побыстрее", "suit": { "code": "task", "name": "Поменяем название пользовательской истории", "icon": "super_idea" }, "space": { "code": "DEVK4ABQX", "name": "Демо спейс" }, "spaces": [ { "code": "DEVK4ABQX", "name": "Демо спейс" } ], "createdBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "createdAt": "2025-01-28T09:13:31.682855Z", "updatedBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "updatedAt": "2025-01-28T09:13:31.682855Z", "isFavorite": false }, "attributes": [ { "attribute": { "code": "assigned_to", "name": "Исполнитель", "type": "user", "description": "Исполнитель" }, "value": { "externalId": "100000", "firstName": "Василий_ROLE_TENANT_CONFIG", "lastName": "Кузякин", "middleName": "Егорович", "login": "vasiakuzyakin", "userDetails": [ ] } } ] } ], "pageSize": 100, "hasNext": false, "pageNumber": 0 }, "required": [ "content", "hasNext", "pageNumber", "pageSize" ] }, "examples": { "Пример": { "description": "Пример", "value": { "content": [ { "unit": { "code": "DEVK4ABQX-10", "summary": "Сделать все хорошо", "description": "Нужно сделать лучше, чем сейчас и побыстрее", "suit": { "code": "task", "name": "Поменяем название пользовательской истории", "icon": "super_idea" }, "space": { "code": "DEVK4ABQX", "name": "Демо спейс" }, "spaces": [ { "code": "DEVK4ABQX", "name": "Демо спейс" } ], "createdBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "createdAt": "2025-01-28T09:13:31.682855Z", "updatedBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "updatedAt": "2025-01-28T09:13:31.682855Z", "isFavorite": false }, "attributes": [ { "attribute": { "code": "assigned_to", "name": "Исполнитель", "type": "user", "description": "Исполнитель" }, "value": { "externalId": "100000", "firstName": "Василий_ROLE_TENANT_CONFIG", "lastName": "Кузякин", "middleName": "Егорович", "login": "vasiakuzyakin", "userDetails": [ ] } } ] } ], "pageSize": 100, "hasNext": false, "pageNumber": 0 } } } } } } } } }, "/rest/api/unit/v3/count": { "description": "Возвращает кол-во юнитов по заданному условию фильтрации", "post": { "tags": [ "API поиска юнита" ], "summary": "Возвращает кол-во юнитов по заданному условию фильтрации", "operationId": "count", "requestBody": { "description": "Запрос получения кол-ва юнитов по фильтру", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLRequestCountDto", "additionalProperties": false, "description": "Фильтры запроса чтения списка юнитов", "example": { "filters": { "spaces": [ "ANYSPC" ] } } }, "examples": { "simple": { "description": "Получить кол-во юнитов по условию фильтра - все юниты спейса ANYSPC", "value": { "filters": { "spaces": [ "ANYSPC" ] } } } } } }, "required": true }, "responses": { "200": { "description": "Возвращает кол-во записей для фильтра запроса поиска юнитов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLResponseCountDto", "additionalProperties": false, "description": "Кол-во записей", "example": { "count": 85 }, "required": [ "count" ] }, "examples": { "Пример": { "description": "Пример", "value": { "content": [ { "unit": { "code": "DEVK4ABQX-10", "summary": "Сделать все хорошо", "description": "Нужно сделать лучше, чем сейчас и побыстрее", "suit": { "code": "task", "name": "Поменяем название пользовательской истории", "icon": "super_idea" }, "space": { "code": "DEVK4ABQX", "name": "Демо спейс" }, "spaces": [ { "code": "DEVK4ABQX", "name": "Демо спейс" } ], "createdBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "createdAt": "2025-01-28T09:13:31.682855Z", "updatedBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "updatedAt": "2025-01-28T09:13:31.682855Z", "isFavorite": false }, "attributes": [ { "attribute": { "code": "assigned_to", "name": "Исполнитель", "type": "user", "description": "Исполнитель" }, "value": { "externalId": "100000", "firstName": "Василий_ROLE_TENANT_CONFIG", "lastName": "Кузякин", "middleName": "Егорович", "login": "vasiakuzyakin", "userDetails": [ ] } } ] } ], "pageSize": 100, "hasNext": false, "pageNumber": 0 } } } } } } } } }, "/rest/api/unit/v3/count/tql": { "description": "Возвращает кол-во юнитов по TQL-запросу", "post": { "tags": [ "API поиска юнита" ], "summary": "Возвращает кол-во юнитов по TQL-запросу", "operationId": "countTql", "requestBody": { "description": "Запрос для получения кол-ва юнитов с помощью TQL", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLRequestCountTqlDto", "additionalProperties": false, "description": "Запрос для получения кол-ва юнитов с помощью TQL", "example": { "query": "space = \"SWTR\"", "timeZone": "Europe/Moscow" }, "required": [ "query" ] }, "examples": { "simple": { "description": "Запрос для получения кол-ва записей юнитов с помощью TQL", "value": { "query": "space = \"SWTR\"", "timeZone": "Europe/Moscow" } } } } }, "required": true }, "responses": { "200": { "description": "Количество юнитов по TQL-запросу", "content": { "application/json": { "schema": { "type": "integer", "format": "int64", "additionalProperties": false, "description": "Количество юнитов", "example": 10, "maxLength": 2147483647, "pattern": ".*" }, "examples": { "success": { "description": "Количество юнитов", "value": 10 } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit/v3/count/composite": { "description": "Возвращает кол-во юнитов по заданному условию фильтрации совместно с пользовательскими фильтрами", "post": { "tags": [ "API поиска юнита" ], "summary": "Возвращает кол-во юнитов по заданному условию фильтрации совместно с пользовательскими фильтрами", "operationId": "countComposite", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLRequestCountCompositeDto", "example": null }, "example": null } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLResponseCountDto", "example": null }, "example": null } } } } } }, "/rest/api/unit/v2": { "description": "Создает новую задачу с заданным типом атрибута", "post": { "tags": [ "API создания/изменения задачи (v2)" ], "summary": "Создает новую задачу с заданным типом атрибута", "operationId": "create_4", "requestBody": { "description": "Создание задачи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitMutationCreateV2RqScheme", "description": "Запрос на создание задачи.\nВ attributes может передаваться иной набор пераметров\nв зависимости от сборки системы (наличия различных плагинов)\n", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "suit": "task", "summary": "Новая задача", "description": "Новая задача", "space": "SWTR", "attributes": { "priority": "mid", "workflow_status": { "command": "NEW" } } } } } } }, "required": true }, "responses": { "200": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "201": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "204": { "description": "Успешное удаление объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное удаление объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное удаление объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit/v2/{suit}/create": { "description": "Создает новую задачу с заданным типом атрибута", "post": { "tags": [ "API создания/изменения задачи (v2)" ], "summary": "Создает новую задачу с заданным типом атрибута", "operationId": "create_5", "parameters": [ { "name": "suit", "in": "path", "description": "Код типа задачи", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "task" } ], "requestBody": { "description": "Создание задачи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitMutationCreateRqScheme", "description": "Запрос на создание задачи.\nВ attributes может передаваться иной набор пераметров\nв зависимости от сборки системы (наличия различных плагинов)\n", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "summary": "Новая задача", "description": "Новая задача", "space": "SWTR", "attributes": { "priority": "mid", "workflow_status": { "command": "NEW" } } } } } } }, "required": true }, "responses": { "200": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "201": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "204": { "description": "Успешное удаление объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное удаление объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное удаление объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/unit/v2/{filter}/find": { "description": "Поиск с фильтром расширенной информации по юниту", "post": { "tags": [ "API поиска юнита" ], "summary": "Поиск с фильтром расширенной информации по юниту", "operationId": "fastFilter_1", "parameters": [ { "name": "filter", "in": "path", "description": "Идентификатор фильтра", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "my-unit" } ], "requestBody": { "description": "Постраничный запрос на поиск юнитов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLRequestDto", "additionalProperties": false, "description": "Запрос на получение постраничного списка юнитов", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 10 юнитами", "value": { "filters": { "spaces": [ "ANYSPC" ] }, "page": { "page": 0, "size": 10 } } } } } }, "required": false }, "responses": { "200": { "description": "Постраничный запрос на поиск юнитов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLResponseDtoPage", "additionalProperties": false, "description": "Постраничный вывод результатов поиска юнитов", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница с одним юнитом", "value": { "content": [ { "unit": { "code": "DEVK4ABQX-10", "summary": "демо 1509", "description": "демо 1509", "suit": { "code": "task", "name": "Поменяем название пользовательской истории", "icon": "super_idea" }, "space": { "code": "DEVK4ABQX", "name": "Демо спейс" }, "spaces": [ { "code": "DEVK4ABQX", "name": "Демо спейс" } ], "createdBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "createdAt": "2025-01-28T09:13:31.682855Z", "updatedBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "updatedAt": "2025-01-28T09:13:31.682855Z", "isFavorite": false }, "attributes": [ { "attribute": { "code": "assigned_to", "name": "Исполнитель", "type": "user", "description": "Исполнитель" }, "value": { "externalId": "100000", "firstName": "Василий_ROLE_TENANT_CONFIG", "lastName": "Кузякин", "middleName": "Егорович", "login": "vasiakuzyakin", "userDetails": [ ] } } ] } ], "pageSize": 100, "hasNext": false, "pageNumber": 0, "totalElements": 10 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/unit/v2/link": { "description": "Создание связи между юнитами", "post": { "tags": [ "API создания/изменения связей юнитов V2" ], "summary": "Создание связи между юнитами", "operationId": "link", "requestBody": { "description": "Запрос на создание связи юнита", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitLinkRq", "additionalProperties": false, "description": "Запрос на создание связи юнита", "example": null }, "examples": { "simple": { "description": "Создание связи", "value": { "source": "SWTR-1", "destination": "SWTR-2", "type": "decomposition" } } } } }, "required": true }, "responses": { "201": { "description": "Запрос на создание связи", "headers": { "Location": { "description": "URL для получения созданного ресурса", "schema": { "format": "uri" } } }, "content": { "application/json": { "schema": { "type": "boolean", "additionalProperties": false, "description": "Информация об успешности создания связи юнита", "example": false, "maxLength": 2147483647, "pattern": ".*" }, "examples": { "success": { "description": "Информация об успешности создания связи юнита", "value": true } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit/v2/link/types": { "description": "Получение типов связей между юнитами", "post": { "tags": [ "API поиска типов связей между юнитами @TT0" ], "summary": "Получение типов связей между юнитами", "operationId": "find_3", "requestBody": { "description": "Постраничный запрос на поиск типов связей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkTypePageRq", "additionalProperties": false, "description": "Запрос на получение постраничного списка типов связей", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 100 типами связей", "value": { "filters": { "textSearch": "Деко" }, "page": { "page": 0, "size": 100 } } } } } }, "required": false }, "responses": { "200": { "description": "Запрос на поиск типов связей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRs", "additionalProperties": false, "description": "Информация о типе связи", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Информация по типу связи", "value": { "content": [ { "code": "decomposition", "name": "Декомпозиция", "description": "Выстраивание наследования при декомпозиции", "source": { "name": "Является частью", "description": "Этот вид связи устанавливает выбранный элемент в качестве родительского по отношению к текущему. Родительский элемент может быть только один" }, "destination": { "name": "Состоит из", "description": "Этот вид связи устанавливает выбранный элемент в качестве дочернего по отношению к текущему. Дочерних элементов может быть больше одного" }, "relationship": "HIERARCHY", "deleted": false } ], "pageSize": 100, "hasNext": false, "pageNumber": 0, "totalElements": 1 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit/v2/find": { "description": "Поиск с фильтром расширенной информации по юниту", "post": { "tags": [ "API поиска юнита" ], "summary": "Поиск с фильтром расширенной информации по юниту", "operationId": "find_4", "requestBody": { "description": "Постраничный запрос на поиск юнитов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLRequestDto", "additionalProperties": false, "description": "Запрос на получение постраничного списка юнитов", "example": { "filters": { "spaces": [ "ANYSPC" ] }, "page": { "page": 0, "size": 10 } } }, "examples": { "simple": { "description": "Запрос первой страницы с 10 юнитами", "value": { "filters": { "spaces": [ "ANYSPC" ] }, "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Страничный ответ для QL запросов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLResponseDtoPage", "description": "Страничный ответ для QL запросов", "example": null }, "example": null } } } }, "deprecated": true } }, "/rest/api/unit/v2/find/tql": { "description": "Поиск с помощью TQL расширенной информации по юниту", "post": { "tags": [ "API поиска юнита" ], "summary": "Поиск с помощью TQL расширенной информации по юниту", "operationId": "findWithTql", "requestBody": { "description": "Постраничный запрос на поиск юнитов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TqlRq", "additionalProperties": false, "description": "Запрос на получение постраничного списка юнитов", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 10 юнитами", "value": { "query": "space IN (\"ANYSPC\") AND date = \"15.08.2025\"", "timeZone": "Asia/Novosibirsk", "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный запрос на поиск юнитов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLResponseDtoPage", "additionalProperties": false, "description": "Постраничный вывод результатов поиска юнитов", "example": { "content": [ { "unit": { "code": "DEVK4ABQX-10", "summary": "демо 1509", "description": "демо 1509", "suit": { "code": "task", "name": "Поменяем название пользовательской истории", "icon": "super_idea" }, "space": { "code": "DEVK4ABQX", "name": "Демо спейс" }, "spaces": [ { "code": "DEVK4ABQX", "name": "Демо спейс" } ], "createdBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "createdAt": "2025-01-28T09:13:31.682855Z", "updatedBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "updatedAt": "2025-01-28T09:13:31.682855Z", "isFavorite": false }, "attributes": [ { "attribute": { "code": "assigned_to", "name": "Исполнитель", "type": "user", "description": "Исполнитель" }, "value": { "externalId": "100000", "firstName": "Василий_ROLE_TENANT_CONFIG", "lastName": "Кузякин", "middleName": "Егорович", "login": "vasiakuzyakin", "userDetails": [ ] } } ] } ], "pageSize": 100, "hasNext": false, "pageNumber": 0, "totalElements": 10 }, "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ] }, "examples": { "success": { "description": "Первая страница с одним юнитом", "value": { "content": [ { "unit": { "code": "DEVK4ABQX-10", "summary": "демо 1509", "description": "демо 1509", "suit": { "code": "task", "name": "Поменяем название пользовательской истории", "icon": "super_idea" }, "space": { "code": "DEVK4ABQX", "name": "Демо спейс" }, "spaces": [ { "code": "DEVK4ABQX", "name": "Демо спейс" } ], "createdBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "createdAt": "2025-01-28T09:13:31.682855Z", "updatedBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null, "login": "test", "userDetails": [ ] }, "updatedAt": "2025-01-28T09:13:31.682855Z", "isFavorite": false }, "attributes": [ { "attribute": { "code": "assigned_to", "name": "Исполнитель", "type": "user", "description": "Исполнитель" }, "value": { "externalId": "100000", "firstName": "Василий_ROLE_TENANT_CONFIG", "lastName": "Кузякин", "middleName": "Егорович", "login": "vasiakuzyakin", "userDetails": [ ] } } ] } ], "pageSize": 100, "hasNext": false, "pageNumber": 0, "totalElements": 10 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/unit/v2/find/csv": { "description": "Ответ на запрос поиска юнитов для выгрузки в csv", "post": { "tags": [ "API поиска юнита" ], "summary": "Ответ на запрос поиска юнитов для выгрузки в csv", "operationId": "exportCsv", "requestBody": { "description": "Постраничный запрос на поиск юнитов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportCsvRq", "additionalProperties": false, "description": "Запрос на получение постраничного списка юнитов", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 10 юнитами", "value": " {\n \"query\": \"space IN (\"ANYSPC\") AND date = \"15.08.2025\"\",\n \"tqlTimeZone\": \"Asia/Novosibirsk\"\n \"page\": {\n \"page\": 0,\n \"size\": 10\n }\n }\n" } } } }, "required": true }, "responses": { "200": { "description": "Ответ с найденной пост функцией", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportCsvRs", "description": "Ответ с найденной пост функцией", "example": null }, "example": null } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit/v2/clone": { "description": "Клонирует задачу", "post": { "tags": [ "API создания/изменения задачи (v2)" ], "summary": "Клонирует задачу", "description": "Клонирует задачу", "operationId": "clone", "requestBody": { "description": "Тело запроса на клонирование задачи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneUnitRq", "additionalProperties": false, "description": "Тело запроса на клонирование задачи", "required": [ "code", "data" ], "example": null }, "examples": { "Пример": { "description": "Тело запроса", "value": { "code": "DEMO-1", "clone_links": true, "data": { "summary": "демо 1006", "description": "демо 1006", "due_date": "2023-06-09T12:01:18Z", "priority": "high", "label": [ "hello", "world", "hello-world", "super", "mega", "task" ], "assigned_to": "100000", "workflow_status": null } } } } } }, "required": true }, "responses": { "200": { "description": "Идентификатор склонированной задачи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Идентификатор склонированной задачи", "required": [ "id" ], "example": null }, "examples": { "success": { "description": "Идентификатор склонированной задачи", "value": { "id": "DEMO-1" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit/v1/{suit}/create": { "description": "Создает новую задачу с заданным типом атрибута", "post": { "tags": [ "API создания/изменения задачи" ], "summary": "Создает новую задачу с заданным типом атрибута", "operationId": "create_6", "parameters": [ { "name": "suit", "in": "path", "description": "Код типа задачи", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "task" } ], "requestBody": { "description": "Создание задачи", "content": { "application/json": { "schema": { "type": "string", "additionalProperties": false, "description": "Запрос на создание задачи", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "Пример": { "description": "Пример", "value": "{\n \"summary\": \"Новая задача\",\n \"description\": \"Новая задача\",\n \"space\": \"SWTR\",\n \"priority\": \"mid\",\n \"workflow_status\": {\n \"command\": \"NEW\"\n },\n \"links\": [ {\"source\": \"SWTR-2\", \"type\": \"decomposition\" }],\n}\n" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "example": null }, "example": null } } } }, "deprecated": true } }, "/rest/api/unit/v1/link": { "description": "Поиск связи по ее коду", "get": { "tags": [ "API поиска связей между юнитами" ], "summary": "Поиск связи по ее коду", "operationId": "get_1", "parameters": [ { "name": "source", "in": "query", "description": "Код юнита - источника", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "SWTR-1" }, { "name": "destination", "in": "query", "description": "Код юнита - назначения", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "SWTR-2" }, { "name": "type", "in": "query", "description": "Тип связи", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "decomposition" } ], "responses": { "200": { "description": "Запрос на поиск связи по коду", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitLinkInfo", "additionalProperties": false, "description": "Информация о связи юнита", "required": [ "destination", "pageNumber", "source", "type" ], "example": null }, "examples": { "success": { "description": "Информация по связи юнита", "value": { "source": "SWTR-1", "destination": "SWTR-2", "type": "decomposition", "deleted": false } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } }, "post": { "tags": [ "API создания/изменения связей юнитов" ], "summary": "Создание связи между юнитами", "operationId": "link_1", "requestBody": { "description": "Запрос на создание связи юнита", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitLinkRq", "additionalProperties": false, "description": "Запрос на создание связи юнита", "example": null }, "examples": { "simple": { "description": "Создание связи", "value": " {\n \"source\": \"SWTR-1\",\n \"destination\": \"SWTR-2\",\n \"type\": \"decomposition\",\n }\n" } } } }, "required": true }, "responses": { "200": { "description": "Запрос на создание связи", "content": { "application/json": { "schema": { "type": "boolean", "additionalProperties": false, "description": "Информация об успешности создания связи юнита", "example": false, "maxLength": 2147483647, "pattern": ".*" }, "examples": { "success": { "description": "Информация об успешности создания связи юнита", "value": true } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/unit/v1/link/types": { "description": "Получение типов связей между юнитами", "post": { "tags": [ "API поиска типов связей между юнитами" ], "summary": "Получение типов связей между юнитами", "operationId": "find_5", "requestBody": { "description": "Постраничный запрос на поиск типов связей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkTypePageRq", "additionalProperties": false, "description": "Запрос на получение постраничного списка типов связей", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 100 типами связей", "value": { "filters": { "textSearch": "Деко" }, "page": { "page": 0, "size": 100 } } } } } }, "required": false }, "responses": { "200": { "description": "Запрос на поиск типов связей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRs", "additionalProperties": false, "description": "Информация о типе связи", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Информация по типу связи", "value": { "content": [ { "code": "decomposition", "name": "Декомпозиция", "description": "Выстраивание наследования при декомпозиции", "sourceText": "Является частью", "sourceDescription": "Этот вид связи устанавливает выбранный элемент в качестве родительского по отношению к текущему. Родительский элемент может быть только один", "destinationText": "Состоит из", "destinationDescription": "Этот вид связи устанавливает выбранный элемент в качестве дочернего по отношению к текущему. Дочерних элементов может быть больше одного", "relationship": "HIERARCHY", "deleted": false } ], "pageSize": 100, "hasNext": false, "pageNumber": 0, "totalElements": 1 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/unit/v1/link/type/create": { "description": "Создание типа связи между юнитами", "post": { "tags": [ "API создания/изменения типов связей юнитов" ], "summary": "Создание типа связи между юнитами", "operationId": "create_7", "requestBody": { "description": "Запрос на создание типа связи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUnitLinkTypeRq", "additionalProperties": false, "description": "Запрос на создание типа связи", "example": null }, "examples": { "simple": { "description": "Запрос на создание типа связи clone", "value": { "code": "clone", "name": "Клон", "description": "Клонирование", "source": { "name": "Клонирует", "description": "Оригинал юнита" }, "destination": { "name": "Склонирован", "description": "Клон юнита" }, "relationship": "FLAT" } } } } }, "required": true }, "responses": { "200": { "description": "Запрос на создание типа связи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Информация о созданном типе связи", "required": [ "id" ], "example": null }, "examples": { "success": { "description": "Информация по созданному типу связи", "value": { "id": "SWTRTST" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit/v1/link/find": { "description": "Поиск связей между юнитам", "post": { "tags": [ "API поиска связей между юнитами" ], "summary": "Поиск связей между юнитам", "operationId": "find_6", "requestBody": { "description": "Постраничный запрос на поиск связи юнита", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitLinkSearchRq", "additionalProperties": false, "description": "Запрос на получение постраничного списка связей юнита", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 10 связями", "value": { "unitId": "SWTR-1", "direction": "source", "types": [ "decomposition" ], "page": { "page": { "page": 0, "size": 10 } } } } } } }, "required": true }, "responses": { "200": { "description": "Запрос на постраничный поиск связей юнита по его коду", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRs", "additionalProperties": false, "description": "Постраничный вывод результатов поиска связей юнита", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Информация по связи юнита", "value": { "content": [ { "source": "SWTR-1", "destination": "SWTR-2", "type": "decomposition", "deleted": false }, { "source": "SWTR-1", "destination": "SWTR-3", "type": "decomposition", "deleted": false }, { "source": "SWTR-1", "destination": "SWTR-4", "type": "decomposition", "deleted": false } ], "pageSize": 100, "hasNext": false, "pageNumber": 0, "totalElements": 3 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit/v1/history/find": { "description": "Поиск истории изменений задачи с фильтром", "post": { "tags": [ "API поиска истории изменений юнита" ], "summary": "Поиск истории изменений задачи с фильтром", "description": "Поиск истории изменений задачи с фильтром", "operationId": "find_7", "requestBody": { "description": "Постраничный запрос поиска истории задачи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitHistoryPageDto", "additionalProperties": false, "description": "Запрос на получение постраничного списка истории по задаче", "required": [ "filter", "page", "sort", "unit" ], "example": null }, "examples": { "Пример": { "description": "Результат запроса на получение постраничного списка истории по задаче", "value": { "unit": "ANYSPC-1", "filter": { "users": [ "100002", "100003" ], "attributes": [ "summary", "story_points" ] }, "sort": "DESC", "page": { "page": 0, "size": 100 } } } } } }, "required": true }, "responses": { "200": { "description": "Поиск истории изменений задачи с фильтром", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoUnitHistoryInfoDto", "additionalProperties": false, "description": "Постраничный список", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница с одной записью в истории", "value": { "content": [ { "user": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович" }, "createdAt": "2025-02-03T10:18:11.491652Z", "type": "BASE_ATTRIBUTE", "action": "UPDATE", "entity": { "element": "BASE_ATTRIBUTE", "code": "summary", "name": null, "type": null, "description": null, "sourceText": null, "destinationText": null }, "oldValue": "Название юнита до правки", "newValue": "Название юнита после правки", "meta": { "masked": false } } ], "pageSize": 100, "hasNext": false, "pageNumber": 0, "totalElements": 1 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit/v1/hierarchy": { "description": "Иерархическая структура юнитов", "post": { "tags": [ "API поиска юнита" ], "summary": "Иерархическая структура юнитов", "operationId": "find_8", "requestBody": { "description": "Запрос иерархической структуры юнитов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HierarchyRq", "additionalProperties": false, "description": "Запрос иерархической структуры", "required": [ "filter" ], "example": null }, "examples": { "lazy": { "description": "Запрос иерархической структуры юнитов спейса ANYSPC. Ленивое чтение - только верхний уровень.", "value": { "filter": { "spaces": [ "ANYSPC" ], "linkTypes": [ "decomposition" ] } } }, "eager": { "description": "Запрос иерархической структуры юнитов спейса ANYSPC. Жадное чтение всей структуры.", "value": { "param": { "eager": true }, "filter": { "spaces": [ "ANYSPC" ], "linkTypes": [ "decomposition" ] } } } } } }, "required": true }, "responses": { "200": { "description": "Иерархическая структура юнитов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HierarchyRs", "additionalProperties": false, "description": "Иерархическая структура юнитов", "required": [ "elements" ], "example": null }, "examples": { "success": { "description": "Элементы иерархии", "value": { "elements": [ { "element": { "code": "ANYSPC-1", "summary": "демо 1509", "description": "демо 1509", "suit": { "code": "task", "name": "Поменяем название пользовательской истории", "icon": "super_idea" }, "space": { "code": "ANYSPC", "name": "Демо спейс" }, "createdBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null }, "createdAt": "2025-01-28T09:13:20.998448Z", "updatedBy": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null }, "updatedAt": "2025-01-28T09:13:20.998448Z" }, "hasChild": true, "childList": null, "recursive": null } ] } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit/v1/generate/description": { "description": "Получение описания задачи по наименованию", "post": { "tags": [ "API для интеграции задачи с гига чатом" ], "summary": "Получение описания задачи по наименованию", "description": "Получение описания задачи по наименованию", "operationId": "generateDescription", "requestBody": { "description": "Запрос на получение описания задачи по наименованию", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitGigaChatMessageRq", "additionalProperties": false, "description": "Запрос на получение описания задачи по наименованию", "required": [ "summary" ], "example": null }, "examples": { "Пример": { "description": "Тело запроса", "value": { "summary": "Разработать поле с типом float" } } } } }, "required": true }, "responses": { "200": { "description": "Описание задачи по наименованию", "content": { "application/json": { "schema": { "type": "string", "additionalProperties": false, "description": "Описание задачи по наименованию", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "success": { "description": "Описание задачи по наименованию", "value": "Описание" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit/v1/find": { "description": "Поиск с фильтром расширенной информации по юниту. deprecated - используйте '/rest/api/unit/v2/find' ", "post": { "tags": [ "API поиска юнита" ], "summary": "Поиск с фильтром расширенной информации по юниту. deprecated - используйте '/rest/api/unit/v2/find' ", "operationId": "find_9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitPageDto", "example": null }, "example": null } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRsUnitInSuitWithSpacesInfo", "example": null }, "example": null } } } }, "deprecated": true } }, "/rest/api/unit/v1/favorite/{unit}": { "description": "Добавляет задачу в избранное", "post": { "tags": [ "API добавления/удаления задачи в избранное" ], "summary": "Добавляет задачу в избранное", "operationId": "create_8", "parameters": [ { "name": "unit", "in": "path", "description": "Код задачи", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "SWTR-1" } ], "requestBody": { "description": "Запрос добавления задачи в избранное", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUnitFavoriteRq", "additionalProperties": false, "description": "Запрос добавления задачи в избранное", "example": null }, "examples": { "simple": { "description": "Запрос добавления задачи в избранное", "value": { } } } } }, "required": false }, "responses": { "200": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "201": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "204": { "description": "Успешное удаление объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное удаление объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное удаление объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } }, "delete": { "tags": [ "API добавления/удаления задачи в избранное" ], "summary": "Удаляет задачу из избранного", "operationId": "delete", "parameters": [ { "name": "unit", "in": "path", "description": "Код задачи", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "SWTR-1" } ], "responses": { "200": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "201": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "204": { "description": "Успешное удаление объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное удаление объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное удаление объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit/v1/convert/suit": { "description": "Ищет типы задач по фильтру", "post": { "tags": [ "API допустимые операции задачи" ], "summary": "Ищет типы задач по фильтру", "description": "Ищет типы задач по фильтру", "operationId": "find_10", "requestBody": { "description": "Постраничный запрос на поиск типов задач", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitConvertSuitPageRq", "additionalProperties": false, "description": "Постраничный запрос на поиск типов задач", "example": null }, "examples": { "simple": { "description": "Постраничный запрос на поиск типов задач", "value": { "filters": { "unit": "SWTR-1" }, "page": { "page": 0, "size": 100 } } } } } }, "required": true }, "responses": { "200": { "description": "Типы задач, в которые можно преобразовать задачу", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRsUnitConvertSuitInfo", "additionalProperties": false, "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "content": [ { "code": "task", "name": "Задача", "description": "Задача", "icon": "task" }, { "code": "idea", "name": "Идея", "description": "Идея", "icon": "idea" }, { "code": "epic", "name": "Эпик", "description": "Эпик", "icon": "epic" } ], "pageSize": 100, "hasNext": false, "pageNumber": 0, "totalElements": 3 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit/v1/convert/space": { "description": "Ищет пространства по фильтру", "post": { "tags": [ "API допустимые операции задачи" ], "summary": "Ищет пространства по фильтру", "description": "Ищет пространства по фильтру", "operationId": "find_11", "requestBody": { "description": "Постраничный запрос на поиск пространств", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitConvertSpacePageRq", "additionalProperties": false, "description": "Постраничный запрос на поиск пространств", "example": null }, "examples": { "simple": { "description": "Постраничный запрос на поиск пространств", "value": { "filters": { "unit": "SWTR-1" }, "page": { "page": 0, "size": 100 } } } } } }, "required": true }, "responses": { "200": { "description": "Пространства, в которые можно перенести задачу", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRsUnitConvertSpaceInfo", "additionalProperties": false, "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "content": [ { "code": "SVTR", "name": "SVTR", "type": "PERSONAL", "createdAt": "2025-06-23T09:39:14.301495Z", "updatedAt": "2025-06-23T09:39:14.301495Z", "allowedActionsInUnit": [ { "name": "read" }, { "name": "create" }, { "name": "update" }, { "name": "write" }, { "name": "delete" } ] }, { "code": "SWTR", "name": "SWTR", "type": "PERSONAL", "createdAt": "2025-06-23T09:07:56.587485Z", "updatedAt": "2025-07-02T08:15:07.170194Z", "allowedActionsInUnit": [ { "name": "read" }, { "name": "create" }, { "name": "update" }, { "name": "write" }, { "name": "delete" } ] } ], "pageSize": 100, "hasNext": false, "pageNumber": 0, "totalElements": 2 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit/v1/clone": { "description": "Клонирует задачу", "post": { "tags": [ "API создания/изменения задачи" ], "summary": "Клонирует задачу", "description": "Клонирует задачу", "operationId": "clone_1", "requestBody": { "description": "Тело запроса на клонирование задачи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneUnitRq", "additionalProperties": false, "description": "Тело запроса на клонирование задачи", "required": [ "code", "data" ], "example": null }, "examples": { "Пример": { "description": "Тело запроса", "value": { "code": "DEMO-1", "clone_links": true, "data": { "summary": "демо 1006", "description": "демо 1006", "due_date": "2023-06-09T12:01:18Z", "priority": "high", "label": [ "hello", "world", "hello-world", "super", "mega", "task" ], "assigned_to": "100000", "workflow_status": null } } } } } }, "required": true }, "responses": { "200": { "description": "Идентификатор склонированной задачи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Идентификатор склонированной задачи", "required": [ "id" ], "example": null }, "examples": { "success": { "description": "Идентификатор склонированной задачи", "value": { "id": "DEMO-1" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/unit/post/function/v1/update": { "description": "Обновить конфигурацию пост-функций", "post": { "tags": [ "API для работы с конфигурацией пост-функций" ], "summary": "Обновить конфигурацию пост-функций", "operationId": "update_2", "requestBody": { "description": "Описание обновлений для конфигурации пост-функции", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostFunctionUpdateRq", "description": "Тело запроса на обновление конфигурации пост-функции", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Успешный ответ об обновлении конфигурации пост-функции", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostFunctionUpdateRs", "description": "Успешный ответ об обновлении конфигурации пост-функции", "example": null }, "example": null } } } }, "deprecated": true } }, "/rest/api/unit/post/function/v1/find": { "description": "Найти установленные функции", "post": { "tags": [ "API для работы с пост функциями юнита" ], "summary": "Найти установленные функции", "operationId": "find_12", "requestBody": { "description": "Выборка пост-функций по фильтру", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostFunctionsRq", "description": "Выборка пост-функций по фильтру", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Список найденных пост-функций", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostFunctionsDto", "description": "Информация о пост-функции", "example": null }, "example": null } } } } } }, "/rest/api/unit/files/v2/upload/{spaceCode}/{unitCode}": { "description": "Загружает в хранилище файл юнита", "post": { "tags": [ "API по работе с файлами юнита" ], "summary": "Загружает в хранилище файл юнита", "operationId": "upload_1", "parameters": [ { "name": "unitCode", "in": "path", "description": "Код юнита", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "minLength": 1, "pattern": ".*" }, "example": "SWTR-1" }, { "name": "spaceCode", "in": "path", "description": "Код пространства", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "minLength": 1, "pattern": ".*" }, "example": "ANYSPC" } ], "requestBody": { "description": "Представление Multipart File как тела запроса", "content": { "multipart/form-data": { "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*", "properties": { "fileName": { "type": "string" }, "file": { "type": "string", "format": "binary" } }, "required": [ "file" ] }, "example": "Пример" } }, "required": true }, "responses": { "201": { "description": "DTO файла с полной информацией о юните", "headers": { "Location": { "description": "URL для получения созданного ресурса", "schema": { "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileFullInfoDto", "description": "DTO файла с полной информацией о юните", "example": null }, "example": null } } } } } }, "/rest/api/unit/files/v1/{unitCode}": { "description": "Получает информацию о файлах юнита", "post": { "tags": [ "API по работе с файлами юнита" ], "summary": "Получает информацию о файлах юнита", "operationId": "findFilesOfUnit", "parameters": [ { "name": "unitCode", "in": "path", "description": "Код юнита", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "SWTR-1" }, { "name": "safe", "in": "query", "description": "Безопасный режим: метод не падает, если файл не найден в S3", "required": false, "schema": { "type": "boolean", "default": false, "example": true }, "example": "true" } ], "requestBody": { "description": "Параметры пагинации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRq", "description": "Параметры пагинации", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "DTO файла с полной информацией о юните", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileFullInfoDto", "description": "DTO файла с полной информацией о юните", "example": null }, "example": null } } } }, "deprecated": true } }, "/rest/api/unit/files/v1/upload/{spaceCode}/{unitCode}": { "description": "Загружает в хранилище файл юнита", "post": { "tags": [ "API по работе с файлами юнита" ], "summary": "Загружает в хранилище файл юнита", "operationId": "upload_2", "parameters": [ { "name": "unitCode", "in": "path", "description": "Код юнита", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "SWTR-1" }, { "name": "spaceCode", "in": "path", "description": "Код пространства", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "ANYSPC" } ], "requestBody": { "description": "Представление Multipart File как тела запроса", "content": { "multipart/form-data": { "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*", "properties": { "fileName": { "type": "string" }, "file": { "type": "string", "format": "binary" } }, "required": [ "file" ] }, "example": "Пример" } }, "required": true }, "responses": { "200": { "description": "DTO файла с полной информацией о юните", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileFullInfoDto", "description": "DTO файла с полной информацией о юните", "example": null }, "example": null } } } }, "deprecated": true } }, "/rest/api/unit/files/v1/copy": { "description": "Копировать файл к юниту", "post": { "tags": [ "API по работе с файлами юнита" ], "summary": "Копировать файл к юниту", "operationId": "copyFileToUnit", "requestBody": { "description": "Тело запроса на клонирование файла к задаче", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileCopyToUnitDto", "additionalProperties": false, "description": "Запрос на клонирование файла к задаче", "example": null }, "examples": { "simple": { "description": "Запрос на клонирование файла к задаче", "value": { "fileId": "177ecd1d-8f1e-4049-85f2-a44c4aef515e", "unitCode": "SWTR-204" } } } } }, "required": true }, "responses": { "200": { "description": "DTO с полной информацией о файле юните", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileFullInfoDto", "description": "DTO с полной информацией о новом файле юните", "example": null }, "examples": { "Success": { "description": "DTO с полной информацией о новом файле юните", "value": "{\n \"fileId\": \"00000000-0000-0000-0000-000000000000\",\n \"filePathParsedDto\": {\n \"relatedToType\": \"UNIT_FILE\",\n \"relativePath\": \"22222222-2222-2222-2222-222222222221/44444444-4444-4444-4444-444444444444\",\n \"fileName\": \"rick_roll.jpeg\"\n },\n \"createdBy\": {\n \"externalId\": \"user_external_id\",\n \"firstName\": \"Иван,\n \"lastName\": \"Иванов\",\n \"middleName\": \"Иванович\"\n },\n \"createdAt\": \"2035-12-31T23:55:01.036924680Z\",\n \"fileMetadataDto\": {\n \"contentType\": \"image/jpeg\",\n \"contentLength\": 112754\n }\n}" } } } } } } } }, "/rest/api/unit-comment/v2/create": { "description": "Создает новый коментарий к юниту", "post": { "tags": [ "API по работе с комментариями юнита @TT0 V2" ], "summary": "Создает новый коментарий к юниту", "operationId": "createComment", "requestBody": { "description": "Данные для создания комментария юнита", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitCommentForCreateDto", "description": "Запрос на создание комментария юнита", "example": null }, "examples": { "simple_unit_comment_creation_request": { "description": "Запрос для создания комментария юнита", "value": { "unitCode": "SPCTSK5-4", "commentText": "Текст комментария" } } } } }, "required": true }, "responses": { "201": { "description": "Идентификатор созданного комментария юнита", "headers": { "Location": { "description": "URL для получения созданного ресурса", "schema": { "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "id": "f1b2f1b0-836b-42c3-84d5-4e331427098a" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit-comment/v1/find": { "description": "Ищет комментарии текущего юнита с соответствии с фильтром", "post": { "tags": [ "API по работе с комментариями юнита @TT0" ], "summary": "Ищет комментарии текущего юнита с соответствии с фильтром", "operationId": "findUnitComments", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitCommentSearchRqDto", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Список комментариев юнита", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRsUnitCommentDto", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "content": [ { "unitCommentCode": "f1b2f1b0-836b-42c3-84d5-4e331427098a", "unitCode": "SPCTSK-4", "commentText": "Текст комментария", "createdBy": { "externalId": "100003", "firstName": "Вероника", "lastName": "Строгая", "middleName": "Марковна", "login": "veronikastrogaya", "locale": "ru_RU", "userDetails": [ ] }, "createdAt": "2025-01-28T13:00:48.494573Z", "updatedBy": { "externalId": "100003", "firstName": "Вероника", "lastName": "Строгая", "middleName": "Марковна", "login": "veronikastrogaya", "locale": "ru_RU", "userDetails": [ ] }, "updatedAt": "2025-01-28T13:00:48.494573Z", "deleted": false } ], "pageSize": 100, "hasNext": false, "pageNumber": 0, "totalElements": 1 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/unit-comment/v1/create": { "description": "Создает новый комментарий к юниту", "post": { "tags": [ "API по работе с комментариями юнита @TT0" ], "summary": "Создает новый комментарий к юниту", "operationId": "createComment_1", "requestBody": { "description": "Данные для создания комментария юнита", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitCommentForCreateDto", "description": "Запрос на создание комментария юнита", "example": null }, "examples": { "simple_unit_comment_creation_request": { "description": "Запрос для создания комментария юнита", "value": { "unitCode": "SPCTSK5-4", "commentText": "Текст комментария" } } } } }, "required": true }, "responses": { "200": { "description": "Идентификатор созданного комментария юнита", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "id": "f1b2f1b0-836b-42c3-84d5-4e331427098a" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/tql_filter/v2/find": { "description": "Ищет все tql фильтры", "post": { "tags": [ "API поиска tql фильтров" ], "summary": "Ищет все tql фильтры", "description": "Ищет все tql фильтры", "operationId": "findAll", "requestBody": { "description": "Постраничный запрос на поиск всх tql фильтров", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TqlFilterPageRq", "additionalProperties": false, "description": "Запрос на получение постраничного списка tql фильтров", "example": null }, "examples": { "simple": { "description": "Запрос на получение списка tql фильтров", "value": { "query": "TQL", "sortOrder": { "direction": "DESC", "attributes": [ "createdAt" ] }, "favoritesOnly": true, "pageDtoRq": { "page": 0, "size": 10 } } } } } }, "required": false }, "responses": { "200": { "description": "Постраничный вывод всех tql фильтров", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRs", "additionalProperties": false, "description": "Постраничный вывод результатов поиска всех tql фильтров", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Список tql фильтров", "value": { "content": [ { "name": "TQL_FILTER_1", "code": "6b3b3f42-7432-4fea-82a9-9542f03de7f8", "isFavorite": "true", "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович" } } ], "pageSize": 1, "hasNext": true, "pageNumber": 0, "totalElements": 82 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/tql_filter/v2/favorite": { "description": "Добавляет tql фильтр в избранное", "post": { "tags": [ "API добавления/удаления tql фильтров из избранного" ], "summary": "Добавляет tql фильтр в избранное", "description": "Добавляет tql фильтр в избранное", "operationId": "create_9", "requestBody": { "description": "Запрос с передачей идентификатора", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TqlAddToFavoriteRq", "additionalProperties": false, "description": "Код tql фильтра", "example": null }, "examples": { "tqlFilterCode": { "description": "Запрос с передачей идентификатора code", "value": { "tqlFilterCode": "8d32709c-7711-43e5-90b2-c65e92e0ef4c" } } } } }, "required": true }, "responses": { "201": { "description": "Успешное добавление фильтра в избранное", "headers": { "Location": { "description": "URL для получения созданного ресурса", "schema": { "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "description": "Ответ об успешном добавлении tql фильтра в избранное", "example": null }, "examples": { "updateResponse": { "description": "Успешное добавление фильтра в избранное", "value": { "id": "9f60d3fe-87df-41a5-b613-a6052e3b353c" } } } } } }, "570": { "description": "Этот фильтр уже был добавлен в избранное", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "description": "Ошибка при добавлении фильтра в избранное", "example": null }, "examples": { "errorDto": { "description": "Этот фильтр уже был добавлен в избранное", "value": { "exceptionUUID": "qytqZxlZx", "uiErrorMessage": "Данный TQL-фильтр был добавлен в избранное ранее", "errorType": "SWTR_BASIC_ERROR" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/tql_filter/v1/find": { "description": "Ищет все tql фильтры", "post": { "tags": [ "API поиска tql фильтров" ], "summary": "Ищет все tql фильтры", "description": "Ищет все tql фильтры", "operationId": "findAll_1", "requestBody": { "description": "Постраничный запрос на поиск", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TqlFilterPageRq", "additionalProperties": false, "description": "Запрос на получение постраничного списка", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 10 записями", "value": { "query": "TQL", "sortOrder": { "direction": "DESC", "attributes": [ "createdAt" ] }, "favoritesOnly": true, "pageDtoRq": { "page": 0, "size": 10 } } } } } }, "required": false }, "responses": { "200": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } }, "201": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "204": { "description": "Успешное удаление объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное удаление объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное удаление объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } } }, "deprecated": true } }, "/rest/api/tql_filter/v1/favorite/{code}": { "description": "Добавляет tql фильтр в избранное", "post": { "tags": [ "API добавления/удаления tql фильтров из избранного" ], "summary": "Добавляет tql фильтр в избранное", "description": "Добавляет tql фильтр в избранное", "operationId": "create_10", "parameters": [ { "name": "code", "in": "path", "description": "Уникальный идентификатор TQL фильтра", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "8d32709c-7711-43e5-90b2-c65e92e0ef4c" } ], "requestBody": { "description": "Запрос добавления tql фильтра в избранное", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TqlFilterCreateFavoriteRq", "additionalProperties": false, "description": "Запрос добавления tql фильтра в избранное", "example": null }, "examples": { "simple": { "description": "Запрос добавления tql фильтра в избранное", "value": { } } } } }, "required": false }, "responses": { "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } }, "200": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "201": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "204": { "description": "Успешное удаление объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное удаление объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное удаление объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } } }, "deprecated": true }, "delete": { "tags": [ "API добавления/удаления tql фильтров из избранного" ], "summary": "Удаляет tql фильтр из избранного", "description": "Добавляет tql фильтр в избранное", "operationId": "delete_1", "parameters": [ { "name": "code", "in": "path", "description": "Уникальный идентификатор TQL фильтра", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "8d32709c-7711-43e5-90b2-c65e92e0ef4c" } ], "responses": { "200": { "description": "успешное удаление фильтра из избранного", "content": { "application/json": { "schema": { "type": "boolean", "additionalProperties": false, "description": "Флаг успешного удаления фильтра из избранного", "example": false, "maxLength": 2147483647, "pattern": ".*" }, "examples": { "simple": { "description": "Успешное удаление tql фильтра из избранного", "value": true } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/tql_filter/v1/create": { "description": "Создает tql фильтр", "post": { "tags": [ "API создания/изменения tql фильтров" ], "summary": "Создает tql фильтр", "description": "Создает tql фильтр", "operationId": "create_11", "requestBody": { "description": "Создает tql фильтр", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TqlFilterCreateRq", "additionalProperties": false, "description": "Запрос на создание TQL фильтра", "example": null }, "examples": { "simple": { "description": "Запрос создания tql фильтра", "value": { "name": "TQL_FILTER_CREATE", "tql": "summary ~ \"таску\" OR label IN (\"два\", \"73\") AND createdBy = \"%s\" AND createdAt < \"%s\"" } } } } }, "required": true }, "responses": { "200": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } }, "201": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "204": { "description": "Успешное удаление объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное удаление объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное удаление объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } } } } }, "/rest/api/tql/alias/v1/find": { "description": "Получает список TQL-алиасы по фильтру", "post": { "tags": [ "API поиска tql алиасов" ], "summary": "Получение списка TQL-алиасов по фильтрру", "description": "Получает список TQL-алиасы по фильтру", "operationId": "findByFilter", "requestBody": { "description": "Запрос TQL-алиасов по фильтрам с пагинацией", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TqlAliasPageRq", "additionalProperties": false, "description": "Фильтры для запроса TQL-алиасов", "example": null }, "examples": { "simple": { "description": "Запрос TQL-алиасов по фильтрам с пагинацией", "value": { "tqlAliasFiltersRq": { }, "pageDtoRq": { "page": 0, "size": 3 } } } } } }, "required": true }, "responses": { "200": { "description": "Список алиасов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRsTqlAliasRs", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "content": [ { "attributeCode": "reporter", "aliases": [ { "code": "re" }, { "code": "repo" }, { "code": "repos" }, { "code": "report" }, { "code": "reporttttt" }, { "code": "reposito" } ] } ], "pageSize": 3, "hasNext": false, "pageNumber": 0, "totalElements": 1 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/tql/alias/v1/create": { "description": "Создает TQL-алиас", "post": { "tags": [ "API создания/изменения tql алиасов" ], "summary": "Создание TQL-алиаса", "description": "Создает TQL-алиас", "operationId": "create_12", "requestBody": { "description": "Запрос на создание TQL-алиаса", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TqlAliasCreateRq", "additionalProperties": false, "description": "Запрос на создание TQL-алиаса", "example": null }, "examples": { "simple": { "description": "Запрос на создание TQL-алиаса", "value": { "attributeCode": "reporter", "aliases": [ { "code": "repo" }, { "code": "repos" }, { "code": "rt" } ] } } } } }, "required": true }, "responses": { "201": { "description": "TQL-алиас, который создали", "headers": { "Location": { "description": "URL для получения созданного ресурса", "schema": { "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TqlAliasRs", "additionalProperties": false, "required": [ "aliases", "attributeCode" ], "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "attributeCode": "reporter", "aliases": [ { "code": "repo" }, { "code": "repos" }, { "code": "rt" } ] } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/timesheet/v1/worktype": { "description": "Получение информации о видах работ списания рабочего времени", "get": { "tags": [ "API Учет рабочего времени" ], "summary": "Получение информации о видах работ списания рабочего времени", "operationId": "getWorkTypes", "parameters": [ { "name": "page", "in": "query", "description": "page", "required": true, "schema": { "type": "integer", "format": "int32", "default": 0, "example": 1, "maximum": 2147483647, "minimum": -2147483648 }, "example": 1 }, { "name": "size", "in": "query", "description": "size", "required": true, "schema": { "type": "integer", "format": "int32", "default": 50, "example": 1, "maximum": 2147483647, "minimum": -2147483648 }, "example": 1 }, { "name": "last_used", "in": "query", "description": "last_used", "required": false, "schema": { "type": "boolean", "example": true }, "example": "true" } ], "responses": { "200": { "description": "Информация о видах работ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrTimesheetWorkTypePageRs", "additionalProperties": false, "description": "Информация о видах работ", "required": [ "content", "hasNext", "pageNumber", "pageSize" ], "example": null }, "examples": { "success": { "description": "Страница со списком видов работ", "value": { "content": [ { "code": "67", "name": "1Р_Аналитика", "description": "Аналитика" } ], "pageSize": 1, "pageNumber": 0, "hasNext": true } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найдет", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } }, "post": { "tags": [ "API Учет рабочего времени" ], "summary": "Получение информации о видах работ списания рабочего времени", "operationId": "workTypes", "requestBody": { "description": "Запрос страницы видов работ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrTimesheetWorkTypePageRq", "additionalProperties": false, "description": "Запрос страницы видов работ", "required": [ "filter" ], "example": null }, "examples": { "success": { "description": "Запрос первой страницы видов работ", "value": { "page": { "page": 0, "size": 50 } } } } } }, "required": true }, "responses": { "200": { "description": "Информация о видах работ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrTimesheetWorkTypePageRs", "additionalProperties": false, "description": "Информация о видах работ", "required": [ "content", "hasNext", "pageNumber", "pageSize" ], "example": null }, "examples": { "success": { "description": "Страница со списком видов работ", "value": { "content": [ { "code": "67", "name": "1Р_Аналитика", "description": "Аналитика" } ], "pageSize": 1, "pageNumber": 0, "hasNext": true } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найдет", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/timesheet/v1/worklog": { "description": "Списать время", "post": { "tags": [ "API Учет рабочего времени" ], "summary": "Списать время", "operationId": "workLog", "requestBody": { "description": "Запрос на создание списания рабочего времени", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkLogCreateRq", "additionalProperties": false, "description": "Запрос на создание списания рабочего времени", "required": [ "time", "type", "unit", "user" ], "example": null }, "examples": { "createAtDate": { "description": "Запрос на создание списания рабочего времени", "value": { "date": "2025-02-15", "unit": "SWTR-1", "user": "200002", "type": { "code": "67" }, "time": { "temporalUnit": "HOURS", "time": 1 } } }, "createInRange": { "description": "Запрос на создание списания рабочего времени", "value": { "range": { "from": "2025-02-15", "to": "2025-03-15" }, "unit": "SWTR-1", "user": "200002", "type": { "code": "67" }, "time": { "temporalUnit": "HOURS", "time": 1 } } } } } }, "required": true }, "responses": { "201": { "description": "Информация о создании списания рабочего времени", "headers": { "Location": { "description": "URL для получения созданного ресурса", "schema": { "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkLogRs", "additionalProperties": false, "description": "Информация о создании списания рабочего времени", "required": [ "id", "success", "unit", "user" ], "example": null }, "examples": { "success": { "description": "Информация о создании списания рабочего времени", "value": { "id": "46e8c261-6483-4bf0-b37f-f584af93b794", "unit": "PVWSAF-1", "user": "200002", "success": true, "messages": [ ] } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найдет", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/timesheet/v1/report": { "description": "Получение информации о списаниях рабочего времени", "post": { "tags": [ "API Учет рабочего времени" ], "summary": "Получение информации о списаниях рабочего времени", "operationId": "report", "requestBody": { "description": "Запрос информация о списаниях рабочего времени по юниту", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrTimesheetPageRq", "additionalProperties": false, "description": "Запрос на изменение списания рабочего времени", "required": [ "date", "time", "type", "unit", "user" ], "example": null }, "examples": { "update": { "description": "Запрос информация о списаниях рабочего времени по юниту", "value": "{\n \"filter\": {\n \"units\": [\"SWTR-1\"],\n },\n \"page\": {\n \"page\": 0,\n \"size\": 20\n }\n}\n" } } } }, "required": true }, "responses": { "200": { "description": "Информация о списании рабочего времени", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrTimesheetPageRs", "additionalProperties": false, "description": "Информация о списании рабочего времени по юниту", "required": [ "content", "hasNext", "pageNumber", "pageSize" ], "example": null }, "examples": { "success": { "description": "Информация о списании рабочего времени по юниту", "value": { "content": [ { "id": "46e8c261-6483-4bf0-b37f-f584af93b794", "date": "2025-02-15", "unit": "PVWSAF-1", "user": { "externalId": "200002", "firstName": "Тест_ALL_ROLES", "lastName": "Тестыч", "middleName": null }, "comment": null, "type": { "code": "67", "name": "1Р_Аналитика", "description": "Аналитика" }, "time": { "temporalUnit": "MILLIS", "time": 3600000, "duration": "PT1H" } } ], "pageSize": 50, "pageNumber": 0, "hasNext": false } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найдет", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/taxonomy/v1/{attribute}/search/used": { "description": "Выдает используемые значения из таксономического справочника для конкретного атрибута", "post": { "tags": [ "API поиска значений таксономических справочников" ], "summary": "Выдает используемые значения из таксономического справочника для конкретного атрибута", "description": "Выдает используемые значения из таксономического справочника для конкретного атрибута", "operationId": "searchUsed", "parameters": [ { "name": "attribute", "in": "path", "description": "Атрибут", "required": true, "schema": { "type": "string", "format": "String", "description": "Атрибут", "examples": [ "color" ], "maxLength": 100, "pattern": ".*" }, "example": "color" } ], "requestBody": { "description": "Тело запроса для получения используемых значений из таксономического справочника по конкретному атрибуту", "content": { "application/json": { "schema": { "type": "string", "additionalProperties": false, "description": "Тело запроса для получения используемых значений из таксономического справочника по конкретному атрибуту", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "example": { "description": "Запрос для получения используемых значений из таксономического справочника по конкретному атрибуту", "value": "{\n \"taxonomyFilter\" {\n \"deleted\": true\n }\n}\n" } } } }, "required": true }, "responses": { "200": { "description": "Успешный вывод используемых значений из таксономического справочника для конкретного атрибута", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "description": "Успешный вывод используемых значений из таксономического справочника для конкретного атрибута", "example": null }, "examples": { "success": { "description": "Успешный вывод используемых значений из таксономического справочника для конкретного атрибута", "value": { "taxonomyValues": [ { "code": "purple", "name": "пурпурный", "description": "пурпурный цвет", "position": "1" } ] } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/suit/v2/create": { "description": "Создает тип юнита", "post": { "tags": [ "API создания/изменения типов юнита" ], "summary": "Создает тип юнита", "operationId": "create_13", "requestBody": { "description": "Запрос на создание типа юнита", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSuitRq", "additionalProperties": false, "description": "Запрос на создание типа юнита", "example": null }, "examples": { "Пример запроса": { "description": "Запрос на создание типа юнита", "value": { "code": "new_task", "name": "Пользовательская история", "description": "Так называемая user story", "icon": "idea", "baseAttributes": [ { "code": "summary", "parameters": { "default_value": "Название юнита" } }, { "code": "description", "parameters": { "default_value": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"Описание\"}]}]}" } } ], "attributes": [ { "code": "assigned_to", "parameters": { "order": 1, "mandatory": true, "default_value": "2073085" } }, { "code": "due_date", "parameters": { "order": 2, "mandatory": false, "default_value": "2024-01-01T10:00:00+00:00" } }, { "code": "label", "parameters": { "order": 3, "mandatory": false, "default_value": [ "срочно", "важно" ] } }, { "code": "watchers", "parameters": { "mandatory": false, "default_value": [ "2073077", "2073085", "2073056" ] } }, { "code": "priority", "parameters": { "default_value": "low" } }, { "code": "workflow_status", "parameters": { "order": 4, "mandatory": true, "value": "approcess_epic_flow_1_0" } } ] } } } } }, "required": true }, "responses": { "201": { "description": "Тип юнита успешно создан", "headers": { "Location": { "description": "URL для получения созданного ресурса", "schema": { "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "example": null }, "examples": { "Пример": { "description": "Пример", "value": "task" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/suit/v1/find": { "description": "Ищет типы юнитов по фильтру", "post": { "tags": [ "API поиска типов юнитов @TT0" ], "summary": "Ищет типы юнитов по фильтру", "operationId": "find_13", "requestBody": { "description": "Параметры поиска", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuitPageRq", "additionalProperties": false, "description": "Параметры поиска", "example": null }, "examples": { "Пример запроса": { "description": "Параметры поиска", "value": { "filters": { "textSearch": "Эпик", "attributeCode": "task" }, "page": { "page": 0, "size": 100 } } } } } }, "required": true }, "responses": { "200": { "description": "Типы юнитов найдены", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRsSuitInfo", "description": "Информация о странице", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "content": [ { "code": "TASK-001", "name": "Задача", "description": "Базовый тип для создания задач", "icon": "task-icon", "attributes": [ { "code": "PRIORITY", "name": "Приоритет", "description": "Приоритет выполнения задачи" }, { "code": "STATUS", "name": "Статус", "description": "Текущий статус задачи" } ] } ], "pageSize": 1, "hasNext": true, "pageNumber": 1, "totalElements": 25 } } } } } } } } }, "/rest/api/suit/v1/find/properties": { "description": "Ищет настройки типа задачи", "post": { "tags": [ "API поиска типов юнитов @TT0" ], "summary": "Ищет настройки типа задачи", "operationId": "getSuitPropertiesBySuitCodes", "requestBody": { "description": "Параметры поиска", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuitPropertyRq", "additionalProperties": false, "description": "Параметры поиска", "example": null }, "examples": { "Пример запроса": { "description": "Параметры поиска", "value": { "suitCodes": [ "task", "epic" ] } } } } }, "required": true }, "responses": { "200": { "description": "Настройки типа задачи найдены", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuitPropertyInfo", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "task": [ { "propertyName": "canMoveToSpace", "propertyValue": true } ], "epic": [ { "propertyName": "canMoveToSpace", "propertyValue": true } ] } } } } } } } } }, "/rest/api/suit/v1/create": { "description": "Создает тип юнита", "post": { "tags": [ "API создания/изменения типов юнита" ], "summary": "Создает тип юнита", "operationId": "create_14", "requestBody": { "description": "Запрос на создание типа юнита", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSuitRq", "additionalProperties": false, "description": "Запрос на создание типа юнита", "example": null }, "examples": { "Пример запроса": { "description": "Запрос на создание типа юнита", "value": { "code": "new_task", "name": "Пользовательская история", "description": "Так называемая user story", "icon": "idea", "baseAttributes": [ { "code": "summary", "parameters": { "default_value": "Название юнита" } }, { "code": "description", "parameters": { "default_value": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"Описание\"}]}]}" } } ], "attributes": [ { "code": "assigned_to", "parameters": { "order": 1, "mandatory": true, "default_value": "2073085" } }, { "code": "due_date", "parameters": { "order": 2, "mandatory": false, "default_value": "2024-01-01T10:00:00+00:00" } }, { "code": "label", "parameters": { "order": 3, "mandatory": false, "default_value": [ "срочно", "важно" ] } }, { "code": "watchers", "parameters": { "mandatory": false, "default_value": [ "2073077", "2073085", "2073056" ] } }, { "code": "priority", "parameters": { "default_value": "low" } }, { "code": "workflow_status", "parameters": { "order": 4, "mandatory": true, "value": "approcess_epic_flow_1_0" } } ] } } } } }, "required": true }, "responses": { "200": { "description": "Тип юнита успешно создан", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "example": null }, "examples": { "Пример": { "description": "Пример", "value": "task" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/structure/v1/{structure}/update": { "description": "Изменение структуры. Используйте PATCH метод", "post": { "tags": [ "API изменения структур" ], "summary": "Изменение структуры. Используйте PATCH метод", "operationId": "updateStructureDeprecated", "parameters": [ { "name": "structure", "in": "path", "description": "structure", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrStructureUpdateRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "example": null }, "example": null } } } }, "deprecated": true }, "patch": { "tags": [ "API изменения структур" ], "summary": "Изменение структуры", "operationId": "updateStructure", "parameters": [ { "name": "structure", "in": "path", "description": "Код структуры", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "structure": { "description": "Код структуры", "value": "STRUCTURE-123" } } } ], "requestBody": { "description": "Данные для изменения структуры", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrStructureUpdateRq", "description": "Данные для изменения структуры", "example": null }, "examples": { "updateStructure": { "description": "updateStructure", "value": { "name": "придумываем структуры", "description": "x", "schema": { "levels": [ { "level": 0, "tql": "space = \"{{space}}\" AND suit IN (\"epic\", \"story\")", "link": [ ], "groupBy": [ "assigned_to", "votes" ] }, { "level": 1, "link": [ { "code": "decomposition", "direction": "destination" } ], "groupBy": [ "assigned_to" ] }, { "level": 2, "link": [ { "code": "decomposition", "direction": "destination" } ] } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "201": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "204": { "description": "Успешное удаление объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное удаление объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное удаление объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } } } } }, "/rest/api/structure/v1/{structure}/update/level": { "description": "Изменение структуры. Используйте PATCH метод", "post": { "tags": [ "API изменения структур" ], "summary": "Изменение структуры. Используйте PATCH метод", "operationId": "updateStructureLevelDeprecated", "parameters": [ { "name": "structure", "in": "path", "description": "structure", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrStructureUpdateRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "example": null }, "example": null } } } }, "deprecated": true }, "patch": { "tags": [ "API изменения структур" ], "summary": "Изменение уровней структуры", "operationId": "updateStructureLevel", "parameters": [ { "name": "structure", "in": "path", "description": "Код структуры", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "structure": { "description": "Код структуры", "value": "STRUCTURE-123" } } } ], "requestBody": { "description": "Данные для изменения структуры", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrStructureUpdateRq", "description": "Данные для изменения структуры", "example": null }, "examples": { "updateStructure": { "description": "updateStructure", "value": { "schema": { "levels": [ { "level": 0, "tql": "space = \"{{space}}\" AND suit IN (\"epic\", \"story\")", "link": [ ], "groupBy": [ "assigned_to", "votes" ] }, { "level": 1, "link": [ { "code": "decomposition", "direction": "destination" } ], "groupBy": [ "assigned_to" ] }, { "level": 2, "link": [ { "code": "decomposition", "direction": "destination" } ] } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "201": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "204": { "description": "Успешное удаление объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное удаление объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное удаление объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } } } } }, "/rest/api/structure/v1/formula/validate": { "description": "Валидация формулы", "post": { "tags": [ "API построения структур" ], "summary": "Валидация формулы", "operationId": "validateFormula", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StructureCustomColumnFormulaRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StructureCustomColumnFormulaRs", "example": null }, "example": null } } } } } }, "/rest/api/structure/v1/find": { "description": "Список доступных структур", "post": { "tags": [ "API построения структур" ], "summary": "Список доступных структур", "operationId": "find_14", "requestBody": { "description": "Параметры поиска структур", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrStructureRequestDto", "description": "Параметры поиска структур", "example": null }, "examples": { "find": { "description": "Параметры поиска структур", "value": { "filter": { "query": "", "createdBy": [ ], "deleted": "ALL" }, "page": { "page": 0, "size": 20 } } } } } }, "required": true }, "responses": { "200": { "description": "Список структур", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrStructurePageRs", "description": "Список структур", "example": null }, "examples": { "find": { "description": "Список структур", "value": { "content": [ { "code": "DEPT_001", "name": "Департамент информационных технологий", "description": "Основное подразделение, отвечающее за разработку и поддержку IT-систем банка", "mutationInfo": { "deleted": false, "createdBy": { "externalId": "ext_12345", "firstName": "Иван", "lastName": "Петров", "middleName": "Сергеевич", "login": "i.petrov", "locale": "ru_RU", "userDetails": [ { "type": { "code": "PHONE", "name": "Телефон", "visible": true, "properties": { "format": "mobile", "required": true } }, "value": "+7 (495) 123-45-67" }, { "type": { "code": "EMAIL", "name": "Электронная почта", "visible": true, "properties": { "domain": "sberbank.ru", "verified": true } }, "value": "i.petrov@sberbank.ru" } ] }, "createdAt": "2024-01-15T10:30:00Z", "updatedBy": { "externalId": "ext_67890", "firstName": "Мария", "lastName": "Сидорова", "middleName": "Александровна", "login": "m.sidorova", "locale": "ru_RU", "userDetails": [ { "type": { "code": "POSITION", "name": "Должность", "visible": true, "properties": { "level": "senior", "department": "HR" } }, "value": "Ведущий специалист по кадрам" } ] }, "updatedAt": "2024-01-20T14:45:30Z" } }, { "code": "DEPT_002", "name": "Департамент розничного бизнеса", "description": "Подразделение, занимающееся обслуживанием физических лиц и малого бизнеса", "mutationInfo": { "deleted": false, "createdBy": { "externalId": "ext_11111", "firstName": "Алексей", "lastName": "Козлов", "middleName": "Владимирович", "login": "a.kozlov", "locale": "ru_RU", "userDetails": [ ] }, "createdAt": "2024-01-10T09:15:00Z", "updatedBy": { "externalId": "ext_11111", "firstName": "Алексей", "lastName": "Козлов", "middleName": "Владимирович", "login": "a.kozlov", "locale": "ru_RU", "userDetails": [ ] }, "updatedAt": "2024-01-18T16:20:15Z" } } ], "pageSize": 10, "hasNext": true, "pageNumber": 1, "totalElements": 25 } } } } } } } } }, "/rest/api/structure/v1/create": { "description": "Создание структуры", "post": { "tags": [ "API изменения структур" ], "summary": "Создание структуры", "operationId": "createStructure", "requestBody": { "description": "Данные для создания структуры", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrStructureCreateRq", "description": "Данные для создания структуры", "example": null }, "examples": { "createStructure": { "description": "Запрос создания структуры", "value": { "code": "wip-aa-1", "name": "придумываем структуры", "description": "", "schema": { "levels": [ { "level": 0, "tql": "space = \"{{space}}\" AND suit IN (\"epic\", \"story\")", "link": [ ], "groupBy": [ "assigned_to", "votes" ] }, { "level": 1, "link": [ { "code": "decomposition", "direction": "destination" } ], "groupBy": [ "assigned_to" ] }, { "level": 2, "link": [ { "code": "decomposition", "direction": "destination" } ] } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "201": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "204": { "description": "Успешное удаление объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное удаление объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное удаление объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } } } } }, "/rest/api/space/v3/users-count": { "description": "Возвращает список пользователей по пространствам", "get": { "tags": [ "API поиска пространства" ], "summary": "Возвращает список пользователей по пространствам", "operationId": "getUsersCount", "parameters": [ { "name": "space-code", "in": "query", "description": "Коды спейсов", "required": true, "schema": { "type": "array", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null } } ], "responses": { "200": { "description": "Получение количества участников спейса", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceUsersQtyRs", "additionalProperties": false, "description": "Информация о количестве пользователей в спейсе", "required": [ "spaces" ], "example": null }, "examples": { "success": { "description": "Количество пользователей в спейсах", "value": "{\n \"spaces: [\n {\n \"code\": \"ANYSPC\",\n \"userQty\": \"5\"\n }\n ]\n}\n" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } }, "post": { "tags": [ "API поиска пространства" ], "summary": "Возвращает список пользователей по пространствам", "operationId": "getUsersCount_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceUsersQtyRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Получение количества участников спейса", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceUsersQtyRs", "additionalProperties": false, "description": "Информация о количестве пользователей в спейсе", "required": [ "spaces" ], "example": null }, "examples": { "success": { "description": "Количество пользователей в спейсах", "value": "{\n \"spaces: [\n {\n \"code\": \"ANYSPC\",\n \"userQty\": \"5\"\n }\n ]\n}\n" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/space/v3/find": { "description": "Ищет пространства по фильтрам", "post": { "tags": [ "API поиска пространства" ], "summary": "Ищет пространства по фильтрам", "operationId": "find_15", "requestBody": { "description": "Постраничный запрос на поиск спейсов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceSearchPageRq", "additionalProperties": false, "description": "Запрос на получение постраничного списка спейсов", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 10 спейсами", "value": { "filters": { "query": "SMLDMSPC2" }, "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный запрос на поиск спейсов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceInfoRsPage", "additionalProperties": false, "description": "Постраничный вывод результатов поиска спейсов", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница с одним спейсом", "value": { "content": [ { "code": "DEVK2AAA", "name": "Демо спейс", "type": { "code": "CHANGE", "name": "Change-команда" }, "createdAt": "2024-12-25T06:36:59.671487Z", "updatedAt": "2024-12-25T06:36:59.671487Z", "userCount": 2 } ], "pageSize": 1, "hasNext": true, "pageNumber": 0, "totalElements": 82 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/space/v2/users-count": { "description": "Возвращает список пользователей по пространствам", "post": { "tags": [ "API поиска пространства @TT0" ], "summary": "Возвращает список пользователей по пространствам", "operationId": "getUsersCount_2", "parameters": [ { "name": "space-code", "in": "query", "description": "Коды спейсов", "required": true, "schema": { "type": "array", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserCountV2Rq", "example": null }, "example": null } }, "required": false }, "responses": { "200": { "description": "Получение количества участников спейса", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceUsersCount", "additionalProperties": false, "description": "Информация о количестве пользователей в спейсе", "required": [ "spaces" ], "example": null }, "examples": { "success": { "description": "Количество пользователей в спейсах", "value": "{\n \"spaces: [\n {\n \"spaceCode\": \"ANYSPC\",\n \"usersCount\": \"5\"\n }\n ]\n}\n" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/space/v2/manage/{code}/suits/parameter": { "description": "Изменение конфигурации пространства", "post": { "tags": [ "API конфигурация пространства" ], "summary": "Изменение конфигурации пространства", "description": "Изменение конфигурации пространства", "operationId": "manageSuitsParameters", "parameters": [ { "name": "code", "in": "path", "description": "Код пространства", "required": true, "schema": { "type": "string", "description": "Код пространства", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "SWTR" } ], "requestBody": { "description": "Запрос на включение/выключение функции голосования за задачу на уровне конфигурации пространства", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceConfigSuitParametersRq", "additionalProperties": false, "description": "Запрос на включение/выключение функции голосования за задачу на уровне конфигурации пространства", "example": null }, "examples": { "success": { "description": "Запрос на изменение параметров типов задач", "value": { "suits": [ { "code": "idea", "parameters": { "ratingEnabled": false } } ] } } } } }, "required": true }, "responses": { "204": { "description": "Успешное изменение конфигурации пространства" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/space/v2/find": { "description": "Ищет пространства по фильтрам", "post": { "tags": [ "API поиска пространства @TT0" ], "summary": "Ищет пространства по фильтрам", "operationId": "find_16", "requestBody": { "description": "Space page request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacePageV2Rq", "additionalProperties": false, "description": "Запрос на получение постраничного списка спейсов", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 10 спейсами", "value": { "filters": { "textSearch": "SMLDMSPC2" }, "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный запрос на поиск спейсов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceSearchInfoPage", "additionalProperties": false, "description": "Постраничный вывод результатов поиска спейсов", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница с одним спейсом", "value": { "content": [ { "code": "DEVK2AAA", "name": "Демо спейс", "type": { "code": "CHANGE", "name": "Change-команда" }, "createdAt": "2024-12-25T06:36:59.671487Z", "updatedAt": "2024-12-25T06:36:59.671487Z", "userCount": 2 } ], "pageSize": 1, "hasNext": true, "pageNumber": 0, "totalElements": 82 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/space/v2/find/all": { "description": "Возвращает пространства не зависимо от того, является ли текущий пользователь участником пространства. Требует соответствующего полномочия", "post": { "tags": [ "API поиска пространства @TT0" ], "summary": "Ищет все пространства в тенанте по фильтрам ", "description": "Возвращает пространства не зависимо от того, является ли текущий пользователь участником пространства. Требует соответствующего полномочия", "operationId": "findAll_2", "requestBody": { "description": "Постраничный запрос на поиск спейсов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacePageV2Rq", "additionalProperties": false, "description": "Запрос на получение постраничного списка спейсов", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 10 спейсами", "value": { "filters": { "textSearch": "SMLDMSPC2" }, "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный запрос на поиск спейсов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceSearchInfoPage", "additionalProperties": false, "description": "Постраничный вывод результатов поиска спейсов", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница с одним спейсом", "value": { "content": [ { "code": "DEVK2AAA", "name": "Демо спейс", "type": { "code": "CHANGE", "name": "Change-команда" }, "createdAt": "2024-12-25T06:36:59.671487Z", "updatedAt": "2024-12-25T06:36:59.671487Z", "userCount": 2 } ], "pageSize": 1, "hasNext": true, "pageNumber": 0, "totalElements": 82 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/space/v2/create": { "description": "Создает пространство", "post": { "tags": [ "API создания/изменения пространства @TT0" ], "summary": "Создает пространство", "operationId": "create_15", "requestBody": { "description": "Запрос на создание спейса", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSpaceRq", "additionalProperties": false, "description": "Запрос на создание спейса", "required": [ "code", "name", "type" ], "example": null }, "examples": { "simple": { "description": "Простое создание спейса. Автор становится владельцем", "value": { "code": "ANYSPC", "type": "RUN", "name": "Какой-то спейс" } }, "user": { "description": "Создание спейса со списком уастников", "value": "{\n \"code\": \"ANYSPC\",\n \"type\": \"RUN\",\n \"name\": \"Какой-то спейс\"\n \"users\": [\n {\n \"externalId\": \"100002\",\n \"permissionGroups\": [\n {\n \"name\": \"SPACE_CONTRIBUTOR\"\n },\n {\n \"name\": \"SPACE_READER\"\n }\n ]\n }\n ]\n}\n" }, "user_group": { "description": "Создание спейса с группами пользователей", "value": "{\n \"code\": \"ANYSPC\",\n \"type\": \"RUN\",\n \"name\": \"Какой-то спейс\"\n \"groups\": [\n {\n \"group\": \"ALL\",\n \"permissionGroups\": [\n {\n \"name\": \"SPACE_READER\"\n }\n ]\n }\n ]\n}\n" } } } }, "required": true }, "responses": { "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } }, "200": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "201": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "204": { "description": "Успешное удаление объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное удаление объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное удаление объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } } } } }, "/rest/api/space/v1/find": { "description": "Ищет пространства по фильтрам", "post": { "tags": [ "API поиска пространства" ], "summary": "Ищет пространства по фильтрам", "operationId": "find_17", "requestBody": { "description": "Постраничный запрос на поиск спейсов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacePageV1Rq", "additionalProperties": false, "description": "Запрос на получение постраничного списка спейсов", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 10 спейсами", "value": { "filters": { "textSearch": "SMLDMSPC2", "permissionGroups": [ "SPACE_CONTRIBUTOR", "SPACE_OWNER", "SPACE_READER" ], "permissions": [ "space:update", "space:read" ] }, "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный запрос на поиск спейсов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceSearchInfoDeprecatedPage", "additionalProperties": false, "description": "Постраничный вывод результатов поиска спейсов", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница с одним спейсом", "value": { "content": [ { "code": "DEVK2AAA", "name": "Демо спейс", "type": { "code": "CHANGE", "name": "Change-команда" }, "createdAt": "2024-12-25T06:36:59.671487Z", "updatedAt": "2024-12-25T06:36:59.671487Z", "permissionGroups": [ { "name": "SPACE_OWNER" } ], "allowedActions": [ { "name": "privilege_group_assignment" }, { "name": "read" }, { "name": "update" }, { "name": "space_owner_assignment" } ], "allowedActionsInUnit": [ { "name": "read" }, { "name": "update" }, { "name": "create" }, { "name": "write" }, { "name": "delete" } ], "userCount": 2 } ], "pageSize": 1, "hasNext": true, "pageNumber": 0, "totalElements": 71 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/space/v1/create": { "description": "use /space/v2/create", "post": { "tags": [ "API создания/изменения пространства" ], "summary": "Создает пространство", "description": "use /space/v2/create", "operationId": "deprecatedCreate", "requestBody": { "description": "Запрос на создание спейса", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSpaceV1Rq", "additionalProperties": false, "description": "Запрос на создание спейса", "required": [ "code", "name" ], "example": null }, "examples": { "simple": { "description": "Простое создание спейса. Автор становится владельцем", "value": { "code": "ANYSPC", "name": "Какой-то спейс" } }, "user": { "description": "Создание спейса со списком уастников", "value": "{\n \"code\": \"ANYSPC\",\n \"name\": \"Какой-то спейс\"\n \"users\": [\n {\n \"externalId\": \"100002\",\n \"permissionGroups\": [\n {\n \"name\": \"SPACE_CONTRIBUTOR\"\n },\n {\n \"name\": \"SPACE_READER\"\n }\n ]\n }\n ]\n}\n" }, "user_group": { "description": "Создание спейса с группами пользователей", "value": "{\n \"code\": \"ANYSPC\",\n \"name\": \"Какой-то спейс\"\n \"groups\": [\n {\n \"group\": \"ALL\",\n \"permissionGroups\": [\n {\n \"name\": \"SPACE_READER\"\n }\n ]\n }\n ]\n}\n" } } } }, "required": true }, "responses": { "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } }, "200": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "201": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "204": { "description": "Успешное удаление объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное удаление объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное удаление объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } } }, "deprecated": true } }, "/rest/api/space/type/v1/find": { "description": "Ищет все типы пространства", "get": { "tags": [ "API поиска типа пространства" ], "summary": "Ищет все типы пространства", "operationId": "findAll_3", "responses": { "200": { "description": "Постраничный запрос на поиск типов пространств", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceTypeInfoDtoPage", "additionalProperties": false, "description": "Постраничный вывод результатов поиска типов спейсов", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница с одним типом спейса", "value": { "types": [ { "code": "CHANGE", "name": "Change-команда", "description": null, "createdAt": "2024-12-10T14:30:47.285150Z", "updatedAt": "2024-12-10T14:30:47.285150Z", "status": "ACTIVE" } ] } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } }, "post": { "tags": [ "API поиска типа пространства" ], "summary": "Ищет типы пространств по фильтрам", "operationId": "find_18", "requestBody": { "description": "Постраничный запрос на поиск спейсов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceTypePageRq", "additionalProperties": false, "description": "Запрос на получение постраничного списка типа спейсов", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 10 спейсами", "value": { "filters": { "query": "", "codes": [ ] }, "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный запрос на поиск типов спейсов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceTypeInfoDtoPage", "additionalProperties": false, "description": "Постраничный вывод результатов поиска типов спейсов", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница с одним типом спейса", "value": { "content": [ { "code": "CHANGE", "name": "Change-команда", "description": null, "createdAt": "2024-12-10T14:30:47.285150Z", "updatedAt": "2024-12-10T14:30:47.285150Z", "status": "ACTIVE" } ], "pageSize": 1, "hasNext": true, "pageNumber": 0, "totalElements": 12 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/space/type/v1/create": { "description": "Создает тип пространства", "post": { "tags": [ "API создания/изменения типа пространства" ], "summary": "Создает тип пространства", "operationId": "create_16", "requestBody": { "description": "Запрос на создание спейса", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSpaceTypeRq", "additionalProperties": false, "description": "Запрос на создание типа спейса", "required": [ "code", "name" ], "example": null }, "examples": { "simple": { "description": "Простое создание типа спейса.", "value": { "code": "ANYSPC", "name": "Какой-то тип спейса" } }, "draft": { "description": "Создание черновика типа", "value": { "code": "ANYSPC", "status": "INACTIVE", "name": "черновик" } }, "configured": { "description": "Создание конфигурации типа спейса", "value": { "code": "{{space_type}}", "name": "Запуск", "configuration": { "suits": [ { "code": "epic", "type": "REQUIRED" } ] } } } } } }, "required": true }, "responses": { "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } }, "200": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "201": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "204": { "description": "Успешное удаление объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное удаление объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное удаление объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } } } } }, "/rest/api/skin/v1/find": { "description": "Поиск схемы отображения типа задачи", "post": { "tags": [ "API для создания, редактирования, удаления схемы отображения типа задачи(скины) @TT0" ], "summary": "Поиск схемы отображения типа задачи", "description": "Поиск схемы отображения типа задачи", "operationId": "find_19", "requestBody": { "description": "Запрос создания схемы отображения типа задачи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuitSkinPageRq", "additionalProperties": false, "description": "Постраничный запрос поиска схемы отображения типа задачи", "required": [ "filters", "page" ], "example": null }, "examples": { "Пример": { "description": "Постраничный запрос поиска схемы отображения типа задачи", "value": { "filters": { "suitCode": "bug", "skinType": "VIEW" }, "page": { "page": 0, "size": 100 } } } } } }, "required": true }, "responses": { "200": { "description": "Поиск схем отображения типов задач с фильтром", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoSuitSkinDto", "additionalProperties": false, "description": "Страница со схемами отображения типов задач", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница с одной записью", "value": { "content": [ { "code": "SKIN-bug1", "content": "[{\"id\": \"root\", \"name\": \"Схема\", \"type\": \"root\"}]", "skinType": "VIEW" } ], "pageSize": 100, "hasNext": false, "pageNumber": 0, "totalElements": 1 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/skin/v1/create": { "description": "Создание схемы отображения типа задачи", "post": { "tags": [ "API для создания, редактирования, удаления схемы отображения типа задачи(скины) @TT0" ], "summary": "Создание схемы отображения типа задачи", "description": "Создание схемы отображения типа задачи", "operationId": "create_17", "requestBody": { "description": "Запрос создания схемы отображения типа задачи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuitSkinCreateRq", "additionalProperties": false, "description": "Запрос с параметрами новой схемы отображения типа задачи", "required": [ "content", "skinType", "suitCode" ], "example": null }, "examples": { "Пример": { "description": "Пример запроса", "value": { "skinType": "VIEW", "suitCode": "bug", "content": "[{\"id\": \"root\", \"name\": \"Схема\", \"type\": \"root\"}]" } } } } }, "required": true }, "responses": { "200": { "description": "Успешное создание схемы отображения типа задачи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Код схемы отображения типа задачи", "required": [ "id" ], "example": null }, "examples": { "Пример": { "description": "Пример ответа", "value": { "id": "SKIN-bug1" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/searchable-taxonomy/v1/{attribute}/search/info": { "description": "Выдает используемые значения из таксономического справочника для конкретного атрибута", "post": { "tags": [ "API для получения значений из поискового таксономического справочника" ], "summary": "Выдает используемые значения из таксономического справочника для конкретного атрибута", "operationId": "searchInfo", "parameters": [ { "name": "attribute", "in": "path", "description": "attribute", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchableTaxonomyDtoRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchableTaxonomyAttributeDetailsInfo", "example": null }, "example": null } } } } } }, "/rest/api/searchable-taxonomy/v1/{attribute}/search/deleted": { "description": "Выдает удаленные значения из таксономического справочника для конкретного атрибута", "post": { "tags": [ "API для получения значений из поискового таксономического справочника" ], "summary": "Выдает удаленные значения из таксономического справочника для конкретного атрибута", "operationId": "searchDeleted", "parameters": [ { "name": "attribute", "in": "path", "description": "attribute", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchableTaxonomyDtoRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRsSearchableTaxonomyValueInfo", "example": null }, "example": null } } } } } }, "/rest/api/searchable-taxonomy/v1/{attribute}/search/active": { "description": "Выдает значения из таксономического справочника для конкретного атрибута", "post": { "tags": [ "API для получения значений из поискового таксономического справочника" ], "summary": "Выдает значения из таксономического справочника для конкретного атрибута", "operationId": "searchActive", "parameters": [ { "name": "attribute", "in": "path", "description": "attribute", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchableTaxonomyDtoRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRsSearchableTaxonomyValueInfo", "example": null }, "example": null } } } } } }, "/rest/api/plugin/suit/v1/put": { "description": "Устанавливает новый типа юнита в систему", "post": { "tags": [ "API установки/изменения тип юнита" ], "summary": "Устанавливает новый типа юнита в систему", "operationId": "installSuitDescriptor", "requestBody": { "description": "Запрос на установку нового типа юнита в систему", "content": { "application/json": { "schema": { "type": "string", "additionalProperties": false, "description": "Запрос на установку нового типа юнита в систему", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "simple_task_unit_type": { "description": "Пример запроса на установку нового юнита в систему", "value": { "code": "task", "name": "сделаем когда-нибудь", "attributes": [ "assigned_to", "due_date", "label", "priority", "status" ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescriptorInstallResponse", "example": null }, "example": null } } } } } }, "/rest/api/plugin/attribute/v1/put": { "description": "Добавляет новый атрибут в систему", "post": { "tags": [ "API добавления атрибута" ], "summary": "Добавляет новый атрибут в систему", "operationId": "installAttributeDescriptor", "requestBody": { "description": "Запрос на добавление нового атрибута в систему", "content": { "application/json": { "schema": { "type": "string", "additionalProperties": false, "description": "Запрос на добавление нового атрибута в систему", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "Пример": { "description": "Пример", "value": { "assigned-to": { "name": "assigned-to", "description": "attribute-description", "type": "user" } } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescriptorInstallResponse", "example": null }, "example": null } } } } } }, "/rest/api/plugin/attribute-type/v1/put": { "description": "Устанавливает новый тип атрибута в систему", "post": { "tags": [ "API установки нового типа атрибута в систему " ], "summary": "Устанавливает новый тип атрибута в систему", "operationId": "installAttributeTypeDescriptor", "requestBody": { "description": "Запрос для установки нового типа атрибута в систему", "content": { "application/json": { "schema": { "type": "string", "additionalProperties": false, "description": "Запрос для установки нового типа атрибута в систему", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "examples": { "simple_time_type_install": { "description": "Пример запроса на установку атрибута времени", "value": "{\n \"code\": \"time\",\n \"name\": \"time\",\n \"multi-value\":\"false\"\n \"type\": \"timestamp\"\n \"directory\":\"some-directory\"\n}\n" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DescriptorInstallResponse", "example": null }, "example": null } } } } } }, "/rest/api/permission_group/v1/find": { "description": "Выдает все возможные группы привилегий", "post": { "tags": [ "API поиска групп привилегий" ], "summary": "Выдает все возможные группы привилегий", "operationId": "find_20", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionGroupPageRq", "example": null }, "example": null } }, "required": false }, "responses": { "200": { "description": "Успешный поиск групп привилегий", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRsPermissionGroupSummaryInfoDt", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "content": [ { "code": "ADMIN_GROUP", "name": "Администраторы", "description": "Группа с административными привилегиями" }, { "code": "USER_GROUP", "name": "Пользователи", "description": "Базовая группа пользователей" } ], "pageSize": 2, "hasNext": true, "pageNumber": 0, "totalElements": 25 } } } } } } } } }, "/rest/api/permission_group/v1/create": { "description": "Создает группу привилегий", "post": { "tags": [ "API создания/изменения групп привилегий" ], "summary": "Создает группу привилегий", "operationId": "create_18", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePermissionGroupRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Успешное создание группы привилегий", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "example": null }, "examples": { "Пример": { "description": "Пример", "value": "readers_group" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/permission/v1/space/permission-group": { "description": "список пространств и привилегии текущего пользователя", "post": { "tags": [ "API поиска групп привилегий текущего пользователя" ], "summary": "список пространств и привилегии текущего пользователя", "operationId": "getPermissionGroup", "requestBody": { "content": { "application/json": { "schema": { "type": "string", "description": "Список кодов спейсов", "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } }, "required": false }, "responses": { "200": { "description": "Список групп привилегий текущего пользователя", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpacePrivilegeGroupDto", "example": null }, "examples": { "Пример": { "description": "Пример", "value": [ { "spaceCode": "SPACE_CODE", "privilegeGroups": [ { "code": "SPACE_READ", "name": "Просмотр", "description": "Просмотр" } ] } ] } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/permission/v1/find": { "description": "Выдает все возможные привилегии", "post": { "tags": [ "API поиска привилегий" ], "summary": "Выдает все возможные привилегии", "operationId": "find_21", "requestBody": { "description": "Параметры поиска", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionPageRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Список привилегий", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRsPermissionInfoDto", "example": null }, "examples": { "Пример": { "description": "Пример", "value": [ { "code": "SWTR_READ", "name": "Просмотр", "description": "Просмотр" }, { "code": "SWTR_WRITE", "name": "Редактирование", "description": "Редактирование" }, { "code": "SWTR_DELETE", "name": "Удаление", "description": "Удаление" }, { "code": "SWTR_CREATE", "name": "Создание", "description": "Создание" }, { "code": "SWTR_ADMIN", "name": "Администрирование", "description": "Администрирование" } ] } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/opensearch/unit/v1/migrate": { "description": "Миграция юнитов", "post": { "tags": [ "API управления миграцией (синхронизацией) юнитов в OpenSearch" ], "summary": "Миграция юнитов", "operationId": "migrate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitMigrationParametersRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrOpenSearchUnitMigrationRs", "example": null }, "example": null } } } } } }, "/rest/api/object/activity/v1/log": { "description": "Зафиксировать активность пользователя по объекту системы", "post": { "tags": [ "API Активность пользователей" ], "summary": "Зафиксировать активность пользователя по объекту системы", "operationId": "logActivity", "requestBody": { "description": "Зафиксировать активность чтения пространства", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrObjectActivityLogRq", "additionalProperties": false, "description": "Зафиксировать активность чтения пространства", "required": [ "obj" ], "example": null }, "examples": { "log_space_read_activity": { "description": "Зафиксировать активность чтения пространства", "value": { "functionType": "menu_space_picker", "objectId": { "type": "space", "id": "SWTR" } } } } } }, "required": true }, "responses": { "201": { "description": "Зафиксирована активность по объекту системы", "headers": { "Location": { "description": "URL для получения созданного ресурса", "schema": { "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrObjectActivityLogRs", "additionalProperties": false, "description": "Результат фиксации активности", "required": [ "success" ], "example": null }, "examples": { "success_activity_log": { "description": "Успешная запись активности" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найдет", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/notification/user_group/v1/create": { "description": "Создает новую группу пользователей для нотификаций", "post": { "tags": [ "API работы с группами пользователей нотификаций @TT0" ], "summary": "Создает новую группу пользователей для нотификаций", "description": "Создает новую группу пользователей для нотификаций", "operationId": "createUserGroup", "requestBody": { "description": "Запрос создания новой группы пользователей для нотификаций", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationUserGroupDto", "additionalProperties": false, "description": "Запрос с параметрами для новой группы пользователей для нотификаций", "required": [ "code" ], "example": null }, "examples": { "Пример": { "description": "Группа пользователей для нотификаций", "value": { "code": "UNIT_UPDATE_2_GROUP", "name": "Группа пользователей изменения юнита второе", "description": "" } } } } }, "required": true }, "responses": { "200": { "description": "Успешное создание новой группы пользователей для нотификаций", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationUserGroupDto", "additionalProperties": false, "description": "Группа пользователй для нотификаций", "required": [ "code" ], "example": null }, "examples": { "Пример": { "description": "Группа пользователей для нотификаций", "value": { "code": "UNIT_UPDATE_2_GROUP", "name": "Группа пользователей изменения юнита второе", "description": "" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/notification/schema/v1/create": { "description": "Создает новую схему нотификаций", "post": { "tags": [ "API работы со схемами нотификаций @TT0" ], "summary": "Создает новую схему нотификаций", "description": "Создает новую схему нотификаций", "operationId": "createSchema", "requestBody": { "description": "Запрос создания схемы для нотификаций", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSchemaCreateDtoRq", "additionalProperties": false, "description": "Запрос с параметрами для новой схемы нотификаций", "required": [ "channel", "code", "event", "name", "template", "userGroupCode" ], "example": null }, "examples": { "Пример": { "description": "Запрос с параметрами для новой схемы нотификаций", "value": "{\n \"code\": \"UNIT_TO_TEST_SCHEMA\",\n \"name\": \"Юнит отправился в тестирование\",\n \"event\": \"UNIT_UPDATE\",\n \"channel\": \"EMAIL\",\n \"template\": {\n \"header\": \"[(${notificationEvent})] - [(${unitName})] [ [(${unitTypeName})] ] - [(${spaceName})] [ [(${tenantName})] ]\",\n \"body\": \"<!DOCTYPE html><html dir=\"ltr\" lang=\"ru\"><head><meta content=\"text/html; charset=UTF-8\" http-equiv=\"Content-Type\"><title>Титул</title></head><body style=\"background-color:#fff;font-family:-apple-system,BlinkMacSystemFont,"\"><table align=\"center\" width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" role=\"presentation\" style=\"background-color:#fff;margin:0 auto;padding:0;padding-top:16px\"><tbody><tr style=\"width:100%\"><td><p style=\"font-size:14px;line-height:20px;margin:16px 0;color:#1E293B;text-align:left;margin-top:0\">[(${userLastName})] [(${userFirstName})] [(${userMiddleName})] назначил(а) вас исполнителем [(${updatedAt})]</p><p style=\"font-size:14px;line-height:20px;margin:16px 0;color:#1E293B;text-align:left;margin-top:0\">(Для просмотра содержимого необходимо перейти на страницу юнита)</p><p style=\"font-size:14px;line-height:20px;margin:16px 0;color:#1E293B;text-align:left;margin-bottom:0\">===</p><p style=\"font-size:14px;line-height:20px;margin:16px 0;color:#1E293B;text-align:left;margin-top:0\">[(${unitCode})] [ [(${unitTypeName})] ]<br>[(${unitName})]<br><a th:href=\"${unitLink}\" style=\"color:#067df7;text-decoration:none\" target=\"_blank\">[(${unitLink})]</a></p><p style=\"font-size:14px;line-height:20px;margin:16px 0;color:#1E293B;text-align:left;margin-bottom:0\">---</p><p style=\"font-size:14px;line-height:20px;margin:16px 0;color:#1E293B;text-align:left;margin-top:0\">Это письмо сформировано автоматически. Отвечать на него не требуется.</p></td></tr></tbody></table></body></html>\"\n },\n \"userGroupCode\": [\n \"UNIT_UPDATE_GROUP\",\n \"ASSIGNED_TO_UPDATE_GROUP\"\n ]\n}\n" } } } }, "required": true }, "responses": { "200": { "description": "Успешное создание схемы нотификаций", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSchemaDtoRs", "additionalProperties": false, "description": "Схема нотификаций", "required": [ "channel", "code", "event", "name", "template" ], "example": null }, "examples": { "Пример": { "description": "Схема нотификаций", "value": "{\n \"code\": \"UNIT_TO_TEST_SCHEMA\",\n \"name\": \"Юнит отправился в тестирование\",\n \"event\": \"UNIT_UPDATE\",\n \"channel\": \"EMAIL\",\n \"template\": {\n \"header\": \"[(${notificationEvent})] - [(${unitName})] [ [(${unitTypeName})] ] - [(${spaceName})] [ [(${tenantName})] ]\",\n \"body\": \"<!DOCTYPE html><html dir=\"ltr\" lang=\"ru\"><head><meta content=\"text/html; charset=UTF-8\" http-equiv=\"Content-Type\"><title>Титул</title></head><body style=\"background-color:#fff;font-family:-apple-system,BlinkMacSystemFont,"\"><table align=\"center\" width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" role=\"presentation\" style=\"background-color:#fff;margin:0 auto;padding:0;padding-top:16px\"><tbody><tr style=\"width:100%\"><td><p style=\"font-size:14px;line-height:20px;margin:16px 0;color:#1E293B;text-align:left;margin-top:0\">[(${userLastName})] [(${userFirstName})] [(${userMiddleName})] назначил(а) вас исполнителем [(${updatedAt})]</p><p style=\"font-size:14px;line-height:20px;margin:16px 0;color:#1E293B;text-align:left;margin-top:0\">(Для просмотра содержимого необходимо перейти на страницу юнита)</p><p style=\"font-size:14px;line-height:20px;margin:16px 0;color:#1E293B;text-align:left;margin-bottom:0\">===</p><p style=\"font-size:14px;line-height:20px;margin:16px 0;color:#1E293B;text-align:left;margin-top:0\">[(${unitCode})] [ [(${unitTypeName})] ]<br>[(${unitName})]<br><a th:href=\"${unitLink}\" style=\"color:#067df7;text-decoration:none\" target=\"_blank\">[(${unitLink})]</a></p><p style=\"font-size:14px;line-height:20px;margin:16px 0;color:#1E293B;text-align:left;margin-bottom:0\">---</p><p style=\"font-size:14px;line-height:20px;margin:16px 0;color:#1E293B;text-align:left;margin-top:0\">Это письмо сформировано автоматически. Отвечать на него не требуется.</p></td></tr></tbody></table></body></html>\"\n },\n \"userGroupCode\": [\n \"UNIT_UPDATE_GROUP\",\n \"ASSIGNED_TO_UPDATE_GROUP\"\n ]\n}\n" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/notification/event/v1/create": { "description": "Создает новое событие для нотификаций", "post": { "tags": [ "API работы с событиями нотификаций @TT0" ], "summary": "Создает новое событие для нотификаций", "description": "Создает новое событие для нотификаций", "operationId": "createEvent", "requestBody": { "description": "Запрос создания события для нотификаций", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationEventDto", "additionalProperties": false, "description": "Запрос с параметрами для нового события нотификаций", "required": [ "code" ], "example": null }, "examples": { "Пример": { "description": "Событие нотификаций", "value": { "code": "UNIT_UPDATE", "name": "Изменение юнита", "description": "Событие изменения юнита" } } } } }, "required": true }, "responses": { "200": { "description": "Успешное создание события нотификаций", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationEventDto", "additionalProperties": false, "description": "Событие нотификаций", "required": [ "code" ], "example": null }, "examples": { "Пример": { "description": "Событие нотификаций", "value": { "code": "UNIT_UPDATE", "name": "Изменение юнита", "description": "Событие изменения юнита" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/last_visit/v1/save": { "description": "Создание записи о последней посещенной сущности", "post": { "tags": [ "API работы с последними посещенными сущностями @TT0" ], "summary": "Сохранить последнюю посещенную сущность", "description": "Создание записи о последней посещенной сущности", "operationId": "saveLastVisitEntity", "requestBody": { "description": "Запрос создания схемы для нотификаций", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LastVisitRq", "additionalProperties": false, "description": "Запрос с параметрами для фиксации посещения сущности", "required": [ "entityCode", "entityType" ], "example": null }, "examples": { "Пример": { "description": "Запрос с параметрами для фиксации посещения сущности", "value": { "entityType": "LABEL", "entityCode": "label_code_123" } } } } }, "required": true }, "responses": { "200": { "description": "Объект с кодом последней посещенной сущности", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное создание", "required": [ "id" ], "example": null }, "examples": { "success": { "description": "Успешное создание записи о последней посещенной сущности", "value": { "id": "label_code_123" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/last_visit/v1/save/{entityType}": { "description": "Сохранить последние посещенные сущности", "post": { "tags": [ "API работы с последними посещенными сущностями @TT0" ], "summary": "Сохранить последние посещенные сущности", "operationId": "saveLastVisitEntities", "parameters": [ { "name": "entityType", "in": "path", "description": "Тип сущности", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "LABEL" } ], "requestBody": { "description": "Запрос создания схемы для нотификаций", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LastVisitRq", "additionalProperties": false, "description": "Запрос с параметрами для фиксации посещения сущности", "required": [ "entityCode", "entityType" ], "example": null }, "examples": { "Пример": { "description": "Запрос с параметрами для фиксации посещения сущности", "value": { "entityCodes": [ "label_code_123", "next_label_code", "not_exist_label_code" ] } } } } }, "required": true }, "responses": { "200": { "description": "Список объектов с кодом успешно сохраненных последних посещенных сущностей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное создание", "required": [ "id" ], "example": null }, "examples": { "success": { "description": "Успешное создание записей о последних посещенных сущностях", "value": [ { "id": "label_code_123" }, { "id": "next_label_code" } ] } } } } } }, "deprecated": true } }, "/rest/api/export/v1": { "description": "Создаёт задачу на выгрузку данных в указанный формат (например, .xlsx). Возвращает идентификатор и начальный статус (PENDING) задачи.", "post": { "tags": [ "API для инициализации и управления выгрузкой данных" ], "summary": "Инициализация выгрузки данных", "description": "Создаёт задачу на выгрузку данных в указанный формат (например, .xlsx). Возвращает идентификатор и начальный статус (PENDING) задачи.", "operationId": "initiateExport", "requestBody": { "description": "Параметры для инициализации выгрузки", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileExportRq", "example": null }, "examples": { "exportRequest": { "description": "exportRequest", "value": "{\n \"worker_type\": \"STRUCTURE\",\n \"filters\": {\n \"spaces\": [],\n \"suits\": [],\n \"units\": [],\n \"structure\": \"175\",\n },\n \"columns\": [\"assigned_to\", \"due_date\", \"summary\", \"description\"],\n \"file_format\": \"xlsx\"\n}\n" } } } }, "required": true }, "responses": { "200": { "description": "Задача на выгрузку успешно создана", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileExportRs", "example": null }, "examples": { "exportInitiated": { "description": "exportInitiated", "value": { "jobId": "uuid-123", "status": "CREATED", "fileName": "structure_2026-02-10_10-22-56.xlsx" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/export/v1/list": { "description": "Возвращает список всех выгрузок текущего пользователя с информацией о статусе, имени файла и идентификаторе.", "post": { "tags": [ "API для инициализации и управления выгрузкой данных" ], "summary": "Получить список выгрузок пользователя", "description": "Возвращает список всех выгрузок текущего пользователя с информацией о статусе, имени файла и идентификаторе.", "operationId": "getUserExports", "requestBody": { "description": "Постраничный запрос на поиск выгрузок", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileExportPageRq", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 10 выгрузками", "value": { "page": { "page": 0, "size": 10 } } } } } }, "required": false }, "responses": { "200": { "description": "Список выгрузок успешно получен", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRs", "example": null }, "examples": { "exportList": { "description": "exportList", "value": { "content": [ { "jobId": "uuid-123", "status": "COMPLETED", "fileName": "Разработка_2025-01-20_14-37-55.xlsx", "fileId": "uuid-456", "createdAt": "2025-01-20T14:37:55.000Z" }, { "jobId": "uuid-789", "status": "PENDING", "fileName": "Тестирование_2025-01-20_15-00-00.xlsx", "fileId": null, "createdAt": "2025-01-20T15:00:00.000Z" } ], "pageSize": 10, "hasNext": false, "pageNumber": 0, "totalElements": 2 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/draft/files/v1/upload": { "description": "Сохранение файла драфта", "post": { "tags": [ "API драфт сервиса" ], "summary": "Сохранение файла драфта", "description": "Сохранение файла драфта", "operationId": "save_2", "parameters": [ { "name": "draftId", "in": "query", "description": "id файла драфта", "required": true, "schema": { "type": "string", "format": "String", "description": "id файла драфта", "examples": [ "c36d067c-2f76-4bb6-9387-a3d9b5a875d0" ], "maxLength": 36, "pattern": ".*" }, "example": "c36d067c-2f76-4bb6-9387-a3d9b5a875d0" }, { "name": "relativePathPart", "in": "query", "description": "Путь драфт файла", "required": true, "schema": { "type": "string", "format": "String", "description": "Путь драфт файла", "examples": [ "draft/draft" ], "maxLength": 255, "pattern": ".*" }, "example": "draft/draft" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "additionalProperties": false, "properties": { "file": { "type": "string", "format": "binary", "description": "Файл драфта", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" } }, "required": [ "file" ], "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Сохранение файла драфта", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftResponse", "additionalProperties": false, "description": "Структура ответа с id файла драфта", "example": null }, "examples": { "success": { "description": "Информация файла драфта", "value": { "draftId": "c36d067c-2f76-4bb6-9387-a3d9b5a875d0" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/draft/files/v1/copyFile": { "description": "Копирование файла в драфт", "post": { "tags": [ "API драфт сервиса" ], "summary": "Копирование файла в драфт", "description": "Копирование файла в драфт", "operationId": "copy_1", "requestBody": { "description": "Тело запроса на клонирование файла в драфт", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileCopyToDraftDto", "additionalProperties": false, "description": "Запрос на клонирование файла в драфт", "required": [ "draftId", "fileId" ], "example": null }, "examples": { "simple": { "description": "Запрос на клонирование файла в драфт", "value": { "fileId": "177ecd1d-8f1e-4049-85f2-a44c4aef515e", "relativePathPart": "draft/draft", "draftId": "c36d067c-2f76-4bb6-9387-a3d9b5a875d0" } } } } }, "required": true }, "responses": { "200": { "description": "Копирование файла в драфт", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftResponse", "additionalProperties": false, "description": "Структура ответа с id файла драфта", "example": null }, "examples": { "success": { "description": "Информация о файле драфта", "value": { "fileName": "ship_2.jpeg", "draftId": "c36d067c-2f76-4bb6-9387-a3d9b5a875d0", "fileId": "7053bebc-f5b5-420c-a1c4-14ec2c3976e9", "relativePath": "draft/draft" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/directory/v1/{code}/find": { "description": "Выдает значения из конкретного справочника с заданным кодом", "post": { "tags": [ "API поиска справочников" ], "summary": "Выдает значения из конкретного справочника с заданным кодом", "operationId": "find_22", "parameters": [ { "name": "code", "in": "path", "description": "Код", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Some code string" } ], "requestBody": { "description": "Запрос на поиск с информацией о странице", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindWithPageRq", "description": "Тело запроса на поиск с информацией о странице", "example": null }, "example": null } }, "required": false }, "responses": { "200": { "description": "Успешный ответ с информацией о странице", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRs", "description": "Успешный ответ с информацией о странице", "example": null }, "example": null } } } }, "deprecated": true } }, "/rest/api/directory/v1/find": { "description": "Выдает список справочников системы", "post": { "tags": [ "API поиска справочников" ], "summary": "Выдает список справочников системы", "operationId": "find_23", "requestBody": { "description": "Запрос на поиск с информацией о странице", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindWithPageRq", "description": "Тело запроса на поиск с информацией о странице", "example": null }, "example": null } }, "required": false }, "responses": { "200": { "description": "Успешный ответ с информацией о странице", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRs", "description": "Успешный ответ с информацией о странице", "example": null }, "example": null } } } }, "deprecated": true } }, "/rest/api/calendar/v1/import": { "description": "Импорт производственного календаря", "post": { "tags": [ "API Производственный календарь" ], "summary": "Импорт производственного календаря", "operationId": "importCalendar", "requestBody": { "description": "Запрос информация о списаниях рабочего времени по юниту", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrCalendarImportYearRq", "additionalProperties": false, "description": "Запрос на загрузку производственного календаря", "required": [ "year" ], "example": null }, "examples": { "calendar": { "description": "Структура календаря" } } } }, "required": true }, "responses": { "201": { "description": "Успешный импорт производственного календаря", "headers": { "Location": { "description": "URL для получения созданного ресурса", "schema": { "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwtrCalendarRangeRs", "additionalProperties": false, "description": "Результат импорта", "example": null }, "examples": { "successCalendarImport": { "description": "Информация об успешном импорте" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найдет", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/bulk/v2/{type}/createForGroups": { "description": "Создает новую массовую операцию для групп юнитов", "post": { "tags": [ "API создания массовых операций" ], "summary": "Создает новую массовую операцию для групп юнитов", "description": "Создает новую массовую операцию для групп юнитов", "operationId": "createForGroupsV2", "parameters": [ { "name": "type", "in": "path", "description": "Тип сущности, над которой происходит групповая операция", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "unit" } ], "requestBody": { "description": "Запрос на групповую операцию", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkForCreateDto", "additionalProperties": false, "description": "Запрос на групповую операцию", "example": null }, "examples": { "simple": { "description": "Запрос на групповую операцию замены описания юнитов", "value": [ { "codes": [ "TST1-1", "TST1-2" ], "actions": [ { "action": "replace", "attribute": "summary", "value": "TTTEEESSSTTT" } ] } ] } } } }, "required": true }, "responses": { "201": { "description": "Объект с UUID идентификатором массовой операции", "headers": { "Location": { "description": "URL для получения созданного ресурса", "schema": { "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное создание групповой операции", "required": [ "id" ], "example": null }, "examples": { "success": { "description": "Успешное создание групповой операции", "value": { "id": "51870410-792d-4678-9c07-ec8c70abda6b" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/bulk/v2/{id}": { "description": "Получение информации о задачах групповой операции", "post": { "tags": [ "API получения информации о групповых операциях" ], "summary": "Получение информации о задачах групповой операции", "description": "Получение информации о задачах групповой операции", "operationId": "getJobs", "parameters": [ { "name": "id", "in": "path", "description": "Уникальный идентификатор групповой операции", "required": true, "schema": { "type": "string", "format": "uuid", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "8d32709c-7711-43e5-90b2-c65e92e0ef4c" } ], "requestBody": { "description": "Постраничный запрос на поиск", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkOperationJobPageRq", "additionalProperties": false, "description": "Запрос на получение постраничного списка задач групповой операции", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 10 задачами", "value": { "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный запрос на поиск задач групповой операции", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRs", "additionalProperties": false, "description": "Постраничный вывод результатов поиска", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница с задачами балковой операцией", "value": { "content": [ { "entity": { "code": "DEVK2AAA", "summary": "Реализация групповых операций", "description": "Описание задачи", "suit": { "code": "DEVK2AAA", "summary": "Реализация групповых операций", "description": "Описание задачи" }, "space": { "code": "DEVK2AAA", "name": "Спейс групповых операций" }, "spaces": [ { "code": "DEVK2AAA", "name": "Спейс групповых операций" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "testov.i.i", "userDetails": [ { "type": { "code": "email", "name": "Email", "visible": true, "properties": { "format": "email" } }, "value": "ivanov@example.com" } ] }, "createdAt": "2024-12-25T06:36:59.671487Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "testov.i.i", "userDetails": [ { "type": { "code": "email", "name": "Email", "visible": true, "properties": { "format": "email" } }, "value": "ivanov@example.com" } ] }, "updatedAt": "2024-12-25T06:36:59.671487Z", "isFavorite": "true" }, "finishedAt": "2024-12-25T06:36:59.671487Z", "status": "FINISHED" } ], "pageSize": 1, "hasNext": true, "pageNumber": 0, "totalElements": 82 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/bulk/v2/find": { "description": "Получение групповых операций", "post": { "tags": [ "API получения информации о групповых операциях" ], "summary": "Получение групповых операций", "description": "Получение групповых операций", "operationId": "find_24", "requestBody": { "description": "Постраничный запрос на поиск", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkOperationPageRq", "additionalProperties": false, "description": "Запрос на получение постраничного списка групповых операций", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 10 операциями", "value": { "filters": { "ids": [ "51870410-792d-4678-9c07-ec8c70abda6b" ], "types": [ "UNIT" ], "statuses": [ "FINISHED" ] }, "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный запрос на поиск операций", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRs", "additionalProperties": false, "description": "Постраничный вывод результатов поиска", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница с одной балковой операцией", "value": { "content": [ { "bulkOperationId": "51870410-792d-4678-9c07-ec8c70abda6b", "completedJobsCount": "2", "jobsCount": "2", "startedAt": "2024-12-25T06:36:59.671487Z", "finishedAt": "2024-12-25T06:36:59.671487Z", "status": "FINISHED", "hasWarning": false } ], "pageSize": 1, "hasNext": true, "pageNumber": 0, "totalElements": 82 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/bulk/v1/{type}/create": { "description": "Создает новую массовую операцию", "post": { "tags": [ "API создания массовых операций" ], "summary": "Создает новую массовую операцию", "description": "Создает новую массовую операцию", "operationId": "create_19", "parameters": [ { "name": "type", "in": "path", "description": "Тип сущности, над которой происходит групповая операция", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "unit" } ], "requestBody": { "description": "Запрос на групповую операцию", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkForCreateDto", "additionalProperties": false, "description": "Запрос на групповую операцию", "example": null }, "examples": { "simple": { "description": "Запрос на групповую операцию замены описания юнитов", "value": { "codes": [ "TST1-1", "TST1-2" ], "actions": [ { "action": "replace", "attribute": "description", "value": "Новое описание" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } }, "201": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "204": { "description": "Успешное удаление объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное удаление объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное удаление объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } } }, "deprecated": true } }, "/rest/api/bulk/v1/{type}/createForGroups": { "description": "Создает новую массовую операцию для групп юнитов", "post": { "tags": [ "API создания массовых операций" ], "summary": "Создает новую массовую операцию для групп юнитов", "description": "Создает новую массовую операцию для групп юнитов", "operationId": "createForGroups", "parameters": [ { "name": "type", "in": "path", "description": "Тип сущности, над которой происходит групповая операция", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "unit" } ], "requestBody": { "description": "Запрос на групповую операцию", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkForCreateDto", "additionalProperties": false, "description": "Запрос на групповую операцию", "example": null }, "examples": { "simple": { "description": "Запрос на групповую операцию замены описания юнитов", "value": [ { "codes": [ "TST1-1", "TST1-2" ], "actions": [ { "action": "replace", "attribute": "summary", "value": "TTTEEESSSTTT" } ] } ] } } } }, "required": true }, "responses": { "200": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } }, "201": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "204": { "description": "Успешное удаление объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное удаление объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное удаление объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } } }, "deprecated": true } }, "/rest/api/bulk/v1/{id}": { "description": "Получение информации о задачах групповой операции", "post": { "tags": [ "API получения информации о групповых операциях" ], "summary": "Получение информации о задачах групповой операции", "description": "Получение информации о задачах групповой операции", "operationId": "getJobs_1", "parameters": [ { "name": "id", "in": "path", "description": "Уникальный идентификатор групповой операции", "required": true, "schema": { "type": "string", "format": "uuid", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "8d32709c-7711-43e5-90b2-c65e92e0ef4c" } ], "requestBody": { "description": "Постраничный запрос на поиск", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkOperationJobPageRq", "additionalProperties": false, "description": "Запрос на получение постраничного списка задач групповой операции", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 10 задачами", "value": { "page": { "page": 0, "size": 10 } } } } } }, "required": false }, "responses": { "200": { "description": "Постраничный запрос на поиск задач групповой операции", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRs", "additionalProperties": false, "description": "Постраничный вывод результатов поиска", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница с задачами балковой операцией", "value": { "content": [ { "entity": { "code": "DEVK2AAA", "summary": "Реализация групповых операций", "description": "Описание задачи", "suit": { "code": "DEVK2AAA", "summary": "Реализация групповых операций", "description": "Описание задачи" }, "space": { "code": "DEVK2AAA", "name": "Спейс групповых операций" }, "spaces": [ { "code": "DEVK2AAA", "name": "Спейс групповых операций" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "testov.i.i", "userDetails": [ { "type": { "code": "email", "name": "Email", "visible": true, "properties": { "format": "email" } }, "value": "ivanov@example.com" } ] }, "createdAt": "2024-12-25T06:36:59.671487Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "testov.i.i", "userDetails": [ { "type": { "code": "email", "name": "Email", "visible": true, "properties": { "format": "email" } }, "value": "ivanov@example.com" } ] }, "updatedAt": "2024-12-25T06:36:59.671487Z", "isFavorite": "true" }, "finishedAt": "2024-12-25T06:36:59.671487Z", "status": "FINISHED" } ], "pageSize": 1, "hasNext": true, "pageNumber": 0, "totalElements": 82 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/bulk/v1/move/unit/workflow/find": { "description": "Ищет пространства с типами задач и статусами по списку задач", "post": { "tags": [ "API получения информации для массового перемещения задач в другое пространство" ], "summary": "Ищет пространства с типами задач и статусами по списку задач", "description": "Ищет пространства с типами задач и статусами по списку задач", "operationId": "findSpaceWithWorkflowsByUnits", "requestBody": { "description": "Запрос на поиск пространства с типами задач и статусами по списку задач", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchByUnitsPageRq", "additionalProperties": false, "description": "Запрос на поиск пространства с типами задач и статусами по списку задач", "required": [ "filters" ], "example": null }, "examples": { "Example space with suits and statuses by units request": { "description": "Запрос на поиск пространства с типами задач и статусами по списку задач", "value": { "filters": { "units": [ "SP6729199-2", "SP6729199-1" ] }, "page": { "page": 0, "size": 100 } } } } } }, "required": true }, "responses": { "200": { "description": "Список пространств с типами задач и статусами", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRs", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "content": [ { "code": "VSLBBR", "name": "Веселые бобры", "suits": [ { "code": "task", "name": "Задача", "workflow": { "code": "default_workflow", "name": "APProcess Task Flow 1.0", "statuses": [ { "code": "to_do", "name": "В работу" } ] } } ] }, { "code": "GRSTNKT", "name": "Грустные коты", "suits": [ { "code": "task", "name": "Задача", "workflow": { "code": "default_workflow", "name": "APProcess Task Flow 1.0", "statuses": [ { "code": "to_do", "name": "В работу" } ] } } ] }, { "code": "ZDMCHVMDVD", "name": "Задумчивые медведи", "suits": [ { "code": "task", "name": "Задача", "workflow": { "code": "default_workflow", "name": "APProcess Task Flow 1.0", "statuses": [ { "code": "to_do", "name": "В работу" } ] } } ] } ], "pageSize": 10, "hasNext": false, "pageNumber": 0, "totalElements": 3 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/bulk/v1/move/unit/suit/find": { "description": "Ищет пространства с типами задач по списку задач", "post": { "tags": [ "API получения информации для массового перемещения задач в другое пространство" ], "summary": "Ищет пространства с типами задач по списку задач", "description": "Ищет пространства с типами задач по списку задач", "operationId": "findWithSuits", "requestBody": { "description": "Запрос на поиск пространства с типами задач по списку задач", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchByUnitsPageRq", "additionalProperties": false, "description": "Запрос на поиск пространства с типами задач по списку задач", "required": [ "filters" ], "example": null }, "examples": { "Example space with suits by units request": { "description": "Запрос на поиск пространства с типами задач по списку задач", "value": { "filters": { "units": [ "SP6729199-2", "SP6729199-1" ] }, "page": { "page": 0, "size": 100 } } } } } }, "required": true }, "responses": { "200": { "description": "Список пространств с типами задач", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRs", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "content": [ { "space": { "code": "VSLBBR", "name": "Веселые бобры" }, "suits": [ { "code": "task", "name": "Задача" } ] }, { "space": { "code": "GRSTNKT", "name": "Грустные коты" }, "suits": [ { "code": "task", "name": "Задача" } ] }, { "space": { "code": "ZDMCHVMDVD", "name": "Задумчивые медведи" }, "suits": [ { "code": "task", "name": "Задача" } ] } ], "pageSize": 10, "hasNext": false, "pageNumber": 0, "totalElements": 3 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/bulk/v1/move/unit/create": { "description": "Создание массовой операции для перемещения задач в другое пространство", "post": { "tags": [ "API создания массовых операций для перемещения задач" ], "summary": "Создание массовой операции для перемещения задач в другое пространство", "description": "Создание массовой операции для перемещения задач в другое пространство", "operationId": "create_20", "requestBody": { "description": "Тело запрос для создания массовой операции для перемещения задач", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkForMoveUnitCreateRq", "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "units": [ "VSLBBR-1", "VSLBBR-2", "VSLBBR-3" ], "action": { "from": [ { "space": { "code": "VSLBBR" }, "suitMap": [ { "from": { "code": "task" }, "to": { "code": "idea" }, "workflow": { "from": { "code": "default_workflow" }, "to": { "code": "default_workflow" }, "statusMap": [ { "from": { "code": "done" }, "to": { "code": "another_done" } } ] } } ] } ], "to": { "space": { "code": "ZDMCHVMDVD" } } } } } } } }, "required": true }, "responses": { "200": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } }, "201": { "description": "Успешное изменение объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное изменение объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } }, "204": { "description": "Успешное удаление объекта", "headers": { "Location": { "description": "URL для получения объекта", "style": "simple", "schema": { "type": "string", "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное удаление объекта", "example": { "id": "ANYSPC" }, "required": [ "id" ] }, "examples": { "success": { "description": "Успешное удаление объекта с кодом ANYSPC", "value": { "id": "ANYSPC" } } } } } } } } }, "/rest/api/bulk/v1/find": { "description": "Получение групповых операций", "post": { "tags": [ "API получения информации о групповых операциях" ], "summary": "Получение групповых операций", "description": "Получение групповых операций", "operationId": "find_25", "requestBody": { "description": "Постраничный запрос на поиск", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkOperationPageRq", "additionalProperties": false, "description": "Запрос на получение постраничного списка групповых операций", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 10 операциями", "value": { "filters": { "ids": [ "51870410-792d-4678-9c07-ec8c70abda6b" ], "types": [ "UNIT" ], "statuses": [ "FINISHED" ] }, "page": { "page": 0, "size": 10 } } } } } }, "required": false }, "responses": { "200": { "description": "Постраничный запрос на поиск операций", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRs", "additionalProperties": false, "description": "Постраничный вывод результатов поиска", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница с одной балковой операцией", "value": { "content": [ { "bulkOperationId": "51870410-792d-4678-9c07-ec8c70abda6b", "completedJobsCount": "2", "jobsCount": "2", "startedAt": "2024-12-25T06:36:59.671487Z", "finishedAt": "2024-12-25T06:36:59.671487Z", "status": "FINISHED", "hasWarning": false } ], "pageSize": 1, "hasNext": true, "pageNumber": 0, "totalElements": 82 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/rest/api/attr/v2/create": { "description": "Создает атрибут", "post": { "tags": [ "API для создания/изменения атрибутов v2" ], "summary": "Создает атрибут", "operationId": "create_21", "requestBody": { "description": "Запрос на создание нового атрибута", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAttributeRqDto", "description": "Тело запроса на создание нового атрибута", "example": null }, "example": null } }, "required": true }, "responses": { "201": { "description": "Успешный ответ о создании нового атрибута", "headers": { "Location": { "description": "URL для получения созданного ресурса", "schema": { "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "description": "Ответ с id новой сущности", "example": null }, "example": null } } } } } }, "/rest/api/attr/v1/search": { "description": "Выдает отфильтрованный по наименованию список доступных кастомных атрибутов", "post": { "tags": [ "API поиска атрибутов @TT0" ], "summary": "Выдает отфильтрованный по наименованию список доступных кастомных атрибутов", "description": "Выдает отфильтрованный по наименованию список доступных кастомных атрибутов", "operationId": "search", "requestBody": { "description": "Запрос на поиск атрибутов по заданным критериям", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttributePageDtoRq", "additionalProperties": false, "description": "Запрос на поиск атрибутов по заданным критериям", "required": [ "filters", "page" ], "example": null }, "examples": { "Пример": { "description": "Тело запроса", "value": { "filters": { "textSearch": "Контрольный срок" }, "page": { "page": 0, "size": 100 } } } } } }, "required": true }, "responses": { "200": { "description": "Список доступных кастомных типов атрибутов c пагинацией", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageableUnitAttributeDetailsInfo", "additionalProperties": false, "description": "Детали атрибутов c пагинацией", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница с тремя атрибутами", "value": { "content": [ { "code": "external_link", "name": "Внешние ссылки", "type": { "code": "external_link", "name": "Внешние ссылки", "description": "", "canHaveDefaultValue": false, "suitQuantityLimit": 1, "viewMode": "CUSTOM" }, "description": "Внешние ссылки", "directoryValues": [ ] }, { "code": "assigned_to", "name": "Исполнитель", "type": { "code": "user", "name": "Пользователь", "description": "", "canHaveDefaultValue": true, "suitQuantityLimit": -1, "viewMode": "DEFAULT" }, "description": "Исполнитель", "directoryValues": [ ] }, { "code": "component_code", "name": "Код компонента", "type": { "code": "searchable_taxonomy", "name": "Таксономия с поиском", "description": "", "canHaveDefaultValue": false, "suitQuantityLimit": -1, "viewMode": "DEFAULT" }, "description": "Код компонента", "directoryValues": [ ] } ], "pageSize": 100, "hasNext": false, "pageNumber": 0, "totalElements": 3 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/attr/v1/intersection/search": { "description": "Выдает список общих атрибутов в задачах", "post": { "tags": [ "API поиска атрибутов @TT0" ], "summary": "Выдает список общих атрибутов в задачах", "description": "Выдает список общих атрибутов в задачах", "operationId": "searchIntersectingAttributes", "requestBody": { "description": "Запрос на поиск атрибутов по заданным задачам", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntersectingAttributePageDtoRq", "additionalProperties": false, "description": "Фильтр для поиска атрибутов по заданным задачам", "required": [ "units" ], "example": null }, "examples": { "Пример": { "description": "Пример", "value": { "units": [ "SWTR-1", "SWTR-2", "SWTR-3", "SWTR-4" ], "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Список общих атрибутов в задачах", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/PageableUnitAttributeDetailsInfo", "additionalProperties": false, "description": "Детали задачи c пагинацией", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница общих атрибутов в задачах", "value": { "content": [ ], "pageSize": 10, "hasNext": false, "pageNumber": 0, "totalElements": 0 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/rest/api/attr/v1/create": { "description": "Создает атрибут", "post": { "tags": [ "API для создания/изменения атрибутов" ], "summary": "Создает атрибут", "operationId": "create_22", "requestBody": { "description": "Запрос на создание нового атрибута", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAttributeRqDto", "description": "Описание нового атрибута", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Успешный ответ о создании нового атрибута", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "description": "id новой сущности", "example": null }, "example": null } } } }, "deprecated": true } }, "/rest/api/admin/space/v3/find": { "description": "Ищет пространства по фильтрам", "post": { "tags": [ "API поиска пространства" ], "summary": "Ищет пространства по фильтрам", "operationId": "find_26", "requestBody": { "description": "Постраничный запрос на поиск спейсов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceSearchPageRq", "additionalProperties": false, "description": "Запрос на получение постраничного списка спейсов", "example": null }, "examples": { "simple": { "description": "Запрос первой страницы с 10 спейсами", "value": { "filters": { "textSearch": "SMLDMSPC2" }, "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный запрос на поиск спейсов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminSpaceInfoRsPage", "additionalProperties": false, "description": "Постраничный вывод результатов поиска спейсов", "required": [ "content", "hasNext", "pageNumber", "pageSize", "totalElements" ], "example": null }, "examples": { "success": { "description": "Первая страница с одним спейсом", "value": { "content": [ { "code": "DEVK2AAA", "name": "Демо спейс", "type": { "code": "CHANGE", "name": "Change-команда" }, "createdAt": "2024-12-25T06:36:59.671487Z", "updatedAt": "2024-12-25T06:36:59.671487Z", "userCount": 2 } ], "pageSize": 1, "hasNext": true, "pageNumber": 0, "totalElements": 82 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/web_items_plugin/v1/web_item/{name}/visible/{visible}": { "description": "Изменение видимости панели. 'GET' deprecated - используйте 'POST' ", "get": { "tags": [ "Web Items Plugin" ], "summary": "Изменение видимости панели. 'GET' deprecated - используйте 'POST' ", "operationId": "changeVisibleOld", "parameters": [ { "name": "name", "in": "path", "description": "name", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "visible", "in": "path", "description": "visible", "required": true, "schema": { "type": "boolean", "example": true }, "example": "true" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebItemDto", "example": null }, "example": null } } } }, "deprecated": true }, "post": { "tags": [ "Web Items Plugin" ], "summary": "Изменение видимости панели.", "operationId": "changeVisible", "parameters": [ { "name": "name", "in": "path", "description": "name", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "visible", "in": "path", "description": "visible", "required": true, "schema": { "type": "boolean", "example": true }, "example": "true" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebItemDto", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/web_items_plugin/v1/web_item/update/{name}": { "description": "Обновление панели", "post": { "tags": [ "Web Items Plugin" ], "summary": "Обновление панели", "operationId": "updateWebItem", "parameters": [ { "name": "name", "in": "path", "description": "name", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebItemRequest", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebItemDto", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/web_items_plugin/v1/web_item/create": { "description": "Создание панели", "post": { "tags": [ "Web Items Plugin" ], "summary": "Создание панели", "operationId": "createWebItem", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebItemRequest", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebItemDto", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wysiwyg/v1/convert/unsupported": { "post": { "tags": [ "wysiwyg-convert-rest-controller" ], "operationId": "convertUnsupported", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WysiwygConvertUnsupportedRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WysiwygConvertUnsupportedRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/user/recent-view/find": { "post": { "tags": [ "wiki-user-recent-view-rest-controller" ], "operationId": "findUserRecentViews", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiUserRecentViewPageRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponseWikiUserRecentViewInfo", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/user/recent-update/find": { "post": { "tags": [ "wiki-user-recent-update-unit-rest-controller" ], "operationId": "findUserRecentUpdateUnits", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiUserRecentUpdatePageRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponseWikiUserRecentUpdateUnitInfo", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/unit/{unitCode}/unit-attribute/{attributeCode}/inline-comment/find": { "post": { "tags": [ "wiki-page-inline-comment-read-rest-controller" ], "operationId": "find_27", "parameters": [ { "name": "unitCode", "in": "path", "description": "unitCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "attributeCode", "in": "path", "description": "attributeCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageRootInlineCommentPageRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponseWikiPageRootInlineCommentInfo", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/unit/{unitCode}/revision/{version}/unit-attribute/{attributeCode}/inline-comment": { "post": { "tags": [ "wiki-page-inline-comment-mutation-rest-controller" ], "operationId": "create_23", "parameters": [ { "name": "unitCode", "in": "path", "description": "unitCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "version", "in": "path", "description": "version", "required": true, "schema": { "type": "integer", "format": "int32", "example": 1, "maximum": 2147483647, "minimum": -2147483648 }, "example": 1 }, { "name": "attributeCode", "in": "path", "description": "attributeCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageRootInlineCommentCreateRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageRootInlineCommentCreateRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/unit/{unitCode}/revision/find": { "post": { "tags": [ "wiki-page-revision-read-rest-controller" ], "operationId": "find_28", "parameters": [ { "name": "unitCode", "in": "path", "description": "unitCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageRevisionPageRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponseWikiPageRevisionInfo", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/unit/{unitCode}/hierarchy/move": { "post": { "tags": [ "wiki-page-hierarchy-controller" ], "operationId": "move", "parameters": [ { "name": "unitCode", "in": "path", "description": "unitCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageHierarchyMoveRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageHierarchyMoveUpdateRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/unit/{unitCode}/heartbeat/active-users": { "post": { "tags": [ "wiki-page-heartbeat-rest-controller" ], "operationId": "findWikiPageActiveUsers", "parameters": [ { "name": "unitCode", "in": "path", "description": "unitCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageHeartbeatActiveUsersRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageHeartbeatActiveUsersInfo", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/unit/{unitCode}/draw-io/find": { "post": { "tags": [ "wiki-page-draw-io-diagram-rest-controller" ], "operationId": "findDrawIoDiagramsOfUnit", "parameters": [ { "name": "unitCode", "in": "path", "description": "unitCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageDrawIoSearchRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponseWikiPageDrawIoDiagramInfo", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/unit/{unitCode}/comment": { "post": { "tags": [ "wiki-page-comment-mutation-rest-controller" ], "operationId": "create_24", "parameters": [ { "name": "unitCode", "in": "path", "description": "unitCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageCommentCreateRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageCommentCreateRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/unit/{unitCode}/comment/find": { "post": { "tags": [ "wiki-page-comment-read-rest-controller" ], "operationId": "find_29", "parameters": [ { "name": "unitCode", "in": "path", "description": "unitCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageCommentPageRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageResponseWikiPageCommentFull", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/unit/{unitCode}/change-lock": { "post": { "tags": [ "wiki-page-lock-rest-controller" ], "operationId": "wikiPageChangeLock", "parameters": [ { "name": "unitCode", "in": "path", "description": "unitCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageLockRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean", "example": true }, "example": true } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/unit/{spaceCode}/{unitCode}/draw-io/create": { "post": { "tags": [ "wiki-page-draw-io-diagram-rest-controller" ], "operationId": "createDrawIoDiagram", "parameters": [ { "name": "unitCode", "in": "path", "description": "unitCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "spaceCode", "in": "path", "description": "spaceCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "fileName", "in": "query", "description": "fileName", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "additionalProperties": false, "properties": { "file": { "type": "string", "format": "binary", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" } }, "required": [ "file" ], "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageDrawIoDiagramInfo", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/unit/hierarchy": { "post": { "tags": [ "wiki-page-hierarchy-controller" ], "operationId": "find_30", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageHierarchyRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageHierarchyRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/unit/find": { "post": { "tags": [ "wiki-page-read-rest-controller" ], "operationId": "find_31", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponseWikiPageInfo", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/unit/draw-io/{drawIoCode}/revision/find": { "post": { "tags": [ "wiki-page-draw-io-revision-rest-controller" ], "operationId": "findDrawIoDiagramRevision", "parameters": [ { "name": "drawIoCode", "in": "path", "description": "drawIoCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageDrawIoSearchRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DrawIoRevisionInfoRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/suit/find": { "post": { "tags": [ "wiki-page-suit-read-rest-controller" ], "operationId": "find_32", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageSuitPageRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponseWikiPageSuitInfo", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/label/find": { "post": { "tags": [ "wiki-page-label-rest-controller" ], "operationId": "find_33", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageLabelRequest", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageLabelResponse", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/inline-comment/{unitCommentCode}/thread/find": { "post": { "tags": [ "wiki-page-inline-comment-read-rest-controller" ], "operationId": "findThread", "parameters": [ { "name": "unitCommentCode", "in": "path", "description": "unitCommentCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WikiPageThreadInlineCommentPageRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponseWikiPageThreadInlineCommentInfo", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/permissions/space/{spaceCode}": { "post": { "tags": [ "wiki-user-permission-controller" ], "operationId": "findSpacePermissions", "parameters": [ { "name": "spaceCode", "in": "path", "description": "spaceCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "uniqueItems": true, "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/permission/space/{spaceCode}": { "post": { "tags": [ "wiki-user-permission-controller" ], "operationId": "hasSpacePermission", "parameters": [ { "name": "spaceCode", "in": "path", "description": "spaceCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean", "example": true }, "example": true } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_migrator_plugin/v1/migration/unit/{unitCode}/start": { "description": "Запустить миграцию страницы.", "post": { "tags": [ "Confluence to Wiki migrator" ], "summary": "Запустить миграцию страницы.", "operationId": "startMigration", "parameters": [ { "name": "unitCode", "in": "path", "description": "unitCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UnitMigrationStartRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_migrator_plugin/v1/migration/space/{spaceCode}/unit/report/find": { "description": "Получить отчет о миграции страницы.", "post": { "tags": [ "Confluence to Wiki migrator" ], "summary": "Получить отчет о миграции страницы.", "operationId": "findMigrationReport", "parameters": [ { "name": "spaceCode", "in": "path", "description": "spaceCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitMigrationReportFindRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CursorPageResponseDtoUnitMigrationReportInfoUnitMigrationReportLastIds", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_migrator_plugin/v1/migration/space/{spaceCode}/unit/find": { "description": "Получить информацию о миграции страниц.", "post": { "tags": [ "Confluence to Wiki migrator" ], "summary": "Получить информацию о миграции страниц.", "operationId": "findMigrationInfo", "parameters": [ { "name": "spaceCode", "in": "path", "description": "spaceCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitMigrationPageRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageResponseDtoUnitMigrationInfo", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_migrator_plugin/v1/migration/space/{spaceCode}/start": { "description": "Запустить миграцию проекта.", "post": { "tags": [ "Confluence to Wiki migrator" ], "summary": "Запустить миграцию проекта.", "operationId": "startMigration_1", "parameters": [ { "name": "spaceCode", "in": "path", "description": "spaceCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SpaceMigrationStartRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_migrator_plugin/v1/migration/space/{spaceCode}/report/find": { "description": "Получить отчет о миграции пространства.", "post": { "tags": [ "Confluence to Wiki migrator" ], "summary": "Получить отчет о миграции пространства.", "operationId": "findMigrationReport_1", "parameters": [ { "name": "spaceCode", "in": "path", "description": "spaceCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceMigrationReportFindRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CursorPageResponseDtoSpaceMigrationReportInfoSpaceMigrationReportLastIds", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_migrator_plugin/v1/migration/space/{spaceCode}/mapping": { "description": "Получить маппинг проектов на пространства для миграции.", "get": { "tags": [ "Confluence to Wiki migrator" ], "summary": "Получить маппинг проектов на пространства для миграции.", "operationId": "getMigrationMapping", "parameters": [ { "name": "spaceCode", "in": "path", "description": "spaceCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SpaceMigrationMappingRs", "example": null }, "example": null } } } } }, "post": { "tags": [ "Confluence to Wiki migrator" ], "summary": "Создать маппинг проектов Confluence на пространство Wiki.", "operationId": "createMapping", "parameters": [ { "name": "spaceCode", "in": "path", "description": "spaceCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceMigrationCreateMappingRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SpaceMigrationCreateMappingRs", "example": null }, "example": null } } } } }, "patch": { "tags": [ "Confluence to Wiki migrator" ], "summary": "Дополнить маппинг проектов Confluence на пространство Wiki.", "operationId": "updateMapping", "parameters": [ { "name": "spaceCode", "in": "path", "description": "spaceCode", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceMigrationCreateMappingRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SpaceMigrationCreateMappingRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_migrator_plugin/v1/migration/space/mapping/find": { "description": "Получить маппинг пространств Confluence на проекты Sberwiki.", "post": { "tags": [ "Confluence to Wiki migrator" ], "summary": "Получить маппинг пространств Confluence на проекты Sberwiki.", "operationId": "findMigrationMapping", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceMigrationFindMappingRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageResponseDtoSpaceMigrationMappingDto", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_migrator_plugin/v1/migration/space/import/csv": { "description": "Получить набор объектов по массовой миграции пространства.", "get": { "tags": [ "Confluence to Wiki migrator" ], "summary": "Получить набор объектов по массовой миграции пространства.", "operationId": "getCsvPack", "parameters": [ { "name": "csvPackId", "in": "query", "description": "csvPackId", "required": true, "schema": { "type": "string", "format": "uuid", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CsvPackDto", "example": null }, "example": null } } } } }, "post": { "tags": [ "Confluence to Wiki migrator" ], "summary": "Загрузить .csv для массовой миграции пространств.", "operationId": "importCsv", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "file": { "type": "string", "format": "binary", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" } }, "required": [ "file" ], "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SpaceMigrationImportCsvRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_wiki_migrator_plugin/v1/migration/project/find": { "description": "Получить пространства из Confluence, доступные для миграции для заданного пользователя.", "post": { "tags": [ "Confluence to Wiki migrator" ], "summary": "Получить пространства из Confluence, доступные для миграции для заданного пользователя.", "operationId": "findProjects", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpaceMigrationFindProjectRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageResponseDtoSpaceMigrationProjectInfo", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/{space_code}/files/upload": { "description": "Загрузить файлы для пространства", "post": { "tags": [ "Test Management System" ], "summary": "Загрузить файлы для пространства", "operationId": "uploadFile", "parameters": [ { "name": "space_code", "in": "path", "description": "Код пространства", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "TMS" }, { "name": "unit_code", "in": "query", "description": "Код юнита (опционально)", "required": false, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "TMS-123" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "additionalProperties": false, "properties": { "step_files": { "type": "array", "description": "Массив файлов для загрузки. Поле `step_files` обязательно. Поддерживается множественная загрузка.", "items": { "type": "string", "format": "binary", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null } }, "required": [ "step_files" ], "example": null }, "example": null } }, "required": false }, "responses": { "200": { "description": "Успешная загрузка. Возвращается список метаданных загруженных файлов.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileFullInfoDto" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "examples": { "success": { "description": "Метаданные загруженных файлов", "value": [ { "fileId": "32f31677-e12c-499e-a3d7-cc83b7ef3e03", "filePathParsedDto": { "relatedToType": "TEST_UNIT_FILE", "relativePath": "f332a9e3-9a45-40b6-bd3b-119b8fb8480a/5e3487e8-fbc4-4aa8-803f-402878dba46e", "fileName": "TMS_file_text_step_number_753.txt" }, "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "locale": "ru_RU", "userDetails": [ ] }, "createdAt": "2025-09-19T12:13:32.529856Z", "fileMetadataDto": { "contentType": "text/plain", "contentLength": 9 } }, { "fileId": "c24106bb-a485-4370-9b25-554e1e625139", "filePathParsedDto": { "relatedToType": "TEST_UNIT_FILE", "relativePath": "f332a9e3-9a45-40b6-bd3b-119b8fb8480a/5e3487e8-fbc4-4aa8-803f-402878dba46e", "fileName": "TMS_file_text_step_number_754.txt" }, "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "locale": "ru_RU", "userDetails": [ ] }, "createdAt": "2025-09-19T12:13:32.628284Z", "fileMetadataDto": { "contentType": "text/plain", "contentLength": 9 } } ] } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/{space_code}/files/delete": { "description": "Удалить файл шага", "post": { "tags": [ "Test Management System" ], "summary": "Удалить файл шага", "operationId": "deleteFile", "parameters": [ { "name": "space_code", "in": "path", "description": "Код пространства", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "TMS" } ], "requestBody": { "description": "Идентификатор файла для удаления", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepFileIdRq", "additionalProperties": false, "description": "Запрос на удаление файла по идентификатору", "required": [ "id" ], "example": null }, "examples": { "Пример запроса на удаление": { "description": "Удаление файла по ID", "value": { "id": { "code": "fc243c48-0f6b-4fdf-8582-cfc56c2cd03a" } } } } } }, "required": true }, "responses": { "200": { "description": "Статус удаления файла", "content": { "application/json": { "schema": { "type": "boolean", "additionalProperties": false, "description": "Результат удаления файла", "example": false, "maxLength": 2147483647, "pattern": ".*" }, "examples": { "success": { "description": "Файл удалён", "value": true } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/{folder_code}/export": { "description": "Экспорт тест-кейсов в Excel", "post": { "tags": [ "Test Management System" ], "summary": "Экспорт тест-кейсов в Excel", "operationId": "exportTestCaseExcel", "parameters": [ { "name": "folder_code", "in": "path", "description": "Код папки", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "TMS_test_case" } ], "requestBody": { "description": "Постраничный запрос на экспорт тест-кейсов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportTestCaseRq", "additionalProperties": false, "description": "Запрос на экспорт тест-кейсов", "required": [ "requestDto" ], "example": null }, "examples": { "Пример запроса": { "description": "Запрос первой страницы с 10000 тест-кейсов в пространстве TMS", "value": { "units": [ ], "requestDto": { "attributes": [ ], "filters": { "spaces": [ "TMS" ] }, "page": { "page": 0, "size": 10000 } } } } } } }, "required": true }, "responses": { "200": { "description": "Файл формата .xlsx с экспортированными тест-кейсами", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", "format": "binary", "additionalProperties": false, "description": "Файл формата .xlsx с экспортированными тест-кейсами", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/test_plans": { "description": "Постраничный запрос на поиск тест-планов с фильтром", "post": { "tags": [ "Test Management System" ], "summary": "Постраничный запрос на поиск тест-планов с фильтром", "operationId": "getTestPlans", "requestBody": { "description": "Запрос юнитов типа тест-план", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestPlansRq", "additionalProperties": false, "description": "Запрос на получение отфильтрованных тест-планов", "required": [ "unitFilters" ], "example": null }, "examples": { "Пример запроса списка тест-планов": { "description": "Запрос на получение отфильтрованных тест-планов", "value": { "linkedTo": { "code": "TMS-5" }, "unitFilters": { "attributes": [ ], "filters": { "spaces": [ "TMS" ] }, "page": { "page": 0, "size": 10 } } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный список отфильтрованных тест-планов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestPlansDto", "additionalProperties": false, "description": "Информация о тест-планах", "required": [ "units" ], "example": null }, "examples": { "success": { "description": "Постраничный список отфильтрованных тест-планов", "value": { "units": { "content": [ { "unit": { "code": "TMF-193", "summary": "Тест-план 148", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":\"40f9a2bd-5b19-4dfb-b47b-a379ed550612\",\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"Такое вот описание\"}]}]}", "suit": { "code": "test_plan", "name": "Тест-план", "icon": "memo_pencil" }, "space": { "code": "TMF", "name": "TMF" }, "spaces": [ { "code": "TMF", "name": "TMF" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-12-02T09:52:09.153467Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-12-02T09:52:09.153467Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] } ], "pageSize": 25, "hasNext": false, "pageNumber": 0, "totalElements": 1 } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/test_plans/tql": { "description": "Постраничный запрос на поиск тест-планов с помощью TQL", "post": { "tags": [ "Test Management System" ], "summary": "Постраничный запрос на поиск тест-планов с помощью TQL", "operationId": "getTestPlansWithTql", "requestBody": { "description": "Запрос на постраничный поиск тест-планов с помощью TQL", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TmsTqlRq", "additionalProperties": false, "description": "Запрос на постраничный поиск тест-планов с помощью TQL", "required": [ "spaceId", "unitTqlFilters" ], "example": null }, "examples": { "Пример запроса на постраничный поиск тест-планов с помощью TQL": { "description": "Запрос на постраничный поиск тест-планов с помощью TQL", "value": { "spaceId": { "code": "TMS" }, "unitTqlFilters": { "attributes": [ ], "calculatedAttributes": [ ], "query": "space = \"TMS\"", "page": { "size": 20, "page": 0 }, "timeZone": "Europe/Moscow" } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный список отфильтрованных тест-планов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestPlansDto", "additionalProperties": false, "description": "Информация о тест-планах", "required": [ "units" ], "example": null }, "examples": { "success": { "description": "Постраничный список отфильтрованных тест-планов", "value": { "units": { "content": [ { "unit": { "code": "TMF-193", "summary": "Тест-план 148", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":\"40f9a2bd-5b19-4dfb-b47b-a379ed550612\",\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"Такое вот описание\"}]}]}", "suit": { "code": "test_plan", "name": "Тест-план", "icon": "memo_pencil" }, "space": { "code": "TMF", "name": "TMF" }, "spaces": [ { "code": "TMF", "name": "TMF" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-12-02T09:52:09.153467Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-12-02T09:52:09.153467Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] } ], "pageSize": 25, "hasNext": false, "pageNumber": 0, "totalElements": 1 } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/test_cycle/{test_cycle_code}/safe_data/create": { "description": "Создание заявки на генерацию SafeData", "post": { "tags": [ "SafeData API" ], "summary": "Создание заявки на генерацию SafeData", "operationId": "createSafeDataGeneration", "parameters": [ { "name": "test_cycle_code", "in": "path", "description": "Код тест-цикла", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "TMS-123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafeDataGenerationRequestDto", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Успешное создание заявки на генерацию (возвращает UUID заявки)", "content": { "*/*": { "schema": { "type": "string", "format": "uuid", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/test_case/{unit_id}/test_data": { "description": "Получение списка тест-данных тест-кейса", "get": { "tags": [ "Test Management System" ], "summary": "Получение списка тест-данных тест-кейса", "operationId": "getTestData", "parameters": [ { "name": "unit_id", "in": "path", "description": "Код юнита", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "TMS-123" } ], "responses": { "200": { "description": "Список тест-данных тест-кейса", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TestCaseDataDto" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "examples": { "success": { "description": "Список сохраненных тест-данных тест-кейса", "value": [ { "id": { "parameterId": "f19c46f9-216f-4116-bd3f-2f4b3a9bc52f" }, "order": 1, "name": "test1111", "value": [ { "order": 1, "value": "value1" }, { "order": 2, "value": "value2" }, { "order": 3, "value": "value3" } ] } ] } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } }, "post": { "tags": [ "Test Management System" ], "summary": "Сохранение тест-данных тест-кейса", "operationId": "saveTestData", "parameters": [ { "name": "unit_id", "in": "path", "description": "Код юнита", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "TMS-123" } ], "requestBody": { "description": "Тело запроса на создание данных тест-кейса", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestCaseDataRequest", "additionalProperties": false, "description": "Запрос на создание данных тест-кейса", "required": [ "data" ], "example": null }, "examples": { "Пример запроса на сохранение тест-данных": { "description": "Запрос на создание данных тест-кейса", "value": { "data": [ { "id": { "parameterId": null }, "order": 1, "name": "test1111", "value": [ { "order": 1, "value": "value1" }, { "order": 2, "value": "value2" }, { "order": 3, "value": "value3" } ] } ] } } } } }, "required": true }, "responses": { "200": { "description": "Сохраненные тест-данные тест-кейса", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TestCaseDataDto" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "examples": { "success": { "description": "Список сохраненных тест-данных тест-кейса", "value": [ { "id": { "parameterId": "f19c46f9-216f-4116-bd3f-2f4b3a9bc52f" }, "order": 1, "name": "test1111", "value": [ { "order": 1, "value": "value1" }, { "order": 2, "value": "value2" }, { "order": 3, "value": "value3" } ] } ] } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/test_case/{unit_id}/parameters": { "description": "Получение списка параметров тест-кейса", "get": { "tags": [ "Test Management System" ], "summary": "Получение списка параметров тест-кейса", "operationId": "getParameters", "parameters": [ { "name": "unit_id", "in": "path", "description": "Код юнита", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "TMS-123" } ], "responses": { "200": { "description": "Список параметров тест-кейса", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TestCaseParameterDto" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "examples": { "success": { "description": "Список параметров тест-кейса", "value": [ { "id": { "parameterId": "5fdf4b86-55f7-4f7d-b5b1-ffa30b940988" }, "order": 1, "name": "test1", "value": "value1" }, { "id": { "parameterId": "6c4bb7d3-466e-4fe7-9c87-fdeb3c826342" }, "order": 2, "name": "test3", "value": "some_value1" } ] } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } }, "post": { "tags": [ "Test Management System" ], "summary": "Сохранение параметров тест-кейса", "operationId": "saveParameters", "parameters": [ { "name": "unit_id", "in": "path", "description": "Код юнита", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "TMS-123" } ], "requestBody": { "description": "Тело запроса на сохранение параметров тест-кейса", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestCaseParameterRequest", "additionalProperties": false, "description": "Запрос на сохранение параметров тест-кейса", "required": [ "parameters" ], "example": null }, "examples": { "Пример запроса на сохранение параметров тест-кейса": { "description": "Запрос на сохранение параметров тест-кейса", "value": { "parameters": [ { "id": { "parameterId": null }, "order": 1, "name": "test1", "value": "value1" }, { "id": { "parameterId": null }, "order": 2, "name": "test3", "value": "some_value1" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Параметры тест-кейса сохранены", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TestCaseParameterDto" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "examples": { "success": { "description": "Список параметров тест-кейса", "value": [ { "id": { "parameterId": "f19c46f9-216f-4116-bd3f-2f4b3a9bc52f" }, "order": 1, "name": "test1111", "value": [ { "order": 1, "value": "value1" }, { "order": 2, "value": "value2" }, { "order": 3, "value": "value3" } ] } ] } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/test_case/statuses/actual": { "description": "Проверка актуальности статусов тест-кейсов", "post": { "tags": [ "Test Management System" ], "summary": "Проверка актуальности статусов тест-кейсов", "operationId": "isTestCaseStatusesActual", "requestBody": { "description": "Тело запроса на проверку актуальности статусов тест-кейсов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestCaseActualStatusCheckRq", "additionalProperties": false, "description": "Запрос на проверку актуальности статусов тест-кейсов", "required": [ "testCaseCodes" ], "example": null }, "examples": { "Список кодов КЭ": { "description": "Запрос на проверку актуальности статусов тест-кейсов", "value": { "testCaseCodes": [ "TMS-21" ] } } } } }, "required": true }, "responses": { "200": { "description": "Проверка актуальности статусов тест-кейсов завершена успешно", "content": { "application/json": { "schema": { "type": "boolean", "additionalProperties": false, "description": "Результат проверки актуальности статусов тест-кейсов.\ntrue - если все статусы актуальны,\nfalse - если найдены неактуальные статусы\n", "example": false, "maxLength": 2147483647, "pattern": ".*" }, "examples": { "actual-statuses": { "description": "Пример успешного ответа при актуальных статусах", "value": true }, "not-actual-statuses": { "description": "Пример успешного ответа при наличии неактуальных статусов", "value": false } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/test_case/link": { "description": "Массовое создание связей тест кейсов с юнитами,\nа также обновление статуса тест кейсов на актуальные,\nв случае, если в needToUpdateTestCasesStatus передано true\n", "post": { "tags": [ "Test Management System" ], "summary": "Массовое создание связей тест кейсов с юнитами,\nа также обновление статуса тест кейсов на актуальные,\nв случае, если в needToUpdateTestCasesStatus передано true\n", "operationId": "createLinksWithUpdateTestCaseStatusToActual", "requestBody": { "description": "Тело запроса на создание связей тест кейсов с юнитом", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestCaseLinksRq", "additionalProperties": false, "description": "Запрос на создание связей тест кейсов с юнитом", "required": [ "destinations", "needToUpdateTestCasesStatus", "source", "type" ], "example": null }, "examples": { "Пример запроса на создание связей тест кейсов с юнитами": { "description": "Запрос на создание связей", "value": { "source": "TMS-27", "destinations": [ "TMS-11" ], "type": "test_cycle_to_test_case_link", "needToUpdateTestCasesStatus": true } } } } }, "required": true }, "responses": { "200": { "description": "Связи созданы успешно", "content": { "application/json": { "schema": { "type": "boolean", "additionalProperties": false, "description": "Результат создания связей", "example": false, "maxLength": 2147483647, "pattern": ".*" }, "examples": { "success": { "description": "Пример успешного ответа", "value": true } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/test_case/crit_regress": { "description": "Получение списка связанных тест-кейсов по кодам КЭ", "post": { "tags": [ "Test Management System" ], "summary": "Получение списка связанных тест-кейсов по кодам КЭ", "operationId": "getCritRegressTestCases", "requestBody": { "description": "Тело запроса на получение тест-кейсов по коду КЭ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CritRegressTestCaseRequest", "additionalProperties": false, "description": "Запрос на получение тест-кейсов по коду КЭ", "required": [ "ciIds" ], "example": null }, "examples": { "Список кодов КЭ": { "description": "Запрос на получение тест-кейсов по коду КЭ", "value": { "ciIds": [ "ci04" ] } } } } }, "required": true }, "responses": { "200": { "description": "Список связанных тест-кейсов по кодам КЭ", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CritRegressDto" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "examples": { "success": { "description": "Список связанных тест-кейсов по кодам КЭ", "value": [ { "ci": "ci04", "project": "TMD", "testsCount": 2, "markupType": "priority", "testCaseKeys": [ "TMD-5228", "TMD-5227" ], "testCases": [ { "key": "TMD-5228", "old_jira_key": "SWTR-123" }, { "key": "TMD-5227", "old_jira_key": "SWTR-456" } ], "testingService": null }, { "ci": "ci04", "project": "TMS", "testsCount": 1, "markupType": "priority", "testCaseKeys": [ "TMS-3436" ], "testCases": [ { "key": "TMS-3436", "old_jira_key": "SWTR-123" } ], "testingService": null } ] } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/safe_data/{generation_id}/start": { "description": "Запуск генерации SafeData", "post": { "tags": [ "SafeData API" ], "summary": "Запуск генерации SafeData", "operationId": "startGeneration", "parameters": [ { "name": "generation_id", "in": "path", "description": "Ид генерации", "required": true, "schema": { "type": "string", "format": "uuid", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "8e4a34ef-6c9d-4d42-8fbc-d07e6c848fd5" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafeDataStartRequestDto", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Генерация успешно запущена", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SafeDataGenerationStatusesDto", "example": null }, "example": null } } }, "400": { "description": "Ошибка валидации входных данных", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SafeDataGenerationStatusesDto", "example": null }, "example": null } } }, "500": { "description": "Ошибка при вызове SafeData API", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SafeDataGenerationStatusesDto", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/safe_data/statuses": { "description": "Получение статусов заявок на генерацию SafeData", "post": { "tags": [ "SafeData API" ], "summary": "Получение статусов заявок на генерацию SafeData", "operationId": "getSafeDataGenerationStatuses", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafeDataGenerationStatusesRequest", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Возвращает статусы заявок по их идентификаторам", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafeDataGenerationStatusesDto", "example": null }, "examples": { "Пример ответа": { "description": "Пример ответа", "value": [ { "generationId": "82d14fa5-4dcd-4386-bf32-ac86fc0cc5e5", "generationStatus": "IN_PROGRESS", "errorMessage": "text" } ] } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/run/{unit_id}/status": { "description": "Изменение статуса прогона тест-кейса", "post": { "tags": [ "Test Management System" ], "summary": "Изменение статуса прогона тест-кейса", "operationId": "changeTestCaseRunStatus", "parameters": [ { "name": "unit_id", "in": "path", "description": "Код прогона", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "TMS-123" } ], "requestBody": { "description": "Тело запроса на обновление статуса тестового прогона", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestCaseRunStatusUpdateRq", "additionalProperties": false, "description": "Запрос на обновление статуса тестового прогона", "required": [ "status" ], "example": null }, "examples": { "Пример запроса": { "description": "Запрос на обновление статуса тестового прогона", "value": { "status": "blocked" } } } } }, "required": true }, "responses": { "200": { "description": "Статус прогона тест-кейса изменён", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse", "additionalProperties": false, "description": "Успешное изменение статуса прогона", "example": null }, "examples": { "success": { "description": "Успешное изменение статуса прогона" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/link": { "description": "Массовое создание связей", "post": { "tags": [ "Test Management System" ], "summary": "Массовое создание связей", "operationId": "createLinks", "requestBody": { "description": "Тело запрос на создание связей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitLinksRq", "additionalProperties": false, "description": "Запрос на создание связей юнита", "required": [ "destinations", "source", "type" ], "example": null }, "examples": { "Пример запроса на создание связей": { "description": "Запрос на создание связей", "value": { "source": "TMS-27", "destinations": [ "TMS-11" ], "type": "test_cycle_to_test_case_link" } } } } }, "required": true }, "responses": { "200": { "description": "Связи созданы успешно", "content": { "application/json": { "schema": { "type": "boolean", "additionalProperties": false, "description": "Результат создания связей", "example": false, "maxLength": 2147483647, "pattern": ".*" }, "examples": { "success": { "description": "Пример успешного ответа", "value": true } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/link/units": { "description": "Получение списка прилинкованных задач по типу связи с фильтрами", "post": { "tags": [ "Test Management System" ], "summary": "Получение списка прилинкованных задач по типу связи с фильтрами", "operationId": "getLinkedUnitsByType", "requestBody": { "description": "Тело запроса на получение связанных юнитов по типу", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTypedLinkedUnitsRq", "additionalProperties": false, "description": "Запрос на получение связанных юнитов по типу", "required": [ "linkType", "unitFilters", "unitId" ], "example": null }, "examples": { "Пример запроса на получение связанных юнитов по типу": { "description": "Запрос на получение связанных юнитов по типу", "value": { "unitId": { "code": "TMS-7" }, "linkType": "TEST_CASE_TO_TEST_CASE_RUN_LINK_TYPE", "unitFilters": { "attributes": [ "test_case_run_status" ], "page": { "page": 0, "size": 10 } } } } } } }, "required": true }, "responses": { "200": { "description": "Список связанных юнитов по типу связи", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLResponseDto", "additionalProperties": false, "description": "Информация о юнитах", "required": [ "unit" ], "example": null }, "examples": { "success": { "description": "Пример ответа с тест-кейсами", "value": { "content": [ { "unit": { "code": "TMS-3434", "summary": "TK!!!", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":null,\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"test\"}]}]}", "suit": { "code": "test_case_run", "name": "Прогон тест-кейса", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-09-24T09:14:30.689964Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-09-24T09:14:30.689964Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ { "attribute": { "code": "test_case_run_status", "name": "Статус", "type": "taxonomy", "description": "Статус" }, "value": { "code": "not_started", "name": "Не запускался" }, "valueAsString": null } ], "calculatedAttributes": [ ] } ], "pageSize": 10, "hasNext": false, "pageNumber": 0, "totalElements": 1 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/link/test_plan/test_cycles": { "description": "Получение списка прилинкованных к тест-плану тест-циклов с фильтрами", "post": { "tags": [ "Test Management System" ], "summary": "Получение списка прилинкованных к тест-плану тест-циклов с фильтрами", "operationId": "getLinkedTestCycles", "requestBody": { "description": "Тело запроса на получение связанных тест-циклов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLinkedUnitsRq", "additionalProperties": false, "description": "Запрос на получения связанных тест-циклов", "required": [ "unitFilters", "unitId" ], "example": null }, "examples": { "Пример запроса на получение связанных тест-циклов": { "description": "Запрос на получения связанных тест-циклов", "value": { "unitId": { "code": "TMS-25" }, "unitFilters": { "attributes": [ "test_cycle_status", "plan_date_end", "plan_date_start", "release", "owner", "iteration_type", "cycles_number", "type_of_testing", "test_case_test_type", "old_jira_key", "folder" ], "page": { "page": 0, "size": 10 } } } } } } }, "required": true }, "responses": { "200": { "description": "Список тест-циклов, привязанных к тест-плану", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLResponseDto", "additionalProperties": false, "description": "Информация о тест-циклах", "required": [ "unit" ], "example": null }, "examples": { "success": { "description": "Пример ответа с привязанными тест-циклами", "value": { "content": [ { "unit": { "unit": { "code": "TMF-191", "summary": "Тестовый цикл-25", "description": null, "suit": { "code": "test_cycle", "name": "Тест-цикл", "icon": "memo_pencil" }, "space": { "code": "TMF", "name": "TMF" }, "spaces": [ { "code": "TMF", "name": "TMF" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-12-01T12:36:41.738853Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-12-01T12:36:41.738853Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ { "attribute": { "code": "plan_date_end", "name": "Плановая дата окончания", "type": "date_time", "description": "Плановая дата окончания" }, "value": null, "valueAsString": null }, { "attribute": { "code": "test_cycle_status", "name": "Статус", "type": "taxonomy", "description": "Статус" }, "value": { "code": "draft", "name": "Не запускался" }, "valueAsString": null }, { "attribute": { "code": "folder", "name": "Папка", "type": "folder", "description": "Папка" }, "value": { "code": "TMF_test_cycle", "title": "Все тест-циклы" }, "valueAsString": null }, { "attribute": { "code": "cycles_number", "name": "Номер цикла", "type": "taxonomy", "description": "Номер цикла" }, "value": { "code": "1", "name": "1" }, "valueAsString": null }, { "attribute": { "code": "test_case_test_type", "name": "Вид теста", "type": "taxonomy", "description": "Вид теста" }, "value": { "code": "smoke", "name": "Smoke" }, "valueAsString": null }, { "attribute": { "code": "old_jira_key", "name": "Ключ задачи в Jira", "type": "text", "description": "Ключ задачи в Jira" }, "value": null, "valueAsString": null }, { "attribute": { "code": "plan_date_start", "name": "Плановая дата начала", "type": "date_time", "description": "Плановая дата начала" }, "value": null, "valueAsString": null }, { "attribute": { "code": "iteration_type", "name": "Тип итерации", "type": "taxonomy", "description": "Тип итерации" }, "value": null, "valueAsString": null } ], "calculatedAttributes": [ ] }, "progressPercentage": { "Не запускался": 0 }, "successPercentage": 0 } ], "pageSize": 10, "hasNext": false, "pageNumber": 0, "totalElements": 1 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/link/test_cycle/test_cases": { "description": "Получение списка прилинкованных к тест-циклу тест-кейсов с фильтрами", "post": { "tags": [ "Test Management System" ], "summary": "Получение списка прилинкованных к тест-циклу тест-кейсов с фильтрами", "operationId": "getTestCases", "requestBody": { "description": "Тело запроса на получение связанных тест-кейсов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLinkedUnitsRq", "additionalProperties": false, "description": "Запрос на получения связанных тест-кейсов", "required": [ "unitFilters", "unitId" ], "example": null }, "examples": { "Пример запроса на получение связанных тест-кейсов": { "description": "Запрос на получения связанных тест-кейсов", "value": { "unitId": { "code": "TMS-27" }, "unitFilters": { "attributes": [ "status" ], "page": { "page": 0, "size": 10 } } } } } } }, "required": true }, "responses": { "200": { "description": "Список тест-кейсов, привязанных к тест-циклу", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLResponseDto", "additionalProperties": false, "description": "Информация о юнитах", "required": [ "unit" ], "example": null }, "examples": { "success": { "description": "Пример ответа с тест-кейсами", "value": { "content": [ { "unit": { "code": "TMS-28", "summary": "TK!!!", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":null,\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"test\"}]}]}", "suit": { "code": "test_case", "name": "Тест-кейс", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-08-21T14:24:56.028278Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-08-21T14:30:51.714929Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] } ], "pageSize": 10, "hasNext": false, "pageNumber": 0, "totalElements": 1 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/link/test_cycle/player": { "description": "Получение списка прилинкованных тест-кейсов и актуальных прогонов к циклу", "post": { "tags": [ "Test Management System" ], "summary": "Получение списка прилинкованных тест-кейсов и актуальных прогонов к циклу", "operationId": "getLinkedTestCasesWithActualRuns", "requestBody": { "description": "Тело запроса на связанные тест-кейсы и прогоны", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTestCyclePlayerRq", "additionalProperties": false, "description": "Запрос на получение связанных тест-кейсов и актуальных прогонов", "required": [ "assignedToMe", "groupType", "testCycleId" ], "example": null }, "examples": { "Пример запроса на получение связанных тест-кейсов и прогонов": { "description": "Запрос на получение связанных тест-кейсов и актуальных прогонов", "value": { "testCycleId": { "code": "TMS-27" }, "testCaseFilters": { "properties": { "or": [ ], "and": [ ] } }, "groupType": "PRIORITY", "assignedToMe": false } } } } }, "required": true }, "responses": { "200": { "description": "Список тест-кейсов и актуальных прогонов к циклу", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupedTestCasesWithActualRuns" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "examples": { "success": { "description": "Пример ответа с сгруппированными тест-кейсами и их прогонами", "value": [ { "group": { "id": "high", "type": "PRIORITY", "name": "Высокий" }, "testCasesWithActualRuns": [ { "testCase": { "id": { "code": "TMS-28" }, "name": "TK!!!", "folder": { "code": "TMS_test_case", "title": "Все тест-кейсы" }, "owner": { "externalId": "2073028", "firstName": "Кирилл", "lastName": "Балашов", "middleName": "Лаврентьевич", "login": "balashovkirill", "userDetails": [ ] }, "priority": { "code": "high", "name": "Высокий" } }, "actualTestCaseRun": { "id": { "code": "TMS-3439" }, "name": "TK!!!", "precondition": null, "assignee": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "status": { "code": "not_started", "name": "Не запускался" } }, "archivedTestCaseRuns": [ { "id": { "code": "TMS-3435" }, "name": "TK!!!", "precondition": null, "assignee": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "status": { "code": "not_started", "name": "Не запускался" } } ] } ] } ] } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/link/test_case_run/test_cycle": { "description": "Запрос возвращает тест-циклы (test cycles) и связанные с ними прогоны (test case runs)\nдля указанного тест-кейса.\n\nЦель метода: отображение таблицы прогонов на странице тест-кейса,\nсгруппированных по тест-циклам.\n\nВ параметре unitId.code передаётся код тест-кейса (например, \"TMS-28\").\n", "post": { "tags": [ "Test Management System" ], "summary": "Получить тест-циклы и связанные с ними прогоны для указанного тест-кейса", "description": "Запрос возвращает тест-циклы (test cycles) и связанные с ними прогоны (test case runs)\nдля указанного тест-кейса.\n\nЦель метода: отображение таблицы прогонов на странице тест-кейса,\nсгруппированных по тест-циклам.\n\nВ параметре unitId.code передаётся код тест-кейса (например, \"TMS-28\").\n", "operationId": "getTestCaseRunLinkedWithCycle", "requestBody": { "description": "Запрос на получение связанных тест-циклов и прогонов для указанного тест-кейса. В unitId.code передаётся код тест-кейса (например, TMS-28)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTypedLinkedUnitsWithTestCycleRq", "additionalProperties": false, "description": "Запрос на получение связанных тест-циклов и прогонов", "required": [ "unitFilters", "unitId" ], "example": null }, "examples": { "Пример запроса на получение связанных тест-циклов и прогонов": { "description": "Запрос на получение связанных тест-циклов и прогонов", "value": { "unitId": { "code": "TMS-28" }, "linkType": "TEST_CASE_TO_TEST_CASE_RUN_LINK_TYPE", "unitFilters": { "attributes": [ "test_case_run_status" ], "page": { "page": 0, "size": 10 } } } } } } }, "required": true }, "responses": { "200": { "description": "Прилинкованные тест-циклы и прогоны", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestCaseRunWithCycle", "additionalProperties": false, "description": "Информация о тест циклах с прогонами", "required": [ "attributes", "cycleCode", "unit" ], "example": null }, "examples": { "success": { "description": "Пример ответа с тест-циклами и прогонами", "value": { "content": [ { "unit": { "code": "TMS-3435", "summary": "TK!!!", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":null,\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"test\"}]}]}", "suit": { "code": "test_case_run", "name": "Прогон тест-кейса", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-09-24T09:36:23.204498Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-09-24T12:05:45.720506Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ { "attribute": { "code": "test_case_run_status", "name": "Статус", "type": "taxonomy", "description": "Статус" }, "value": { "code": "not_started", "name": "Не запускался" }, "valueAsString": null } ], "cycleCode": { "code": "TMS-27" } }, { "unit": { "code": "TMS-3439", "summary": "TK!!!", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":null,\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"test\"}]}]}", "suit": { "code": "test_case_run", "name": "Прогон тест-кейса", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-09-24T12:05:45.341192Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-09-24T12:05:45.341192Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ { "attribute": { "code": "test_case_run_status", "name": "Статус", "type": "taxonomy", "description": "Статус" }, "value": { "code": "not_started", "name": "Не запускался" }, "valueAsString": null } ], "cycleCode": { "code": "TMS-27" } } ], "pageSize": 10, "hasNext": false, "pageNumber": 0, "totalElements": 2 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/integration/units": { "description": "Получение списка задач заданного типа из всех пространств с фильтрами", "post": { "tags": [ "Test Management System" ], "summary": "Получение списка задач заданного типа из всех пространств с фильтрами", "operationId": "searchUnits", "requestBody": { "description": "Тело запроса на поиск юнитов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SPUnitSearchRq", "additionalProperties": false, "description": "Запрос на поиск юнитов", "required": [ "attributes", "from", "page", "type" ], "example": null }, "examples": { "Пример запроса": { "description": "Запрос на поиск юнитов", "value": { "type": "TEST_CYCLE", "requiredAtributes": [ "status" ], "from": "2024-01-01T00:00:00.000Z", "to": null, "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Список задач по заданному типу с фильтрами", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLResponseDto", "additionalProperties": false, "description": "Информация о юнитах", "required": [ "unit" ], "example": null }, "examples": { "success": { "description": "Список задач заданного типа из всех пространств с фильтрами", "value": { "content": [ { "unit": { "code": "TMS-3433", "summary": "Тестовый цикл-1", "description": null, "suit": { "code": "test_cycle", "name": "Тест-цикл", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-09-16T12:06:47.709121Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-09-16T12:06:47.709121Z", "isFavorite": null, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] } ], "pageSize": 10, "hasNext": false, "pageNumber": 0, "totalElements": 1 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/import/test_case": { "description": "Загрузить файл импорта тест-кейсов", "post": { "tags": [ "Test Management System" ], "summary": "Загрузить файл импорта тест-кейсов", "operationId": "importTestCaseExcel", "parameters": [ { "name": "spaceId", "in": "query", "description": "Код пространства", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "TMS" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "additionalProperties": false, "properties": { "file": { "type": "string", "format": "binary", "description": "Оригинальное имя файла", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" } }, "required": [ "file" ], "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Успешная загрузка. Возвращает id задачи импорта тест-кейсов.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportResponse" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "examples": { "success": { "description": "Информация о задаче импорта", "value": { "taskId": "831479e6-7421-41f5-b149-68c0a695bfde", "status": "SUCCESS", "message": "Импорт начат" } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/folder/root": { "description": "Иерархическая структура папок от корня", "post": { "tags": [ "Test Management System" ], "summary": "Иерархическая структура папок от корня", "operationId": "getRootFolderHierarchy", "requestBody": { "description": "Тело запроса корневой структуры папок", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRootFolderRq", "additionalProperties": false, "description": "Запрос на получения структуры папок от корня", "required": [ "spaceId", "type" ], "example": null }, "examples": { "Пример запроса корневой структуры папок": { "description": "Запрос на получения структуры папок от корня", "value": { "type": "TEST_CASE", "spaceId": { "code": "TMS" } } } } } }, "required": true }, "responses": { "200": { "description": "Иерархическая структура папок от корня", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderDto", "additionalProperties": false, "description": "Информация о папке", "required": [ "children", "id", "key", "title" ], "example": null }, "examples": { "success": { "description": "Структура папок от корня", "value": { "id": { "code": "TMS_test_case" }, "key": "TMS_test_case", "title": "Все тест-кейсы", "children": [ ] } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/folder/root/units": { "description": "Иерархическая структура папок от корня с содержащимися задачами", "post": { "tags": [ "Test Management System" ], "summary": "Иерархическая структура папок от корня с содержащимися задачами", "operationId": "getRootFolderHierarchyWithUnits", "requestBody": { "description": "Запрос структуры от корневой папки с юнитами", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRootUnitFolderRq", "additionalProperties": false, "description": "Запрос на получения структуры папок от корня с юнитами", "required": [ "getRootFolderRq", "unitFilters" ], "example": null }, "examples": { "Пример запроса корневой папки с юнитами": { "description": "Запрос структуры от корневой папки с юнитам", "value": { "getRootFolderRq": { "type": "TEST_CASE", "spaceId": { "code": "TMS" } }, "linkedTo": { "code": "TMS-5" }, "unitFilters": { "page": { "page": 0, "size": 10 } } } } } } }, "required": true }, "responses": { "200": { "description": "Иерархическая структура папок от корня с содержащимися задачами", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderUnitsDto", "additionalProperties": false, "description": "Информация о папке и юнитах в ней", "required": [ "folderHierarchy", "units" ], "example": null }, "examples": { "success": { "description": "Иерархия папок и юниты", "value": { "folderHierarchy": { "id": { "code": "TMS_test_case" }, "key": "TMS_test_case", "title": "Все тест-кейсы", "children": [ { "id": { "code": "d58c8d9f-aa53-4f85-977e-985ddbb4e1d5" }, "key": "d58c8d9f-aa53-4f85-977e-985ddbb4e1d5", "title": "new_name", "children": [ { "id": { "code": "26123c25-e7bb-43cb-9840-38268c075247" }, "key": "26123c25-e7bb-43cb-9840-38268c075247", "title": "test6", "children": [ ] } ] } ] }, "units": { "content": [ { "unit": { "code": "TMS-3", "summary": "TK!!!", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":null,\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"test\"}]}]}", "suit": { "code": "test_case", "name": "Тест-кейс", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-08-18T20:07:11.787194Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-08-21T06:58:43.287526Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] } ], "pageSize": 10, "hasNext": false, "pageNumber": 0, "totalElements": 1 } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/folder/root/units/test_cases/tql": { "description": "Иерархическая структура папок от корня с поиском тест-кейсов с помощью TQL", "post": { "tags": [ "Test Management System" ], "summary": "Иерархическая структура папок от корня с поиском тест-кейсов с помощью TQL", "operationId": "getRootFolderHierarchyWithUnitsTql", "requestBody": { "description": "Запрос на постраничный поиск тест-кейсов с помощью TQL и иерархия папок от корня", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TmsTqlRq", "additionalProperties": false, "description": "Запрос на постраничный поиск тест-кейсов с помощью TQL", "required": [ "spaceId", "unitTqlFilters" ], "example": null }, "examples": { "Пример запроса иерархии от корневой папки с юнитами с помощью TQL": { "description": "Запрос структуры от корневой папки с юнитами с помощью TQL", "value": { "spaceId": { "code": "TMS" }, "unitTqlFilters": { "attributes": [ ], "calculatedAttributes": [ ], "query": "space = \"TMS\"", "page": { "size": 20, "page": 0 }, "timeZone": "Europe/Moscow" } } } } } }, "required": true }, "responses": { "200": { "description": "Иерархическая структура папок от корня с содержащимися задачами", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderUnitsDto", "additionalProperties": false, "description": "Информация о папке и юнитах в ней", "required": [ "folderHierarchy", "units" ], "example": null }, "examples": { "success": { "description": "Иерархия папок и юниты", "value": { "folderHierarchy": { "id": { "code": "TMS_test_case" }, "key": "TMS_test_case", "title": "Все тест-кейсы", "children": [ { "id": { "code": "d58c8d9f-aa53-4f85-977e-985ddbb4e1d5" }, "key": "d58c8d9f-aa53-4f85-977e-985ddbb4e1d5", "title": "new_name", "children": [ { "id": { "code": "26123c25-e7bb-43cb-9840-38268c075247" }, "key": "26123c25-e7bb-43cb-9840-38268c075247", "title": "test6", "children": [ ] } ] } ] }, "units": { "content": [ { "unit": { "code": "TMS-3", "summary": "TK!!!", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":null,\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"test\"}]}]}", "suit": { "code": "test_case", "name": "Тест-кейс", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-08-18T20:07:11.787194Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-08-21T06:58:43.287526Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] } ], "pageSize": 10, "hasNext": false, "pageNumber": 0, "totalElements": 1 } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/folder/root/units/progress": { "description": "Иерархическая структура папок от корня с задачами и прогрессом тест-циклов", "post": { "tags": [ "Test Management System" ], "summary": "Иерархическая структура папок от корня с задачами и прогрессом тест-циклов", "operationId": "getRootTestCycleFolderHierarchyAndUnitsWithProgress", "requestBody": { "description": "Постраничный запрос на получение структуры от корневой папки с циклами и прогрессом", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRootUnitFolderRq", "additionalProperties": false, "description": "Запрос на получения структуры папок от корня с юнитами", "required": [ "getRootFolderRq", "unitFilters" ], "example": null }, "examples": { "Пример запроса": { "description": "Запрос на получение структуры от корневой папки с циклами и прогрессом", "value": { "getRootFolderRq": { "type": "TEST_CYCLE", "spaceId": { "code": "TMS" } }, "unitFilters": { "sort": { "direction": "DESC", "attribute": [ "createdAt" ] }, "page": { "page": 0, "size": 10 } } } } } } }, "required": true }, "responses": { "200": { "description": "Иерархическая структура папок от корня с задачами и прогрессом тест-циклов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderUnitsWithProgressDto", "additionalProperties": false, "description": "Информация о структуре папок, циклах и их прогрессе", "required": [ "folderHierarchy", "units" ], "example": null }, "examples": { "success": { "description": "Иерархическая структура папок от корня с задачами и прогрессом тест-циклов", "value": { "folderHierarchy": { "id": { "code": "TMS_test_cycle" }, "key": "TMS_test_cycle", "title": "Все тест-циклы", "children": [ ] }, "units": { "content": [ { "unit": { "unit": { "code": "TMS-3433", "summary": "Тестовый цикл-1", "description": null, "suit": { "code": "test_cycle", "name": "Тест-цикл", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-09-16T12:06:47.709121Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-09-16T12:06:47.709121Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] }, "progressPercentage": { "Не запускался": 2 }, "successPercentage": 0 }, { "unit": { "unit": { "code": "TMS-3430", "summary": "TCL!!!", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":null,\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"test cycle\"}]}]}", "suit": { "code": "test_cycle", "name": "Тест-цикл", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-09-16T12:06:00.357347Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-09-16T12:06:00.357347Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] }, "progressPercentage": { "Не запускался": 0 }, "successPercentage": 0 }, { "unit": { "unit": { "code": "TMS-27", "summary": "TCL!!!", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":null,\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"test cycle\"}]}]}", "suit": { "code": "test_cycle", "name": "Тест-цикл", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-08-21T14:24:47.761223Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-08-21T14:24:47.761223Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] }, "progressPercentage": { "Не запускался": 1 }, "successPercentage": 0 }, { "unit": { "unit": { "code": "TMS-25", "summary": "TCL!!!", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":null,\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"test cycle\"}]}]}", "suit": { "code": "test_cycle", "name": "Тест-цикл", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-08-21T13:34:16.393600Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-08-21T13:34:16.393600Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] }, "progressPercentage": { "Не запускался": 1 }, "successPercentage": 0 }, { "unit": { "unit": { "code": "TMS-24", "summary": "TCL!!!", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":null,\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"test cycle\"}]}]}", "suit": { "code": "test_cycle", "name": "Тест-цикл", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-08-20T14:37:14.381887Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-08-20T14:37:14.381887Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] }, "progressPercentage": { "Не запускался": 0 }, "successPercentage": 0 }, { "unit": { "unit": { "code": "TMS-5", "summary": "TCL!!!", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":null,\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"test cycle\"}]}]}", "suit": { "code": "test_cycle", "name": "Тест-цикл", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-08-18T20:08:08.916257Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-08-20T07:27:57.116052Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] }, "progressPercentage": { "Пройден": 1 }, "successPercentage": 100 } ], "pageSize": 10, "hasNext": false, "pageNumber": 0, "totalElements": 6 } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/folder/root/units/progress/tql": { "description": "Иерархическая структура папок от корня с поиском тест-циклов и прогресса с помощью TQL", "post": { "tags": [ "Test Management System" ], "summary": "Иерархическая структура папок от корня с поиском тест-циклов и прогресса с помощью TQL", "operationId": "getRootTestCycleFolderHierarchyAndUnitsWithProgressTql", "requestBody": { "description": "Запрос на постраничный поиск тест-циклов с прогрессом с помощью TQL и иерархия папок от корня", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TmsTqlRq", "additionalProperties": false, "description": "Запрос на постраничный поиск тест-циклов с помощью TQL", "required": [ "spaceId", "unitTqlFilters" ], "example": null }, "examples": { "Пример запроса иерархии от корневой папки с юнитами с помощью TQL": { "description": "Запрос структуры от корневой папки с юнитами с помощью TQL", "value": { "spaceId": { "code": "TMS" }, "unitTqlFilters": { "attributes": [ ], "calculatedAttributes": [ ], "query": "space = \"TMS\"", "page": { "size": 20, "page": 0 }, "timeZone": "Europe/Moscow" } } } } } }, "required": true }, "responses": { "200": { "description": "Иерархическая структура папок от корня с задачами и прогрессом тест-циклов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderUnitsWithProgressDto", "additionalProperties": false, "description": "Информация о структуре папок, циклах и их прогрессе", "required": [ "folderHierarchy", "units" ], "example": null }, "examples": { "success": { "description": "Иерархическая структура папок от корня с задачами и прогрессом тест-циклов", "value": { "folderHierarchy": { "id": { "code": "TMS_test_cycle" }, "key": "TMS_test_cycle", "title": "Все тест-циклы", "children": [ ] }, "units": { "content": [ { "unit": { "unit": { "code": "TMS-3433", "summary": "Тестовый цикл-1", "description": null, "suit": { "code": "test_cycle", "name": "Тест-цикл", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-09-16T12:06:47.709121Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-09-16T12:06:47.709121Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] }, "progressPercentage": { "Не запускался": 2 }, "successPercentage": 0 }, { "unit": { "unit": { "code": "TMS-3430", "summary": "TCL!!!", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":null,\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"test cycle\"}]}]}", "suit": { "code": "test_cycle", "name": "Тест-цикл", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-09-16T12:06:00.357347Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-09-16T12:06:00.357347Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] }, "progressPercentage": { "Не запускался": 0 }, "successPercentage": 0 }, { "unit": { "unit": { "code": "TMS-27", "summary": "TCL!!!", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":null,\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"test cycle\"}]}]}", "suit": { "code": "test_cycle", "name": "Тест-цикл", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-08-21T14:24:47.761223Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-08-21T14:24:47.761223Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] }, "progressPercentage": { "Не запускался": 1 }, "successPercentage": 0 }, { "unit": { "unit": { "code": "TMS-25", "summary": "TCL!!!", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":null,\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"test cycle\"}]}]}", "suit": { "code": "test_cycle", "name": "Тест-цикл", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-08-21T13:34:16.393600Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-08-21T13:34:16.393600Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] }, "progressPercentage": { "Не запускался": 1 }, "successPercentage": 0 }, { "unit": { "unit": { "code": "TMS-24", "summary": "TCL!!!", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":null,\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"test cycle\"}]}]}", "suit": { "code": "test_cycle", "name": "Тест-цикл", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-08-20T14:37:14.381887Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-08-20T14:37:14.381887Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] }, "progressPercentage": { "Не запускался": 0 }, "successPercentage": 0 }, { "unit": { "unit": { "code": "TMS-5", "summary": "TCL!!!", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":null,\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"test cycle\"}]}]}", "suit": { "code": "test_cycle", "name": "Тест-цикл", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-08-18T20:08:08.916257Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-08-20T07:27:57.116052Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] }, "progressPercentage": { "Пройден": 1 }, "successPercentage": 100 } ], "pageSize": 10, "hasNext": false, "pageNumber": 0, "totalElements": 6 } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/folder/rename": { "description": "Изменение папки", "post": { "tags": [ "Test Management System" ], "summary": "Изменение папки", "operationId": "renameFolder", "requestBody": { "description": "Тело запроса для переименования папки", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameFolderRq", "additionalProperties": false, "description": "Запрос на переименование папки", "required": [ "folderId", "newName" ], "example": null }, "examples": { "Пример запроса на переименование": { "description": "Запрос на переименование папки", "value": { "folderId": { "code": "d58c8d9f-aa53-4f85-977e-985ddbb4e1d5" }, "newName": "new_name" } } } } }, "required": true }, "responses": { "200": { "description": "Папка переименована", "content": { "application/json": { "schema": { "type": "boolean", "additionalProperties": false, "description": "Результат переименования", "example": false, "maxLength": 2147483647, "pattern": ".*" }, "examples": { "success": { "description": "Успешное переименование", "value": true } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/folder/move": { "description": "Перемещение папки", "post": { "tags": [ "Test Management System" ], "summary": "Перемещение папки", "operationId": "moveFolder", "requestBody": { "description": "Тело запроса для перемещения папки", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveFolderRq", "additionalProperties": false, "description": "Запрос на перемещение папки", "required": [ "folderId", "newParentId" ], "example": null }, "examples": { "Пример запроса на перемещение": { "description": "Запрос на перемещение папки", "value": { "folderId": { "code": "26123c25-e7bb-43cb-9840-38268c075247" }, "newParentId": { "code": "d58c8d9f-aa53-4f85-977e-985ddbb4e1d5" } } } } } }, "required": true }, "responses": { "200": { "description": "Папка перемещена успешно", "content": { "application/json": { "schema": { "type": "boolean", "additionalProperties": false, "description": "Результат перемещения", "example": false, "maxLength": 2147483647, "pattern": ".*" }, "examples": { "success": { "description": "Успешное перемещение", "value": true } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/folder/hierarchy/{folder_code}/units": { "description": "Иерархическая структура папок от заданной с содержащимися задачами (устаревший)", "post": { "tags": [ "Test Management System" ], "summary": "Иерархическая структура папок от заданной с содержащимися задачами (устаревший)", "operationId": "getFolderHierarchyAndUnits", "parameters": [ { "name": "folder_code", "in": "path", "description": "folder_code", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLRequestDto", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Дерево папок + задачи для заданной папки (deprecated)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderUnitsDto", "additionalProperties": false, "description": "Информация о папке и юнитах в ней", "required": [ "folderHierarchy", "units" ], "example": null }, "examples": { "success": { "description": "Иерархия и юниты для заданной папки", "value": { "folders": [ { "code": "sub1", "name": "Подпапка 1", "units": [ { "unitCode": "unitA", "name": "Задача A" } ], "children": [ ] } ] } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/folder/hierarchy/{folder_code}/units/progress": { "description": "Иерархическая структура папок от заданной с задачами и прогрессом тест-циклов", "post": { "tags": [ "Test Management System" ], "summary": "Иерархическая структура папок от заданной с задачами и прогрессом тест-циклов", "operationId": "getTestCycleFolderHierarchyAndUnitsWithProgress", "parameters": [ { "name": "folder_code", "in": "path", "description": "Код папки, от которой строится иерархия", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "TMS_test_cycle" } ], "requestBody": { "description": "Тело запроса на получение структуры папок и циклов с прогрессом", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QLRequestDto", "additionalProperties": false, "description": "Запрос на получение структуры папок и отфильтрованных юнитов", "example": null }, "examples": { "Пример запроса": { "description": "Запрос на получение структуры от заданной папки с циклами и прогрессом", "value": { "attributes": [ "test_cycle_status", "plan_date_end", "plan_date_start", "release", "owner", "iteration_type", "cycles_number", "type_of_testing", "test_case_test_type", "old_jira_key", "folder" ], "filters": { "attributes": { "or": [ ], "and": [ ] }, "properties": { "and": [ ], "or": [ { "property": "code", "value": "", "operator": "like" }, { "property": "summary", "value": "", "operator": "like" } ] } }, "page": { "page": 0, "size": 25 }, "sort": null } } } } }, "required": true }, "responses": { "200": { "description": "Иерархическая структура папок от заданной с задачами и прогрессом тест-циклов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderUnitsWithProgressDto", "additionalProperties": false, "description": "Информация о структуре папок, циклах и их прогрессе", "required": [ "folderHierarchy", "units" ], "example": null }, "examples": { "success": { "description": "Иерархическая структура папок от заданной с задачами и прогрессом тест-циклов", "value": { "folderHierarchy": { "id": { "code": "TMS_test_cycle" }, "key": "TMS_test_cycle", "title": "Все тест-циклы", "children": [ ] }, "units": { "content": [ { "unit": { "unit": { "code": "TMS-3433", "summary": "Тестовый цикл-1", "description": null, "suit": { "code": "test_cycle", "name": "Тест-цикл", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-09-16T12:06:47.709121Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-09-16T12:06:47.709121Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ { "attribute": { "code": "plan_date_end", "name": "Плановая дата окончания", "type": "date_time", "description": "Плановая дата окончания" }, "value": null, "valueAsString": null }, { "attribute": { "code": "test_cycle_status", "name": "Статус", "type": "taxonomy", "description": "Статус" }, "value": { "code": "draft", "name": "Не запускался" }, "valueAsString": null }, { "attribute": { "code": "folder", "name": "Папка", "type": "folder", "description": "Папка" }, "value": { "code": "TMS_test_cycle", "title": "Все тест-циклы" }, "valueAsString": null }, { "attribute": { "code": "cycles_number", "name": "Номер цикла", "type": "taxonomy", "description": "Номер цикла" }, "value": { "code": "1", "name": "1" }, "valueAsString": null }, { "attribute": { "code": "test_case_test_type", "name": "Вид теста", "type": "taxonomy", "description": "Вид теста" }, "value": { "code": "smoke", "name": "Smoke" }, "valueAsString": null }, { "attribute": { "code": "old_jira_key", "name": "Ключ задачи в Jira", "type": "text", "description": "Ключ задачи в Jira" }, "value": null, "valueAsString": null }, { "attribute": { "code": "plan_date_start", "name": "Плановая дата начала", "type": "date_time", "description": "Плановая дата начала" }, "value": null, "valueAsString": null }, { "attribute": { "code": "iteration_type", "name": "Тип итерации", "type": "taxonomy", "description": "Тип итерации" }, "value": null, "valueAsString": null } ], "calculatedAttributes": [ ] }, "progressPercentage": { "Не запускался": 2 }, "successPercentage": 0 } ], "pageSize": 25, "hasNext": false, "pageNumber": 0, "totalElements": 1 } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/folder/hierarchy/{folder_code}/units/filtered": { "description": "Иерархическая структура папок от заданной с отфильтрованными содержащимися задачами", "post": { "tags": [ "Test Management System" ], "summary": "Иерархическая структура папок от заданной с отфильтрованными содержащимися задачами", "operationId": "getFolderHierarchyAndUnits_1", "parameters": [ { "name": "folder_code", "in": "path", "description": "Код папки, от которой строится иерархия", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "TMS_test_case" } ], "requestBody": { "description": "Постраничный запрос на получение иерархии папок и привязанных к задаче юнитов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderUnitsRq", "additionalProperties": false, "description": "Запрос на получение структуры папок и отфильтрованных юнитов", "required": [ "type", "unitFilters" ], "example": null }, "examples": { "Пример запроса": { "description": "Запрос на получение структуры папок и отфильтрованных юнитов", "value": { "type": "TEST_CASE", "linkedTo": { "code": "TMS-5" }, "unitFilters": { "page": { "page": 0, "size": 10 } } } } } } }, "required": true }, "responses": { "200": { "description": "Иерархическая структура папок от заданной с отфильтрованными содержащимися задачами\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderUnitsDto", "additionalProperties": false, "description": "Информация о папке и юнитах в ней", "required": [ "folderHierarchy", "units" ], "example": null }, "examples": { "success": { "description": "Иерархия папок от заданной и юниты в ней", "value": { "folderHierarchy": { "id": { "code": "TMS_test_case" }, "key": "TMS_test_case", "title": "Все тест-кейсы", "children": [ { "id": { "code": "d58c8d9f-aa53-4f85-977e-985ddbb4e1d5" }, "key": "d58c8d9f-aa53-4f85-977e-985ddbb4e1d5", "title": "new_name", "children": [ { "id": { "code": "26123c25-e7bb-43cb-9840-38268c075247" }, "key": "26123c25-e7bb-43cb-9840-38268c075247", "title": "test6", "children": [ ] } ] } ] }, "units": { "content": [ { "unit": { "code": "TMS-3", "summary": "TK!!!", "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"id\":null,\"indent\":0,\"textAlign\":\"justify\"},\"content\":[{\"type\":\"text\",\"text\":\"test\"}]}]}", "suit": { "code": "test_case", "name": "Тест-кейс", "icon": "memo_pencil" }, "space": { "code": "TMS", "name": "Пространство TMS" }, "spaces": [ { "code": "TMS", "name": "Пространство TMS" } ], "createdBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "createdAt": "2025-08-18T20:07:11.787194Z", "updatedBy": { "externalId": "100002", "firstName": "Иван", "lastName": "Тестов", "middleName": "Иванович", "login": "ivantestov", "userDetails": [ ] }, "updatedAt": "2025-08-21T06:58:43.287526Z", "isFavorite": false, "descriptionPlain": null }, "attributes": [ ], "calculatedAttributes": [ ] } ], "pageSize": 10, "hasNext": false, "pageNumber": 0, "totalElements": 1 } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/folder/create": { "description": "Создание папки", "post": { "tags": [ "Test Management System" ], "summary": "Создание папки", "operationId": "createFolder", "requestBody": { "description": "Тело запроса для создания папки", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFolderRq", "additionalProperties": false, "description": "Запрос на cоздание папки", "required": [ "name", "parentId", "spaceId" ], "example": null }, "examples": { "Пример запроса на создание папки": { "description": "Создание папки в папке TMS_test_case", "value": { "name": "test5", "parentId": { "code": "TMS_test_case" }, "spaceId": { "code": "TMS" } } } } } }, "required": true }, "responses": { "200": { "description": "Папка создана", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderDto", "additionalProperties": false, "description": "Информация о папке", "required": [ "children", "id", "key", "title" ], "example": null }, "examples": { "success": { "description": "Создание новой подпапки", "value": { "id": { "code": "d58c8d9f-aa53-4f85-977e-985ddbb4e1d5" }, "key": "d58c8d9f-aa53-4f85-977e-985ddbb4e1d5", "title": "test5", "children": [ ] } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка доступа", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Доступ запрещен. Проверьте наличие необходимых прав" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "not_found": { "description": "Элемент не найден", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Элемент 'AnyObj' с идентификатором 'ANY' не найден " } } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "server_error": { "description": "Неизвестная серверная ошибка", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "Неизвестная ошибка" } } } } } } } } }, "/extension/plugin/v2/rest/api/swtr_task_tracker_plugin/v1/version/find": { "description": "Поиск версий с пагинацией.", "post": { "tags": [ "Task Tracker Plugin" ], "summary": "Поиск версий с пагинацией.", "operationId": "find_34", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionPageRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageRsVersionTinyDto", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_task_tracker_plugin/v1/version/find-all": { "description": "Поиск всех версий.", "post": { "tags": [ "Task Tracker Plugin" ], "summary": "Поиск всех версий.", "operationId": "findAll_4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionFindAllRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageRsVersionDto", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_task_tracker_plugin/v1/version/create": { "description": "Создать версию (атрибут).", "post": { "tags": [ "Task Tracker Plugin" ], "summary": "Создать версию (атрибут).", "operationId": "createVersion", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVersionRq", "example": null }, "example": null } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Location": { "description": "URL для получения созданного ресурса", "schema": { "format": "uri" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionDto", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_task_tracker_plugin/v1/unit/search": { "description": "Поиск кодов юнитов", "post": { "tags": [ "Task Tracker Plugin" ], "summary": "Поиск кодов юнитов", "operationId": "search_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCUnitSearchRq", "example": null }, "example": null } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCUnitCodesStatusRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_task_tracker_plugin/v1/unit/find": { "description": "Поиск юнитов с расширенной информацией", "post": { "tags": [ "Task Tracker Plugin" ], "summary": "Поиск юнитов с расширенной информацией", "operationId": "find_35", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCUnitInfoSearchRq", "example": null }, "example": null } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRsSCUnitInfoRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_task_tracker_plugin/v1/pull_request/find": { "description": "Поиск ПРов", "post": { "tags": [ "Task Tracker Plugin" ], "summary": "Поиск ПРов", "operationId": "find_36", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PullRequestPageRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDtoRsPullRequestInfoDto", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_task_tracker_plugin/v1/pull_request/delete": { "description": "Удаление ПРа", "post": { "tags": [ "Task Tracker Plugin" ], "summary": "Удаление ПРа", "operationId": "deletePullRequest", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePullRequestRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/extension/plugin/v2/rest/api/swtr_task_tracker_plugin/v1/permissions/space/{code}": { "description": "Список привилегий пользователя в спейсе.", "post": { "tags": [ "Task Tracker Plugin" ], "summary": "Список привилегий пользователя в спейсе.", "operationId": "findSpacePermissions_1", "parameters": [ { "name": "code", "in": "path", "description": "code", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "uniqueItems": true, "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/swtr_task_tracker_plugin/v1/permission/space/check/{code}": { "description": "Наличие привилегий пользователя в спейсе.", "post": { "tags": [ "Task Tracker Plugin" ], "summary": "Наличие привилегий пользователя в спейсе.", "operationId": "hasSpacePermission_1", "parameters": [ { "name": "code", "in": "path", "description": "code", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean", "example": true }, "example": true } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v3/sprint/unit/find": { "description": "Поиск задач в спринте без вычисления количества записей", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск задач в спринте", "description": "Поиск задач в спринте без вычисления количества записей", "operationId": "find_37", "requestBody": { "description": "Запрос на постраничный поиск задач в спринте", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitSprintPageRequest", "additionalProperties": false, "description": "Запрос на поиск задач в спринте", "examples": [ "{\n \"sprint\": \"sprint-1\",\n \"page\": {\n \"page\": 0,\n \"size\": 10\n }\n}\n" ], "required": [ "page", "sprint" ] }, "examples": { "simple_find_units_in_sprint": { "description": "Запрос первой страницы с 10 задачами", "value": { "sprint": "sprint-1", "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный запрос на поиск задач в спринте без вычисления количества записей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SliceResponse", "additionalProperties": false, "description": "Постраничный вывод результатов поиска задач без вычисления количества записей", "example": "content", "required": [ "content", "hasNext", "pageNumber", "pageSize" ] }, "examples": { "simple_sprint_unit_find_response": { "description": "Ответ на постраничный поиск задач в спринте без вычисления количества записей", "value": "\"content\": [\n {\n \"unit\": {\n \"code\": \"SWTR-1\",\n \"space\": {\n \"code\": \"SWTR\",\n \"name\": \"Пространство для проверки бэклога\"\n },\n \"summary\": \"Юнит\",\n \"description\": \"Описание юнита\",\n \"descriptionPlain\": \"Описание юнита\",\n \"suit\": {\n \"code\": \"bug\",\n \"name\": \"Дефект\",\n \"icon\": \"bug\"\n },\n \"parent\": null,\n \"createdBy\": {\n \"externalId\": \"200002\",\n \"firstName\": \"Тест\",\n \"lastName\": \"Тестыч\",\n \"middleName\": \"Тест\"\n },\n \"createdAt\": \"2025-10-09T14:40:03.907003Z\",\n \"updatedBy\": {\n \"externalId\": \"200002\",\n \"firstName\": \"Тест\",\n \"lastName\": \"Тестыч\",\n \"middleName\": \"Тест\"\n },\n \"updatedAt\": \"2025-10-09T14:40:03.907003Z\"\n },\n \"attributes\": [\n {\n \"attribute\": {\n \"code\": \"workflow_status\",\n \"name\": \"Статус\",\n \"type\": \"workflow_status\",\n \"description\": \"Статус\"\n },\n \"value\": {\n \"name\": \"В работу\",\n \"code\": \"to_do\"\n },\n \"valueAsString\": \"\"\n },\n {\n \"attribute\": {\n \"code\": \"story_points\",\n \"name\": \"Относительная сложность\",\n \"type\": \"non_negative_int\",\n \"description\": \"Относительная сложность\"\n },\n \"value\": 5,\n \"valueAsString\": \"\"\n },\n {\n \"attribute\": {\n \"code\": \"estimate\",\n \"name\": \"Трудозатраты\",\n \"type\": \"non_negative_int\",\n \"description\": \"Трудозатраты\"\n },\n \"value\": 7,\n \"valueAsString\": \"\"\n },\n {\n \"attribute\": {\n \"code\": \"assigned_to\",\n \"name\": \"Исполнитель\",\n \"type\": \"user\",\n \"description\": \"Исполнитель\"\n },\n \"value\": {\n \"externalId\": \"200002\",\n \"firstName\": \"Тест\",\n \"lastName\": \"Тестыч\",\n \"middleName\": \"Тест\",\n \"login\": \"test\",\n \"userDetails\": []\n },\n \"valueAsString\": \"\"\n }\n ],\n \"calculatedAttributes\": [\n {\n \"attribute\": {\n \"code\": \"votes\"\n },\n \"value\": 0\n }\n ]\n }\n],\n \"pageSize\": 5,\n \"hasNext\": false,\n \"pageNumber\": 0\n}\n" } } } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v3/sprint/unit/find/composite": { "description": "Поиск задач в спринте без вычисления количества записей", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск задач в спринте", "description": "Поиск задач в спринте без вычисления количества записей", "operationId": "findComposite_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitSprintPageCompositeRequest", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "Постраничный запрос на поиск задач в спринте без вычисления количества записей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SliceResponse", "additionalProperties": false, "description": "Постраничный вывод результатов поиска задач без вычисления количества записей", "example": "content", "required": [ "content", "hasNext", "pageNumber", "pageSize" ] }, "examples": { "simple_sprint_unit_find_response": { "description": "Ответ на постраничный поиск задач в спринте без вычисления количества записей", "value": "\"content\": [\n {\n \"unit\": {\n \"code\": \"SWTR-1\",\n \"space\": {\n \"code\": \"SWTR\",\n \"name\": \"Пространство для проверки бэклога\"\n },\n \"summary\": \"Юнит\",\n \"description\": \"Описание юнита\",\n \"descriptionPlain\": \"Описание юнита\",\n \"suit\": {\n \"code\": \"bug\",\n \"name\": \"Дефект\",\n \"icon\": \"bug\"\n },\n \"parent\": null,\n \"createdBy\": {\n \"externalId\": \"200002\",\n \"firstName\": \"Тест\",\n \"lastName\": \"Тестыч\",\n \"middleName\": \"Тест\"\n },\n \"createdAt\": \"2025-10-09T14:40:03.907003Z\",\n \"updatedBy\": {\n \"externalId\": \"200002\",\n \"firstName\": \"Тест\",\n \"lastName\": \"Тестыч\",\n \"middleName\": \"Тест\"\n },\n \"updatedAt\": \"2025-10-09T14:40:03.907003Z\"\n },\n \"attributes\": [\n {\n \"attribute\": {\n \"code\": \"workflow_status\",\n \"name\": \"Статус\",\n \"type\": \"workflow_status\",\n \"description\": \"Статус\"\n },\n \"value\": {\n \"name\": \"В работу\",\n \"code\": \"to_do\"\n },\n \"valueAsString\": \"\"\n },\n {\n \"attribute\": {\n \"code\": \"story_points\",\n \"name\": \"Относительная сложность\",\n \"type\": \"non_negative_int\",\n \"description\": \"Относительная сложность\"\n },\n \"value\": 5,\n \"valueAsString\": \"\"\n },\n {\n \"attribute\": {\n \"code\": \"estimate\",\n \"name\": \"Трудозатраты\",\n \"type\": \"non_negative_int\",\n \"description\": \"Трудозатраты\"\n },\n \"value\": 7,\n \"valueAsString\": \"\"\n },\n {\n \"attribute\": {\n \"code\": \"assigned_to\",\n \"name\": \"Исполнитель\",\n \"type\": \"user\",\n \"description\": \"Исполнитель\"\n },\n \"value\": {\n \"externalId\": \"200002\",\n \"firstName\": \"Тест\",\n \"lastName\": \"Тестыч\",\n \"middleName\": \"Тест\",\n \"login\": \"test\",\n \"userDetails\": []\n },\n \"valueAsString\": \"\"\n }\n ],\n \"calculatedAttributes\": [\n {\n \"attribute\": {\n \"code\": \"votes\"\n },\n \"value\": 0\n }\n ]\n }\n],\n \"pageSize\": 5,\n \"hasNext\": false,\n \"pageNumber\": 0\n}\n" } } } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v3/sprint/unit/count": { "description": "Поиск количества задач в спринте", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск количества задач в спринте", "description": "Поиск количества задач в спринте", "operationId": "count_1", "requestBody": { "description": "Запрос на поиск количества задач в спринте", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintCountRequest", "additionalProperties": false, "description": "Запрос на получение количества задач в спринте", "example": { "sprint": "sprint-1", "filters": { "suits": [ "exampleSuit" ] } }, "required": [ "sprint" ] }, "examples": { "Запрос на получение количества задач в спринте": { "description": "Запрос на получение количества задач в спринте", "value": { "sprint": "sprint-1", "filters": { "suits": [ "exampleSuit" ] } } } } } }, "required": true }, "responses": { "200": { "description": "Поиск количества задач в спринте", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintCountResponse", "additionalProperties": false, "description": "Количество задач в спринте", "example": { "countSprintUnits": 666 }, "required": [ "countSprintUnits" ] }, "examples": { "simple_count_units_in_sprint_response": { "description": "Ответ с количеством задач в спринте", "value": { "countSprintUnits": 666 } } } } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v3/sprint/unit/count/composite": { "description": "Поиск количества задач в спринте", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск количества задач в спринте", "operationId": "countComposite_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintCountCompositeRequest", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintCountResponse", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v3/backlog/unit/find": { "description": "Поиск задач в бэклоге пространства без вычисления кол-ва записей", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск задач в бэклоге пространства", "description": "Поиск задач в бэклоге пространства без вычисления кол-ва записей", "operationId": "find_38", "requestBody": { "description": "Постраничный запрос на поиск юнитов без вычисления кол-ва записей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BacklogPageRequest", "additionalProperties": false, "description": "Запрос на получение постраничного списка юнитов без вычисления кол-ва записей", "example": { "space": "SWTR", "filters": { "suits": [ "task" ] }, "page": { "page": 0, "size": 10 } }, "required": [ "page", "space" ] }, "examples": { "simple": { "description": "Запрос первой страницы с 10 юнитами без вычисления кол-ва записей", "value": { "space": "SWTR", "filters": { "suits": [ "task" ] }, "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный запрос на поиск задач в бэклоге пространства без вычисления кол-ва записей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SliceResponse", "additionalProperties": false, "description": "Постраничный вывод результатов поиска юнитов без вычисления кол-ва записей", "example": { "content": [ { "unit": { "code": "SWTR-1", "space": { "code": "SWTR", "name": "Пространство для проверки бэклога" }, "summary": "Юнит", "description": "Описание юнита", "descriptionPlain": "Описание юнита", "suit": { "code": "bug", "name": "Дефект", "icon": "bug" }, "parent": null, "createdBy": { "externalId": "200002", "firstName": "Тест", "lastName": "Тестыч", "middleName": "Тест" }, "createdAt": "2025-10-09T14:40:03.907003Z", "updatedBy": { "externalId": "200002", "firstName": "Тест", "lastName": "Тестыч", "middleName": "Тест" }, "updatedAt": "2025-10-09T14:40:03.907003Z" }, "attributes": [ { "attribute": { "code": "workflow_status", "name": "Статус", "type": "workflow_status", "description": "Статус" }, "value": { "name": "В работу", "code": "to_do" }, "valueAsString": "" }, { "attribute": { "code": "story_points", "name": "Относительная сложность", "type": "non_negative_int", "description": "Относительная сложность" }, "value": 5, "valueAsString": "" }, { "attribute": { "code": "estimate", "name": "Трудозатраты", "type": "non_negative_int", "description": "Трудозатраты" }, "value": 7, "valueAsString": "" }, { "attribute": { "code": "assigned_to", "name": "Исполнитель", "type": "user", "description": "Исполнитель" }, "value": { "externalId": "200002", "firstName": "Тест", "lastName": "Тестыч", "middleName": "Тест", "login": "test", "userDetails": [ ] }, "valueAsString": "" } ], "calculatedAttributes": [ { "attribute": { "code": "votes" }, "value": 0 } ] } ], "pageSize": 5, "hasNext": false, "pageNumber": 0 }, "required": [ "content", "hasNext", "pageNumber", "pageSize" ] }, "examples": { "Пример": { "description": "Постраничный вывод результатов поиска юнитов без вычисления кол-ва записей", "value": { "content": [ { "unit": { "code": "SWTR-1", "space": { "code": "SWTR", "name": "Пространство для проверки бэклога" }, "summary": "Юнит", "description": "Описание юнита", "descriptionPlain": "Описание юнита", "suit": { "code": "bug", "name": "Дефект", "icon": "bug" }, "parent": null, "createdBy": { "externalId": "200002", "firstName": "Тест", "lastName": "Тестыч", "middleName": "Тест" }, "createdAt": "2025-10-09T14:40:03.907003Z", "updatedBy": { "externalId": "200002", "firstName": "Тест", "lastName": "Тестыч", "middleName": "Тест" }, "updatedAt": "2025-10-09T14:40:03.907003Z" }, "attributes": [ { "attribute": { "code": "workflow_status", "name": "Статус", "type": "workflow_status", "description": "Статус" }, "value": { "name": "В работу", "code": "to_do" }, "valueAsString": "" }, { "attribute": { "code": "story_points", "name": "Относительная сложность", "type": "non_negative_int", "description": "Относительная сложность" }, "value": 5, "valueAsString": "" }, { "attribute": { "code": "estimate", "name": "Трудозатраты", "type": "non_negative_int", "description": "Трудозатраты" }, "value": 7, "valueAsString": "" }, { "attribute": { "code": "assigned_to", "name": "Исполнитель", "type": "user", "description": "Исполнитель" }, "value": { "externalId": "200002", "firstName": "Тест", "lastName": "Тестыч", "middleName": "Тест", "login": "test", "userDetails": [ ] }, "valueAsString": "" } ], "calculatedAttributes": [ { "attribute": { "code": "votes" }, "value": 0 } ] } ], "pageSize": 5, "hasNext": false, "pageNumber": 0 } } } } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v3/backlog/unit/find/composite": { "description": "Поиск задач в бэклоге пространства без вычисления кол-ва записей", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск задач в бэклоге пространства", "description": "Поиск задач в бэклоге пространства без вычисления кол-ва записей", "operationId": "findComposite_2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BacklogPageCompositeRequest", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SliceResponsePlanningUnitInfo", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v3/backlog/unit/count": { "description": "Поиск количества юнитов в бэклоге пространства", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск количества юнитов в бэклоге пространства", "description": "Поиск количества юнитов в бэклоге пространства", "operationId": "count_2", "requestBody": { "description": "Запрос на поиск количества юнитов в бэклоге", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BacklogCountRequest", "additionalProperties": false, "description": "Запрос на поиск количества юнитов в бэклоге", "example": { "space": "SWTR", "filters": { "suits": [ "task" ] } }, "required": [ "space" ] }, "examples": { "simple": { "description": "Запрос на поиск количества юнитов в бэклоге", "value": { "space": "SWTR", "filters": { "suits": [ "task" ] } } } } } }, "required": true }, "responses": { "200": { "description": "Поиск количества юнитов в бэклоге пространства", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BacklogCountResponse", "additionalProperties": false, "description": "Количество юнитов в бэклоге пространства", "example": { "count": 1 }, "required": [ "count" ] }, "examples": { "Пример": { "description": "Количество юнитов в бэклоге пространства", "value": { "count": 1 } } } } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v3/backlog/unit/count/composite": { "description": "Поиск количества юнитов в бэклоге пространства", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск количества юнитов в бэклоге пространства", "operationId": "countComposite_2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BacklogCountCompositeRequest", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BacklogCountResponse", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v2/sprint/unit/find": { "description": "Поиск задач в спринте без вычисления количества записей", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск задач в спринте", "description": "Поиск задач в спринте без вычисления количества записей", "operationId": "find_39", "requestBody": { "description": "Запрос на постраничный поиск задач в спринте", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitSprintPageRequest", "additionalProperties": false, "description": "Запрос на поиск задач в спринте", "examples": [ "{\n \"sprint\": \"sprint-1\",\n \"page\": {\n \"page\": 0,\n \"size\": 10\n }\n}\n" ] }, "examples": { "simple_find_units_in_sprint": { "description": "Запрос первой страницы с 10 задачами", "value": { "sprint": "sprint-1", "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный запрос на поиск задач в спринте без вычисления количества записей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SliceResponse", "additionalProperties": false, "description": "Постраничный вывод результатов поиска задач без вычисления количества записей", "example": { "content": [ { "code": "SWTRLT_TST1-10", "space": { "code": "SWTRLT_TST1", "name": "Пространство для НТ" }, "summary": "Наименование", "description": null, "suit": { "code": "bug", "name": "Дефект", "icon": "bug" }, "status": { "code": "to_do", "name": "В работу", "updatedAt": "2025-10-09T14:40:03.907003Z" }, "parent": null, "createdBy": { "externalId": "5432109876", "firstName": "Каколексий", "lastName": "Каколексий", "middleName": "Мексий" }, "createdAt": "2025-10-09T14:40:03.844440Z", "updatedBy": { "externalId": "5432109876", "firstName": "Каколексий", "lastName": "Каколексий", "middleName": "Мексий" }, "updatedAt": "2025-10-10T06:36:24.292057Z", "assignUser": null } ], "pageSize": 20, "hasNext": false, "pageNumber": 0 }, "required": [ "content", "hasNext", "pageNumber", "pageSize" ] }, "examples": { "simple_sprint_unit_find_response": { "description": "Ответ на постраничный поиск задач в спринте без вычисления количества записей", "value": { "content": [ { "code": "SWTRLT_TST1-10", "space": { "code": "SWTRLT_TST1", "name": "Пространство для НТ" }, "summary": "Наименование", "description": null, "suit": { "code": "bug", "name": "Дефект", "icon": "bug" }, "status": { "code": "to_do", "name": "В работу", "updatedAt": "2025-10-09T14:40:03.907003Z" }, "parent": null, "createdBy": { "externalId": "5432109876", "firstName": "Каколексий", "lastName": "Каколексий", "middleName": "Мексий" }, "createdAt": "2025-10-09T14:40:03.844440Z", "updatedBy": { "externalId": "5432109876", "firstName": "Каколексий", "lastName": "Каколексий", "middleName": "Мексий" }, "updatedAt": "2025-10-10T06:36:24.292057Z", "assignUser": null } ], "pageSize": 20, "hasNext": false, "pageNumber": 0 } } } } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v2/sprint/unit/count": { "description": "Поиск количества задач в спринте", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск количества задач в спринте", "description": "Поиск количества задач в спринте", "operationId": "count_3", "requestBody": { "description": "Запрос на поиск количества задач в спринте", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintCountRequest", "additionalProperties": false, "description": "Запрос на получение количества задач в спринте", "example": { "sprint": "sprint-1", "filters": { "suits": [ "exampleSuit" ] } } }, "examples": { "Запрос на получение количества задач в спринте": { "description": "Запрос на получение количества задач в спринте", "value": { "sprint": "sprint-1", "filters": { "suits": [ "exampleSuit" ] } } } } } }, "required": true }, "responses": { "200": { "description": "Поиск количества задач в спринте", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintCountResponse", "additionalProperties": false, "description": "Количество задач в спринте", "example": { "countSprintUnits": 666 }, "required": [ "countSprintUnits" ] }, "examples": { "simple_count_units_in_sprint_response": { "description": "Ответ с количеством задач в спринте", "value": { "countSprintUnits": 666 } } } } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v2/backlog/unit/find": { "description": "Поиск задач в бэклоге пространства без вычисления кол-ва записей", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск задач в бэклоге пространства", "description": "Поиск задач в бэклоге пространства без вычисления кол-ва записей", "operationId": "find_40", "requestBody": { "description": "Постраничный запрос на поиск юнитов без вычисления кол-ва записей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BacklogPageRequest", "additionalProperties": false, "description": "Запрос на получение постраничного списка юнитов без вычисления кол-ва записей", "example": { "space": "SWTR", "filters": { "suits": [ "task" ] }, "page": { "page": 0, "size": 10 } }, "required": [ "page", "space" ] }, "examples": { "simple": { "description": "Запрос первой страницы с 10 юнитами без вычисления кол-ва записей", "value": { "space": "SWTR", "filters": { "suits": [ "task" ] }, "page": { "page": 0, "size": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "Постраничный запрос на поиск задач в бэклоге пространства без вычисления кол-ва записей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SliceResponse", "additionalProperties": false, "description": "Постраничный вывод результатов поиска юнитов без вычисления кол-ва записей", "example": { "content": [ { "code": "SWTRLT_TST1-10", "space": { "code": "SWTRLT_TST1", "name": "Пространство для НТ" }, "summary": "Наименование", "description": null, "suit": { "code": "bug", "name": "Дефект", "icon": "bug" }, "status": { "code": "to_do", "name": "В работу", "updatedAt": "2025-10-09T14:40:03.907003Z" }, "parent": null, "createdBy": { "externalId": "5432109876", "firstName": "Каколексий", "lastName": "Каколексий", "middleName": "Мексий" }, "createdAt": "2025-10-09T14:40:03.844440Z", "updatedBy": { "externalId": "5432109876", "firstName": "Каколексий", "lastName": "Каколексий", "middleName": "Мексий" }, "updatedAt": "2025-10-10T06:36:24.292057Z", "assignUser": null } ], "pageSize": 20, "hasNext": false, "pageNumber": 0 }, "required": [ "content", "hasNext", "pageNumber", "pageSize" ] }, "examples": { "Пример": { "description": "Постраничный вывод результатов поиска юнитов без вычисления кол-ва записей", "value": { "content": [ { "code": "SWTRLT_TST1-10", "space": { "code": "SWTRLT_TST1", "name": "Пространство для НТ" }, "summary": "Наименование", "description": null, "suit": { "code": "bug", "name": "Дефект", "icon": "bug" }, "status": { "code": "to_do", "name": "В работу", "updatedAt": "2025-10-09T14:40:03.907003Z" }, "parent": null, "createdBy": { "externalId": "5432109876", "firstName": "Каколексий", "lastName": "Каколексий", "middleName": "Мексий" }, "createdAt": "2025-10-09T14:40:03.844440Z", "updatedBy": { "externalId": "5432109876", "firstName": "Каколексий", "lastName": "Каколексий", "middleName": "Мексий" }, "updatedAt": "2025-10-10T06:36:24.292057Z", "assignUser": null } ], "pageSize": 20, "hasNext": false, "pageNumber": 0 } } } } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v2/backlog/unit/count": { "description": "Поиск количества юнитов в бэклоге пространства", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск количества юнитов в бэклоге пространства", "description": "Поиск количества юнитов в бэклоге пространства", "operationId": "count_4", "requestBody": { "description": "Запрос на поиск количества юнитов в бэклоге", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BacklogCountRequest", "additionalProperties": false, "description": "Запрос на поиск количества юнитов в бэклоге", "example": { "space": "SWTR", "filters": { "suits": [ "task" ] } }, "required": [ "space" ] }, "examples": { "simple": { "description": "Запрос на поиск количества юнитов в бэклоге", "value": { "space": "SWTR", "filters": { "suits": [ "task" ] } } } } } }, "required": true }, "responses": { "200": { "description": "Поиск количества юнитов в бэклоге пространства", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BacklogCountResponse", "additionalProperties": false, "description": "Количество юнитов в бэклоге пространства", "example": { "count": 1 }, "required": [ "count" ] }, "examples": { "Пример": { "description": "Количество юнитов в бэклоге пространства", "value": { "count": 1 } } } } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/workflow/suit/statuses": { "description": "Получить все статусы workflow сьютов.", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Получить все статусы workflow сьютов.", "operationId": "getAllWorkflowStatusesBySuits", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardWorkflowStatusesRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SuitWithWorkflowStatuses" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/sprint/update/{code}": { "description": "Изменить спринт.", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Изменить спринт.", "operationId": "updateSprint", "parameters": [ { "name": "code", "in": "path", "description": "code", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSprintRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSprintRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/sprint/update/{code}/status": { "description": "Изменить статус спринта.", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Изменить статус спринта.", "operationId": "updateSprintStatus", "parameters": [ { "name": "code", "in": "path", "description": "code", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSprintStatusRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSprintRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/sprint/unit/find": { "description": "Поиск юнитов в спринте.", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск юнитов в спринте.", "operationId": "find_41", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitSprintPageRequest", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponseSprintUnitInfo", "example": null }, "example": null } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/sprint/find": { "description": "Поиск спринтов.", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск спринтов.", "operationId": "find_42", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintPageRequest", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponseSprint", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/sprint/create": { "description": "Создать спринт.", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Создать спринт.", "operationId": "createSprint", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSprintRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSprintRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/sprint/burndown": { "description": "Отчет о сгорании юнитов в спринте.", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Отчет о сгорании юнитов в спринте.", "operationId": "getBurnDownReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BurnDownRequest", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BurnDownInfo", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/permissions/sprint/{code}": { "description": "Список привилегий пользователя в спринте.", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Список привилегий пользователя в спринте.", "operationId": "findSprintPermissions", "parameters": [ { "name": "code", "in": "path", "description": "code", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "uniqueItems": true, "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/permissions/space/{code}": { "description": "Список привилегий пользователя в спейсе.", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Список привилегий пользователя в спейсе.", "operationId": "findSpacePermissions_2", "parameters": [ { "name": "code", "in": "path", "description": "code", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "uniqueItems": true, "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/permission/sprint/{code}": { "description": "Наличие привилегий пользователя в спринте.", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Наличие привилегий пользователя в спринте.", "operationId": "hasSprintPermission", "parameters": [ { "name": "code", "in": "path", "description": "code", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean", "example": true }, "example": true } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/permission/space/{code}": { "description": "Наличие привилегий пользователя в спейсе.", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Наличие привилегий пользователя в спейсе.", "operationId": "hasSpacePermission_2", "parameters": [ { "name": "code", "in": "path", "description": "code", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "maxItems": 2147483647, "minItems": 0, "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean", "example": true }, "example": true } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/board/{code}/units/find": { "description": "Поиск юнитов на доске", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск юнитов на доске", "operationId": "findBoardUnits", "parameters": [ { "name": "code", "in": "path", "description": "code", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardUnitsRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardUnitsRs", "example": null }, "example": null } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/board/{code}/units/find/composite": { "description": "Поиск юнитов на доске с пользовательскими фильтрами", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск юнитов на доске с пользовательскими фильтрами", "operationId": "findBoardUnitsComposite", "parameters": [ { "name": "code", "in": "path", "description": "code", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardUnitsCompositeRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardUnitsRs", "example": null }, "example": null } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/board/{code}/units/filter": { "description": "Получение данных для фильтра юнитов на доске", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Получение данных для фильтра юнитов на доске", "operationId": "getBoardUnitsFilter", "parameters": [ { "name": "code", "in": "path", "description": "code", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardUnitsFilterRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardUnitsFilterRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/board/{code}/swimlane/roads": { "description": "Получить свимлайн дорожки для доски", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Получить свимлайн дорожки для доски", "operationId": "getSwimlaneRoads", "parameters": [ { "name": "code", "in": "path", "description": "code", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwimlaneRoadRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwimlaneRoadsRs", "example": null }, "example": null } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/board/{code}/swimlane/roads/composite": { "description": "Получить свимлайн дорожки для доски c пользовательскими фильтрами", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Получить свимлайн дорожки для доски c пользовательскими фильтрами", "operationId": "getSwimlaneRoadsComposite", "parameters": [ { "name": "code", "in": "path", "description": "code", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwimlaneRoadCompositeRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwimlaneRoadsRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/board/{code}/sprint/find": { "description": "Поиск юнитов в спринте, на доске", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск юнитов в спринте, на доске", "operationId": "findBySprint", "parameters": [ { "name": "code", "in": "path", "description": "code", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintBoardUnitRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintBoardInfo", "example": null }, "example": null } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/board/{board}/{unit}/to/status/{status}": { "description": "Изменение статуса. deprecated - используйте '/scrum_board_plugin/v1/board/unit/to/status ", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Изменение статуса. deprecated - используйте '/scrum_board_plugin/v1/board/unit/to/status ", "operationId": "moveUnitToStatus", "parameters": [ { "name": "board", "in": "path", "description": "board", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "unit", "in": "path", "description": "unit", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "status", "in": "path", "description": "status", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveUnitToStatusRq", "example": null }, "example": null } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUnitStatusLegacyRs", "example": null }, "example": null } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/board/{board}/{unit}/to/column/{column}": { "description": "Изменение статуса по колонке. deprecated - используйте '/scrum_board_plugin/v1/board/unit/to/status ", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Изменение статуса по колонке. deprecated - используйте '/scrum_board_plugin/v1/board/unit/to/status ", "operationId": "moveUnitToColumn", "parameters": [ { "name": "board", "in": "path", "description": "board", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "unit", "in": "path", "description": "unit", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" }, { "name": "column", "in": "path", "description": "column", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveUnitToColumnRq", "example": null }, "example": null } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUnitStatusLegacyRs", "example": null }, "example": null } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/board/update/{code}": { "description": "Изменить доску.", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Изменить доску.", "operationId": "updateBoard", "parameters": [ { "name": "code", "in": "path", "description": "code", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBoardRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/board/unit/to/status": { "description": "Изменение статуса по коду операции", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Изменение статуса по коду операции", "operationId": "moveUnitToStatus_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUnitStatusRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUnitStatusRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/board/find": { "description": "Поиск досок.", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск досок.", "operationId": "find_43", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardPageRequest", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponseBoardDto", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/board/create": { "description": "Создать доску.", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Создать доску.", "operationId": "createBoard", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBoardRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBoardRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/board/clone/{code}": { "description": "Клонировать доску.", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Клонировать доску.", "operationId": "cloneBoard", "parameters": [ { "name": "code", "in": "path", "description": "code", "required": true, "schema": { "type": "string", "example": "Пример", "maxLength": 2147483647, "pattern": ".*" }, "example": "Пример" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneBoardRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBoardRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/backlog/units/filter": { "description": "Получение данных для фильтра юнитов в планировании", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Получение данных для фильтра юнитов в планировании", "operationId": "getBacklogUnitsFilter", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BacklogUnitsFilterRq", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BacklogUnitsFilterRs", "example": null }, "example": null } } } } } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/backlog/unit/find": { "description": "Поиск юнитов в бэклоге спейса.", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Поиск юнитов в бэклоге спейса.", "operationId": "find_44", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BacklogPageRequest", "example": null }, "example": null } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponseSprintUnitInfo", "example": null }, "example": null } } } }, "deprecated": true } }, "/extension/plugin/v2/rest/api/scrum_board_plugin/v1/assignee/story-points": { "description": "Информация об относительной сложности юнитов,\nсгруппированная по пользователям и типам статусов воркфлоу\n", "post": { "tags": [ "SCRUM Board Plugin @TT0" ], "summary": "Получение статистики относительной сложности по исполнителям и типам wf статусов", "description": "Информация об относительной сложности юнитов,\nсгруппированная по пользователям и типам статусов воркфлоу\n", "operationId": "findAssigneeStoryPoints", "requestBody": { "description": "Запрос на получение статистики относительной сложности по исполнителям и типам wf статусов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssigneeStoryPointsSummaryRq", "additionalProperties": false, "description": "Запрос на получение статистики относительной сложности по исполнителям и типам wf статусов", "example": { "sprint": "sprint-1", "board": "82f69ced-10fa-422c-812b-7d31966520f0", "filters": { "suits": [ "exampleSuit" ] }, "tqlFilterIds": [ "82f69ced-10fa-422c-812b-7d31966520f0" ] }, "required": [ "sprint" ] }, "examples": { "Запрос на получение статистики относительной сложности по исполнителям и типам wf статусов": { "description": "Запрос на получение статистики относительной сложности по исполнителям и типам wf статусов", "value": { "sprint": "sprint-1", "board": "82f69ced-10fa-422c-812b-7d31966520f0", "filters": { "suits": [ "exampleSuit" ] }, "tqlFilterIds": [ "82f69ced-10fa-422c-812b-7d31966520f2" ] } } } } }, "required": true }, "responses": { "200": { "description": "Запрос на получение статистики относительной сложности по исполнителям и типам wf статусов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SliceResponse", "additionalProperties": false, "description": "Информация об относительной сложности юнитов,\nсгруппированная по пользователям и типам статусов воркфлоу\n", "example": { "assignees": [ { "assignedTo": { "code": "74739512", "firstName": "Ант1он", "lastName": "Фуфаев2", "middleName": "Рюрикович", "login": "74739512", "userDetails": [ { "type": { "code": "avatar_url", "name": "Аватар", "visible": true, "properties": { } }, "value": "picture-service.mock16640cf0-5743-441a-9aed-67a2db8c6338" } ] }, "totalUnits": 4, "storyPointsByStatusType": [ { "statusType": "done", "storyPoints": 10 }, { "statusType": "pause", "storyPoints": 15 }, { "statusType": "progress", "storyPoints": 3 }, { "statusType": null, "storyPoints": 123234 } ] } ] }, "required": [ "assignees" ] }, "examples": { "Пример": { "description": "Информация об относительной сложности юнитов,\nсгруппированная по пользователям и типам статусов воркфлоу\n", "value": { "assignees": [ { "assignedTo": { "code": "74739512", "firstName": "Ант1он", "lastName": "Фуфаев2", "middleName": "Рюрикович", "login": "74739512", "userDetails": [ { "type": { "code": "avatar_url", "name": "Аватар", "visible": true, "properties": { } }, "value": "picture-service.mock16640cf0-5743-441a-9aed-67a2db8c6338" } ] }, "totalUnits": 4, "storyPointsByStatusType": [ { "statusType": "done", "storyPoints": 10 }, { "statusType": "pause", "storyPoints": 15 }, { "statusType": "progress", "storyPoints": 3 }, { "statusType": null, "storyPoints": 123234 } ] } ] } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ErrorDTO", "additionalProperties": false, "description": "Ответ в случае ошибки", "required": [ "exceptionUUID", "uiErrorMessage" ], "example": null }, "examples": { "forbidden": { "description": "Ошибка запроса", "value": { "exceptionUUID": "18pE95Ic93", "uiErrorMessage": "-" } }