Documentation

ItemHistoryTable

Description and methods

ORM class object for handling item update history.

ORM object.


Chain of inheritance

Descendant of class Bitrix\Main\ORM\Data\DataManager.

Methods

Method Description Available from version
public static function getListByItem(int $typeId, int $itemId): EO_ItemHistory_Collection Returns collection of item update objects.
public static function removeForItem(int $typeId, int $itemId): Result Deletes all table records associated with item $itemId of process $typeId. Returns object Bitrix\Main\Result.
public static function removeByTypeId(int $typeId): Result Deletes all table records associated with the process $typeId. Returns object Bitrix\Main\Result.
public static function getScopePossibleValues(): array Returns array of available values for the field SCOPE

[
    'manual',
    'task',
    'automation',
    'rest',
];

Table fields

Field Description Type Req.
ID Identifier.Int Yes
TYPE_ID Process ID.Int Да
ITEM_ID Item ID.Int Да
STAGE_ID Item stage ID before the update.Int
NEW_STAGE_ID New stage ID for the moved item. Empty when stage didn't change.Int
CREATED_TIME Created record time.Int Yes
USER_ID User ID who perform the update.Int
ACTION Update string ID.String
SCOPE Updated scope string ID. Contains one of two options:
  1. manual updated by user via interface;
  2. task updated while completing task;
  3. automation automation rule/activity performed the update;
  4. restapplication/webhook performed the update.
String Yes
TASK_ID Ongoing Task ID when performing the update.Int

Additionally, separate table stores array of updated user field codes.



© «Bitrix24», 2001-2022
Up