Task Fields in REST 3.0
In the section Task Object, all task fields are described, while other sections cover the fields of related objects. Some task fields are available as both an identifier number and as an object, for example, creatorId and creator. Use the identifier field in the methods for creating and updating a task. Use the object field in the method for getting a task. Instructions on how to work with the fields of related objects are described in the article Overview of REST API 3.0.
The rights to write and modify fields depend on the user's role in the task, group permission settings, employee hierarchy, task status, and certain flags in the task, such as allowChangeDeadline.
Task Object
|
Name |
Description |
|
id |
Task identifier |
|
title |
Task title, a required field for creating a task |
|
description |
Task description |
|
creatorId |
Creator identifier, a required field for creating a task |
|
creator |
Creator. An object of type user. Use for data requests in the |
|
created |
Creation date in ISO-8601 format |
|
responsibleId |
Assignee identifier, a required field for creating a task |
|
responsible |
Assignee. An object of type user. Use for data requests in the |
|
deadline |
Deadline in ISO-8601 format, for example, |
|
needsControl |
Task control by the creator. Possible values: |
|
startPlan |
Planned start date in ISO-8601 format, for example, |
|
endPlan |
Planned end date in ISO-8601 format, for example, |
|
checklist |
Identifiers of checklist items. To work with checklists, use the methods task.checklistitem.* |
|
groupId |
Group/project identifier. To work with groups, use the methods sonet_group.* |
|
group |
Group/project. An object of type group. Use for data requests in the |
|
stageId |
Stage identifier. Use if the task is in a group/project |
|
stage |
Stage. An object of type stage. Use for data requests in the |
|
epicId |
Epic identifier. To work with epics, use the methods tasks.api.scrum.epic.* |
|
storyPoints |
Story points. To update a Scrum task, use the method tasks.api.scrum.task.update |
|
flowId |
Flow identifier. To work with flows, use the methods tasks.flow.Flow.* |
|
flow |
Flow. An object of type flow. Use for data requests in the |
|
priority |
Task priority. Possible values:
|
|
status |
Task status. Possible values:
|
|
statusChanged |
Status change date in ISO 8601 format |
|
accomplices |
List of user identifiers — participants in the methods for creating or updating a task. |
|
auditors |
List of user identifiers — auditors of the task in the methods for creating or updating a task. |
|
parentId |
Parent task identifier. |
|
parent |
Parent task. An object of type task. Use for data requests in the |
|
containsChecklist |
Indicates the presence of a checklist. The field is automatically updated |
|
containsSubTasks |
Indicates the presence of subtasks. The field is automatically updated |
|
containsRelatedTasks |
Indicates the presence of related tasks. The field is automatically updated |
|
containsGanttLinks |
Indicates the presence of Gantt links. The field is automatically updated |
|
containsPlacements |
Indicates the presence of integrations. The field is automatically updated |
|
containsResults |
Indicates the presence of results. The field is automatically updated |
|
numberOfReminders |
Number of reminders for the task. The field is automatically updated |
|
chatId |
Task chat identifier. To work with the task chat, use the methods im.message.* |
|
chat |
Task chat. An object of type task chat. Use for data requests in the |
|
plannedDuration |
Planned duration |
|
actualDuration |
Actual duration |
|
durationType |
Unit of planned duration. Possible values: |
|
started |
Start date of execution in ISO 8601 format |
|
estimatedTime |
Time estimate in seconds |
|
replicate |
Indicates a recurring task. Possible values:
|
|
changed |
Change date in ISO 8601 format |
|
changedById |
Identifier of the user who changed the task |
|
changedBy |
Who changed. An object of type user. Use for data requests in the |
|
statusChangedById |
Identifier of the user who changed the status |
|
statusChangedBy |
Who changed the status. An object of type user. Use for data requests in the |
|
closedById |
Identifier of the user who closed the task |
|
closedBy |
Who closed. An object of type user. Use for data requests in the |
|
closed |
Closing date in ISO 8601 format |
|
activity |
Date of last activity in ISO 8601 format |
|
guid |
Task |
|
xmlId |
External identifier |
|
exchangeId |
Exchange identifier |
|
exchangeModified |
Date of modification in Exchange |
|
outlookVersion |
Version of synchronization with Outlook |
|
mark |
Task rating. Possible values: |
|
allowsChangeDeadline |
Allowed to change the deadline. Possible values:
|
|
allowsTimeTracking |
Time tracking enabled for the task. Possible values:
|
|
matchesWorkTime |
Consider working hours. Possible values:
|
|
addInReport |
Add to report. Possible values:
|
|
isMultitask |
Indicates "base task with subtasks". Possible values:
|
|
siteId |
Site identifier |
|
forkedByTemplateId |
Identifier of the template if the task was created from a template |
|
forkedByTemplate |
Task template. An object of type template. Use for data requests in the |
|
maxDeadlineChangeDate |
Date after which the deadline cannot be changed, in ISO 8601 format |
|
maxDeadlineChanges |
Maximum number of deadline extensions |
|
requireDeadlineChangeReason |
Require a reason when changing the deadline. Possible values:
|
|
link |
Link to the task |
|
rights |
Array of actions that the user can perform with the task |
|
archiveLink |
Link to the archive for downloading all task files |
|
crmItemIds |
Array of identifiers of related CRM objects in the format:
|
|
emailId |
Identifier of the email from which the task was created |
|
email |
Email from which the task was created. An object of type email. Use for data requests in the |
|
elapsedTime |
Time tracking. An object of type time tracking. Use for data requests in the |
|
requireResult |
Require a result. Possible values:
|
|
matchesSubTasksTime |
Consider subtasks deadlines. Possible values:
|
|
autocompleteSubTasks |
Auto-completion of subtasks. Possible values:
|
|
allowsChangeDatePlan |
Allowed to change planned dates. Possible values:
|
|
inFavorite |
Indicates "in favorites". The field returns an array containing the ID of the current user if their setting is active |
|
inPin |
Indicates "task pinned". The field returns an array containing the ID of the current user if their setting is active |
|
inGroupPin |
Indicates "task pinned in group". The field returns an array containing the ID of the current user if their setting is active |
|
inMute |
Indicates "mute". The field returns an array containing the ID of the current user if their setting is active |
|
source |
Source of the task. An object source. Use for data requests in the |
|
dependsOn |
Dependencies on tasks |
|
scenarios |
Task creation scenario. Possible values:
|
User Object
|
Name |
Description |
|
id |
User identifier |
|
name |
User name |
|
role |
User role |
|
image |
An object of type file. Use for data requests in the |
|
gender |
Gender |
|
email |
|
|
externalAuthId |
External auth ID |
|
rights |
User rights |
File Object
|
Name |
Description |
|
id |
File identifier |
|
src |
Link to the file |
|
name |
File name |
|
width |
Width |
|
height |
Height |
|
size |
Size |
|
subDir |
Subdirectory |
|
contentType |
MIME type |
|
file |
File data |
Group Object
|
Name |
Description |
|
id |
Group identifier |
|
name |
Group name |
|
image |
An object of type file. Use for data requests in the |
|
type |
Group type |
|
isVisible |
Visibility indicator |
Stage Object
|
Name |
Description |
|
id |
Stage identifier |
|
title |
Stage title |
|
color |
Stage color |
Flow Object
|
Name |
Description |
|
id |
Flow identifier |
|
name |
Flow name |
Task Chat Object
|
Name |
Description |
|
id |
Chat element identifier |
|
entityId |
Chat object identifier |
|
entityType |
Chat object type |
Task Template Object
|
Name |
Description |
|
id |
Template identifier |
|
task |
An object of type task. Use for data requests in the |
|
title |
Title |
|
description |
Description |
|
creator |
An object of type user. Use for data requests in the |
|
responsibleCollection |
Collection of responsible persons |
|
deadlineAfterTs |
Deadline shift |
|
startDatePlanTs |
Planned start date |
|
endDatePlanTs |
Planned end date |
|
replicate |
Task repetition from the template |
|
checklist |
Array of checklist item identifiers |
|
group |
An object of type group. Use for data requests in the |
|
priority |
Priority |
|
accomplices |
Participants |
|
auditors |
Auditors |
|
parent |
Parent template. An object of type task template |
|
replicateParams |
An object of replication parameters. Use for data requests in the |
Template Replication Parameters Object
|
Name |
Description |
|
period |
Frequency |
|
everyDay |
Every day |
|
workdayOnly |
Only working days |
|
dailyMonthInterval |
Interval in days of the month |
|
everyWeek |
Every week |
|
monthlyType |
Type of monthly repetition |
|
monthlyDayNum |
Day of the month |
|
monthlyMonthNum1 |
First month of the period |
|
monthlyWeekDayNum |
Week number in the month |
|
monthlyWeekDay |
Day of the week |
|
monthlyMonthNum2 |
Second month of the period |
|
yearlyType |
Type of yearly repetition |
|
yearlyDayNum |
Day of the month for yearly repetition |
|
yearlyMonth1 |
First month of yearly repetition |
|
yearlyWeekDayNum |
Week number for yearly repetition |
|
yearlyWeekDay |
Day of the week for yearly repetition |
|
yearlyMonth2 |
Second month of yearly repetition |
|
time |
Time |
|
timezoneOffset |
Timezone offset |
|
startDate |
Start date of repetition |
|
repeatTill |
Until what date to repeat |
|
endDate |
End date of repetition |
|
times |
Number of repetitions |
Email Object
|
Name |
Description |
|
id |
Email ID |
|
taskId |
Task ID |
|
mailboxId |
Mailbox ID |
|
title |
Email title |
|
body |
Email body |
|
from |
Email sender |
|
dateTs |
Email sending timestamp |
|
link |
Link to the email |
Time Tracking Object
|
Name |
Description |
|
id |
Time tracking record identifier |
|
userId |
User |
|
taskId |
Task |
|
minutes |
Minutes |
|
seconds |
Seconds |
|
source |
Source |
|
text |
Comment |
|
createdAtTs |
Creation date |
|
startTs |
Start time |
|
stopTs |
End time |
Source Object
|
Name |
Description |
|
type |
Source type |
|
data |
Source data |