Перейти к содержанию

Лейбл

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

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

class Label {...}
Название Тип данных Описание
id string UUID лейбла
projectId string UUID проекта, в котором находится лейбл
value string Название лейбла
description string Описание лейбла
hexColor string Код цвета лейбла в формате HEX

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

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

Создание лейбла

labelService.create(toCreate: Label) => Label

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

Название Тип данных Описание
projectId string UUID проекта, в котором будет создан лейбл
value string Название лейбла
description string Описание лейбла
hexColor string Код цвета лейбла в формате HEX

Изменение лейбла

labelService.edit(toEdit Label) => Label

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

Название Тип данных Описание
id string UUID лейбла
projectId string UUID проекта, в котором будет изменен лейбл
value string Необязательный параметр. Название лейбла
description string Необязательный параметр. Описание лейбла
hexColor string Необязательный параметр. Код цвета лейбла в формате HEX

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

labelService.getAll({projectId}, {startPage}, {pageSize}) => Page<Label>

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

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

Получение списка лейблов по UUID

labelService.findAllByIds({projectId}, {ids}) => Label[]

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

Название Тип данных Описание
projectId string UUID проекта, в котором будет осуществлен поиск
ids []string Список UUID лейблов, которые нужно получить