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;
}

Структура DocumentInfoV3 представляет данные документа, которые не меняются в течение его жизненного цикла (метаданные). Как часть структуры DocumentWithDocflowV3, возвращается методами GetDocflows (версия 3), GetDocflowsByPacketId (версия 3), SearchDocflows (версия 3).

  • FullVersion - тип, функция и версия документа
  • MessageType - тип сообщения: письмо, черновик или шаблон
  • WorkflowId - вид документооборота
  • Participants - участники документооборота
  • DocumentDirection - направление движения документа
  • DepartmentId - идентификатор подразделения, в котором находится документ
  • CustomDocumentId - идентификатор документа, определяемый внешней системой
  • Metadata - метаданные документа
  • CustomData - пользовательские данные, привязанные к документу
  • DocumentLinks - идентификаторы документов, на которые ссылается данный документ, и которые ссылаются на данный документ
  • PacketInfo - информация о пакете, в котором содержится документ
  • IsRead - был ли документ прочитан сотрудником организации
  • IsDeleted - был ли удален данный документ
  • IsInvitation - является ли документ приглашением к ЭДО (тип документа - TrustConnectionRequest, или он поддерживает работу в режиме приглашения и отправлен в таком режиме)
  • LetterInfo - информация о письме, заполянется когда MessageType = Letter
  • DraftInfo - информация о черновике, заполянется когда MessageType = Draft
  • TemplateInfo - информация о шаблоне, заполянется когда MessageType = Template
  • Origin - ссылка на письмо, на основе которого был создан документ

DocumentLetterInfo

Предупреждение

Эта версия контракта — экспериментальная и может измениться.

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

Структура содержит свойства, присущие только документам в письме.

  • IsEncrypted - является ли документ зашифрованным
  • ForwardDocumentEvents - события пересылки документа третьим сторонам
  • IsTest - является ли документ тестовым

DocumentDraftInfo

Предупреждение

Эта версия контракта — экспериментальная и может измениться.

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

Структура содержит свойства, присущие только документам в черновике.

  • IsRecycled - удален ли черновик
  • IsLocked - залочен ли черновик
  • TransformedToLetterIds - список идентификаторов писем, созданных на основе данного черновика

DocumentTemplateInfo

Предупреждение

Эта версия контракта — экспериментальная и может измениться.

message DocumentTemplateInfo
{
    required DocumentParticipants LetterParticipants = 1;
    repeated string TransformedToLetterIds = 2;
    repeated TemplateTransformationInfo TemplateTransformationInfos = 3;
}

Структура содержит свойства, присущие только документам в шаблоне

  • LetterParticipants - информация об отправителе и получателе письма, которое можно создать на основе данного шаблона
  • TransformedToLetterIds - список идентификаторов писем, созданных на основе данного шаблона и содержащих данный документ

TemplateTransformationInfo

Предупреждение

Эта версия контракта — экспериментальная и может измениться.

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

Структура содержит информацию о документе, созданном на основе шаблона

  • TransformationId - идентификатор трансформации
  • TransformedToLetterId - идентификаторы письма и документа, созданного на основе шаблона
  • AuthorUserId - идентификатор пользователя, который создал документ из шаблона