DocumentInfoV3

Информация о документе, которая не зависит от статуса документооборота.

message DocumentInfoV3
{
    required FullVersion FullVersion = 1;
    required Documents.MessageType MessageType = 2;
    required int32 WorkflowId = 3;
    required DocumentParticipants Participants = 4;
    required DocumentDirection DocumentDirection = 5;
    required string DepartmentId = 6;
    optional string CustomDocumentId = 7;
    repeated Events.MetadataItem Metadata = 8;
    repeated CustomDataItem CustomData = 9;
    required DocumentLinks DocumentLinks = 10;
    required PacketInfo PacketInfo = 11;
    required bool IsRead = 12;
    required bool IsDeleted = 13;
    required bool IsInvitation = 14;
    optional DocumentLetterInfo LetterInfo = 15;
    optional DocumentDraftInfo DraftInfo = 16;
    optional DocumentTemplateInfo TemplateInfo = 17;
    optional Documents.Origin Origin = 18;
    optional string EditingSettingId = 19 [default = ""];
}

message DocumentLetterInfo
{
    required bool IsEncrypted = 1;
    repeated ForwardDocumentEvent ForwardDocumentEvents = 2;
    required bool IsTest = 3;
}

message DocumentDraftInfo
{
    required bool IsRecycled = 1;
    required bool IsLocked = 2;
    repeated string TransformedToLetterIds = 3;
}

message DocumentTemplateInfo
{
    required DocumentParticipants LetterParticipants = 1;
    repeated string TransformedToLetterIds = 2;
    repeated TemplateTransformationInfo TemplateTransformationInfos = 3;
    optional TemplateRefusalInfo TemplateRefusalInfo = 4;
    optional bool IsReusable = 5 [default = false];
}

message TemplateTransformationInfo
{
    required string TransformationId = 1;
    optional DocumentId TransformedToLetterId = 2;
    optional string AuthorUserId = 3;
    repeated TemplateTransformationChangeInfo Changes = 4;
}

message TemplateTransformationChangeInfo
{
    required string ChangeId = 1;
    required TemplateTransformationChangeType ChangeType = 2 [default = UnknownTemplateTransformationChange];
    required string ChangeInitiatorBoxId = 3;
    optional string AuthorUserId = 4;
}

message TemplateRefusalInfo
{
    required string BoxId = 1;
    optional string AuthorUserId = 2;
    optional string Comment = 3;
}

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

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

  • WorkflowId — идентификатор вида документооборота.

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

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

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

  • CustomDocumentId — идентификатор документа во внешней системе.

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

  • CustomData — список пользовательских данных (тегов), привязанных к документу, представленных структурой CustomDataItem.

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

  • PacketInfo — информация о пакете, в котором содержится документ, представленная структурой PacketInfo.

  • IsRead — признак того, что документ был прочитан сотрудником организации.

  • IsDeleted — признак того, что документ был удален.

  • IsInvitation — признак того, что документ является приглашением к ЭДО (тип документа — TrustConnectionRequest, или он поддерживает работу в режиме приглашения и отправлен в таком режиме).

  • LetterInfo — информация о письме. Заполняется, если MessageType = Letter. Представлена структурой DocumentLetterInfo с полями:

    • IsEncrypted — признак того, что документ передается в зашифрованном виде.

    • ForwardDocumentEvents — список событий пересылки документа третьим сторонам, представленных структурой ForwardDocumentEvent.

    • IsTest — признак того, что документ является тестовым.

  • DraftInfo — информация о черновике. Заполняется, если MessageType = Draft. Представлена структурой DocumentDraftInfo с полями:

    • IsRecycled — признак того, что черновик удален.

    • IsLocked — признак того, что черновик заблокирован.

    • TransformedToLetterIds — список идентификаторов писем, созданных на основе данного черновика.

  • TemplateInfo — информация о шаблоне. Заполняется, если MessageType = Template. Представлена структурой DocumentTemplateInfo с полями:

    • LetterParticipants — информация об отправителе и получателе письма, которое можно создать на основе шаблона. Представлена структурой DocumentParticipants.

    • TemplateTransformationInfos — список идентификаторов писем, созданных на основе шаблона и содержащих данный документ. Каждый элемент списка представлен структурой TemplateTransformationInfo с полями:

      • TransformationId — идентификатор преобразования из шаблона.

      • TransformedToLetterId — список идентификаторов письма и документа, созданных на основе шаблона. Представлены структурой DocumentId.

      • AuthorUserId — идентификатор пользователя, создавшего документ на основе шаблона.

      • Changes — список изменений, произошедших с документами, созданными на основе шаблона. Каждый элемент списка представлен структурой TemplateTransformationChangeInfo с полями:

        • ChangeId — идентификатор изменения документа, созданного на основе шаблона.

        • ChangeType — тип изменения документа, принимает значения из перечисления TemplateTransformationChangeType.

        • ChangeInitiatorBoxId — идентификатор ящика инициатора изменений.

        • AuthorUserId — идентификатор пользователя, который произвел изменения по документу, созданному на основе шаблона.

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

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

      • AuthorUserId — идентификатор пользователя, отклонившего или отозвавшего шаблон.

      • Comment — комментарий, указанный при отклонении или отзыве.

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

  • Origin — ссылка на письмо, на основе которого был создан документ, представленная структурой Origin.

  • EditingSettingId — идентификатор настройки редактирования содержимого документа.

См. также

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