Проблемы проектов

Описание структуры JSON-объекта, описывающего проблему
Поле Тип Описание
id String Уникальный ID проблемы
localId String Локальный ID проблемы
description String Описание проблемы
title String Псевдоним проблемы
status Set(Status) Статус проблемы
assigneUsers Set(User) Информация о прикрепленных к проблеме пользователях
labels Set(Label) Лейблы проблемы
projectAlias String Псевдоним проекта
userAlias String Псевдоним владельца проекта
updatedAt LocalDateTime Время последнего обновления проблемы
createdAt LocalDateTime Время создания проблемы
updatedBy User Информация о последнем пользователе, обновившем проблему
Описание структуры JSON-объекта, описывающего статус проблемы
Поле Тип Описание
id String ID статуса
title String Название статуса
hash String Хэш статуса
alias String Псевдоним статуса
ownerAlias String Псевдоним владельца статуса
color String Название цвета статуса
hexColor String Код цвета
icon String Иконка проблемы
isDeleted Boolean Удален ли статус
Описание структуры JSON-объекта, описывающего лейблы
Поле Тип Описание
id String ID лейбла
hexColor String Код цвета лейбла
title String Название лейбла
description String Описание лейбла
isTextLight Boolean Определяет цвет названия лейбла. true обозначает белый цвет, false обозначает черный цвет

Ознакомиться со структурой JSON-объекта, описывающего пользователя можно здесь

Метод для получения проблемы

GET /project/{ownerAlias}/{projectAlias}/issue/{localId}

Запрос возвращает проблему проекта по ее локальному номеру.

Переменная пути запроса Тип Описание
ownerAlias String Псевдоним владельца проекта
projectAlias String Псевдоним проекта
localId Long ID проблемы

Responses

STATUS 200 пример JSON:

Пример JSON тела 
    
{
    "id": "522d58b6-aaaa-aaaa-aaaa-a3ccba39032b",
    "localId": 19,
    "description": "Пример описания",
    "title": "Пример названия",
    "status": {
        "id": "COMPLETED",
        "title": "Завершена",
        "hash": null,
        "alias": null,
        "ownerAlias": null,
        "color": "success",
        "hexColor": "28A745",
        "icon": null,
        "isDeleted": false
    },
    "assignedUsers": [
        {
            "id": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
            "username": "USER",
            "name": "user",
            "surname": "name",
            "fullName": "user name",
            "avatar": "https://gitflic.ru/upload/img/6da34d10-aaaa-aaaa-aaaa-19b7e2151276.jpg",
            "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
        }
    ],
    "labels": [
        {
            "id": "c3e20e76-aaaa-aaaa-aaaa-0846de71cfc3",
            "hexColor": "F58A07",
            "title": "ошибка",
            "description": "Ошибка в новой фиче",
            "isTextLight": false
        }
    ],
    "projectAlias": "test_project",
    "userAlias": "USER",
    "updatedAt": "14 минут назад",
    "createdAt": "1 месяц назад",
    "updatedBy": {
        "id": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
        "username": "USER",
        "name": "user",
        "surname": "name",
        "fullName": "user name",
        "avatar": "https://gitflic.ru/upload/img/6da34d10-aaaa-aaaa-aaaa-19b7e2151276.jpg",
        "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для получения списка проблем

GET /project/{ownerAlias}/{projectAlias}/issue

Запрос возвращает список проблем проекта

Переменная пути запроса Тип Описание
ownerAlias String Псевдоним владельца проекта
projectAlias String Псевдоним проекта

Responses

STATUS 200 пример JSON:

Пример JSON тела 
    
{
    "_embedded": {
        "issueModelList": [
            {
                "id": "522d58b6-aaaa-aaaa-aaaa-a3ccba39032b",
                "localId": 19,
                "description": "Пример описания",
                "title": "Пример названия",
                "status": {
                    "id": "COMPLETED",
                    "title": "Завершена",
                    "hash": null,
                    "alias": null,
                    "ownerAlias": null,
                    "color": "success",
                    "hexColor": "28A745",
                    "icon": null,
                    "isDeleted": false
                },
                "assignedUsers": [
                    {
                        "id": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
                        "username": "USER",
                        "name": "user",
                        "surname": "name",
                        "fullName": "user name",
                        "avatar": "https://gitflic.ru/upload/img/6da34d10-aaaa-aaaa-aaaa-19b7e2151276.jpg",
                        "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
                    }
                ],
                "labels": [
                    {
                        "id": "c3e20e76-aaaa-aaaa-aaaa-0846de71cfc3",
                        "hexColor": "F58A07",
                        "title": "ошибка",
                        "description": "Ошибка в новой фиче",
                        "isTextLight": false
                    }
                ],
                "projectAlias": "test_project",
                "userAlias": "USER",
                "updatedAt": "14 минут назад",
                "createdAt": "1 месяц назад",
                "updatedBy": {
                    "id": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
                    "username": "USER",
                    "name": "user",
                    "surname": "name",
                    "fullName": "user name",
                    "avatar": "https://gitflic.ru/upload/img/6da34d10-aaaa-aaaa-aaaa-19b7e2151276.jpg",
                    "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
                }
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 1,
        "totalPages": 1,
        "number": 0
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для создания проблемы

POST /project/{ownerAlias}/{projectAlias}/issue

Запрос создает проблему по параметрам и возвращает ее

Переменная пути запроса Тип Описание
ownerAlias String Псевдоним владельца проекта
projectAlias String Псевдоним проекта

Request

Поддерживаемый формат JSON

Структура тела POST-запроса:

Параметр Тип Описание
title String Название проблемы (обязательный параметр)
description String Описание проблемы (обязательный параметр)
status IssueStatus Статус проблемы. Принимает список параметров id, которые могут иметь следующие значения: OPEN, IN_PROGRESS, CLOSED или COMPLETED
assignedUsers Set(User) Список пользователей, которые являются ответственными. Принимает список параметров id
labels Set(Label) Список лейблов. Принимает список параметров id

Пример JSON объекта

{
    "title": "Пример названия",
    "description": "Пример описания",
    "assignedUsers": [
        {
            "id": "fe9e9812-aaaa-aaaa-aaaa-63cd21e53210"
        }
    ],
    "labels": [
        {
            "id": "c3e20e76-aaaa-aaaa-aaaa-0846de71cfc3"
        }
    ],
    "status":
        {
           "id": "OPEN"
        }
}

Responses

STATUS 200 пример JSON:

Пример JSON тела 
    
{
    "id": "522d58b6-aaaa-aaaa-aaaa-a3ccba39032b",
    "localId": 19,
    "description": "Пример описания",
    "title": "Пример названия",
    "status": {
        "id": "OPEN",
        "title": "Новая",
        "hash": null,
        "alias": null,
        "ownerAlias": null,
        "color": "info",
        "hexColor": "17A2B8",
        "icon": null,
        "isDeleted": false
    },
    "assignedUsers": [
        {
            "id": "fe9e9812-aaaa-aaaa-aaaa-63cd21e53210",
            "username": "USER",
            "name": "user",
            "surname": "name",
            "fullName": "user name",
            "avatar": "https://gitflic.ru/upload/img/6da34d10-aaaa-aaaa-aaaa-19b7e2151276.jpg",
            "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
        }
    ],
    "labels": [
        {
            "id": "c3e20e76-aaaa-aaaa-aaaa-0846de71cfc3",
            "hexColor": "F58A07",
            "title": "ошибка",
            "description": "Ошибка в новой фиче",
            "isTextLight": false
        }
    ],
    "projectAlias": "test_project",
    "userAlias": "USER",
    "updatedAt": "14 минут назад",
    "createdAt": "1 месяц назад",
    "updatedBy": {
        "id": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
        "username": "USER",
        "name": "user",
        "surname": "name",
        "fullName": "user name",
        "avatar": "https://gitflic.ru/upload/img/6da34d10-aaaa-aaaa-aaaa-19b7e2151276.jpg",
        "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для редактирования проблемы

PUT /project/{ownerAlias}/{projectAlias}/issue/{localId}/edit

Запрос редактирует проблему проекта по параметрам и возвращает ее

Переменная пути запроса Тип Описание
ownerAlias String Псевдоним владельца проекта
projectAlias String Псевдоним проекта
localId Long ID проблемы

Request

Поддерживаемый формат JSON

Структура тела PUT-запроса:

Параметр Тип Описание
title String Название проблемы (обязательный параметр)
description String Описание проблемы (обязательный параметр)
status IssueStatus Статус проблемы. Принимает список параметров id, которые могут иметь следующие значения: OPEN, IN_PROGRESS, CLOSED или COMPLETED
assignedUsers Set(User) Список пользователей, которые являются ответственными. Принимает список параметров id
labels Set(Label) Список лейблов. Принимает список параметров id

Пример JSON объекта

{
    "title": "Пример названия",
    "description": "Пример описания",
    "assignedUsers": [
        {
            "id": "fe9e9812-aaaa-aaaa-aaaa-63cd21e53210"
        }
    ],
    "labels": [
        {
            "id": "c3e20e76-aaaa-aaaa-aaaa-0846de71cfc3"
        }
    ],
    "status":
        {
           "id": "OPEN"
        }
}

Responses

STATUS 200 пример JSON:

Пример JSON тела 
    
{
    "id": "522d58b6-aaaa-aaaa-aaaa-a3ccba39032b",
    "localId": 19,
    "description": "Пример описания",
    "title": "Пример названия",
    "status": {
        "id": "OPEN",
        "title": "Новая",
        "hash": null,
        "alias": null,
        "ownerAlias": null,
        "color": "info",
        "hexColor": "17A2B8",
        "icon": null,
        "isDeleted": false
    },
    "assignedUsers": [
        {
            "id": "fe9e9812-aaaa-aaaa-aaaa-63cd21e53210",
            "username": "USER",
            "name": "user",
            "surname": "name",
            "fullName": "user name",
            "avatar": "https://gitflic.ru/upload/img/6da34d10-aaaa-aaaa-aaaa-19b7e2151276.jpg",
            "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
        }
    ],
    "labels": [
        {
            "id": "c3e20e76-aaaa-aaaa-aaaa-0846de71cfc3",
            "hexColor": "F58A07",
            "title": "ошибка",
            "description": "Ошибка в новой фиче",
            "isTextLight": false
        }
    ],
    "projectAlias": "test_project",
    "userAlias": "USER",
    "updatedAt": "14 минут назад",
    "createdAt": "1 месяц назад",
    "updatedBy": {
        "id": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
        "username": "USER",
        "name": "user",
        "surname": "name",
        "fullName": "user name",
        "avatar": "https://gitflic.ru/upload/img/6da34d10-aaaa-aaaa-aaaa-19b7e2151276.jpg",
        "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для удаления проблемы

DELETE /project/{ownerAlias}/{projectAlias}/issue/{localId}/delete

Запрос удаляет проблему

Переменная пути запроса Тип Описание
ownerAlias String Псевдоним владельца проекта
projectAlias String Псевдоним проекта
localId Long ID проблемы

Responses

STATUS 200 - Успешное удаление проблемы.

STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Навигация