API Data Provider - Online Help

CustomFields

Returns custom fields in the workspace.

Columns

Name Type ReadOnly References Description
Id [KEY] String True

Custom field UUID

Name String False

Display name (max 63 chars)

CanonicalName String True

Standardized field name

Description String False

Purpose description

FieldType String True

Field type (e.g. enum)

IsEnabled Boolean False

Whether field is active

IsFixedPosition Boolean True

Whether position is fixed

Position Integer True

Sort order

EntityType String True

Type identifier

StoryTypes String True

Applicable story types

Values String False

Enum values array

CreatedAt Datetime True

Creation timestamp

UpdatedAt Datetime True

Last modification timestamp

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0