Documentation

List of fields

Allowed fields

Name Description Read Write*
TITLE Specifies the task name. + +
DESCRIPTION Specifies the task description. + +
DEADLINE Specifies the task deadline date. + +
START_DATE_PLAN Specifies the date when the task is scheduled to start. + +
END_DATE_PLAN Specifies the date when the task is planned to be finished. + +
PRIORITY Determines the task priority level. + +
ACCOMPLICES Contains the user ID's of persons involved in the task (shown in the user interface as participants). + +
AUDITORS Contains the user ID's of persons who were set to monitor task progress and results (shown in the user interface as observers). + +
TAGS Contains tags assigned to the task. To set multiple tags for a task, specify them as space separated words (plain text).

The CTasks::GetList method does not return the TAGS field.

The call CTaskItem::getInstance()->getTags() will return an array of the tag names.

+ +
ALLOW_CHANGE_DEADLINE A boolean (Y/N) value which, if set to "Y", specifies that a responsible person associated with the task is allowed to shift the deadline date. + +
TASK_CONTROL A boolean (Y/N) value which, if set to "Y", specifies that the task result needs to be approved by a creator. Otherwise, the task will auto close once marked as completed.  + +
PARENT_ID Specifies the ID of a parent task. + +
DEPENDS_ON Specifies the ID of a task that needs to be completed prior to this one. + +
GROUP_ID Specifies the ID of a workgroup to which this task relates. + +
RESPONSIBLE_ID The user ID of a person to whom the task is assigned. + +
TIME_ESTIMATE Specifies a time estimate for the task.  + +
ID The current task ID. The identifier is unique across the database. +
CREATED_BY Specifies the user ID of a person who created the task. + +
DESCRIPTION_IN_BBCODE A boolean (Y/N) value which, if set to "Y", specifies that the task description includes BB codes. +
DECLINE_REASON A text description of the reason for rejecting the task. + +
REAL_STATUS Determines the task's real status set using the STATUS field (see CTasks::STATE_xxx). This field is read-only. +
STATUS Use this field to set the meta status for a task.

To set this field, use the CTasks::STATE_xxx constants. However, this field may return one of the CTasks::METASTATE_xxx values.

For example, if a task had never been started and became overdue, this field will return CTasks::METASTATE_EXPIRED, while the real status is CTasks::STATE_NEW returned by the REAL_STATUS field.

+ +
RESPONSIBLE_NAME Contains the first name of a person to whom the task is assigned (a responsible person). +
RESPONSIBLE_LAST_NAME The last name of the task's responsible person. +
RESPONSIBLE_SECOND_NAME The second name of the task's responsible person. +
DATE_START Specifies the date the task was started. +
DURATION_FACT Specifies the time required to complete the task, in minutes. +
CREATED_BY_NAME Contains the first name of a person who created the task. +
CREATED_BY_LAST_NAME The last name of the task creator. +
CREATED_BY_SECOND_NAME The second name of the task creator. +
CREATED_DATE Specifies the date the task was created. +
CHANGED_BY The user ID of a person who last updated the task. +
CHANGED_DATE Specifies the date the task was last updated. +
STATUS_CHANGED_BY The user ID of a person who changed the task status. +
STATUS_CHANGED_DATE Specifies the date the task status was changed. +
CLOSED_BY The user ID of a person who completed the task. +
CLOSED_DATE Specifies the date the task was completed. +
GUID A GUID (globally unique identifier) associated with the task. It can be said, with a fair amount of confidence, that this identifier will always remain unique across multiple databases. +
MARK The rating score given by a task creator. + +
VIEWED_DATE Contains the date the task was last viewed in the public area by a currently logged in user. +
TIME_SPENT_IN_LOGS Specifies the actual time spent for the task, in seconds. +
XML_ID Specifies the task external ID. + +
ALLOW_TIME_TRACKING A boolean (Y/N) value which, if set to "Y", specifies that the system keeps tracking of the time spent for the task. + +
ADD_IN_REPORT A boolean (Y/N) value which, if set to "Y", includes the task in the performance report. + +
FORUM_ID Specifies the ID of the forum containing comments to the task. + +
FORUM_TOPIC_ID Specifies the ID of the forum topic containing comments to the task. + +
COMMENTS_COUNT Contains the number of forum comments.  +
SITE_ID Specifies the ID of the site on which the task was created. + +
SUBORDINATE A boolean (Y/N) value which, if set to "Y", specifies that at least one of the task participants is subordinate to a current user. +
FORKED_BY_TEMPLATE_ID Contains the ID of a template used to create the task. This field may be empty for tasks created in outdated versions. +

Notice: the task fields are updated according to the business logic and the current user's permissions depending on the user role, workgroup access permissions, organizational hierarchy, task flags (e.g.  ALLOW_CHANGE_DEADLINE) and the task status.

Date and Time Fields in ISO 8601 Format

Name
DEADLINE
START_DATE_PLAN
END_DATE_PLAN
DATE_START
CREATED_DATE
CLOSED_DATE
CHANGED_DATE
STATUS_CHANGED_DATE
VIEWED_DATE

User Comments

User comments are not part of official documentation. Use information provided by other users in the comments at your own risk.

The User Comments section is not to be used as a feature discussion board. Only registered users can post comments. Your comment will be visible once it has been approved by the moderator.
© «Bitrix Inc.», 2001-2017, «Bitrix Inc.», 2017