DocuSign - C# SDK 提供的 "EnvelopesApi" 的 "ListDocuments" API 未返回 "Custom Document Fields"

Question

1. 目前我们有一个用例，其中一些 自定义数据 需要为每个 存储 DocuSign 信封 的文档。

2. 我们在创建要发送的 EnvelopeDefinition 实例时使用 Document class 的 DocumentFields 属性 CreateEnvelope API 由 DocuSign C# SDK 提供，如下所示。

        var envelope = new EnvelopeDefinition {
           Documents = new List<Document> {
               new Document {
                   DocumentFields = new List<NameValue> {
                       new NameValue {
                           Name = "CustomField",
                           Value = "123"
                       }
                   }
               }
           }
       };
   

3. 但是这些字段 不是 返回 [= =19=] API 尽管 EnvelopeDocument 模型 class 中有一个 DocumentFields 属性 被返回。

4. ListDocumentFieldsAPI 返回相同的字段。

谁能告诉我这个是否是预期的行为或者无论如何 ] 这些 字段 可以使用 ListDocuments API 检索 以避免额外的 API 调用。

Answer 1

这是 DocuSign 平台的预期行为。 ListDocuments API 用于列出信封中每个文档周围的高级元数据 - 例如文档的 name 和 documentId。如需更详细的信息，例如自定义字段值等，您需要调用 ListDocumentFields API。