Документация для разработчиков
Темная тема

tasks.api.scrum.sprint.list

Scope: task Права на выполнение: для всех

Описание и пример

tasks.api.scrum.sprint.list()

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

Метод аналогичен другим методам с фильтрацией по списку.

Параметры

ПараметрОписание
orderМассив для сортировки результата. Массив вида {"поле_сортировки": 'направление сортировки' [, ...]}. Доступные поля описаны в таблице ниже.
Направление сортировки может принимать значения:
  • asc - по возрастанию;
  • desc - по убыванию;
filterМассив вида {"фильтруемое_поле": "значение фильтра" [, ...]}. Доступные поля описаны в таблице ниже.
selectМассив полей записей, которые будут возвращены методом. Можно указать только те поля, которые необходимы. Если в массиве присутствует значение "*", то будут возвращены все доступные поля.

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

Примеры

const groupId = 1;
BX24.callMethod(
	'tasks.api.scrum.sprint.list',
	{
		filter: {
		GROUP_ID: groupId,
		'>=DATE_END': new Date()
		}
	},
	function(res)
	{
		console.log(res);
	}
);

Доступные поля

Поле Описание
ID Идентификатор спринта
GROUP_ID Идентификатор Скрама
ENTITY_TYPE Тип элемента
NAME Имя
SORT Сортировка
CREATED_BY Кем создан
MODIFIED_BY Кем изменён
DATE_START Дата запуска
DATE_END Дата окончания
STATUS Статус
INFO Информация

Пользовательские комментарии

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

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024