OPENAPI / COMPONENTS / SCHEMAS

数据结构:Sub Form Fields Per Document Base

SubFormFieldsPerDocumentBase

应出现在文档中的字段,表示为对象数组。 (有关更多详细信息,您可以在这里阅读:[使用每个文档的表单字段](/docs/openapi/form-fields-per-document)。) **注意:** 像 **text**、**dropdown**、**checkbox**、**radio** 和 **hyperlink** 等字段具有额外的必填和可选参数。查看这些字段类型的[附加参数](/api/reference/constants/#form-fields-per-document)列表。 * 文本字段使用`SubFormFieldsPerDocumentText` * 下拉字段使用`SubFormFieldsPerDocumentDropdown` * 超链接字段使用`SubFormFieldsPerDocumentHyperlink` * 复选框字段使用 `SubFormFieldsPerDocumentCheckbox` * 无线电现场使用`SubFormFieldsPerDocumentRadio` * 签名字段使用`SubFormFieldsPerDocumentSignature` * 签名日期 字段使用 `SubFormFieldsPerDocumentDateSigned` * 缩写 现场使用 `SubFormFieldsPerDocumentInitials` * 文本合并字段使用`SubFormFieldsPerDocumentTextMerge` * 复选框合并字段使用 `SubFormFieldsPerDocumentCheckboxMerge`

object11字段
document_indexinteger必填

表示字段应附加到的 `file` 或 `file_url` 文档的整数索引。

api_idstring必填

字段的标识符,在请求中的所有文档中都是唯一的。

heightinteger必填

字段的大小(以像素为单位)。

namestring

字段的显示名称。

pageinteger

文档中应放置该字段的页面(要求文档为 PDF 文件)。 - 当提供页码参数时,API 将使用新的坐标系。 - 查看两个[坐标系](https://faq.hellosign.com/hc/en-us/articles/217115577)之间的差异以及如何使用它们。

requiredboolean必填

该字段是否必填。

signerstring必填

签名者索引由签名者参数中的偏移量(基于 0 的索引)标识,指示哪个签名者应填写该字段。 **注意:** 要将字段的值设置为准备者,您必须将其设置为 `me_now` **注意:** 如果类型为 `text-merge` 或 `checkbox-merge`,则必须将其设置为发送方才能使用预填充数据。

typestring必填

widthinteger必填

字段的大小(以像素为单位)。

xinteger必填

字段的位置坐标(以像素为单位)。

yinteger必填

字段的位置坐标(以像素为单位)。