Question

我们正在使用API从信封中检索数据，主要是文本标签，但我们需要的其中一个字段是品牌。我已经看到在创建信封时可以设置brandId的位置，但是在信封上进行GET时这些数据是否可用？

Answer 1

我不知道有任何方法可以检索现有Envelope的 brandId ，并且在DocuSign REST API指南中没有提到这种可能性。

解决方法是使用＆＃34; 自定义信封字段 ＆＃34; （type = Text）将 brandId 存储为创建信封时与信封关联的元数据。例如，要在创建信封 API请求中设置（文本）自定义信封字段以存储品牌标识，您只需将此结构作为创建信封API请求的一部分包含在其中：

"customFields":{ 
     "textCustomFields":[ 
         { 
             "name":"envBrandId", 
             "required":"false", 
             "show":"false", 
             "value":"XXXX-XX-XXXX-XX-XXXX" 
         } 
     ] 
 }

有关详细信息，请参阅DocuSign REST API指南（https://10226ec94e53f4ca538f-0035e62ac0d194a46695a3b225d72cc8.ssl.cf2.rackcdn.com/rest-api-guide-v2.pdf）。

然后，一旦创建了信封，您就可以使用此请求检索自定义信封字段的值：

GET /accounts/{accountId}/envelopes/{envelopeId}/custom_fields

REST API指南再次包含有关此操作的详细信息。

可以使用REST API检索brandId的信封吗？

1 个答案: