DocumentHistoryItemPayload

Дополнительные данные события в истории документа.

В структуре заполняется только то поле, которое соответствует типу события из поля Type структуры DocumentHistoryItem. Остальные поля не заполняются. Для событий Deleted и Restored структура не заполняется.

message DocumentHistoryItemPayload {
    optional CreatedFromTemplatePayload CreatedFromTemplate = 1;
    optional OutOfWorkflowUniversalMessageAddedPayload OutOfWorkflowUniversalMessageAdded = 2;
    optional WillBeSentToPayload WillBeSentTo = 3;
    optional SentPayload Sent = 4;
    optional ReceivedPayload Received = 5;
    optional TtGisFixationCancellationSignedPayload TtGisFixationCancellationSigned = 6;
    optional RoamingDeliveryErrorPayload RoamingDeliveryError = 7;
    optional SignedPayload Signed = 8;
    optional PartiallySignedPayload PartiallySigned = 9;
    optional RejectedPayload Rejected = 10;
    optional ReceiptSentPayload ReceiptSent = 11;
    optional ApprovedWithSignaturePayload ApprovedWithSignature = 12;
    optional AmendmentRequestedPayload AmendmentRequested = 13;
    optional RevokedPayload RevokedUnilaterally = 14;
    optional RevokedPayload RevokedForcibly = 15;
    optional RevocationRequestedPayload RevocationRequested = 16;
    optional RevocationAcceptedPayload RevocationAccepted = 17;
    optional RevocationRejectedPayload RevocationRejected = 18;
    optional ResolutionRouteActionsPayload ResolutionRouteActions = 19;
    optional MoveToDepartmentResolutionRoutePayload MoveToDepartmentResolutionRoute = 20;
    optional ResolutionRequestedPayload ResolutionRequested = 21;
    optional ResolutionRequestCancelledPayload ResolutionRequestCancelled = 22;
    optional SignatureRequestDeniedPayload SignatureRequestDenied = 23;
    optional ResolvedPayload Resolved = 24;
    optional ResolutionRouteAssignedPayload ResolutionRouteAssigned = 25;
    optional ResolutionRouteRemovedPayload ResolutionRouteRemoved = 26;
    optional MovedPayload Moved = 27;
    optional EditedPayload Edited = 30;
    optional ForwardedPayload Forwarded = 31;
    optional TagsChangedPayload TagsChanged = 32;
    optional AmendmentSentPayload AmendmentSent = 33;
    optional OuterDocflowChangedPayload OuterDocflowChanged = 34;
    optional TransformedToPayload TransformedTo = 35;
    optional DocumentTemplateRefusedPayload DocumentTemplateRefused = 36;
    optional TemplateRefusedPayload TemplateRefused = 37;
}

message CreatedFromTemplatePayload {
    optional DocumentId TemplateDocumentId = 1;
}

message OutOfWorkflowUniversalMessageAddedPayload {
    optional UniversalMessageInfo MessageInfo = 1;
    optional int32 TitleIndex = 2;
    optional string TitleEntityId = 3;
    optional Entity MessageEntity = 4;
}

message WillBeSentToPayload {
    repeated DocumentParticipantV2 Participants = 1;
    optional Entity CommentEntity = 2;
}

message SentPayload {
    optional SignatureV3 Signature = 1;
    optional Entity CommentEntity = 2;
}

message ReceivedPayload {
    repeated DocumentParticipantV2 Recipients = 1;
    optional int32 TitleIndex = 2;
    optional string TitleEntityId = 3;
}

message TtGisFixationCancellationSignedPayload {
    optional SignatureV3 Signature = 1;
    optional Entity CancellationRequestEntity = 2;
}

message RoamingDeliveryErrorPayload {
    optional string NotificationId = 1;
    optional string ErrorText = 2;
}

message SignedPayload {
    optional SignatureV3 Signature = 1;
    optional int32 TitleIndex = 2;
    optional string TitleEntityId = 3;
    optional DocumentParticipantV2 SignedBy = 4;
}

message PartiallySignedPayload {
    optional SignatureV3 Signature = 1;
    optional int32 TitleIndex = 2;
    optional string TitleEntityId = 3;
    optional DocumentParticipantV2 SignedBy = 4;
}

message RejectedPayload {
    optional SignedAttachmentV3 Rejection = 1;
    optional int32 TitleIndex = 2;
    optional string TitleEntityId = 3;
    optional UniversalMessageInfo UniversalMessage = 4;
    optional DocumentParticipantV2 RejectedBy = 5;
    optional string PlainText = 6;
}

message ReceiptSentPayload {
    optional SignedAttachmentV3 Receipt = 1;
    optional int32 TitleIndex = 2;
    optional string TitleEntityId = 3;
    optional UniversalMessageInfo UniversalMessage = 4;
    optional DocumentParticipantV2 ReceiptSentBy = 5;
}

message ApprovedWithSignaturePayload {
    optional SignatureV3 Signature = 1;
    optional HistoryParentEntity Parent = 2;
    optional string ResolutionRequestId = 3;
}

message AmendmentRequestedPayload {
    optional SignedAttachmentV3 AmendmentRequest = 1;
    optional UniversalMessageInfo UniversalMessage = 2;
    optional DocumentParticipantV2 AmendmentRequestedBy = 3;
    optional string PlainText = 4;
}

message AmendmentSentPayload {
    optional DocumentId AmendmentDocumentId = 1;
    optional SignatureV3 Signature = 2;
    optional DocumentTypePresentation DocumentTypePresentation = 3;
    optional Entity CommentEntity = 4;
}

message DocumentTypePresentation {
    optional string Name = 1;
    optional string NameAccusative = 2;
    optional HistoryGender Gender = 3;
}

message RevokedPayload {
    optional SignedAttachmentV3 RevocationRequest = 1;
    optional DocumentParticipantV2 RevokedBy = 2;
    optional string PlainText = 3;
}

message RevocationRequestedPayload {
    optional SignedAttachmentV3 RevocationRequest = 1;
    optional DocumentParticipantV2 RevocationRequestedBy = 2;
    optional string PlainText = 3;
}

message RevocationAcceptedPayload {
    optional SignatureV3 AcceptanceSignature = 1;
    optional DocumentParticipantV2 RevocationAcceptedBy = 2;
}

message RevocationRejectedPayload {
    optional SignedAttachmentV3 Rejection = 1;
    optional UniversalMessageInfo UniversalMessage = 2;
    optional DocumentParticipantV2 RevocationRejectedBy = 3;
    optional string PlainText = 4;
}

message ResolutionRouteActionsPayload {
    optional ResolutionTarget Target = 1;
    repeated ResolutionAction Actions = 2;
    optional HistoryParentEntity Parent = 3;
    optional sfixed64 TimeLimitTicks = 4;
}

message MoveToDepartmentResolutionRoutePayload {
    optional string TargetDepartmentId = 1;
}

message ResolutionRequestedPayload {
    optional ResolutionRequestV3 Request = 1;
    optional HistoryParentEntity Parent = 2;
    optional bool IsCancellable = 3;
}

message ResolutionRequestCancelledPayload {
    optional ResolutionRequestV3 Request = 1;
    optional Entity CancellationCommentEntity = 2;
    optional HistoryParentEntity Parent = 3;
}

message SignatureRequestDeniedPayload {
    optional SignatureDenialV3 Denial = 1;
    optional HistoryParentEntity Parent = 2;
    optional bool IsCancellable = 3;
}

message ResolvedPayload {
    optional ResolutionV3 Resolution = 1;
    optional HistoryParentEntity Parent = 2;
    optional bool IsCancellable = 3;
}

message ResolutionRouteAssignedPayload {
    optional Entity AssignmentEntity = 1;
    optional string RouteId = 2;
    optional string RouteName = 3;
    optional HistoryParentEntity Parent = 4;
    optional sfixed64 TimeLimitTicks = 5;
}

message ResolutionRouteRemovedPayload {
    optional Entity RemovalEntity = 1;
    optional string RouteId = 2;
    optional string RouteName = 3;
    optional HistoryParentEntity Parent = 4;
}

message MovedPayload {
    optional string TargetDepartmentId = 1;
}

message EditedPayload {
    optional Entity EditionEntity = 1;
}

message ForwardedPayload {
    optional string TargetBoxId = 1;
}

message TagsChangedPayload {
    repeated TagChange Added = 1;
    repeated TagChange Edited = 2;
    repeated TagChange Removed = 3;
    optional Entity CommentEntity = 4;
}

message TagChange {
    required string Key = 1;
    optional string OldValue = 2;
    optional string NewValue = 3;
}

message OuterDocflowChangedPayload {
    optional string DocflowNamedId = 1;
    optional string StatusNamedId = 2;
    optional StatusEntity StatusEntity = 3;
    optional OuterDocflowStatusPresentation Presentation = 4;
    optional HistoryParentEntity Parent = 5;
}

message OuterDocflowStatusPresentation {
    required string Name = 1;
    optional HistoryOuterDocflowSeverity Severity = 2;
    optional string HelpText = 3;
    optional string HelpUrl = 4;
    optional string Details = 5;
}

enum HistoryOuterDocflowSeverity {
    UnknownHistoryOuterDocflowSeverity = 0;
    Normal = 1;
    Success = 2;
    Warning = 3;
    ErrorSeverity = 4;
}

message TransformedToPayload {
    optional DocumentId TargetDocumentId = 1;
}

message DocumentTemplateRefusedPayload {
    optional HistoryTemplateRefusalType RefusalType = 1;
    optional DocumentId TemplateDocumentId = 2;
    optional Entity CommentEntity = 3;
}

message TemplateRefusedPayload {
    optional HistoryTemplateRefusalType RefusalType = 1;
    optional Entity CommentEntity = 2;
}

enum HistoryTemplateRefusalType {
    UnknownHistoryTemplateRefusalType = 0;
    Refusal = 1;
    Withdrawal = 2;
}

• CreatedFromTemplate — параметры создания документа из шаблона, представленные структурой CreatedFromTemplatePayload с полями:

  • TemplateDocumentId — идентификатор шаблона, представленный структурой DocumentId.

• OutOfWorkflowUniversalMessageAdded — параметры добавления универсального сообщения, не влияющего на статус документооборота, представленные структурой OutOfWorkflowUniversalMessageAddedPayload с полями:

  • MessageInfo — информация об универсальном сообщении, представленная структурой UniversalMessageInfo;

  • TitleIndex — числовой идентификатор титула, нумерация с нуля;

  • TitleEntityId — идентификатор сущности титула;

  • MessageEntity — сущность сообщения, представленная структурой Entity.

• WillBeSentTo — параметры отправки документа, представленные структурой WillBeSentToPayload с полями:

  • Participants — список участников, которым документ будет отправлен, представленных структурой DocumentParticipantV2;

  • CommentEntity — комментарий, представленный структурой Entity.

• Sent — параметры отправки документа, представленные структурой SentPayload с полями:

  • Signature — подпись, представленная структурой SignatureV3;

  • CommentEntity — комментарий, представленный структурой Entity.

• Received — параметры получения документа, представленные структурой ReceivedPayload с полями:

  • Recipients — список получателей, представленных структурой DocumentParticipantV2;

  • TitleIndex — числовой идентификатор титула, нумерация с нуля;

  • TitleEntityId — идентификатор сущности титула.

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

  • Signature — подпись, представленная структурой SignatureV3;

  • CancellationRequestEntity — сущность запроса на отмену, представленная структурой Entity.

• RoamingDeliveryError — параметры ошибки доставки в роуминге, представленные структурой RoamingDeliveryErrorPayload с полями:

  • NotificationId — идентификатор уведомления;

  • ErrorText — текст ошибки.

• Signed — параметры подписания документа, представленные структурой SignedPayload с полями:

  • Signature — подпись, представленная структурой SignatureV3;

  • TitleIndex — числовой идентификатор титула, нумерация с нуля;

  • TitleEntityId — идентификатор сущности титула;

  • SignedBy — участник, который подписал документ, представленный структурой DocumentParticipantV2.

• PartiallySigned — параметры частичного подписания документа, представленные структурой PartiallySignedPayload с полями:

  • Signature — подпись, представленная структурой SignatureV3;

  • TitleIndex — числовой идентификатор титула, нумерация с нуля;

  • TitleEntityId — идентификатор сущности титула;

  • SignedBy — участник, который подписал документ, представленный структурой DocumentParticipantV2.

• Rejected — параметры отказа в подписании, представленные структурой RejectedPayload с полями:

  • Rejection — отказ в подписи, представленный структурой SignedAttachmentV3;

  • TitleIndex — числовой идентификатор титула, нумерация с нуля;

  • TitleEntityId — идентификатор сущности титула;

  • UniversalMessage — универсальное сообщение, представленное структурой UniversalMessageInfo;

  • RejectedBy — участник, который отказал в подписи, представленный структурой DocumentParticipantV2;

  • PlainText — текст комментария.

• ReceiptSent — параметры отправки извещения о получении, представленные структурой ReceiptSentPayload с полями:

  • Receipt — извещение о получении, представленное структурой SignedAttachmentV3;

  • TitleIndex — числовой идентификатор титула, нумерация с нуля;

  • TitleEntityId — идентификатор сущности титула;

  • UniversalMessage — универсальное сообщение, представленное структурой UniversalMessageInfo;

  • ReceiptSentBy — участник, который отправил извещение, представленный структурой DocumentParticipantV2.

• ApprovedWithSignature — параметры подписания согласующей подписью, представленные структурой ApprovedWithSignaturePayload с полями:

  • Signature — подпись, представленная структурой SignatureV3;

  • Parent — родительская сущность, представленная структурой HistoryParentEntity;

  • ResolutionRequestId — идентификатор запроса на согласование документа или запроса на аннулирование.

• AmendmentRequested — параметры запроса уточнения, представленные структурой AmendmentRequestedPayload с полями:

  • AmendmentRequest — запрос уточнения, представленный структурой SignedAttachmentV3;

  • UniversalMessage — универсальное сообщение, представленное структурой UniversalMessageInfo;

  • AmendmentRequestedBy — участник, который запросил уточнение, представленный структурой DocumentParticipantV2;

  • PlainText — текст комментария.

• RevokedUnilaterally — параметры одностороннего аннулирования, представленные структурой RevokedPayload с полями:

  • RevocationRequest — запрос на аннулирование, представленный структурой SignedAttachmentV3;

  • RevokedBy — участник, который аннулировал документ, представленный структурой DocumentParticipantV2;

  • PlainText — текст комментария.

• RevokedForcibly — параметры принудительного аннулирования, представленные структурой RevokedPayload с полями:

  • RevocationRequest — запрос на аннулирование, представленный структурой SignedAttachmentV3;

  • RevokedBy — участник, который аннулировал документ, представленный структурой DocumentParticipantV2;

  • PlainText — текст комментария.

• RevocationRequested — параметры предложения об аннулировании, представленные структурой RevocationRequestedPayload с полями:

  • RevocationRequest — предложение об аннулировании, представленное структурой SignedAttachmentV3;

  • RevocationRequestedBy — участник, который отправил предложение, представленный структурой DocumentParticipantV2;

  • PlainText — текст комментария.

• RevocationAccepted — параметры принятия предложения об аннулировании, представленные структурой RevocationAcceptedPayload с полями:

  • AcceptanceSignature — подпись принятия, представленная структурой SignatureV3;

  • RevocationAcceptedBy — участник, который принял предложение, представленный структурой DocumentParticipantV2.

• RevocationRejected — параметры отказа в предложении об аннулировании, представленные структурой RevocationRejectedPayload с полями:

  • Rejection — отказ, представленный структурой SignedAttachmentV3;

  • UniversalMessage — универсальное сообщение, представленное структурой UniversalMessageInfo;

  • RevocationRejectedBy — участник, который отказал в аннулировании, представленный структурой DocumentParticipantV2;

  • PlainText — текст комментария.

• ResolutionRouteActions — параметры действий по маршруту согласования, представленные структурой ResolutionRouteActionsPayload с полями:

  • Target — получатель запроса, представленный структурой ResolutionTarget;

  • Actions — список действий, принимает значения из перечисления ResolutionAction;

  • Parent — родительская сущность, представленная структурой HistoryParentEntity;

  • TimeLimitTicks — срок в тиках (100-наносекундных интервалах).

• MoveToDepartmentResolutionRoute — параметры перемещения в подразделение по маршруту согласования, представленные структурой MoveToDepartmentResolutionRoutePayload с полями:

  • TargetDepartmentId — идентификатор подразделения, в которое перемещен документ.

• ResolutionRequested — параметры запроса на согласование документа или запроса на аннулирование, представленные структурой ResolutionRequestedPayload с полями:

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

  • Parent — родительская сущность, представленная структурой HistoryParentEntity;

  • IsCancellable — признак того, что запрос можно отменить.

• ResolutionRequestCancelled — параметры отмены запроса на согласование документа или запроса на аннулирование, представленные структурой ResolutionRequestCancelledPayload с полями:

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

  • CancellationCommentEntity — комментарий к отмене, представленный структурой Entity;

  • Parent — родительская сущность, представленная структурой HistoryParentEntity.

• SignatureRequestDenied — параметры отказа в запросе подписи, представленные структурой SignatureRequestDeniedPayload с полями:

  • Denial — отказ, представленный структурой SignatureDenialV3;

  • Parent — родительская сущность, представленная структурой HistoryParentEntity;

  • IsCancellable — признак того, что отказ можно отменить.

• Resolved — параметры согласования документа или запроса на аннулирование, представленные структурой ResolvedPayload с полями:

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

  • Parent — родительская сущность, представленная структурой HistoryParentEntity;

  • IsCancellable — признак того, что согласование документа или запроса на аннулирование можно отменить.

• ResolutionRouteAssigned — параметры назначения маршрута согласования, представленные структурой ResolutionRouteAssignedPayload с полями:

  • AssignmentEntity — сущность назначения, представленная структурой Entity;

  • RouteId — идентификатор маршрута;

  • RouteName — название маршрута;

  • Parent — родительская сущность, представленная структурой HistoryParentEntity;

  • TimeLimitTicks — срок в тиках (100-наносекундных интервалах).

• ResolutionRouteRemoved — параметры снятия маршрута согласования, представленные структурой ResolutionRouteRemovedPayload с полями:

  • RemovalEntity — сущность снятия маршрута, представленная структурой Entity;

  • RouteId — идентификатор маршрута;

  • RouteName — название маршрута;

  • Parent — родительская сущность, представленная структурой HistoryParentEntity.

• Moved — параметры перемещения документа, представленные структурой MovedPayload с полями:

  • TargetDepartmentId — идентификатор подразделения, в которое перемещен документ.

• Edited — параметры редактирования документа, представленные структурой EditedPayload с полями:

  • EditionEntity — сущность редакции, представленная структурой Entity.

• Forwarded — параметры пересылки документа, представленные структурой ForwardedPayload с полями:

  • TargetBoxId — идентификатор ящика, в который переслан документ.

• TagsChanged — параметры изменения тегов документа, представленные структурой TagsChangedPayload с полями:

  • Added — добавленные теги, представленные структурой TagChange с полями:

    • Key — ключ тега;

    • OldValue — предыдущее значение;

    • NewValue — новое значение;

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

  • Removed — удаленные теги, представленные структурой TagChange;

  • CommentEntity — комментарий, представленный структурой Entity.

• AmendmentSent — параметры отправки уточнения, представленные структурой AmendmentSentPayload с полями:

  • AmendmentDocumentId — идентификатор документа уточнения, представленный структурой DocumentId;

  • Signature — подпись, представленная структурой SignatureV3;

  • DocumentTypePresentation — представление типа документа, представленное структурой DocumentTypePresentation с полями:

    • Name — наименование;

    • NameAccusative — наименование в винительном падеже;

    • Gender — род для согласования формулировок, принимает значения из перечисления HistoryGender;

  • CommentEntity — комментарий, представленный структурой Entity.

• OuterDocflowChanged — параметры изменения внешнего документооборота, представленные структурой OuterDocflowChangedPayload с полями:

  • DocflowNamedId — строковый идентификатор внешнего документооборота;

  • StatusNamedId — строковый идентификатор статуса;

  • StatusEntity — сущность статуса, представленная структурой StatusEntity;

  • Presentation — представление статуса, представленное структурой OuterDocflowStatusPresentation с полями:

    • Name — наименование статуса;

    • Severity — уровень статуса, принимает значения из перечисления HistoryOuterDocflowSeverity:

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

      • Normal — обычный;

      • Success — успех;

      • Warning — предупреждение;

      • ErrorSeverity — ошибка;

    • HelpText — поясняющий текст;

    • HelpUrl — ссылка на пояснение;

    • Details — дополнительные сведения;

  • Parent — родительская сущность, представленная структурой HistoryParentEntity.

• TransformedTo — параметры преобразования шаблона в документ, представленные структурой TransformedToPayload с полями:

  • TargetDocumentId — идентификатор созданного документа, представленный структурой DocumentId.

• DocumentTemplateRefused — параметры отказа от шаблона документа, представленные структурой DocumentTemplateRefusedPayload с полями:

  • RefusalType — тип отказа, принимает значения из перечисления HistoryTemplateRefusalType:

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

    • Refusal — отказ;

    • Withdrawal — отзыв;

  • TemplateDocumentId — идентификатор шаблона, представленный структурой DocumentId;

  • CommentEntity — комментарий, представленный структурой Entity.

• TemplateRefused — параметры отказа от шаблона, представленные структурой TemplateRefusedPayload с полями:

  • RefusalType — тип отказа, принимает значения из перечисления HistoryTemplateRefusalType;

  • CommentEntity — комментарий, представленный структурой Entity.

---

См. также

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

• в структуре DocumentHistoryItem