Skip to main content

FormBundleItem

@gravity-rail/sdk


@gravity-rail/sdk / FormBundleItem

Interface: FormBundleItem

A whole Form definition, created in the installing workspace.

dataTypeUuid is the source workspace's DataType identity: the uuid a published Workflow ability names in its data_access configuration. It is the relocation key — installation maps it to the local DataType it creates — and a new draft must carry it (:class:ReplaceBundleDraftRequest).

Stored items published before this identity existed omit the key. Reading them back leaves it unset so the version stays readable; installation refuses that item instead of answering 500 or inventing an identity.

Properties​

dataTypeUuid?​

optional dataTypeUuid: string | null


description?​

optional description: string | null


fields​

fields: RequirementSchemaField[]

Min Items​

1

Max Items​

100


isCollection?​

optional isCollection: boolean


key​

key: string

Min Length​

1

Max Length​

100

Pattern​

^[a-z][a-z0-9_]*$


kind​

kind: "form"


name​

name: string

Min Length​

1

Max Length​

255


prompt?​

optional prompt: string | null


recordScope?​

optional recordScope: FormBundleItemRecordScope


slug​

slug: string

Min Length​

1

Max Length​

255