Interface IOperation

Операция.

interface IOperation {
    completed: null | string;
    created: string;
    createdById: string;
    creationFlags: OperationCreationFlags;
    digest: null | string;
    hash: null | string;
    id: string;
    inProgress: null | string;
    objectId: null | string;
    postponed: null | string;
    progress: null | number;
    request: null | OperationRequest;
    response: null | OperationResponse;
    sessionId: string;
    state: OperationState;
    typeId: string;
}

Implemented by

Properties

completed created createdById creationFlags digest hash id inProgress objectId postponed progress request response sessionId state typeId

Properties

Readonlycompleted

completed: null | string

Дата и время окончания операции в UTC или null, если операция ещё не завершена.

Readonlycreated

created: string

Дата и время создания операции в UTC.

ReadonlycreatedById

createdById: string

Идентификатор пользователя, создавшего запрос на операцию.

ReadonlycreationFlags

creationFlags: OperationCreationFlags

Флаги, описывающие созданную операцию.

Readonlydigest

digest: null | string

Краткое описание операции.

Readonlyhash

hash: null | string

Хеш, посчитанный для типа операции typeId, для объекта objectId и для данных в запросе request, или null, если хеш не был рассчитан для этой операции (операция создана в предыдущих версиях системы).

Для расчёта обычно используется функция хеширования HMAC-SHA256, размер хеша в которой 256 бит или 32 байта.

Расчёт выполняется автоматически в момент создания операции. Заполнять поле вручную не рекомендуется.

Readonlyid

id: string

Идентификатор операции.

ReadonlyinProgress

inProgress: null | string

Дата и время начала выполнения операции в UTC или null, если выполнение операции ещё не начато.

ReadonlyobjectId

objectId: null | string

Идентификатор объекта, с которым связана операция (обычно это идентификатор карточки или файла). Может быть не указан. Влияет на расчёт хеша hash.

Readonlypostponed

postponed: null | string

Дата и время, до наступления которого операция отложена, или null, если операция не отложена.

Readonlyprogress

progress: null | number

Процент выполнения операции от 0 до 100 или null, если операция не сообщает процент своей готовности.

Readonlyrequest

request: null | OperationRequest

Запрос на выполнение операции или null, если для выполнения операции не требуется запрос.

Readonlyresponse

response: null | OperationResponse

Результат выполнения операции или null, если операция ещё не завершена или для операции недоступна информация о результате.

ReadonlysessionId

sessionId: string

Идентификатор сессии, в рамках которой была создана операция.

Readonlystate

state: OperationState

Состояние операции.

ReadonlytypeId

typeId: string

Идентификатор типа операции. Должен быть добавлен в таблицу-перечисление OperationTypes.

Settings

Member Visibility

On This Page

Properties