https://pastein.ru/t/O6A
Загрузка данных
"/rest/api/unit/v1/link/restore": {
"description": "Помечает удаленную связь как активную",
"patch": {
"tags": [
"API создания/изменения связей юнитов"
],
"summary": "Помечает удаленную связь как активную",
"operationId": "restore_4",
"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": "Неизвестная ошибка"
}
}
}
}
}
}
}
}
},
"/extension/plugin/v2/rest/api/swtr_wiki_plugin/v1/wiki/unit/hierarchy/link": {
"patch": {
"tags": [
"wiki-page-hierarchy-controller"
],
"operationId": "link_1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WikiPageHierarchyCreateRq",
"example": null
},
"example": null
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WikiPageHierarchyCreateRs",
"example": null
},
"example": null
}
}
}
}
}
},
"/extension/plugin/v2/rest/api/swtr_tms_plugin/v1/link/{unitId}/test_cases_to_review": {
"description": "Обновление статуса связанных тест-кейсов на need review",
"patch": {
"tags": [
"Test Management System"
],
"summary": "Обновление статуса связанных тест-кейсов на need review",
"operationId": "updateTestCasesStatus",
"parameters": [
{
"name": "unitId",
"in": "path",
"description": "Код юнита",
"required": true,
"schema": {
"type": "string",
"example": "Пример",
"maxLength": 2147483647,
"pattern": ".*"
},
"example": "TMS-1"
}
],
"responses": {
"200": {
"description": "Статус связанных тест-кейсов успешно обновлён",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateResponse",
"additionalProperties": false,
"description": "Успешное изменение статуса связанных тест-кейсов",
"example": null
},
"examples": {
"success": {
"description": "success"
}
}
}
}
},
"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/{suitCode}/space/{spaceCode}/workflow": {
"description": "Получить workflow типа юнита и пространства",
"get": {
"tags": [
"API по workflow для бизнес сущностей коры",
"API справочника workflow",
"API workflow статуса"
],
"summary": "Получить workflow типа юнита и пространства",
"description": "Получить workflow типа юнита и пространства",
"operationId": "getWorkflow",
"parameters": [
{
"name": "spaceCode",
"in": "path",
"description": "Код пространства",
"required": true,
"schema": {
"type": "string",
"description": "Код пространства",
"example": "SWTR",
"maxLength": 100,
"pattern": "^.{0,100}$"
},
"example": "SWTR"
},
{
"name": "suitCode",
"in": "path",
"description": "Тип задачи",
"required": true,
"schema": {
"type": "string",
"description": "Тип задачи",
"example": "bug",
"maxLength": 100,
"pattern": "^.{0,100}$"
},
"example": "bug"
}
],
"responses": {
"200": {
"description": "Список представлений воркфлоу",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WfRepresentationDto",
"additionalProperties": false,
"description": "Представление воркфлоу",
"required": [
"wfSchema",
"wfSchemaStatuses",
"wfTransitions"
],
"example": null
},
"examples": {
"success": {
"description": "Список представлений воркфлоу",
"value": {
"wfSchema": {
"code": "{{schemaCode}}",
"name": "super_wf45",
"description": "super_wf for super tasks"
},
"wfTransitions": [
{
"wfActionCode": "start_progress",
"oldStatusCode": "to_do",
"destStatusCode": "in_progress"
},
{
"wfActionCode": "start",
"oldStatusCode": null,
"destStatusCode": "to_do"
}
],
"wfSchemaStatuses": [
{
"wfStatusCode": "done",
"wfStatusMetadata": null
},
{
"wfStatusCode": "need_info",
"wfStatusMetadata": null
},
{
"wfStatusCode": "to_do",
"wfStatusMetadata": null
},
{
"wfStatusCode": "in_progress",
"wfStatusMetadata": 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/space/type/{spaceTypeCode}/suit/{suitCode}/list": {
"description": "Получить список настроек ворфлоу для типа пространств по типам задач",
"get": {
"tags": [
"API по workflow для бизнес сущностей коры",
"API справочника workflow",
"API workflow статуса"
],
"summary": "Получить список настроек ворфлоу для типа пространств по типам задач",
"description": "Получить список настроек ворфлоу для типа пространств по типам задач",
"operationId": "getWorkflowDetailsBySpaceTypeAndSuit",
"parameters": [
{
"name": "spaceTypeCode",
"in": "path",
"description": "Код типа пространства",
"required": true,
"schema": {
"type": "string",
"description": "Код типа пространства",
"example": "default",
"maxLength": 100,
"pattern": "^.{0,100}$"
},
"example": "default"
},
{
"name": "suitCode",
"in": "path",
"description": "Тип задачи",
"required": true,
"schema": {
"type": "string",
"description": "Тип задачи",
"example": "bug",
"maxLength": 100,
"pattern": "^.{0,100}$"
},
"example": "bug"
}
],
"responses": {
"200": {
"description": "Список настроек воркфлоу",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkflowSettingDto",
"additionalProperties": false,
"description": "Настройки воркфлоу",
"required": [
"code",
"isDefault",
"name"
],
"example": null
},
"examples": {
"success": {
"description": "Список настроек воркфлоу",
"value": [
{
"code": "default_workflow",
"name": "APProcess Task Flow 1.0",
"default": 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": "Неизвестная ошибка"
}
}
}
}
}
}
}
}
},
"/rest/api/unit/v2/{code}": {
"description": "Получение юнита с атрибутами по его коду",
"get": {
"tags": [
"API поиска юнита V3 с отдельным запросом полного кол-ва записей",
"API поиска юнита"
],
"summary": "Получение юнита с атрибутами по его коду",
"operationId": "get_4",
"parameters": [
{
"name": "code",
"in": "path",
"description": "code",
"required": true,
"schema": {
"type": "string",
"example": "Пример",
"maxLength": 2147483647,
"pattern": ".*"
},
"example": "Пример"
},
{
"name": "validatorEnabled",
"in": "query",
"description": "validatorEnabled",
"required": false,
"schema": {
"type": "boolean",
"example": true
},
"example": "true"
}
],
"responses": {
"200": {
"description": "Информация о юните",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnitWithAttributes",
"additionalProperties": false,
"description": "Информация о юните",
"required": [
"code",
"space",
"suit"
],
"example": null
},
"examples": {
"success": {
"description": "Описание юнита",
"value": {
"code": "DEVK4ABQX-1",
"summary": "демо 1509",
"description": "демо 1509",
"isFavorite": false,
"createdAt": "2025-01-28T09:13:20.998448Z",
"createdBy": {
"externalId": "200002",
"firstName": "Тест_ALL_ROLES",
"lastName": "Тестыч",
"middleName": null,
"login": "test",
"userDetails": []
},
"updatedAt": "2025-01-28T09:13:20.998448Z",
"updatedBy": {
"externalId": "200002",
"firstName": "Тест_ALL_ROLES",
"lastName": "Тестыч",
"middleName": null,
"login": "test",
"userDetails": []
},
"suit": {
"code": "task",
"name": "Поменяем название пользовательской истории",
"icon": "super_idea"
},
"space": {
"code": "DEVK4ABQX",
"name": "Демо спейс"
},
"attributes": [
{
"code": "assigned_to",
"name": "Исполнитель",
"type": "user",
"value": {
"externalId": "100000",
"firstName": "Василий_ROLE_TENANT_CONFIG",
"lastName": "Кузякин",
"middleName": "Егорович",
"login": "vasiakuzyakin",
"userDetails": []
},
"parameters": {}
},
{
"code": "due_date",
"name": "Контрольный срок",
"type": "date_time",
"value": null,
"parameters": {}
},
{
"code": "estimate",
"name": "Трудозатраты",
"type": "non_negative_int",
"value": 6,
"parameters": {}
},
{
"code": "label",
"name": "Метки",
"type": "label",
"value": null,
"parameters": {}
},
{
"code": "priority",
"name": "Приоритет",
"type": "taxonomy",
"value": null,
"parameters": {}
},
{
"code": "reporter",
"name": "Постановщик",
"type": "user",
"value": null,
"parameters": {
"ORDER": 4,
"MANDATORY": false
}
},
{
"code": "status",
"name": "Статус",
"type": "taxonomy",
"value": null,
"parameters": {}
},
{
"code": "story_points",
"name": "Относительная сложность",
"type": "non_negative_int",
"value": 3,
"parameters": {}
},
{
"code": "workflow_status",
"name": "Статус",
"type": "workflow_status",
"value": null,
"parameters": {}
}
],
"validatorErrorMsgs": 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/link/type/{code}": {
"description": "Получение типа связи между юнитами по его коду",
"get": {
"tags": [
"API поиска типов связей между юнитами @TT0"
],
"summary": "Получение типа связи между юнитами по его коду",
"operationId": "get_5",
"parameters": [
{
"name": "code",
"in": "path",
"description": "Код юнита",
"required": true,
"schema": {
"type": "string",
"example": "Пример",
"maxLength": 2147483647,
"pattern": ".*"
},
"example": "SWTR-1"
}
],
"responses": {
"200": {
"description": "Запрос на поиск типов связей юнита",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LinkTypeInfoV2Dto",
"additionalProperties": false,
"description": "Информация о типе связи",
"required": [
"code",
"deleted",
"destination",
"name",
"relationship",
"source"
],
"example": null
},
"examples": {
"success": {
"description": "Информация по типу связи юнита",
"value": {
"code": "decomposition",
"name": "Декомпозиция",
"description": "Выстраивание наследования при декомпозиции",
"source": {
"name": "Является частью",
"description": "Этот вид связи устанавливает выбранный элемент в качестве родительского по отношению к текущему. Родительский элемент может быть только один"
},
"destination": {
"name": "Состоит из",
"description": "Этот вид связи устанавливает выбранный элемент в качестве дочернего по отношению к текущему. Дочерних элементов может быть больше одного"
},
"relationship": "HIERARCHY",
"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": "Неизвестная ошибка"
}
}
}
}
}
}
}
}
},
"/rest/api/unit/v1/link/type/{code}": {
"description": "Получение типа связи между юнитами по его коду",
"get": {
"tags": [
"API поиска типов связей между юнитами"
],
"summary": "Получение типа связи между юнитами по его коду",
"operationId": "get_7",
"parameters": [
{
"name": "code",
"in": "path",
"description": "Код юнита",
"required": true,
"schema": {
"type": "string",
"example": "Пример",
"maxLength": 2147483647,
"pattern": ".*"
},
"example": "SWTR-1"
}
],
"responses": {
"200": {
"description": "Запрос на поиск типов связей юнита",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LinkTypeInfo",
"additionalProperties": false,
"description": "Информация о типе связи",
"required": [
"code",
"deleted",
"destinationText",
"name",
"relationship",
"sourceText"
],
"example": null
},
"examples": {
"success": {
"description": "Информация по типу связи юнита",
"value": {
"code": "decomposition",
"name": "Декомпозиция",
"description": "Выстраивание наследования при декомпозиции",
"sourceText": "Является частью",
"sourceDescription": "Этот вид связи устанавливает выбранный элемент в качестве родительского по отношению к текущему. Родительский элемент может быть только один",
"destinationText": "Состоит из",
"destinationDescription": "Этот вид связи устанавливает выбранный элемент в качестве дочернего по отношению к текущему. Дочерних элементов может быть больше одного",
"relationship": "HIERARCHY",
"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": "Неизвестная ошибка"
}
}
}
}
}
}
},
"deprecated": true
}
},
"/rest/api/space/v3/{code}/suits": {
"description": "Получаем доступные для пространства типы задач",
"get": {
"tags": [
"API поиска конфигурации пространства"
],
"summary": "Получаем доступные для пространства типы задач",
"operationId": "getSuits",
"parameters": [
{
"name": "code",
"in": "path",
"description": "Код пространства",
"required": true,
"schema": {
"type": "string",
"example": "Пример",
"maxLength": 2147483647,
"pattern": ".*"
},
"example": "ANYSPC"
}
],
"responses": {
"200": {
"description": "Получаем доступные для пространства типы задач",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpaceSuitsRs",
"additionalProperties": false,
"description": "Информация о доступных типах задач",
"required": [
"code",
"suits"
],
"example": null
},
"examples": {
"success": {
"description": "Доступные типы задач",
"value": "{\n \"code\": \"DEVK4ABR\",\n \"suits\": [\n {\n \"code\": \"task\",\n \"name\": \"Поменяем название пользовательской истории\",\n \"description\": \"Ну и описание тоже\",\n \"icon\": \"super_idea\",\n \"workflow\": {\n \"name\": \"default_workflow\",\n \"code\": \"APProcess Task Flow 1.0\"\n }\n \"parameters\": {\n \"ratingEnabled\": true\n }\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/manage/parameters/{unitCode}": {
"description": "Получение конфигурации пространства для задачи",
"get": {
"tags": [
"API поиска пространства"
],
"summary": "Получение конфигурации пространства для задачи",
"description": "Получение конфигурации пространства для задачи",
"operationId": "getUnitParameters",
"parameters": [
{
"name": "unitCode",
"in": "path",
"description": "Код задачи",
"required": true,
"schema": {
"type": "string",
"description": "Код задачи",
"example": "Пример",
"maxLength": 2147483647,
"pattern": ".*"
},
"example": "SWTR-1"
}
],
"responses": {
"200": {
"description": "Конфигурация пространства для задачи",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpaceConfigUnitParametersRs",
"additionalProperties": false,
"description": "Успешное получение конфигурации пространства для задачи",
"required": [
"parameters",
"spaceCode",
"suitCode"
],
"example": null
},
"examples": {
"success": {
"description": "Конфигурация пространства для задачи",
"value": {
"spaceCode": "SWTR",
"suitCode": "epic",
"parameters": {
"ratingEnabled": 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/space/v2/{code}": {
"description": "Ищет пространство по его коду",
"get": {
"tags": [
"API поиска пространства @TT0"
],
"summary": "Ищет пространство по его коду",
"operationId": "get_14",
"parameters": [
{
"name": "code",
"in": "path",
"description": "Код спейса",
"required": true,
"schema": {
"type": "string",
"example": "Пример",
"maxLength": 2147483647,
"pattern": ".*"
},
"example": "ANYSPC"
}
],
"responses": {
"200": {
"description": "Success get space",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpaceInfo",
"additionalProperties": false,
"description": "Информация о спейсе",
"required": [
"allowedActions",
"code",
"createdAt",
"groupsInfo",
"name",
"suits",
"type",
"updatedAt",
"usersInfo"
],
"example": null
},
"examples": {
"success": {
"description": "Описание спейса",
"value": {
"code": "DEVK4ABR",
"name": "Демо спейс",
"type": {
"code": "CHANGE",
"name": "Change-команда"
},
"createdAt": "2025-01-21T05:59:31.229003Z",
"updatedAt": "2025-01-21T05:59:31.229003Z",
"allowedActions": [
{
"name": "privilege_group_assignment"
},
{
"name": "read"
},
{
"name": "update"
},
{
"name": "space_owner_assignment"
}
],
"usersInfo": [
{
"permissionGroups": [
{
"name": "SPACE_OWNER"
}
],
"info": {
"externalId": "200002",
"firstName": "Тест_ALL_ROLES",
"lastName": "Тестыч",
"middleName": null
}
}
],
"groupsInfo": [],
"suits": [
{
"code": "task",
"name": "Поменяем название пользовательской истории",
"description": "Ну и описание тоже",
"icon": "super_idea",
"workflow": {
"name": "APProcess Task Flow 1.0",
"code": "default_workflow"
}
}
]
}
}
}
}
}
},
"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/{code}": {
"description": "Ищет тип пространства по его коду",
"get": {
"tags": [
"API поиска типа пространства"
],
"summary": "Ищет тип пространства по его коду",
"operationId": "get_17",
"parameters": [
{
"name": "code",
"in": "path",
"description": "Код типа спейса",
"required": true,
"schema": {
"type": "string",
"example": "Пример",
"maxLength": 2147483647,
"pattern": ".*"
},
"example": "PERSONAL"
}
],
"responses": {
"200": {
"description": "Информация о типе пространства",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpaceTypeDetailsDto",
"additionalProperties": false,
"description": "Информация о типе спейса",
"required": [
"configuration",
"info"
],
"example": null
},
"examples": {
"success": {
"description": "Описание типа спейса",
"value": "{\n \"info\": {\n \"code\": \"PERSONAL\",\n \"name\": \"Индивидуальный спейс\",\n \"description\": null,\n \"createdAt\": \"2024-12-10T14:30:47.282580Z\",\n \"updatedAt\": \"2024-12-10T14:30:47.282580Z\",\n \"status\": \"ACTIVE\"\n },\n \"configuration\": {\n \"suits\": [\n {\n \"code\": \"idea\",\n \"name\": \"Поменяем название пользовательской истории\",\n \"description\": \"Ну и описание тоже\",\n \"icon\": \"super_idea\",\n \"type\": \"REQUIRED\",\n \"workflows\": []\n },\n ],\n \"suitWorkflows\": [],\n \"linkTypes\": [],\n \"userGroupPermGroupConfigs\": [],\n \"permissionGroups\": []\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/configuration/v1/{space}/suits/find": {
"description": "Поиск используемых в пространстве типов задач",
"get": {
"tags": [
"API Конфигурация пространства. Разрешенные к использованию типы задач."
],
"summary": "Поиск используемых в пространстве типов задач",
"operationId": "findAccessibleSuits",
"parameters": [
{
"name": "space",
"in": "path",
"description": "Код пространства",
"required": true,
"schema": {
"type": "string",
"example": "Пример",
"maxLength": 2147483647,
"pattern": ".*"
},
"example": "ANYSPC"
}
],
"responses": {
"200": {
"description": "Результат поиска используемых в пространстве типов задач",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpaceConfigAppliedSuitRs",
"additionalProperties": false,
"description": "Информация по конфигурации пространства",
"required": [
"applied",
"available",
"required"
],
"example": null
},
"examples": {
"success": {
"description": "Успешная попытка добавить тип задачи",
"value": {
"required": [
{
"code": "task",
"name": "Поменяем название пользовательской истории",
"description": "Ну и описание тоже",
"icon": "super_idea"
}
],
"available": [],
"applied": [
{
"code": "idea",
"name": "Поменяем название пользовательской истории",
"description": "Ну и описание тоже",
"icon": "super_idea"
},
{
"code": "epic",
"name": "Поменяем название пользовательской истории",
"description": "Ну и описание тоже",
"icon": "super_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": "Неизвестная ошибка"
}
}
}
}
}
}
}
}
},