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

task.elapseditem.getlist

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

Описание

Возвращает список записей о затраченном времени по задаче.

Параметры

ПараметрОписание
TASKID Идентификатор задачи. Необязательный параметр.
ORDER Массив для сортировки результата. Поле для сортировки может принимать значения:
  • ID - идентификатор записи о затраченном времени;
  • USER_ID - идентификатор пользователя, от имени которого была сделана запись о затраченном времени;
  • MINUTES - затраченное время, минуты;
  • SECONDS - затраченное время, секунды;
  • CREATED_DATE - дата создания записи;
  • DATE_START - дата начала;
  • DATE_STOP - дата конца.
Направление сортировки может принимать значения:
  • asc - по возрастанию;
  • desc - по убыванию;
Необязательный. По умолчанию фильтруется по убыванию идентификатора записи о затраченном времени.
FILTER Массив вида {"фильтруемое_поле": "значение фильтра" [, ...]}. Фильтруемое поле может принимать значения:
  • ID - идентификатор комментария;
  • USER_ID - идентификатор пользователя, от имени которого была сделана запись о затраченном времени;
  • CREATED_DATE - дата создания записи;
Перед названием фильтруемого поля может указать тип фильтрации:
  • "!" - не равно;
  • "<" - меньше;
  • "<=" - меньше либо равно;
  • ">" - больше;
  • ">=" - больше либо равно.
"значения фильтра" - одиночное значение или массив.

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

Значение по умолчанию - пустой массив array() - означает, что будут возвращены все поля основной таблицы запроса.
PARAMSМассив для опций вызова. Элементом является массив NAV_PARAMS вида {"опция вызова": 'значение' [, ...]}, хранящий следующие опции:
  • nPageSize - количество элементов на странице. В целях ограничения нагрузки на постраничную навигацию наложено ограничение в 50 записей.
  • iNumPage - номер страницы при постраничной навигации.

Внимание! Соблюдение порядка следования параметров в запросе обязательно. При его нарушении запрос будет выполнен с ошибками.

Особенности ручного добавления информации о времени работы, которая было фактически выполнена несколько дней назад. В этом случае меняется значение некоторых полей:
  • CREATED_DATE - дата начала;
  • DATE_START - дата создания записи;
  • DATE_STOP - дата создания записи;

Примеры

// Получить все записи о затраченном времени с сортировкой по ID в нисходящем порядке. 
// Будут отфильтрованы только те записи, ID которых имеет значение меньше 50.
BX24.callMethod(
	'task.elapseditem.getlist',
	[1, {'ID': 'desc'}, {'<ID': 50}],
	function(result){
		console.info(result.data());
		console.log(result);
	}
);

Получение выборки по затраченному времени на основании общий условий фильтрации. Например, выбрать данные о трудозатратах с указанной даты:

BX24.callMethod(
	'task.elapseditem.getlist',
	[{'ID': 'desc'}, {>=CREATED_DATE': '2018-02-16'}],
	function(result){
		console.info(result.data());
		console.log(result);
	}
);

Пример для работы с php:

// Пример для работы с php
// Получение GET-запроса на выборку данных.
$appParams = array(
	"auth" => '92006f4ae0c55d400f1e6e09428af64a',
	"ORDER" => array("ID" => "DESC"),			// Сортировка по ID - по убыванию
	"FILTER" => array(">ID" => 1),				// Фильтр
	"SELECT" => array('ID', 'TASK_ID'),			// Выборка - только ID записи и задачи
	"PARAMS" => array('NAV_PARAMS' => array(	// Постраничка
		"nPageSize" => 2,						// по 2 элемента на странице
		'iNumPage' => 2							// страница номер 2
	)),
);
$appRequestUrl = 'http://test-domain.ru/rest/task.elapseditem.getlist.xml?'.http_build_query($appParams);
print(urldecode($appRequestUrl));;


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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
0
Павел Апексимов
Сообщение не промодерировано, возможны ошибки и неточности.
Фильтр по датам для 1С
order[ID]=ASC&filter[>ID]=0&filter[USER_ID]=220&filter[>CREATED_DATE]=" + ПериодНачала + "&filter[<CREATED_DATE]=" + ПериодОкончания
5
Виктор Краснов
Сообщение не промодерировано, возможны ошибки и неточности.
Хочется плакать навзрыд. Чтобы выгрузить порциями данные, надо делать так:

task.elapseditem.getlist?order[ID]=ASC&filter[>ID]=0&select[]=*&PARAMS[NAV_PARAMS][nPageSize]=50&PARAMS[NAV_PARAMS][iNumPage]=2.

Без других параметров оно не работает, кроме того, порядок параметров важен.

Боюсь представить, какие стажеры писали код этого "REST API".
6
AndrewTishkin
Один из эндпойнтов, за реализацию которого нужно слать лютые лучи поноса приложившим руку (или ногу, хз), потому что кроме очередного отсутствия единства в наименованиях, регистрах полей (большими или маленькими буквами) всплывают откровенные нежданчики по логике работы.

Он прекрасно отрабатывает на
Код
"ORDER":{
   "ID":"DESC"
},
хотя согласно документации не должен работатьв  этом случае.
Но не хочет работать при
Код
"ORDER":{
   "DATE_START":"DESC"
},
а только при
Код
"ORDER":{
   "DATE_START":"desc"
},
Для каждого поля использовать свою логику работы фильтра, вместо какого-то единообразия, обобщения - это жесть жестяная  :evil:
Работа с битрикс-API - это задумываться НА КАЖДОМ ШАГУ о том, какую буковку написать, чтобы не получить мало помогающую ошибку, вместо того, чтобы как при работе с нормальными апишками - просто писать код, выучив базовые принципы
© «Битрикс», 2001-2024, «1С-Битрикс», 2024