DocumentHistoryItem

Событие в истории документа.

message DocumentHistoryItem {
    enum EventType {
        Unknown = 0;
        CreatedFromTemplate = 1;
        OutOfWorkflowUniversalMessageAdded = 2;
        WillBeSentTo = 3;
        Sent = 4;
        Received = 5;
        TtGisFixationCancellationSigned = 6;
        RoamingDeliveryError = 7;
        Signed = 8;
        PartiallySigned = 9;
        Rejected = 10;
        ReceiptSent = 11;
        ApprovedWithSignature = 12;
        AmendmentRequested = 13;
        RevokedUnilaterally = 14;
        RevokedForcibly = 15;
        RevocationRequested = 16;
        RevocationAccepted = 17;
        RevocationRejected = 18;
        ResolutionRouteActions = 19;
        MoveToDepartmentResolutionRoute = 20;
        ResolutionRequested = 21;
        ResolutionRequestCancelled = 22;
        SignatureRequestDenied = 23;
        Resolved = 24;
        ResolutionRouteAssigned = 25;
        ResolutionRouteRemoved = 26;
        Moved = 27;
        Deleted = 28;
        Restored = 29;
        Edited = 30;
        Forwarded = 31;
        TagsChanged = 32;
        AmendmentSent = 33;
        OuterDocflowChanged = 34;
        TransformedTo = 35;
        DocumentTemplateRefused = 36;
        TemplateRefused = 37;
    }

    optional Timestamp OccurredAt = 1;
    optional DocumentHistoryItemCategory Category = 2;
    optional EventType Type = 3;
    required string BoxId = 4;
    optional HistoryAuthor Author = 5;
    optional string DepartmentId = 6;
    optional DocumentHistoryItemPayload Payload = 7;
}

  • OccurredAt — время события, представленное структурой Timestamp.

  • Category — категория события, принимает значения из перечисления DocumentHistoryItemCategory.

  • Type — тип события, принимает значения из перечисления EventType:

    • Unknown — неизвестное значение;

    • CreatedFromTemplate — документ создан из шаблона;

    • OutOfWorkflowUniversalMessageAdded — добавлено универсальное сообщение, не влияющее на статус документооборота;

    • WillBeSentTo — документ будет отправлен указанным участникам;

    • Sent — документ отправлен;

    • Received — документ получен;

    • TtGisFixationCancellationSigned — подписан документ для отмены сведений об отгрузке маркированных товаров;

    • RoamingDeliveryError — ошибка доставки в роуминге;

    • Signed — документ подписан;

    • PartiallySigned — документ подписан частично;

    • Rejected — в подписании отказано;

    • ReceiptSent — отправлено извещение о получении;

    • ApprovedWithSignature — документ подписан согласующей подписью;

    • AmendmentRequested — запрошено уточнение;

    • RevokedUnilaterally — документ аннулирован в одностороннем порядке;

    • RevokedForcibly — документ аннулирован принудительно;

    • RevocationRequested — отправлено предложение об аннулировании;

    • RevocationAccepted — предложение об аннулировании принято;

    • RevocationRejected — в предложении об аннулировании отказано;

    • ResolutionRouteActions — действия по маршруту согласования;

    • MoveToDepartmentResolutionRoute — перемещение в подразделение по маршруту согласования;

    • ResolutionRequested — запрошено согласование документа или запрос на аннулирование;

    • ResolutionRequestCancelled — запрос на согласование документа или запрос на аннулирование отменен;

    • SignatureRequestDenied — отказано в запросе подписи;

    • Resolved — выполнено согласование документа или запроса на аннулирование;

    • ResolutionRouteAssigned — назначен маршрут согласования;

    • ResolutionRouteRemoved — снят маршрут согласования;

    • Moved — документ перемещен;

    • Deleted — документ отмечен как удаленный;

    • Restored — документ восстановлен из удаленных;

    • Edited — документ отредактирован;

    • Forwarded — документ переслан;

    • TagsChanged — изменены теги документа;

    • AmendmentSent — отправлено уточнение;

    • OuterDocflowChanged — изменились параметры внешнего документооборота;

    • TransformedTo — шаблон преобразован в документ;

    • DocumentTemplateRefused — отказ от шаблона документа;

    • TemplateRefused — отказ от шаблона.

  • BoxId — идентификатор ящика, в контексте которого произошло событие.

  • Author — автор события, представленный структурой HistoryAuthor.

  • DepartmentId — идентификатор подразделения.

  • Payload — дополнительные данные события, представленные структурой DocumentHistoryItemPayload. Заполняется поле, которое соответствует значению Type. Для событий Deleted и Restored поле не заполняется.

См. также

Структура используется: