метод REST scope: task

tasks.api.scrum.epic.list

Получить список эпиков

Кто может выполнять: любой пользователь

Описание

Метод возвращает список эпиков.

Параметры

order array необязательный

Массив для сортировки результата вида {'поле_сортировки': 'направление сортировки' [, ...]}.

Направление сортировки может принимать значения:
- asc — по возрастанию
- desc — по убыванию

Возможные значения элементов массива соответствуют полям ответа tasks.api.scrum.epic.add

filter array необязательный

Массив вида {'фильтруемое_поле': 'значение фильтра' [, ...]}.

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

Возможные значения префикса:
- = — равно (работает и с массивами)
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- > — больше
- < — меньше
- != — не равно
- !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обоих сторон.
- >= — больше либо равно
- <= — меньше либо равно
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищем значения начинающиеся с «мол»
- "%мол" — ищем значения заканчивающиеся на «мол»
- "%мол%" — ищем значения, где «мол» может быть в любой позиции
- %= — LIKE (смотрите описание выше)
- !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищем значения не начинающиеся с «мол»
- "%мол" — ищем значения не заканчивающиеся на «мол»
- "%мол%" — ищем значения, где подстроки «мол» нет в любой позиции
- !%= — NOT LIKE (смотрите описание выше)

Возможные значения элементов массива соответствуют полям ответа tasks.api.scrum.epic.add

select array необязательный

Массив полей записей, которые будут возвращены методом.

Возможные значения элементов массива соответствуют полям ответа tasks.api.scrum.epic.add. Можно указать только те поля, которые необходимы.

Если в массиве присутствует значение "*", то будут возвращены все доступные поля.

Значение по умолчанию — пустой массив array(). Это означает, что будут возвращены все поля основной таблицы запроса

start integer необязательный

Номер страницы вывода. Работает для https запросов.

Размер страницы результатов всегда статичный: 50 записей.

Чтобы выбрать вторую страницу результатов необходимо передавать значение 50. Чтобы выбрать третью страницу результатов значение — 100 и так далее.

Формула расчета значения параметра start:
start = (N-1) * 50, где N — номер нужной страницы

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-d '{
    "filter": {
        "GROUP_ID": 143,
        ">=ID": 1,
        "<=ID": 50,
        "NAME": "%эпик%",
        "!=DESCRIPTION": "old epic",
    },
    "order": {
        "ID": "asc",
        "NAME": "desc"
    },
    "select": ["ID", "NAME", "DESCRIPTION", "CREATED_BY", "MODIFIED_BY", "COLOR"],
    "start": 0
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.epic.list

Ответ

HTTP-статус: 200

[
    {
        "id": 1,
        "groupId": 143,
        "name": "эпик",
        "description": "",
        "createdBy": 1,
        "modifiedBy": 0,
        "color": "#69dafc"
    },
    {
        "id": 3,
        "groupId": 143,
        "name": "эпик2",
        "description": "new epic",
        "createdBy": 3,
        "modifiedBy": 5,
        "color": "#69dagc"
    }
]

Возвращаемые данные

id integer

Идентификатор эпика

groupId integer

Идентификатор группы (скрама), к которой привязан эпик

name string

Название эпика

description string

Описание эпика

createdBy integer

Идентификатор пользователя, создавшего эпик

modifiedBy integer

Идентификатор пользователя, который последним изменял эпик

color string

Цвет эпика в формате HEX

Обработка ошибок

HTTP-статус: 400

{
    "error": 0,
    "error_description": "Could not load list"
}
Код Описание Значение
0 Could not load list Не найдено ни одного эпика с указанными фильтрами

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.