使用 Docusign REST API 进行复选框验证

Question

从 Docusign Web UI 中，我可以添加一个复选框组并添加如下验证：

但任何 API 都无法提供相同的验证。是否有任何解决方法或其他 API 端点来添加此验证？

Answer 1

这可以通过 API 获得。诀窍在于，您必须将每个 Checkbox 设置为有一个 Group，然后必须将验证规则分配给 TabGroup。这是一个例子：

            "tabs": {
                "checkboxTabs": [
                    {
                        "tabLabel": "Checkbox1",
                        "required": false,
                        "selected": false,
                        "pageNumber": 1,
                        "documentId": "1",
                        "recipientId": "1",
                        "tabGroupLabels": [
                            "Checkbox Group"
                        ],
                        "xPosition": 308,
                        "yPosition": 43,
                    },
                    {
                        "tabLabel": "Checkbox2",
                        "pageNumber": 1,
                        "documentId": "1",
                        "recipientId": "1",
                        "tabGroupLabels": [
                            "Checkbox Group"
                        ],
                        "xPosition": 308,
                        "yPosition": 59,
                    }
                ],
                "tabGroups": [
                    {
                        "groupLabel": "Checkbox Group",
                        "locked": false,
                        "groupRule": "SelectAtLeast",
                        "minimumRequired": 1,
                        "maximumAllowed": 1,
                        "validationMessage": "Please check a box",
                        "documentId": "1",
                        "pageNumber": 1,
                        "tabScope": "Document",
                        "recipientId": "1"
                    }
                ]
            }

要了解如何准确设置组以获得所需的验证规则，您可以使用API 日志记录来捕获 Web 控制台的 AddEnvelopeTabs 流量。请注意，Web 控制台使用两个 API 调用（一个用于创建复选框，一个用于创建组），但您的应用程序可以通过一个 API 调用来完成此操作。

添加

可能的groupRule值为SelectAtLeast, SelectAtMost, SelectExactly, SelectARange。使用适合您的用例的值。

关联属性为minimumRequired, maximumAllowed, 根据groupRule设置而定。

内部 Jira DEVDOCS-2087 已提交以更新文档。