Interface CustomField

interface CustomField {
    canonical_name?: string;
    created_at: string;
    description?: string;
    enabled: boolean;
    entity_type: "custom-field";
    field_type: "enum";
    fixed_position?: boolean;
    icon_set_identifier?: string;
    id: string;
    name: string;
    position: number;
    story_types?: string[];
    updated_at: string;
    values?: CustomFieldEnumValue[];
}

Properties

canonical_name? created_at description? enabled entity_type field_type fixed_position? icon_set_identifier? id name position story_types? updated_at values?

Properties

Optionalcanonical_name

canonical_name?: string

The canonical name for a Shortcut-defined field.

created_at

created_at: string

The instant when this CustomField was created.

Format

date-time

Optionaldescription

description?: string

A string description of the CustomField

Min Length

1

Max Length

512

enabled

enabled: boolean

When true, the CustomField can be applied to entities in the Workspace.

entity_type

entity_type: "custom-field"

A string description of this resource.

field_type

field_type: "enum"

The type of Custom Field, eg. 'enum'.

Optionalfixed_position

fixed_position?: boolean

When true, the CustomFieldEnumValues may not be reordered.

Optionalicon_set_identifier

icon_set_identifier?: string

A string that represents the icon that corresponds to this custom field.

Min Length

1

Max Length

63

id

id: string

The unique public ID for the CustomField.

Format

uuid

name

name: string

The name of the Custom Field.

Min Length

1

Max Length

63

position

position: number

An integer indicating the position of this Custom Field with respect to the other CustomField

Format

int64

Optionalstory_types

story_types?: string[]

The types of stories this CustomField is scoped to.

updated_at

updated_at: string

The instant when this CustomField was last updated.

Format

date-time

Optionalvalues

values?: CustomFieldEnumValue[]

A collection of legal values for a CustomField.

Settings

Member Visibility

On This Page

Properties