Получить документы из шаблона

Question

Я создал шаблон в моей изолированной программной среде разработчика DocuSign, который содержит один документ. Я использую C # SDK, чтобы попытаться отправить пользователю конверт на основе шаблона.

Вот код, где я получаю все шаблоны.

TemplatesApi templateApi = new TemplatesApi(ApiClient.Configuration);

         EnvelopeTemplateResults templateResults = templateApi.ListTemplates(AccountID);

У меня проблема с EnvelopeTemplateResults Не имеет НЕ какие-либо документы, связанные с ним.

Когда я использую REST API с помощью POSTMAN, выполняя GET для этого URL, я вижу, что есть envelopeTemplateDefinition , в котором есть Document, именно тот, который мне нужен.

У меня вопрос, как с помощью API SDK я могу получить envelopeTemplateDefinition ?

Answer 1

Чтобы метод ListTemplates включал информацию о документах, необходимо установить параметр Включить:

        var templatesApi = new TemplatesApi(apiClient.Configuration);
        var listTemplatesOptions = new TemplatesApi.ListTemplatesOptions { include = "documents" };
        var templateResults = templatesApi.ListTemplates(accountId, listTemplatesOptions);

Если вы пытаетесь получить определение шаблона для одного шаблона, метод templatesApi.Get() можно использовать со своим собственным набором параметров включения:

        var getTemplateOptions = new TemplatesApi.GetOptions { include = "documents" };
        var templateDefinition = templatesApi.Get(accountId, templateId, getTemplateOptions);

Наконец, если вы пытаетесь получить фактический PDF из определенного шаблона, это будет метод templatesApi.GetDocument():

templatesApi.GetDocument(accountId, templateId, documentId);

Где DocumentId - это конкретный документ, который вы хотите вытащить, или «Объединенный», если вы хотите вытащить все документы как один PDF.

Answer 2

Крис, если вы используете v2 API, есть конечная точка: GET / v2 / account / {accountId} / templates / {templateId} / documents / {documentId}

Вы можете попробовать это здесь - https://apiexplorer.docusign.com/#/esign/restapi?categories=Templates&tags=TemplateDocuments&operations=get

SDK c # внутри TemplateAPI имеет методы GetDocument () и UpdateDocument ()