信封中的DocuSign API元数据

Question

使用C＃SDK向远程收件人请求签名。 想知道是否可以将元数据添加到信封本身，例如，特定于我们域的另一个ID，该ID可以一次设置（初始设置），并且无论文档状态如何都可以随时检索。 我将EnvelopeDocument.DocumentFields看作是一种潜在的方法，但不确定这是否适合我的工作。 另请参阅EnvelopeDefinition.CustomFields。*。 尝试使用TextCustomFields，但我看不到此内容显示在文档中（当show = true时），更不用说它是否在整个生命周期中都附着在信封上。 任何帮助，将不胜感激。 谢谢！

Answer 1

创建DocuSign信封时，可以在“ 文档”级别或“ 信封”级别指定自定义元数据（通过使用“ 自定义字段 ”）。

• 文档级自定义字段与信封中的特定文档相关联。
• 信封级别的自定义字段与信封本身相关联。

使用自定义字段指定的元数据（无论是在文档级别还是信封级别）对于信封收件人都是不可见的，但随后可以随时通过API进行检索 。

根据您提供的信息，听起来您最可能对信封自定义字段感兴趣。 我没有使用DocuSign C＃SDK的丰富经验，但这是Create Envelope请求的JSON部分，该请求在Envelope级别指定了一个自定义字段：

{
    "emailSubject": "Please Print, Complete and Sign Document",
    "emailBlurb": "Please print and complete documents and sign on paper. ",
    "status": "sent",
    "compositeTemplates": [{
        "inlineTemplates": [{
            "sequence": "1",        
            "customFields": {
                "textCustomFields": [{
                    "name": "MyOwnField",
                    "required": "true",
                    "show": "true",
                    "value": "MyValue"
                }]
            },
            "recipients": {
                "signers": [{
                    "requireSignOnPaper": "true",
                    "name": "John Doe",
                    "email": "jdoe@test.com",
                    "recipientId": "1",
                    "routingOrder": "1"
                }]
            }
        }],
        "document": {
            "documentId": "1",
            "name": "AccountApplication.pdf",
            "transformPdfFields": false
        }
    }]
}

基于此，如果您在C＃SDK中看到EnvelopeDefinition.CustomFields.TextCustomFields ，我怀疑这就是您用来创建信封自定义字段的方法。 如前所述，收件人在DocuSign Web UI中不会看到“信封自定义字段”值，但是您应该能够随后在信封生命周期中的任何时候通过API检索“信封自定义字段”值。

更新 （C＃代码示例）：

基于对C＃SDK的简要了解，下面的代码示例显示了如何在信封上创建两个（文本）自定义字段：

// create a new envelope which we will use to send the signature request
EnvelopeDefinition envDef = new EnvelopeDefinition();

// create my first Envelope custom field
TextCustomField myFirstCustomField = new TextCustomField();
myFirstCustomField.Name = "field1";
myFirstCustomField.Value = "value1";

// create my second Envelope custom field
TextCustomField mySecondCustomField = new TextCustomField();
mySecondCustomField.Name = "field2";
mySecondCustomField.Value = "value2";

// add my custom fields to the envelope
envDef.CustomFields.TextCustomFields.Add(myFirstCustomField);
envDef.CustomFields.TextCustomFields.Add(mySecondCustomField);

...