如何设置自定义标签字段的值?

时间:2019-03-26 10:59:15

标签: docusignapi

我必须使用Docusign Api从系统填充“自定义”字段值,是否有可用的api?

到目前为止,我一直在关注

  1. 创建了一个自定义字段,并将其放在“文档”上,如下图所示。

screenshot of custom tab

  1. 已使用

    POST / v2 /帐户/ {accountId} / envelopes / {envelopeId} / documents / {documentId} / fields

它给出了一个错误:

enter image description here

在发送给特定签名者之前,有什么方法可以填充自定义字段值? 需要帮助。

1 个答案:

答案 0 :(得分:1)

首先,不幸的是,术语“自定义字段”通常用于DocuSign系统中的两个不同功能:

信封可以包含元数据字段。这些字段不会显示给任何收件人。他们的全名是Envelope Custom Fields。它们通过使用管理工具进行管理。请参阅管理工具导航面板的屏幕截图:

Admin Tool navigation panel

Envelope Custom Fields可以由信封的发件人(或通过API)设置。它们在完成证书上可见,可以通过API进行访问。

据您所知,这不是您在做什么。

选项卡可以具有自定义设置。由于选项卡(API术语)在Web用户界面中称为字段,因此一旦对其进行了自定义,就可以将其称为“自定义字段”。但是更好的术语是Document Custom Fields

它们是在帐户级别进行管理的,因此您也可以使用管理工具来管理它们。

用于填充文档自定义字段的API ,您可以在创建信封时设置其值。

这是一个用于创建文档自定义字段的创建信封示例,该字段是一个下拉字段。信封是通过模板创建的。

请注意模板角色的设置方式,对于具有相关标签的角色,只需设置标签值即可。

{
    "status": "sent",
    "templateId": "77b6fbef-1448-4ac3-819f-253a9e1cb08e",
    "templateRoles": [
        {
            "clientUserId": "1000",
            "email": "signer@example.com",
            "name": "Larry Kluger",
            "roleName": "signer",
            "tabs": {
                "listTabs": [
                    {
                        "tabLabel": "Custom Drop down",
                        "value": "Option 2"
                    }
                ],
            }
        },
        {
            "email": "cc_person@example.com",
            "name": "Susan Kluger",
            "roleName": "cc"
        }
    ]
}