Использование API-интерфейсов DocuSign для получения/установки полей шаблонов

Question

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

До сих пор у меня не было проблем с аутентификацией или созданием «конверта», построенного из шаблона, или назначением ролей. Я могу получить идентификаторы шаблонов, конвертов, документов без проблем. Тем не менее, ни одна из моих попыток получить список пользовательских полей или заполнить их через API REST не удалась.

Я попытался вытащить поля из шаблона и из конверта после применения шаблона. Я даже вручную задал значения через пользовательский интерфейс, но ничего не получил. И запросы не терпят неудачу. Они успешны. Там либо только пустые структуры данных ответа, либо обновление не выполняется.

Например, при попытке восстановить пользовательские поля, это то, что я получаю:

{ 
    "textCustomFields": [], 
    "listCustomFields": [] 
} 

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

{ 
    "documentFields": [] 
} 

Я не могу не думать, что я что-то здесь отсутствует, и не знаю, что. Я тяну базовый URL из ответа аутентификации, и я сделал звонки по следующим адресам API:

• /конверты/{1}/custom_fields
• /конверты/{1}/документы/{2 }/поля
• /конверты/{1}/получатели/{2}/вкладки
• /шаблоны/{1}/custom_fields
• /шаблоны/{1}/документы/{2}/поля

- E DIT -

Хорошо, поэтому, следуя приведенным ниже ответам, я обнаружил, что все поля являются фактически «вкладками», несмотря на то, что они были фактически указаны в пользовательском интерфейсе во время создания шаблона. Теперь остается вопрос, почему они возвращаются только для одной роли получателя. Вот скриншот того, как эти роли на конверте (адрес электронной почты редактируется более):

Вкладка не возвращается на «That Guy», несмотря на то, что роль отмечена «необходимо подписать» , Они возвращаются для «Другого парня», хотя эта роль предназначена только для копирования. Итак, возможно, теперь похоже, что проблема связана с определением роли, чем с чем-либо еще. Или мне нужно снова рассмотреть все это, потому что эти поля, нуждающиеся в предпопуляции, должны быть установлены для всех получателей и не зависят от роли. Все должны видеть одно и то же.

Answer 1

DocuSign использует термин «пользовательские поля» в (по крайней мере) 3 различных способах:

• Конверт Пользовательских поля позволяют указать метаданные, которые получают связанные на уровне конвертов.Эти данные не видны получателям; это просто дополнительные метаданные, которые можно связать с конвертом и запросом позже (через API). См. here для получения дополнительной информации.

• Документ Пользовательские поля позволяет указывать метаданные, которые ассоциируются на уровне документа. Эти данные никоим образом не видны получателям; это дополнительные метаданные, которые можно связать с конкретным документом и запросом позже (через API). См. here для получения дополнительной информации.

• Пользовательские поля (так называемое «пользовательские вкладки») позволяют создавать (и сохранить) свою собственную пользовательские вкладки для использования в документах - см here и here для получения дополнительной информации.

Основываясь на информации, предоставленной Вами в вопросе Ты, я предполагаю, что вы используете термин «пользовательские поля» для обозначения вкладок вы разместили по всему документу (s) в шаблоне, некоторые из которых вы хотите динамически заполнять данными через API при создании конверта, а другие, которые получатели будут заполнять данными во время подписания. Это верно?

Если это то, что вы имеете в виду, вы можете получить список вкладок (полей), что конкретный получатель владеет путем выполнения Список Конверт Вкладка запроса, как описано here.

GET /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs

Чтобы получить вкладки для шаблона (а не как конверт), использовать этот же URI, но задать значение шаблона ID вместо {envelopeId}. Также обратите внимание, что значение, указанное вами для {recipientId}, должно идентифицировать получателя, который «владеет» вкладками в шаблоне/конверте. (Каждая вкладка в шаблоне/конверте «принадлежит» конкретным получателем.)

Если я неправильно понял вашу проблему (или что вы подразумеваете под «настраиваемыми полями»), прокомментируйте этот ответ, и я попытаться прояснить далее.