Question

我正在使用C＃DocuSign API检索有关信封的信息：

Configuration apiConfiguration = GetApiConfiguration();
EnvelopesApi envelopesApi = new EnvelopesApi(apiConfiguration);
var envelope = envelopesApi.GetEnvelope(AccountId, envelopeId);

我需要来自var envelope的某些字段，例如：InitialSendDate，这是可用的。我也知道我需要CustomFields和Recipients中提供的数据。这两个属性从GetEnvelope请求返回为null。有没有办法指定要从GetEnvelope调用中填充的其他属性（或者更好的是，所有属性）？或者是否有另一个更合适的API方法返回信封的总和？

目前，我正在进行额外的API调用以检索数据：

CustomFieldsEnvelope customFields = envelopesApi.ListCustomFields(AccountId, envelopeId);
Recipients recipients = envelopesApi.ListRecipients(AccountId, envelopeId);

Answer 1

您可以通过调用以下端点在一次通话中拨打custom_fields，recipients和tabs

GET /restapi/v2/accounts/<accountId>/envelopes/<envelopeId>?include=custom_fields,recipients,tabs&advanced_update=true

Answer 2

我不相信有一个API调用可以检索您正在寻找的所有信息。根据设计，Get Envelope操作仅返回顶级属性值，以及可用于随后用于检索其他数据（如收件人，自定义字段，文档等）的URI。

如果您担心API限制限制，并且/或者想要限制您需要进行的API请求数量以检索您所描述的信息，您可以考虑配置DocuSign Connect对于您的帐户（或通过创建信封 API请求单独为每个信封），在发生信封事件时向您的应用发送HTTP通知（例如，信封已完成等）。 Connect通知的有效负载将包含信封的所有数据（前提是您已按此方式配置），并且因为它是webhook，您不必进行任何API请求来检索那封信息。

你能在一次API调用中检索所有信封属性吗？

2 个答案: