Поля задачи в REST 3.0
- Какие поля принимают и возвращают методы
- Объект задачи
- Объект пользователя
- Объект тега
- Объект пользовательского поля
- Объект файла
- Объект группы
- Объект стадии
- Объект потока
- Объект чата задачи
- Объект шаблона задачи
- Объект параметров повторения шаблона
- Объект письма
- Объект учета времени
- Объект источника
- Продолжите изучение
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Страница помогает разобрать поля задачи в REST 3.0. Их возвращают методы tasks.task.get, tasks.task.list и tasks.task.add, а принимают методы tasks.task.add и tasks.task.update. В блоке Объект задачи описаны все поля задачи, в других блоках — поля связанных объектов.
Часть полей задачи существует в двух видах: как идентификатор и как объект, например creatorId и creator. Какой вид принимает и возвращает каждый метод, показано в таблице.
Какие поля принимают и возвращают методы
|
Метод |
Принимает |
Возвращает |
|
Поля таблицы Объект задачи с идентификаторами связанных объектов: |
Объект задачи в том же составе, что tasks.task.get без |
|
|
Те же поля, что |
Признак успеха |
|
|
|
Без |
|
|
|
Без |
В fields методов tasks.task.add и tasks.task.update нельзя передать id, created, accomplices, auditors, tags, userFields и поля-объекты — creator, group, parent и другие. На такое поле метод вернет ошибку валидации «Поле не доступно к изменению». Поля с пометкой «изменяется автоматически» передавать не нужно: их значение вычисляет Битрикс24.
Как устроены поля связанных объектов, описано в статье Обзор REST API 3.0.
Права на запись и изменение полей зависят от роли пользователя в задаче, настроек прав на группу, иерархии сотрудников, статуса задачи и флагов задачи, например allowsChangeDeadline. Перед изменением задачи проверьте объект rights: его поля показывают действия, доступные текущему пользователю.
Логические поля принимают и возвращают true или false. Строковые значения Y и N из классических методов задач в REST 3.0 не подходят: метод вернет ошибку валидации.
Объект задачи
|
Название |
Описание |
|
id |
Идентификатор задачи |
|
title |
Название задачи, обязательное поле для создания задачи |
|
description |
Описание задачи |
|
creatorId |
Идентификатор постановщика, обязательное поле для создания задачи. Поле возвращает tasks.task.list, в ответе tasks.task.get вместо него запрашивайте объект |
|
creator |
Постановщик. Объект типа пользователь. Используйте для запроса данных в параметре |
|
created |
Дата создания в формате ISO 8601. Поле возвращает tasks.task.list, в ответе tasks.task.get его нет |
|
responsibleId |
Идентификатор исполнителя, обязательное поле для создания задачи. Поле возвращает tasks.task.list, в ответе tasks.task.get вместо него запрашивайте объект |
|
responsible |
Исполнитель. Объект типа пользователь. Используйте для запроса данных в параметре |
|
deadline |
Крайний срок в формате ISO 8601, например |
|
needsControl |
Контроль задачи постановщиком: |
|
startPlan |
Плановая дата начала в формате ISO 8601, например |
|
endPlan |
Плановая дата окончания в формате ISO 8601, например |
|
checklist |
Идентификаторы пунктов чек-листов. Для работы с чек-листами используйте методы task.checklistitem.* |
|
fileIds |
Идентификаторы файлов Диска, которые нужно прикрепить к задаче. Поле принимают tasks.task.add и tasks.task.update. В ответе tasks.task.get поле не заполняется и приходит как |
|
groupId |
Идентификатор группы/проекта. Для работы с группами используйте методы sonet_group.*. Поле возвращает tasks.task.list, в ответе tasks.task.get вместо него запрашивайте объект |
|
group |
Группа/проект. Объект типа группа. Используйте для запроса данных в параметре |
|
stageId |
Идентификатор стадии. Используйте, если задача находится в группе/проекте. Поле возвращает tasks.task.list, в ответе tasks.task.get вместо него запрашивайте объект |
|
stage |
Стадия. Объект типа стадия. Используйте для запроса данных в параметре |
|
epicId |
Идентификатор эпика. Для работы с эпиками используйте методы tasks.api.scrum.epic.* |
|
storyPoints |
Стори поинты. Для изменения задачи Скрама используйте метод tasks.api.scrum.task.update |
|
flowId |
Идентификатор потока. Для работы с потоком используйте методы tasks.flow.Flow.*. Поле возвращает tasks.task.list, в ответе tasks.task.get вместо него запрашивайте объект |
|
flow |
Поток. Объект типа поток. Используйте для запроса данных в параметре |
|
priority |
Приоритет задачи. Возможные значения:
|
|
status |
Статус задачи. Возможные значения:
|
|
statusChanged |
Дата изменения статуса в формате ISO 8601 |
|
accomplices |
Соисполнители. Массив объектов типа пользователь. Используйте для запроса данных в параметре Методы tasks.task.add и tasks.task.update поле не принимают. Чтобы назначить соисполнителей, используйте классический метод tasks.task.update с полем |
|
auditors |
Наблюдатели. Массив объектов типа пользователь. Используйте для запроса данных в параметре Методы tasks.task.add и tasks.task.update поле не принимают. Чтобы назначить наблюдателей, используйте классический метод tasks.task.update с полем |
|
parentId |
Идентификатор родительской задачи. |
|
parent |
Родительская задача. Объект типа задача. Используйте для запроса данных в параметре |
|
containsChecklist |
Признак наличия чек-листа. Поле изменяется автоматически |
|
containsSubTasks |
Признак наличия подзадач. Поле изменяется автоматически |
|
containsRelatedTasks |
Признак наличия связанных задач. Поле изменяется автоматически |
|
containsGanttLinks |
Признак наличия связей в Гантте. Поле изменяется автоматически |
|
containsPlacements |
Признак наличия встроек. Поле изменяется автоматически |
|
containsResults |
Признак наличия результатов. Поле изменяется автоматически |
|
numberOfReminders |
Количество напоминаний по задаче. Поле изменяется автоматически |
|
chatId |
Идентификатор чата задачи. Для работы с чатом задачи используйте методы сообщений, подробнее — Новая карточка задач: обзор изменений |
|
chat |
Чат задачи. Объект типа чат задачи. Используйте для запроса данных в параметре |
|
plannedDuration |
Плановая длительность |
|
actualDuration |
Фактическая длительность |
|
durationType |
Единица плановой длительности. Возможные значения: |
|
started |
Дата начала выполнения в формате ISO 8601 |
|
estimatedTime |
Оценка времени в секундах |
|
replicate |
Признак регулярной задачи: |
|
changed |
Дата изменения в формате ISO 8601 |
|
changedById |
Идентификатор пользователя, изменившего задачу. Поле возвращает tasks.task.list, в ответе tasks.task.get вместо него запрашивайте объект |
|
changedBy |
Кто изменил. Объект типа пользователь. Используйте для запроса данных в параметре |
|
statusChangedById |
Идентификатор пользователя, изменившего статус. Поле возвращает tasks.task.list, в ответе tasks.task.get вместо него запрашивайте объект |
|
statusChangedBy |
Кто изменил статус. Объект типа пользователь. Используйте для запроса данных в параметре |
|
closedById |
Идентификатор пользователя, закрывшего задачу. Поле возвращает tasks.task.list, в ответе tasks.task.get вместо него запрашивайте объект |
|
closedBy |
Кто закрыл. Объект типа пользователь. Используйте для запроса данных в параметре |
|
closed |
Дата закрытия в формате ISO 8601 |
|
activity |
Дата последней активности в формате ISO 8601 |
|
guid |
Идентификатор |
|
xmlId |
Внешний идентификатор |
|
exchangeId |
Идентификатор Exchange |
|
exchangeModified |
Дата изменения в Exchange |
|
outlookVersion |
Версия синхронизации с Outlook |
|
mark |
Оценка задачи. Возможные значения:
|
|
allowsChangeDeadline |
Исполнителю разрешено менять крайний срок |
|
allowsTimeTracking |
Включен учет времени по задаче |
|
matchesWorkTime |
Учитывать рабочее время: пропускать выходные дни при расчете плановых дат |
|
addInReport |
Добавлять задачу в отчет |
|
isMultitask |
Признак «базовая задача с подзадачами» |
|
siteId |
Идентификатор сайта |
|
deadlineCount |
Служебное поле счетчиков задач. В интеграциях не используйте |
|
declineReason |
Причина отклонения задачи. Заполняется, когда исполнитель отклонил задачу |
|
forumTopicId |
Идентификатор темы форума с комментариями к задаче. Пока тема не создана — |
|
forkedByTemplateId |
Идентификатор шаблона, если задача создана из шаблона. Поле возвращает tasks.task.list, в ответе tasks.task.get вместо него запрашивайте объект |
|
forkedByTemplate |
Шаблон задачи. Объект типа шаблон. Используйте для запроса данных в параметре |
|
maxDeadlineChangeDate |
Дата, после которой нельзя менять крайний срок, в формате ISO 8601 |
|
maxDeadlineChanges |
Максимальное количество переносов крайнего срока |
|
requireDeadlineChangeReason |
Требовать причину при переносе крайнего срока |
|
tags |
Теги задачи. Массив объектов типа тег. Используйте для запроса данных в параметре |
|
link |
Относительная ссылка на задачу в интерфейсе Битрикс24, например |
|
userFields |
Пользовательские поля задачи. Массив объектов типа пользовательское поле. Используйте для запроса данных в параметре |
|
rights |
Действия текущего пользователя с задачей. Ключ — код действия, значение — |
|
archiveLink |
Ссылка на архив для скачивания всех файлов задачи |
|
crmItemIds |
Идентификаторы связанных объектов CRM в формате:
|
|
emailId |
Идентификатор письма, из которого создана задача. Поле возвращает tasks.task.list, в ответе tasks.task.get вместо него запрашивайте объект |
|
email |
Письмо, из которого создана задача. Объект типа письмо. Используйте для запроса данных в параметре |
|
elapsedTime |
Учет времени. Объект типа учет времени. Используйте для запроса данных в параметре |
|
requireResult |
Требовать результат: задачу нельзя завершить без записи о результате |
|
matchesSubTasksTime |
Учитывать сроки подзадач при расчете плановых дат |
|
autocompleteSubTasks |
Завершать подзадачи автоматически вместе с базовой задачей |
|
allowsChangeDatePlan |
Исполнителю разрешено менять плановые даты |
|
inFavorite |
Признак «в избранном». В поле возвращается массив, в котором лежит ID текущего пользователя, если у него настройка активна |
|
inPin |
Признак «задача закреплена». В поле возвращается массив, в котором лежит ID текущего пользователя, если у него настройка активна |
|
inGroupPin |
Признак «задача закреплена в группе». В поле возвращается массив, в котором лежит ID текущего пользователя, если у него настройка активна |
|
inMute |
Признак «выключить звук». В поле возвращается массив, в котором лежит ID текущего пользователя, если у него настройка активна |
|
source |
Источник задачи. Объект источник. Используйте для запроса данных в параметре |
|
dependsOn |
Зависимости от задач |
|
scenarios |
Сценарии создания задачи. Возможные значения элементов:
|
Объект пользователя
|
Название |
Описание |
|
id |
Идентификатор пользователя |
|
name |
Имя пользователя |
|
role |
Роль пользователя |
|
image |
Объект типа файл. Используйте для запроса данных в параметре |
|
gender |
Пол. Возможные значения:
|
|
email |
|
|
externalAuthId |
Внешний auth ID |
|
rights |
Права пользователя |
Объект тега
|
Название |
Описание |
|
id |
Идентификатор тега |
|
name |
Название тега |
Объект пользовательского поля
Пользовательские поля задачи создают методы task.item.userfield.*.
|
Название |
Описание |
|
key |
Код поля, например |
|
value |
Значение поля. Тип зависит от настроек поля. Если поле не заполнено — |
Объект файла
|
Название |
Описание |
|
id |
Идентификатор файла |
|
src |
Ссылка на файл |
|
name |
Имя файла |
|
width |
Ширина |
|
height |
Высота |
|
size |
Размер |
|
subDir |
Подкаталог |
|
contentType |
MIME-тип |
|
file |
Данные файла |
Объект группы
|
Название |
Описание |
|
id |
Идентификатор группы |
|
name |
Название группы |
|
image |
Объект типа файл. Используйте для запроса данных в параметре |
|
type |
Тип группы. Возможные значения:
|
|
isVisible |
Признак видимости |
Объект стадии
|
Название |
Описание |
|
id |
Идентификатор стадии |
|
title |
Название стадии |
|
color |
Цвет стадии |
Объект потока
|
Название |
Описание |
|
id |
Идентификатор потока |
|
name |
Название потока |
Объект чата задачи
|
Название |
Описание |
|
id |
Идентификатор элемента чата |
|
entityId |
Идентификатор объекта чата |
|
entityType |
Тип объекта чата. Для чата задачи — |
Объект шаблона задачи
|
Название |
Описание |
|
id |
Идентификатор шаблона |
|
task |
Объект типа задача. Используйте для запроса данных в параметре |
|
title |
Название |
|
description |
Описание |
|
creator |
Объект типа пользователь. Используйте для запроса данных в параметре |
|
responsibleCollection |
Коллекция ответственных |
|
deadlineAfterTs |
Сдвиг крайнего срока |
|
startDatePlanTs |
Плановая дата начала |
|
endDatePlanTs |
Плановая дата окончания |
|
replicate |
Повторение задачи из шаблона |
|
checklist |
Массив идентификаторов пунктов чек-листов |
|
group |
Объект типа группа. Используйте для запроса данных в параметре |
|
priority |
Приоритет |
|
accomplices |
Соисполнители |
|
auditors |
Наблюдатели |
|
parent |
Родительский шаблон. Объект типа шаблон задачи |
|
replicateParams |
Объект параметров повторения. Используйте для запроса данных в параметре |
Объект параметров повторения шаблона
|
Название |
Описание |
|
period |
Периодичность. Возможные значения:
|
|
everyDay |
Каждый день |
|
workdayOnly |
Только рабочие дни |
|
dailyMonthInterval |
Интервал в днях месяца |
|
everyWeek |
Каждую неделю |
|
monthlyType |
Тип ежемесячного повтора |
|
monthlyDayNum |
День месяца |
|
monthlyMonthNum1 |
Первый месяц периода |
|
monthlyWeekDayNum |
Номер недели в месяце |
|
monthlyWeekDay |
День недели |
|
monthlyMonthNum2 |
Второй месяц периода |
|
yearlyType |
Тип годового повтора |
|
yearlyDayNum |
День месяца для годового повтора |
|
yearlyMonth1 |
Первый месяц годового повтора |
|
yearlyWeekDayNum |
Номер недели для годового повтора |
|
yearlyWeekDay |
День недели для годового повтора |
|
yearlyMonth2 |
Второй месяц годового повтора |
|
time |
Время |
|
timezoneOffset |
Смещение часового пояса |
|
startDate |
Дата начала повторения |
|
repeatTill |
До какой даты повторять |
|
endDate |
Дата окончания повторения |
|
times |
Количество повторов |
Объект письма
|
Название |
Описание |
|
id |
ID письма |
|
taskId |
ID задачи |
|
mailboxId |
ID почтового ящика |
|
title |
Название письма |
|
body |
Тело письма |
|
from |
Отправитель письма |
|
dateTs |
Таймстамп отправки письма |
|
link |
Ссылка на письмо |
Объект учета времени
|
Название |
Описание |
|
id |
Идентификатор записи учета времени |
|
userId |
Пользователь |
|
taskId |
Задача |
|
minutes |
Минуты |
|
seconds |
Секунды |
|
source |
Откуда взялась запись учета времени. Возможные значения:
|
|
text |
Комментарий |
|
createdAtTs |
Дата создания |
|
startTs |
Время старта |
|
stopTs |
Время завершения |
Объект источника
|
Название |
Описание |
|
type |
Тип источника. Возможное значение — |
|
data |
Данные источника |