Можете ли вы добавить DocumentFields при использовании шаблона?

Question

Предислоизвлекается на уровне документа).Если это неверно, дайте мне знать.

---

Можно ли в любом случае определить DocumentFields при использовании шаблона?Шаблоны, которые я использую, будут содержать только один документ.В настоящее время я создаю запросы DocuSign, используя комбинацию шаблонов и загруженных документов.Вот фрагмент кода, который показывает создание запроса с использованием шаблона:

var compositeTemplate = new CompositeTemplate()
{
     ServerTemplates = new List<ServerTemplate>(),
     InlineTemplates = new List<InlineTemplate>()
};

var signer = new Signer()
{
     RecipientId = primaryRecipient.ID.ToString(),
     Name = "Full Name Here",
     RoleName = "Role 1", // Matches role on template
     Email = "Fakeemail@fakeemail.com",
};
InlineTemplate inlineTemplate = new InlineTemplate()
{
     Sequence = "1",
     Recipients = new Recipients()
     {
          Signers = new List<Signer>(),
          CarbonCopies = envelopeCarbonCopies // Set but not included here
     }
};

ServerTemplate serverTemplate = new ServerTemplate()
{
    Sequence = "1",
    TemplateId = documentConfigurations[i].TemplateId
};

compositeTemplate.ServerTemplates.Add(serverTemplate);

inlineTemplate.Recipients.Signers.Add(signer);
compositeTemplate.InlineTemplates.Add(inlineTemplate);

Запрос работает, и шаблон используется.Однако объект ServerTemplate не позволяет мне указывать DocumentFields, и я не могу использовать свойство Documents встроенного шаблона, поскольку я использую шаблон, определенный в DocuSign.

ЕслиЯ не могу указать DocumentFields для шаблона через API, вы можете сделать это с помощью пользовательского интерфейса?

Answer 1

Если поле документа, которое вы хотите установить в шаблоне сервера, является static, то вы можете выполнить следующие шаги, чтобы добавить эти статические documentfields в шаблон сервера, и, когда конверт будет создан с использованием этого шаблона сервера, он будетбыть доступным и в конверте.

a.Используя DS Web App, скачайте шаблон сервера, он будет загружен как JSON

b.Откройте JSON в текстовом редакторе (например, Notepad ++) и перейдите к узлу documents в JSON и добавьте documentFields, как показано ниже.

"documents": [{
        "documentId": "1",
        "uri": "/envelopes/40365a36-ddba-4132-a553-40b4d087935b/documents/1",
        "name": "Test.pdf",
        "order": "1",
        "pages": "1",
        "documentBase64": "<PDFBytes>",
        "display": "inline",
        "includeInDownload": "true",
        "signerMustAcknowledge": "no_interaction",
        "templateLocked": "false",
        "templateRequired": "false",
        "documentGroup": "content",
        "documentFields": [{
                "name": "s_businessDocType",
                "value": "TL"
        }]
    }]

c.Сохраните этот JSON и повторно загрузите его на WEBApp, он сгенерирует новый templateId.

Когда вы будете использовать этот шаблон сервера в конверте, тогда конверт будет иметь documentFields, присутствующий в шаблоне сервера.

ОБНОВЛЕНИЕ:

Если поля документа являются динамическими, выполните следующие действия:

a.Создать конверт в состоянии черновика.

b.Вызовите ниже конечной точки, чтобы добавить documentFields к документу

POST /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields

c.После того, как вы добавили поля документа, измените статус конверта на отправленный с использованием указанной ниже конечной точки

PUT /v2/accounts/{accountId}/envelopes/{envelopeId}