Question

我在DocuSign沙箱中创建了一个测试模板，为另一个系统的某些自动化做准备。我正在尝试填充这些自定义字段，因为会有动态输入的数据需要包含在内。

到目前为止，我在验证方面没有遇到任何问题，或者创建了一个＆＃34;信封＆＃34;建立模板或分配角色。我可以获得模板，信封，文件的ID没问题。但是，我尝试检索自定义字段列表或通过REST API填充它们都没有成功。

我已尝试从模板中提取字段，并在应用模板后从信封中提取字段。我甚至通过UI手动设置了值，但仍然没有得到任何结果。请求并没有失败。他们取得了成功。只有空响应数据结构，或者没有执行更新。

例如，当我尝试检索自定义字段时，这就是我得到的：

{
  "textCustomFields": [],
  "listCustomFields": []
}

尽管已经通过UI创建了自定义字段并将其应用于模板等。我也尝试获取文档字段，但收到的响应基本相同：

{
  "documentFields": []
}

我无能为力，但我觉得我在这里遗漏了一些东西并且不知道是什么。我从身份验证响应中提取基本网址，然后我调用了以下API网址：

/信封/ {1} / custom_fields
/信封/ {1} /文档/ {2} /字段
/信封/ {1} /接收者/ {2} /翼片
/模板/ {1} / custom_fields
/模板/ {1} /文档/ {2} /字段

- 编辑 -

好的，所以根据以下答案的建议，我发现这些字段实际上都是＆＃34;标签＆＃34;，尽管在创建模板期间它们在UI中实际引用了它们。现在问题仍然是为什么他们只返回一个收件人角色。以下是角色在信封上的截图（电子邮件地址已经过编辑）：

即使该角色已标记为“＃34;需要签名＆＃34;”，也不会为＆＃34;那个家伙＆＃34;返回标签。它们被返回给＃34;其他人＃34;即使该角色只是为了被复制。所以，也许它现在看起来问题与角色定义有关，而不是其他任何事情。或者我必须再次回顾所有这些，因为必须为所有收件人设置需要预填充的字段，而不依赖于角色。每个人都应该看到同样的事情。

Answer 1

DocuSign使用术语＆＃34;自定义字段＆＃34; （至少）3种不同的方式：

信封自定义字段可让您指定在信封级别关联的元数据。这些数据对收件人不可见;它只是额外的元数据，您可以稍后与信封和查询相关联（通过API）。有关详细信息，请参阅here。
文档自定义字段允许您指定在文档级别关联的元数据。这些数据不会以任何方式对收件人可见;它只是额外的元数据，您可以稍后与特定的文档和查询相关联（通过API）。有关详细信息，请参阅here。
自定义字段（又名＆＃34;自定义标签＆＃34;）可让您创建（并保存）自己的自定义标签，以便在文档中使用 - 有关详细信息，请参阅here和here。

根据您在问题中提供的信息，我猜您是否正在使用术语＆＃34;自定义字段＆＃34;引用您放置在模板中的整个文档中的选项卡，其中一些要在创建信封时通过API动态填充数据，而其他一些接收者将填充数据在签署期间。那是对的吗？

如果这是您的意思，您可以通过执行列表信封标签请求获取特定收件人拥有的标签（字段）列表，如here所述。

GET /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs

要检索模板（而不是信封）的标签，请使用相同的URI，但指定模板ID 值of {envelopeId} 。另请注意，您为 {recipientId} 指定的值应标识拥有＆＃34;拥有＆＃34;的收件人。模板/信封中的选项卡。（模板/信封中的每个标签都是＆＃34;由特定收件人拥有＆＃34;）

如果我误解了您的问题（或您的意思是＆＃34;自定义字段＆＃34;），请对此答案发表评论，我会尝试进一步澄清。

使用DocuSign REST API获取/设置模板字段

1 个答案: