Docusignapi DocuSign：从模板创建信封时，documentId来自哪里？

我正在从模板创建信封。我需要提前知道将在信封中创建的DocumentID，以便我可以处理一个奇怪的特殊情况，即预填充单选按钮。（我可以更详细地解释原因，但这与这个问题无关。）

那么这些文档ID来自哪里呢？我使用RESTAPI来实现所有这些

这是我的模板：

GET https://demo.docusign.net/restapi/v2/accounts/{{accountId}}/templates/78b351c5-84f8-49c9-af48-redacted

{
    "envelopeTemplateDefinition": {
        "templateId": "78b351c5-84f8-49c9-af48-redacted",
        "name": "my dev template",
        .... truncated for brevity ....
    },
    "documents": [
        {
            "documentId": "73370178",
            "uri": "/envelopes/78b351c5-84f8-49c9-af48-redacted/documents/73370178",
            "name": "DS_Testing_Doc1.pdf",
            "order": "1",
            "pages": "1"
        },
        {
            "documentId": "13535052",
            "uri": "/envelopes/78b351c5-84f8-49c9-af48-redacted/documents/13535052",
            "name": "DS_Testing_Doc2.pdf",
            "order": "2",
            "pages": "1"
        }
    ],
    "recipients": {
            .... truncated for brevity ....
    }
}

这是我的“从模板创建信封”调用：

POST https://demo.docusign.net/restapi/v2/accounts/{{accountId}}/envelopes/

{ "envelopeId":null,
   "accountId":"redacted",
   "templateId":"78b351c5-84f8-49c9-af48-redacted",
   "status":"sent",
   "templateRoles":[  
      {  
         "id":null,
         "roleName":"producer",
         "email":"myemail@mycompany.com",
         "name":"Eric",
         "clientUserId":"",
         "status":"sent",
         "tabs":{  
            .... truncated for brevity ....
         }
      },
      {  
         "id":null,
         "roleName":"hidden",
         "email":"myemail2@mycompany.com",
         "name":"My Agent",
         "clientUserId":"",
         "status":"created",
         "tabs":{  
            .... truncated for brevity ....
         }
      }
   ],
   "voidedReason":null
}

创建信封的响应：

{
    "envelopeId": "2ab1e693-6f30-4f93-9902-redacted",
    "uri": "/envelopes/2ab1e693-6f30-4f93-9902-redacted",
    "statusDateTime": "2016-01-26T20:41:59.2400000Z",
    "status": "sent"
}

GET https://demo.docusign.net/restapi/v2/accounts/{{accountId}}/envelopes/2ab1e693-6f30-4f93-9902-redacted/documents

{
    "envelopeId": "2ab1e693-6f30-4f93-9902-redacted",
    "envelopeDocuments": [
        {
            "documentId": "1",
            "name": "DS_Testing_Doc1.pdf",
            "type": "content",
            "uri": "/envelopes/2ab1e693-6f30-4f93-9902-redacted/documents/1",
            "order": "1",
            "pages": "1",
            "availableDocumentTypes": [
                {
                    "type": "electronic",
                    "isDefault": "true"
                }
            ]
        },
        {
            "documentId": "2",
            "name": "DS_Testing_Doc2.pdf",
            "type": "content",
            "uri": "/envelopes/2ab1e693-6f30-4f93-9902-redacted/documents/2",
            "order": "2",
            "pages": "1",
            "availableDocumentTypes": [
                {
                    "type": "electronic",
                    "isDefault": "true"
                }
            ]
        },
        {
            "documentId": "certificate",
            "name": "Summary",
            "type": "summary",
            "uri": "/envelopes/2ab1e693-6f30-4f93-9902-redacted/documents/certificate",
            "order": "999",
            "pages": "1",
            "availableDocumentTypes": [
                {
                    "type": "electronic",
                    "isDefault": "true"
                }
            ]
        }
    ]
}

现在获取信封中文档的详细信息：

{
    "envelopeId": "2ab1e693-6f30-4f93-9902-redacted",
    "uri": "/envelopes/2ab1e693-6f30-4f93-9902-redacted",
    "statusDateTime": "2016-01-26T20:41:59.2400000Z",
    "status": "sent"
}

GET https://demo.docusign.net/restapi/v2/accounts/{{accountId}}/envelopes/2ab1e693-6f30-4f93-9902-redacted/documents

{
    "envelopeId": "2ab1e693-6f30-4f93-9902-redacted",
    "envelopeDocuments": [
        {
            "documentId": "1",
            "name": "DS_Testing_Doc1.pdf",
            "type": "content",
            "uri": "/envelopes/2ab1e693-6f30-4f93-9902-redacted/documents/1",
            "order": "1",
            "pages": "1",
            "availableDocumentTypes": [
                {
                    "type": "electronic",
                    "isDefault": "true"
                }
            ]
        },
        {
            "documentId": "2",
            "name": "DS_Testing_Doc2.pdf",
            "type": "content",
            "uri": "/envelopes/2ab1e693-6f30-4f93-9902-redacted/documents/2",
            "order": "2",
            "pages": "1",
            "availableDocumentTypes": [
                {
                    "type": "electronic",
                    "isDefault": "true"
                }
            ]
        },
        {
            "documentId": "certificate",
            "name": "Summary",
            "type": "summary",
            "uri": "/envelopes/2ab1e693-6f30-4f93-9902-redacted/documents/certificate",
            "order": "999",
            "pages": "1",
            "availableDocumentTypes": [
                {
                    "type": "electronic",
                    "isDefault": "true"
                }
            ]
        }
    ]
}

在最后一次调用中，我查看信封中文档的详细信息，ID是“1”和“2”。然而，在我的模板中，documentid是“73370178”和“13535052”

那么，从模板创建信封时如何分配DocumentID？它们是否与模板中的“顺序”一致？我能依赖于它们总是从1开始，从那里开始递增吗

是否可以在模板中定义DocumentID，并在创建信封时使其相同

从模板创建信封时是否可以分配DocumentID（假设PDF已上载到模板，而不是发送整个PDF字节流）

---

干杯

文档ID实际上完全由您决定-它是客户端定义的值，并采用字符串，因此您可以使用任何您想要的命名标准（即数字、字母或组合）。许多集成对DocumentID使用简单的数字（1、2、3等），而其他集成则使用字符串或其他标识符

在任何情况下，如果以后要将单选选项卡分配给给定文档的收件人，只需记住为该文档设置的值

---

注意：如果在创建信封时未提供

documentId

，系统将自动生成并分配一个GUID作为documentId，然后可以调用Get Documents API来检索该ID。

信封ID是由DocuSign自己创建的GUID。另一方面，DocumentID依赖于文档的顺序，因为它们在模板上。正如@Batuta所说，我认为自动生成的DocumentID是简单的整数，而不是GUID。信封ID是GUI，由DocuSign分配。很酷，谢谢你的解释。是的，我认为自动生成的documentid是从1开始的整数，而不是guid（基于经验，而不是文档）。无论如何，我会接受这个答案。谢谢@因此，我试图在json中为模板添加documentId，但我无法让它工作。。。有没有办法做到这一点？虽然它是一个字符串，但它必须表示一个正整数，否则您会得到错误

请求，该请求至少包含一个无效参数。指定的documentId不是正整数。

我的documentId有问题，如果我使用任何一个整数，它就会工作，如果我使用不同的东西，字母或uuid，它表示请求不正确。。。