Autonumber Field API

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

Autonumber field

<field type=”autonumber” name=”String” roleId=”id” prefix=”string” search=”boolean”/>

Autonumber is read-only field with the value incrementally generated on each new envelope draft with current template version UUID.

Autonumber Field attributes

  • type — define if this field is autonumber 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.

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

  • prefix — string, length from 0 up to 15 symbols, static data which will be used before incremental variable of auto numbering, option attribute.

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