Проблема

Для взаимодействия с проблемами определен объект issueService

Сущность проблема содержит в себе следующие данные:

class Issue {...}
Название Тип данных Описание
id string UUID проблемы
localId number Номер проблемы в проекте
projectId string UUID проекта
title string Заголовок проблемы
description string Описание проблемы
status string Статус проблемы. Возможные значения: OPEN, IN_PROGRESS, CLOSED, COMPLETED
priority string Приоритет проблемы. Возможные значения: LOW, MIDDLE, HIGH, EXTREME
authorId string UUID автора проблемы
assignedUserIds string[] Список UUID ответственных за проблему
labelIds string[] Список UUID лейблов

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

Для работы с сущностью проблема существуют следующие методы:

Создание проблемы

issueService.create(toCreate: Issue) => Issue

Метод создает проблему и возвращает ее. Необходимо передать следующие значения в методе

Название Тип данных Описание
projectId string UUID проекта, в котором будет создана проблема
title string Заголовок проблемы
description string Описание проблемы
status string Статус проблемы. Возможные значения: OPEN, IN_PROGRESS, CLOSED, COMPLETED
priority string Приоритет проблемы. Возможные значения: LOW, MIDDLE, HIGH, EXTREME
assignedUserIds string[] Список UUID ответственных за проблему
labelIds string[] Список UUID лейблов

Изменение проблемы

issueService.edit(toEdit: Issue) => Issue

Метод изменяет проблему и возвращает ее. Необходимо передать следующие значения в методе

Название Тип данных Описание
projectId string UUID проекта, в котором будет обновлена проблема
id string UUID проблемы
title string Заголовок проблемы
description string Описание проблемы
status string Статус проблемы. Возможные значения: OPEN, IN_PROGRESS, CLOSED, COMPLETED
priority string Приоритет проблемы. Возможные значения: LOW, MIDDLE, HIGH, EXTREME
assignedUserIds string[] Список UUID ответственных за проблему
labelIds string[] Список UUID лейблов

Получение списка всех проблем

issueService.getAll({projectId}, {startPage}, {pageSize}) => Page<Issue>

Метод возвращает объект со всеми проблемами проекта. Необходимо передать следующие значения в методе

Название Тип данных Описание
projectId string UUID проекта, в котором будет осуществлен поиск
startPage number Номер запрашиваемой страницы
pageSize number Размер страницы

Получение списка всех проблем с указанным статусом

issueService.getAllWithStatus({projectId}, {startPage}, {pageSize}, {status}) => Page<Issue>

Метод возвращает объект, содержащий проблемы с указанным статусом в проекте. Необходимо передать следующие значения в методе

Название Тип данных Описание
projectId string UUID проекта, в котором будет осуществлен поиск
startPage number Номер запрашиваемой страницы
pageSize number Размер страницы
status string Статус проблемы. Возможные значения: OPEN, IN_PROGRESS, CLOSED, COMPLETED

Получение проблемы по локальному номеру

issueService.findByLocalId({projectId}, {localId}) => Issue

Метод возвращает проблему с указанным номеров в проекте. Необходимо передать следующие значения в методе

Название Тип данных Описание
projectId string UUID проекта, в котором будет осуществлен поиск
localId number Номер проблемы в проекте

Получение проблемы по UUID

Метод возвращает проблему с указанным UUID в проекте. Необходимо передать следующие значения в методе

issueService.findById({id}) => Issue

Название Тип данных Описание
id string UUID проблемы
Навигация