TemplateDocumentAttachment

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

message TemplateDocumentAttachment {
    required UnsignedContent UnsignedContent = 1;
    optional string Comment = 2;
    required string TypeNamedId = 3;
    optional string Function = 4;
    optional string Version = 5;
    repeated MetadataItem Metadata = 6;
    optional int32 WorkflowId = 7;
    optional string CustomDocumentId = 8;
    optional string EditingSettingId = 9;
    optional bool NeedRecipientSignature = 10 [default = false];
    optional PredefinedRecipientTitle PredefinedRecipientTitle = 11;
    optional bool RefusalDisabled = 12 [default = false];
    repeated CustomDataItem CustomData = 13;
}

message PredefinedRecipientTitle {
    required UnsignedContent UnsignedContent = 1;
}

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

  • Comment — комментарий к документу. Длина не более 5000 символов.

  • TypeNamedId — строковый идентификатор типа документа.

  • Function — функция документа. Обязательна при отправке зашифрованных документов.

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

  • Metadata — список метаданных документа, представленных структурой MetadataItem. Список доступных метаданных для типа можно получить с помощью метода GetDocumentTypes (V2). Инструкция о получении данных из метода GetDocumentTypes приведена на странице Получение информации о типе документа.

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

  • CustomDocumentId — идентификатор документа во внешней системе, уникальный в рамках структуры TemplateToPost. Используется для выстраивания связей между документами внутри отправляемого сообщения. После создания шаблона идентификатор хранится в поле Document.CustomDocumentId.

  • EditingSettingId — идентификатор настройки редактирования содержимого документа. Наличие настройки означает, что в содержимом файла могут отсутствовать данные, редактирование которых разрешено этой настройкой.

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

  • PredefinedRecipientTitle — данные титула получателя. Предназначено для двухтитульных документов с версией, поддерживающей предопределенный титул получателя.

  • RefusalDisabled — признак, управляющий возможностью отклонять шаблон на стороне получателя. Если указано значение true, то у получателя нет возможности отклонить шаблон.

  • CustomData — список пар вида «ключ-значение», содержащих произвольные данные по документу. Каждый элемент списка представлен структурой CustomDataItem.

См. также

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