Docusignapi 使用模板时是否可以添加文档字段？

前言：据我所知，

文档字段

不是专门与收件人关联的字段（因此不会显示为表单数据，可以在文档级别检索）。如果这是不正确的，让我知道

---

在使用模板时，是否需要定义

文档字段

？我正在使用的模板将只包含一个文档。我目前正在使用模板和上载文档的组合创建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);

var compositeTemplate=new compositeTemplate（）
{
ServerTemplates=新列表（），
InlineTemplates=新列表（）
};
var signer=new signer（）
{
RecipientId=primaryRecipient.ID.ToString（），
Name=“此处全名”，
RoleName=“Role 1”，//匹配模板上的角色
电子邮件=”Fakeemail@fakeemail.com",
};
InlineTemplate InlineTemplate=新的InlineTemplate（）
{
Sequence=“1”，
收件人=新收件人（）
{
签名者=新列表（），
CarbonCopies=信封CarbonCopies//已设置，但未包含在此处
}
};
ServerTemplate ServerTemplate=新的ServerTemplate（）
{
Sequence=“1”，
TemplateId=documentConfigurations[i]。TemplateId
};
compositeTemplate.ServerTemplates.Add（serverTemplate）；
inlineTemplate.Recipients.Signers.Add（signer）；
compositeTemplate.InlineTemplates.Add（inlineTemplate）；

请求起作用，并使用模板。但是，

ServerTemplate

对象不允许我指定

DocumentFields

，并且我不能使用内联模板的

Documents

属性，因为我使用的是DocuSign中定义的模板

---

如果我无法通过API在模板上指定

文档字段

，您可以使用UI执行此操作吗？

如果要在服务器模板中设置的文档字段是

静态

，则您可以按照以下步骤将这些静态

文档字段

添加到服务器模板，然后，当使用此服务器模板创建信封时，它也将在信封中可用

a。使用DS Web App下载服务器模板，它将作为JSON下载

b。在文本编辑器中打开JSON（如Notepad++），然后转到 JSON中的

文档

节点，并添加

文档字段

，如下所示

"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。添加文档字段后，将信封状态更改为“使用以下端点发送”

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

---

如果要在服务器模板中设置的文档字段是静态的，则可以按照以下步骤将这些静态的

文档字段添加到服务器模板中，并且在使用此服务器模板创建信封时，也可以在信封中使用

a。使用DS Web App下载服务器模板，它将作为JSON下载

b。在文本编辑器中打开JSON（如Notepad++），然后转到
JSON中的
文档
节点，并添加
文档字段
，如下所示

"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。添加文档字段后，将信封状态更改为“使用以下端点发送”

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

谢谢，我不知道你能做到。如果数据是动态的，还有其他有效的方法吗？您想在文档级还是信封级检索也可以？我更喜欢在文档级检索。本质上，我希望有一个DocumentField来指定该文档的类型，就像您的示例JSON一样。如果数据是动态的，还有其他有效的方法吗？您想在文档级还是信封级检索也可以？我更喜欢在文档级检索。本质上，我希望有一个DocumentField来指定文档的类型，很像您的示例JSON