Interface UpdateCustomField

interface UpdateCustomField {
    after_id?: string;
    before_id?: string;
    description?: string;
    enabled?: boolean;
    icon_set_identifier?: string;
    name?: string;
    values?: UpdateCustomFieldEnumValue[];
}

Properties

after_id? before_id? description? enabled? icon_set_identifier? name? values?

Properties

Optionalafter_id

after_id?: string

The ID of the CustomField we want to move this CustomField after.

Format

uuid

Optionalbefore_id

before_id?: string

The ID of the CustomField we want to move this CustomField before.

Format

uuid

Optionaldescription

description?: string

A description of the purpose of this field.

Optionalenabled

enabled?: boolean

Indicates whether the Field is enabled for the Workspace. Only enabled fields can be applied to Stories.

Optionalicon_set_identifier

icon_set_identifier?: string

A frontend-controlled string that represents the icon for this custom field.

Min Length

1

Max Length

63

Optionalname

name?: string

A collection of objects representing reporting periods for years.

Min Length

1

Max Length

63

Optionalvalues

values?: UpdateCustomFieldEnumValue[]

A collection of EnumValue objects representing the values in the domain of some Custom Field.

Settings

Member Visibility

On This Page

Properties