使用DocuSign REST API獲取/設置模板字段

Question

我已經在DocuSign沙箱內創建了一個測試模板，以準備與其他系統進行一些自動化。我試圖填充這些自定義字段，因爲會有動態輸入的數據需要包含在內。

到目前爲止，我在身份驗證或創建由模板構建的「信封」或分配角色方面沒有任何問題。我可以得到模板，信封，文件的ID沒有問題。但是，我沒有試圖檢索自定義字段列表或通過REST API填充它們的嘗試都取得了成功。

我試圖從模板中拉出字段，並在應用模板之後從信封中拉出字段。我甚至通過UI手動設置了這些值，但仍然沒有任何結果。這些要求並沒有失敗。他們很成功。只有空的響應數據結構，或者沒有執行更新。

例如，當我試圖檢索自定義字段，這是我得到：

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

儘管這是通過用戶界面具有創建自定義字段，並把它們應用到模板，這樣。我也試圖讓文檔區域，而不是，但收到本質上是相同的迴應：

{ 
    "documentFields": [] 
} 

我不禁想起我在這裏失去了一些東西，不知道是什麼。我拉從認證響應的基本URL，並且我做了調用以下API網址：

• /袋/ {1}/custom_fields
• /袋/ {1} /文件/ {2 } /字段
• /信封/ {1} /接收者/ {2} /選項卡
• /模板/ {1}/custom_fields
• /模板/ {1} /文檔/ {2} /字段

- E DIT -

好吧，所以下面的答案建議，我發現這些字段實際上都是「標籤」，儘管它們在創建模板時實際上是如何在UI中引用的。現在問題仍然是爲什麼他們只返回一個單一的收件人角色。這裏有一個角色是如何在信封上截圖（電子郵件地址被修改過）：

的選項卡將不返回「那傢伙」，即使該角色被標記爲「需要簽訂」 。他們返回「其他人」，即使該角色只是爲了複製。所以，也許現在看起來問題比角色定義更重要。或者我必須再次回顧所有這些，因爲需要預先填充的這些字段必須爲所有收件人設置，而且不是與角色相關的。每個人都想看到同樣的事情。

Answer 1

的DocuSign中使用（至少）3種不同方式的術語「自定義字段」：

• 信封自定義字段讓你指定被在信封水平相關的元數據。這些數據對收件人不可見;它只是額外的元數據，您可以將其與信封相關聯，並稍後通過API進行查詢。有關更多信息，請參閱here。

• 文檔自定義字段允許您指定在文檔級別關聯的元數據。收件人無法以任何方式看到此數據;它只是額外的元數據，您可以將其與特定的文檔關聯並稍後（通過API）進行查詢。有關更多信息，請參閱here。

• 自定義字段（又名「自定義選項卡」）讓你創建（並保存）您自己定製標籤用在你的文件 - 見here和here獲取更多信息。

基於你在你的問題中提供的信息，我猜你正在使用的術語「自定義字段」來指代標籤你放在整個文件（S ），其中一些您希望在創建信封時通過API動態填充數據，另一些收件人將在簽名期間填充數據。那是對的嗎？

如果這是你的意思，你可以得到標籤（場）的列表，特定收件人通過執行名單信封標籤要求擁有，所描述的here。

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

要檢索的選項卡用於模板（而非信封），使用相同的URI，而是代替{envelopeId}指定模板ID值。另請注意，您爲{recipientId}指定的值應標識「擁有」模板/信封中選項卡的收件人。 （模板/信封中的每個標籤由特定收件人「擁有」。）

如果我誤解了您的問題（或者您的意思是「自定義字段」），請評論此答案，我會試圖進一步澄清。