Azure Connectors Node.js SDK
    Preparing search index...

    Interface AutoPlaceFieldRequest

    Definition: AutoPlaceFieldRequest

    interface AutoPlaceFieldRequest {
        dimensions?: FieldDimension;
        field_type?: string;
        font?: Font;
        format?: string;
        level_of_assurance?: string[];
        max_length: number;
        multiline: boolean;
        order: number;
        placeholder?: string;
        placement?: string;
        radio_group_name?: string;
        search_text?: string;
        validation?: FieldValidationValue;
        validation_rule?: string;
        value?: string;
    }
    Index
    dimensions?: FieldDimension
    field_type?: string

    Type of field to be created in the document. Possible values are "SIGNATURE", "IN_PERSON_SIGNATURE", "INITIALS", "TEXT", "NUMBER" ,"NAME", "EMAIL", "COMPANY", "JOBTITLE", "RADIOBOX", "CHECKBOX", "DATE", "ATTACHMENT"

    font?: Font
    format?: string

    Text format of the field. Used for the date type field only. Possible values are

    • m/d
    • m/d/yy
    • m/d/yyyy
    • mm/dd/yy
    • mm/dd/yyyy
    • mm/yy
    • mm/yyyy
    • d-mmm
    • d-mmm-yy
    • d-mmm-yyyy
    • dd-mmm-yy
    • dd-mmm-yyyy
    • yy-mm-dd
    • yyyy-mm-dd
    • mmm-yy
    • mmm-yyyy
    • mmmm-yy
    • mmmm-yyyy
    • mmmm d, yyyy
    • dd/mm/yy
    • ddmmmyyyy
    level_of_assurance?: string[]

    Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"

    max_length: number

    Maximum length of the value allowed in the field. Must between 1 - 9999

    multiline: boolean

    This belongs to Text Area field type and If set to true, text area field would be created with multi line option.

    order: number

    Order of the user to which the fields will be assigned automatically. Workflow in SigningHub orders recipients. This list begins with “1” for the first designated signer.

    placeholder?: string

    Provide note in the case of Mandatory Attachment

    placement?: string

    If the text is found, fields are to be placed in the document. Placement of the field can be mentioned in this attribute. Possible values of placement of a field are LEFT, RIGHT, TOP, BOTTOM. If no value is provided the default value will be LEFT.

    radio_group_name?: string

    The group name required only when adding a Radio Box type field to group multiple Radio boxes together.

    search_text?: string

    Word that needs to be searched in the document.

    validation_rule?: string

    One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".

    value?: string

    Value that user want to show in the field.