OPENAPI / COMPONENTS / SCHEMAS

数据结构:Template Response

TemplateResponse

包含有关您和您的团队创建的模板的信息。

object16字段
template_idstring

模板的 id。

titlestring

模板的标题。当使用此模板发送 SignatureRequest 时,这也将是发送给签名者的消息的默认主题。发送 SignatureRequest 时可以覆盖此设置。

messagestring

使用此模板发送 SignatureRequest 时将发送给签名者的默认消息。发送 SignatureRequest 时可以覆盖此设置。

updated_atinteger

模板上次更新时间。

is_embeddedboolean

如果此模板是使用嵌入式流程创建的,则为 `true`;如果是在我们的网站上创建的,则为 `false`。当您不是模板的创建者时,将为 `null`。

is_creatorboolean

如果您是此模板的所有者,则为 `true`;如果团队成员与您共享了该模板,则为 `false`。

can_editboolean

指示所有者是否已向您授予编辑权限(如果是您,则始终为 `true`)。

is_lockedboolean

指示模板是否被锁定。 如果是 `true`,则该模板是在您的配额之外创建的,并且只能在 `test_mode` 中使用。 如果是 `false`,则该模板在您的配额范围内,可用于创建签名请求。

metadataobject

附加到模板的元数据。

signer_rolesTemplateResponseSignerRole

使用此模板发送 SignatureRequest 时必须指定的指定签名者角色的数组。

cc_rolesTemplateResponseCCRole

使用此模板发送 SignatureRequest 时必须指定的指定 CC 角色的数组。

documentsTemplateResponseDocument

描述与此模板关联的每个文档的数组。包括每个文档的表单字段数据。

custom_fieldsTemplateResponseDocumentCustomFieldBase

已弃用。请改用 [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) 数组内的 `custom_fields` 。

named_form_fieldsTemplateResponseDocumentFormFieldBase

已弃用。请改用 [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) 数组内的 `form_fields` 。

accountsTemplateResponseAccount

可以使用此模板的账户数组。

attachmentsSignatureRequestResponseAttachment

签名者附件。