Task Fields
The recording and modification of fields are carried out according to business logic and user permissions. This means it depends on the user's role, group permission settings, hierarchy, task status, and certain flags in the task, such as allowChangeDeadline.
|
Name |
Description |
|
|
id |
Task identifier |
|
|
parentId |
Identifier of the parent task. It is |
|
|
title |
Task title |
|
|
description |
Task description |
|
|
chatId |
Identifier of the chat for the new task card |
|
|
mark |
Task rating. Possible values: |
|
|
priority |
Task priority. Possible values:
|
|
|
multitask |
Indicator of "base task with subtasks." Possible values:
|
|
|
notViewed |
Indicator of "not viewed." Possible values:
|
|
|
replicate |
Indicator of "repeat task." Possible values:
|
|
|
stageId |
Stage identifier |
|
|
sprintId |
Sprint identifier |
|
|
backlogId |
Backlog identifier |
|
|
createdBy |
Identifier of the Creator |
|
|
createdDate |
Creation date in |
|
|
responsibleId |
Identifier of the responsible person |
|
|
changedBy |
Identifier of the user who modified the task |
|
|
changedDate |
Modification date in |
|
|
statusChangedBy |
Identifier of the user who changed the task status |
|
|
closedBy |
Identifier of the user who completed the task. It is |
|
|
closedDate |
Completion date in |
|
|
activityDate |
Date of the last activity in |
|
|
dateStart |
Start date |
|
|
deadline |
Deadline |
|
|
startDatePlan |
Planned start date |
|
|
endDatePlan |
Planned end date |
|
|
guid |
Task |
|
|
xmlId |
External identifier |
|
|
commentsCount |
Number of comments |
|
|
serviceCommentsCount |
Number of system comments |
|
|
allowChangeDeadline |
Allowed to change the deadline. Possible values:
|
|
|
allowTimeTracking |
Allowed to track time. Possible values:
|
|
|
taskControl |
Task control is enabled. Possible values:
|
|
|
addInReport |
Add to report. Possible values:
|
|
|
forkedByTemplateId |
Identifier of the template if the task was created from a template |
|
|
timeEstimate |
Time estimate in seconds |
|
|
timeSpentInLogs |
Actual time spent |
|
|
matchWorkTime |
Consider working time. Possible values:
|
|
|
forumTopicId |
Identifier of the comment topic |
|
|
forumId |
Identifier of the forum |
|
|
siteId |
Identifier of the site |
|
|
subordinate |
Indicator that the task is a subtask. Possible values:
|
|
|
exchangeModified |
Date of modification by synchronization in |
|
|
exchangeId |
Synchronization identifier |
|
|
outlookVersion |
Version |
|
|
viewedDate |
Date the task was viewed in |
|
|
sorting |
Sorting value |
|
|
durationFact |
Actual duration |
|
|
isMuted |
Indicator of "muted." Possible values:
|
|
|
isPinned |
Indicator of "pinned." Possible values:
|
|
|
isPinnedInGroup |
Indicator of "pinned in group." Possible values:
|
|
|
flowId |
Flow identifier |
|
|
descriptionInBbcode |
Description in BBCode format. Possible values:
|
|
|
status |
Task status. Possible values:
|
|
|
statusChangedDate |
Date of status change in |
|
|
durationPlan |
Planned duration |
|
|
durationType |
Unit of planned duration. Possible values: |
|
|
favorite |
Indicator of "favorite." Possible values:
|
|
|
groupId |
Identifier of the group to which the task is linked |
|
|
auditors |
List of user identifiers — task observers |
|
|
accomplices |
List of user identifiers — Participants |
|
|
checklist |
Object with checklist items. Key — item identifier, value — object with item description |
|
|
group |
Object with group description |
|
|
creator |
Object with user description — Creator of the task |
|
|
responsible |
Object with user description — responsible for the task |
|
|
accomplicesData |
Object with descriptions of users — Participants. The key of the object is the user identifier, and the value is the object with user description |
|
|
auditorsData |
Object with descriptions of users — task observers. The key of the object is the user identifier, and the value is the object with user description |
|
|
newCommentsCount |
Number of new comments |
|
|
action |
Object with available actions for the task |
|
|
checkListTree |
Object with checklist tree description |
|
|
checkListCanAdd |
Can checklist items be added |
|
|
ufCrmTask |
List of links to CRM entities in the format:
|
|
|
ufTaskWebdavFiles |
List of files from Drive |
|
|
ufMailMessage |
E-mail message |
|
|
UF_* |
Custom fields. More details in the article Custom Fields in Tasks: Overview of Methods |
To retrieve custom fields of the task, use the selection methods tasks.task.get and tasks.task.list. Specify the required fields in the SELECT parameter.
System fields UF_CRM_TASK, UF_TASK_WEBDAV_FILES, and UF_MAIL_MESSAGE are not returned by default. Specify one of these fields in SELECT — all three will be returned. In the response, the fields are returned in camelCase: ufCrmTask, ufTaskWebdavFiles, ufMailMessage.
Object checklist.item
|
Name |
Description |
|
id |
Item identifier |
|
taskId |
Task identifier |
|
createdBy |
Identifier of the item author |
|
parentId |
Parent item. A value of |
|
title |
Item title |
|
sortIndex |
Sorting index |
|
isComplete |
Completion indicator. Possible values:
|
|
isImportant |
Importance indicator. Possible values:
|
|
toggledBy |
Identifier of the user who changed the item's status |
|
toggledDate |
Date of status change in |
|
ufChecklistFiles |
Indicator of the presence of files in the item |
|
members |
List of item participants |
|
attachments |
List of item attachments |
|
entityId |
Task identifier |
|
action |
Object with available actions for the item |
Object checklist.item.action
|
Name |
Description |
|
modify |
Modification of the item is available |
|
remove |
Removal of the item is available |
|
toggle |
Toggling the item's status is available |
|
add |
Adding a sub-item is available |
|
addAccomplice |
Adding a Participant to the item is available |
Object group
|
Name |
Description |
|
id |
Group identifier |
|
name |
Group name |
|
opened |
Indicator of an open group |
|
membersCount |
Number of group members |
|
image |
URL of the group image |
|
additionalData |
Additional data of the group |
Object with user description
|
Name |
Description |
|
id |
User identifier |
|
name |
User's first and last name |
|
link |
Link to the user's profile |
|
icon |
URL of the user's avatar |
|
workPosition |
User's position |
Object action
|
Name |
Description |
|
accept |
Accepting the task is available. Deprecated field, no longer used |
|
decline |
Declining the task is available. Deprecated field, no longer used |
|
complete |
Completing the task is available |
|
approve |
Approving the contractor's work on the task is available when |
|
disapprove |
Indicating what the contractor needs to finish on the task is available when |
|
start |
Starting execution is available |
|
pause |
Pausing execution is available |
|
delegate |
Delegation is available |
|
remove |
Task removal is available |
|
edit |
Editing is available |
|
defer |
Deferring the task is available |
|
renew |
Resuming is available |
|
create |
Creating related tasks is available |
|
changeDeadline |
Changing the deadline is available |
|
checklistAddItems |
Adding checklist items is available |
|
addFavorite |
Adding to favorites is available |
|
deleteFavorite |
Removing from favorites is available |
|
rate |
Rating is available |
|
take |
Taking the task for work is available |
|
edit.originator |
Editing the Creator is available |
|
checklist.reorder |
Changing the order of checklist items is available |
|
elapsedtime.add |
Adding time spent is available |
|
dayplan.timer.toggle |
Controlling the timer in the daily plan is available |
|
edit.plan |
Editing planned parameters is available |
|
checklist.add |
Adding a checklist is available |
|
favorite.add |
Adding to favorites is available |
|
favorite.delete |
Removing from favorites is available |
Object checkListTree
|
Name |
Description |
|
nodeId |
Identifier of the root node of the checklist tree |
|
fields |
Object with description of node fields |
|
action |
Array of available actions for the node |
|
descendants |
Array of child nodes |
Object checkListTree.fields
|
Name |
Description |
|
id |
Identifier of the item for the root |
|
copiedId |
Identifier of the source when copying |
|
entityId |
Task identifier |
|
userId |
Identifier of the user forming the tree |
|
createdBy |
Identifier of the item author |
|
parentId |
Identifier of the parent |
|
title |
Title of the item |
|
sortIndex |
Sorting index |
|
displaySortIndex |
Displayed sorting index |
|
isComplete |
Indicator of item completion |
|
isImportant |
Indicator of item importance |
|
completedCount |
Number of completed sub-items |
|
members |
Array of item participants |
|
attachments |
Array of item attachments |
|
nodeId |
Node identifier |