DocuSign Rest API - Получение документа о состоянии конверта после использования compositeTemplates

#docusignapi

Вопрос:

Я использую PdfTransformFields для создания конверта:

 {
  "emailBlurb": "Test Transform PDF Fields",
  "emailSubject": "Test Transform PDF Fields",
  "status": "sent",
  "compositeTemplates": [{
    "inlineTemplates": [{
      "recipients": {
        "signers": [{
          "recipientId": "777",
          "name": "LastName FirstName",
          "email": "some email",                  
          "tabs":{
             "signHereTabs":[
                {
                   "tabLabel":"employee_esignature\*"
                }
             ]
          }          
        }]
      }
    }],
    "document": {
      "documentId": "1234567",
      "name": "Test.pdf",
      "transformPdfFields": "true"
    }

  }]
}

Хотя были определены recipientId =»777″ и documentId =»1234567″, но когда я получаю envelopeStatus с помощью вызова:

 envelopesApi.listRecipients(accountId,env.getEnvelopeId(),
   listRecipientsOptions);

Я вижу, что
получатели-> подписчики-> вкладки-> signHereTabs содержит
documentId=»1″, recipientId=»1″

Почему documentId и recipientId отличаются от того, что я передал?

1. DocuSign всегда запускает documentId и Recipientid с 1 и увеличивает их на 1 для каждого последующего документа, добавленного с помощью составных шаблонов. Но каково использование и почему вам нужно знать документ или идентификатор получателя?

2. Отвечая на ваш вопрос «Но что такое usecase и почему вам нужно знать документ или идентификатор получателя?» Если я добавляю несколько документов в один конверт, то мне нужно знать, с помощью какого документа статус был изменен.

3. DocuSign выполняет транзакцию как All или None, поскольку транзакция перемещается из одного статуса в другой на уровне конверта. Таким образом, конверт перейдет из одного статуса в другой, когда подписывающий завершит все действия со всеми документами, присутствующими в конверте, и нажмет Finish кнопку сверху.

Ответ №1:

Я думаю, что documentId и recipientId несколько эфемерны — вы можете ссылаться на них в других частях вашего составного шаблона, используя заданные вами значения, но затем они могут быть перезаписаны платформой DocuSign, когда она завершит обработку вашего запроса.

Если вы хотите связать свои собственные метаданные с получателем, используйте customFields атрибут в объекте подписывающего.

Вы можете добавить свои собственные метаданные к объектам документа с помощью documentFields атрибута.

1. Единственное, не ясно, почему при использовании автоматического размещения (привязка тегов) вместо преобразования поля формы PDF (compositeTemplates), то при передаче documentId и recepientId, то при вызове EnvelopeStatus я получаю именно те documentId и recipentId, которые я передал.