Text Field API

This document contains the Text field API format and a list of supported attributes.

Text field
<field type=”text” name=”string” placeholder=”string” roleId=”id” optional=”boolean” search=”boolean” multilines=”boolean” min=”intager” max=”integer”/>

Text Field attributes

• type — define if this field is text type, mandatory attribute.

• name — string, length from 1 up to 128 symbols, restricted symbols &, “, <, >, field name used to fill in on envelope, unique for document, mandatory attribute.

• placeholder — field placeholder displayable on template and envelope, length from 0 up to 1024 symbols, if empty on envelope will be displayed field name, optional attribute.

• roleId — id of the role who should fill field on envelope, mandatory attribute.

• optional — boolean, defines if field to be filled in optionally or not on envelope, if not set default value false, optional attribute.

• search — boolean, defines if field is searchable on envelope search or not, if not set default value false, optional attribute.

• multilines — boolean, multiline or single line text, multiline should be textarea on UI, optional, default false, optional attribute.

• min — integer, allowed values range from 0 to 1000 (if multiline applied than up to 5000), define minimal quantity of symbols has to be entered to field become valid, default value empty, optional attribute.

• max — integer, allowed values range from 0 to 1000 (if multiline applied than up to 5000), define maximum quantity of symbols allowed to field to be valid, default value empty, optional attribute.