DocuSign get 或 listStatusChange API 不提供带有“include”参数的附加信息答案

【问题标题】：DocuSign get or listStatusChange API does not provide additional info with "include" parameterDocuSign get 或 listStatusChange API 不提供带有“include”参数的附加信息
【发布时间】：2019-07-23 20:10:48
【问题描述】：

根据“get”信封或“listStatusChange”API 文档，它们都支持查询参数“include”以获取附加信息（不仅是信封名称、状态和电子邮件主题）。例如：指定要返回的有关信封的附加信息。输入逗号分隔的列表，例如标签、收件人。有效值为：选项卡、收件人、文档、custom_fields、附件、扩展等。

但我确实在 DocuSign (https://apiexplorer.docusign.com/#/esign/restapi?categories=Envelopes&tags=Envelopes&operations=listStatusChanges) 提供的 REST API 资源管理器上使用上述关键字尝试了此查询参数

但我没有在响应中获得任何其他信息，如 JSON 响应示例 (https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges#examples) 中详述的那样

我需要获取大多数信封字段，例如姓名、主题、带有签名者的收件人、carbonCopies、EnvelopeTabs、路由顺序、附件等。

我确实尝试了以下 3 个 API。但它们都没有按照 API 文档中关于“包含”查询参数的说明工作。请让我知道什么应该是适当的 API 来获得完整的信封定义（没有引用嵌套对象的内部 URI）

https://apiexplorer.docusign.com/#/esign/restapi?categories=Envelopes&tags=Envelopes&operations=listStatusChanges

预期结果如示例 JSON 响应中所述 https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges#examples

【问题讨论】：

标签： docusignapi

【解决方案1】：

刚刚做了一些测试，似乎在listStatusChanges 和listTemplates 调用中将包含参数设置为tabs 被忽略，无论API 版本如何。 DS Support 已向我确认这是 API 文档中的一个错误，并将在未来更正。

【讨论】：

【解决方案2】：

https://{{EnvironmentVal}}/restapi/v2/accounts/{{AccountIdVal}}/envelopes/{{envelopeId}}?include=custom_fields,recipients,tabs&advanced_update=true

是使用 V2 API 版本获取 CustomFields、Recipients 及其选项卡的端点，如果您注意到上面的端点，您还需要传递 advanced_update=true 以返回响应。此版本的 API 调用中也不返回文档参考。

但使用 V2.1 API 版本，

https://{{EnvironmentVal}}/restapi/v2.1/accounts/{{AccountIdVal}}/envelopes/{{envelopeId}}?include=custom_fields,recipients,tabs,documents

您也可以获得文档参考，并且您不需要在 API 调用中传递 advanced_update=true。因此，如果您正在做新的集成，建议使用 V2.1 API 版本。

【讨论】：

谢谢，Amit.. 这对我很有帮助并且满足我的要求

【解决方案3】：

很遗憾，API Explorer 仅限于支持 API 的 v2 版本，而您要查找的 Include 参数位于 v2.1。

您需要通过 Postman 之类的工具自己调用 2.1 来检查它们。

作为参考，您可以通过访问页面顶部的下拉列表来查看 v2 API 文档：

【讨论】：

谢谢！！我现在可以看到文档之间的区别了。