Interface IAddTemplateFieldRequest

Request body for adding an existing field definition to a template.

interface IAddTemplateFieldRequest {
    fieldName: string;
    isRequired?: boolean;
    localDescription?: string;
    position?: number;
}

Implemented by

Properties

fieldName isRequired? localDescription? position?

Properties

fieldName

fieldName: string

The name of an existing field definition to assign to the template. Required.

OptionalisRequired

isRequired?: boolean

Whether the field is required for entries assigned to this template specifically. Distinct from the repository-level IsRequired on the field definition.

OptionallocalDescription

localDescription?: string

The per-template description for this field assignment. Distinct from the field definition's repository-level description.

Optionalposition

position?: number

The 1-based position at which to insert the field. Omit (or set null) to append to the end of the template. Values less than 1 or greater than the current field count + 1 are rejected with 400.

Settings

Member Visibility

On This Page

Properties