@shortcut/client
    Preparing search index...

    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[];
    }
    Index

    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

    canonical_name?: string

    The canonical name for a Shortcut-defined field.

    created_at: string

    The instant when this CustomField was created.

    date-time

    description?: string

    A string description of the CustomField

    1

    512

    enabled: boolean

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

    entity_type: "custom-field"

    A string description of this resource.

    field_type: "enum"

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

    fixed_position?: boolean

    When true, the CustomFieldEnumValues may not be reordered.

    icon_set_identifier?: string

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

    1

    63

    id: string

    The unique public ID for the CustomField.

    uuid

    name: string

    The name of the Custom Field.

    1

    63

    position: number

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

    int64

    Optionalstory_types

    story_types?: string[]

    The types of stories this CustomField is scoped to.

    updated_at: string

    The instant when this CustomField was last updated.

    date-time

    values?: CustomFieldEnumValue[]

    A collection of legal values for a CustomField.

    Settings

    Member Visibility

    On This Page

    Properties