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

add

Описание

\CTaskCheckListItem::add(CTaskItemInterface $oTaskItem, array $fields)

Статический метод для создания пункта чек-листа. После успешного создания пункта чек-листа вернется объект \CTaskCheckListItem.

Параметры

Первым параметром передается объект конкретной задачи для того, чтобы прикрепить к ней пункт чек-листа. Вторым параметром передается массив значений этого пункта чек-листа.

ПараметрОписание и параметрыВерсия
TITLE (обязательный)  Текст чек-листа. Можно передавать любую строку, кроме пустой строки или строки, содержащей только пробелы.

Если TITLE будет равен === (трем знакам "равно"), то вместо пункта чек-листа будет разделительная линия.

SORT_INDEX  Индекс сортировки. Целое число. Чем больше, тем ниже в списке.
IS_COMPLETE  Флаг о том, что пункт чек-листа уже выполнен.

События

OnBeforeTaskCheckListItemAdd ($task, $fields)
OnAfterTaskCheckListItemAdd ($task, $oldFields, $newFields)

Пример

$task = \CTaskItem::getInstance($taskId, $userId);

\CTaskCheckListItem::add($task, ['TITLE'=>'First item', 'SORT_INDEX'=>10, 'IS_COMPLETE'=>'N']);

\CTaskCheckListItem::add($task, ['TITLE'=>'Second item', 'SORT_INDEX'=>20, 'IS_COMPLETE'=>'N']);

\CTaskCheckListItem::add($task, ['TITLE'=>'Third item. Completed', 'SORT_INDEX'=>30, 'IS_COMPLETE'=>'Y']);

REST запрос

// 20190207175030
// http://site.ru/rest/1/********/tasks.task.checklist.add?taskId=1&fields[TITLE]=Hello%20world
{
	"result": {
		"item": [
			{
				"ID": "1",
				"CREATED_BY": "1",
				"TASK_ID": "1",
				"TITLE": "Hello world",
				"IS_COMPLETE": "N",
				"SORT_INDEX": "1"
			}
		]
	},
	"time": {
		"start": 1549554630.441403,
		"finish": 1549554630.552115,
		"duration": 0.11071205139160156,
		"processing": 0.05162310600280762,
		"date_start": "2019-02-07T17:50:30+02:00",
		"date_finish": "2019-02-07T17:50:30+02:00"
	}
}


© «Битрикс», 2001-2024, «1С-Битрикс», 2024