--- title: "Replace a job's plan" method: PUT path: "/jobs/{jobId}/plan" tags: ["jobs"] --- # Replace a job's plan `PUT /jobs/{jobId}/plan` Update a job's entire execution plan ## Path parameters - `jobId` string, required — Pipeline Job ID ## Headers - `Authorization` string, required - `X-Disable-Hooks` 'true', required ## Request body - TypeJobsJobExecutionPlanRequest - `fieldMapping` TypeJobsEdge[], required - `sourceField` union, required - object - `type` 'string', required — Discriminator value: string - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyStringConfig - `size` 'tiny' | 'normal' | 'medium' | 'long', required — How much text should be storeable in this field - object - `type` 'number', required — Discriminator value: number - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyNumberConfig - `decimalPlaces` integer — Number of decimal places to round data to - object - `type` 'boolean', required — Discriminator value: boolean - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyBooleanPropertyConfig - `allowIndeterminate` boolean, required — Allow a neither true or false state to be stored as `null` - object - `type` 'date', required — Discriminator value: date - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - object - `type` 'enum', required — Discriminator value: enum - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `multi` boolean — Will allow multiple values and store / provide the values in an array if set. Not all field types support arrays. Use enum-list type instead. - `config` TypePropertyEnumPropertyConfig, required - `allowCustom` boolean — Permit the user to create new options for this specific field. - `options` TypePropertyEnumPropertyOption[], required - `label` string — A visual label for this option - `description` string — A short description for this option - `color` string — An optional color to assign this option - `icon` string — A reference pointer to a previously registered icon - `meta` object — An arbitrary JSON object to be associated with this option and made available to hooks - `value` unknown, required - `alternativeNames` string[] — Alternative names to match this enum option to - `ordinal` integer — The order of this option in the list. SortBy must be set to `ordinal` to use this. - `sortBy` 'label' | 'value' | 'ordinal' - object - `type` 'reference', required — Discriminator value: reference - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyReferencePropertyConfig, required - `ref` string, required — Full path reference to a sheet configuration. Must be in the same workbook. - `key` string, required — Key of the property to use as the reference key. Defaults to `id` - `filter` TypePropertyReferenceFilter — If provided, the reference filter will narrow the set of records in the reference sheet used as the set of valid values for the record. Only rows where the value in the reference sheet's refField matches the value in this record's recordField will be used. - `refField` string, required — The field key of the reference sheet to filter with - `recordField` string, required — The field key of the record used to filter the reference field - `relationship` 'has-one' | 'has-many' - object - `type` 'reference-list', required — Discriminator value: reference-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyReferenceListPropertyConfig, required - `ref` string, required — Full path reference to a sheet configuration. Must be in the same workbook. - `key` string, required — Key of the property to use as the reference key. Defaults to `id` - `filter` TypePropertyReferenceFilter — If provided, the reference filter will narrow the set of records in the reference sheet used as the set of valid values for the record. Only rows where the value in the reference sheet's refField matches the value in this record's recordField will be used. - `refField` string, required — The field key of the reference sheet to filter with - `recordField` string, required — The field key of the record used to filter the reference field - object - `type` 'string-list', required — Discriminator value: string-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - object - `type` 'enum-list', required — Discriminator value: enum-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyEnumPropertyConfig, required - `allowCustom` boolean — Permit the user to create new options for this specific field. - `options` TypePropertyEnumPropertyOption[], required - `label` string — A visual label for this option - `description` string — A short description for this option - `color` string — An optional color to assign this option - `icon` string — A reference pointer to a previously registered icon - `meta` object — An arbitrary JSON object to be associated with this option and made available to hooks - `value` unknown, required - `alternativeNames` string[] — Alternative names to match this enum option to - `ordinal` integer — The order of this option in the list. SortBy must be set to `ordinal` to use this. - `sortBy` 'label' | 'value' | 'ordinal' - `destinationField` union, required - object - `type` 'string', required — Discriminator value: string - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyStringConfig - `size` 'tiny' | 'normal' | 'medium' | 'long', required — How much text should be storeable in this field - object - `type` 'number', required — Discriminator value: number - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyNumberConfig - `decimalPlaces` integer — Number of decimal places to round data to - object - `type` 'boolean', required — Discriminator value: boolean - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyBooleanPropertyConfig - `allowIndeterminate` boolean, required — Allow a neither true or false state to be stored as `null` - object - `type` 'date', required — Discriminator value: date - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - object - `type` 'enum', required — Discriminator value: enum - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `multi` boolean — Will allow multiple values and store / provide the values in an array if set. Not all field types support arrays. Use enum-list type instead. - `config` TypePropertyEnumPropertyConfig, required - `allowCustom` boolean — Permit the user to create new options for this specific field. - `options` TypePropertyEnumPropertyOption[], required - `label` string — A visual label for this option - `description` string — A short description for this option - `color` string — An optional color to assign this option - `icon` string — A reference pointer to a previously registered icon - `meta` object — An arbitrary JSON object to be associated with this option and made available to hooks - `value` unknown, required - `alternativeNames` string[] — Alternative names to match this enum option to - `ordinal` integer — The order of this option in the list. SortBy must be set to `ordinal` to use this. - `sortBy` 'label' | 'value' | 'ordinal' - object - `type` 'reference', required — Discriminator value: reference - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyReferencePropertyConfig, required - `ref` string, required — Full path reference to a sheet configuration. Must be in the same workbook. - `key` string, required — Key of the property to use as the reference key. Defaults to `id` - `filter` TypePropertyReferenceFilter — If provided, the reference filter will narrow the set of records in the reference sheet used as the set of valid values for the record. Only rows where the value in the reference sheet's refField matches the value in this record's recordField will be used. - `refField` string, required — The field key of the reference sheet to filter with - `recordField` string, required — The field key of the record used to filter the reference field - `relationship` 'has-one' | 'has-many' - object - `type` 'reference-list', required — Discriminator value: reference-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyReferenceListPropertyConfig, required - `ref` string, required — Full path reference to a sheet configuration. Must be in the same workbook. - `key` string, required — Key of the property to use as the reference key. Defaults to `id` - `filter` TypePropertyReferenceFilter — If provided, the reference filter will narrow the set of records in the reference sheet used as the set of valid values for the record. Only rows where the value in the reference sheet's refField matches the value in this record's recordField will be used. - `refField` string, required — The field key of the reference sheet to filter with - `recordField` string, required — The field key of the record used to filter the reference field - object - `type` 'string-list', required — Discriminator value: string-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - object - `type` 'enum-list', required — Discriminator value: enum-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyEnumPropertyConfig, required - `allowCustom` boolean — Permit the user to create new options for this specific field. - `options` TypePropertyEnumPropertyOption[], required - `label` string — A visual label for this option - `description` string — A short description for this option - `color` string — An optional color to assign this option - `icon` string — A reference pointer to a previously registered icon - `meta` object — An arbitrary JSON object to be associated with this option and made available to hooks - `value` unknown, required - `alternativeNames` string[] — Alternative names to match this enum option to - `ordinal` integer — The order of this option in the list. SortBy must be set to `ordinal` to use this. - `sortBy` 'label' | 'value' | 'ordinal' - `preview` string[] — A list of preview values of the data in the destination field - `enumDetails` TypeJobsEnumDetails — Only available if one or more of the destination fields is of type enum. Provides category mapping. - `mapping` TypeJobsCategoryMapping[], required — The mapping of source values to destination values - `sourceValue` union - string - integer - boolean - `destinationValue` union - string - integer - boolean - `unusedSourceValues` TypeJobsEnumValue[] — A list of source values that are not mapped from - union - string - integer - boolean - `unusedDestinationValues` TypeJobsEnumValue[] — A list of destination values that are not mapped to - union - string - integer - boolean - `metadata` TypeJobsMetadata - `certainty` 'absolute' | 'strong' | 'moderate' | 'weak' - `confidence` number, double - `source` string - `detectedDelimiter` string - `unmappedSourceFields` TypeJobsSourceField[], required - `sourceField` union, required - object - `type` 'string', required — Discriminator value: string - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyStringConfig - `size` 'tiny' | 'normal' | 'medium' | 'long', required — How much text should be storeable in this field - object - `type` 'number', required — Discriminator value: number - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyNumberConfig - `decimalPlaces` integer — Number of decimal places to round data to - object - `type` 'boolean', required — Discriminator value: boolean - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyBooleanPropertyConfig - `allowIndeterminate` boolean, required — Allow a neither true or false state to be stored as `null` - object - `type` 'date', required — Discriminator value: date - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - object - `type` 'enum', required — Discriminator value: enum - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `multi` boolean — Will allow multiple values and store / provide the values in an array if set. Not all field types support arrays. Use enum-list type instead. - `config` TypePropertyEnumPropertyConfig, required - `allowCustom` boolean — Permit the user to create new options for this specific field. - `options` TypePropertyEnumPropertyOption[], required - `label` string — A visual label for this option - `description` string — A short description for this option - `color` string — An optional color to assign this option - `icon` string — A reference pointer to a previously registered icon - `meta` object — An arbitrary JSON object to be associated with this option and made available to hooks - `value` unknown, required - `alternativeNames` string[] — Alternative names to match this enum option to - `ordinal` integer — The order of this option in the list. SortBy must be set to `ordinal` to use this. - `sortBy` 'label' | 'value' | 'ordinal' - object - `type` 'reference', required — Discriminator value: reference - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyReferencePropertyConfig, required - `ref` string, required — Full path reference to a sheet configuration. Must be in the same workbook. - `key` string, required — Key of the property to use as the reference key. Defaults to `id` - `filter` TypePropertyReferenceFilter — If provided, the reference filter will narrow the set of records in the reference sheet used as the set of valid values for the record. Only rows where the value in the reference sheet's refField matches the value in this record's recordField will be used. - `refField` string, required — The field key of the reference sheet to filter with - `recordField` string, required — The field key of the record used to filter the reference field - `relationship` 'has-one' | 'has-many' - object - `type` 'reference-list', required — Discriminator value: reference-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyReferenceListPropertyConfig, required - `ref` string, required — Full path reference to a sheet configuration. Must be in the same workbook. - `key` string, required — Key of the property to use as the reference key. Defaults to `id` - `filter` TypePropertyReferenceFilter — If provided, the reference filter will narrow the set of records in the reference sheet used as the set of valid values for the record. Only rows where the value in the reference sheet's refField matches the value in this record's recordField will be used. - `refField` string, required — The field key of the reference sheet to filter with - `recordField` string, required — The field key of the record used to filter the reference field - object - `type` 'string-list', required — Discriminator value: string-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - object - … - object - … - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - object - `type` 'enum-list', required — Discriminator value: enum-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - union - object - … - object - … - object - … - object - … - object - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - `size` 'xs' | 's' | 'm' | 'l' | 'xl' — The default visual sizing. This sizing may be overridden by a user - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - … - `mount` union - object - … - object - … - object - … - … truncated; see the full OpenAPI document linked below ## Response `200` Response with status 200 - TypeJobsJobPlanResponse - `data` TypeJobsJobPlan, required — The job/plan tuple that contains the full plan and the jobs status - `job` TypeJobsJob, required — A single unit of work that will execute asynchronously - `type` 'file' | 'workbook' | 'sheet' | 'space' | 'document' | 'app' | 'agent' | 'autobuild' | 'onboarding', required — The type of job - `operation` string, required — the type of operation to perform on the data. For example, "export". - `source` string, required — The id of a file, workbook, sheet, or app - `destination` string — Workbook ID - `config` union - TypeJobsDeleteRecordsJobConfig — The configuration for a delete job - `filter` 'valid' | 'error' | 'all' | 'none' — Options to filter records - `filterField` string — Use this to narrow the valid/error filter results to a specific field - `searchValue` string — Search for the given value, returning matching rows. For exact matches, wrap the value in double quotes ("Bob"). To search for null values, send empty double quotes ("") - `searchField` string — Use this to narrow the searchValue results to a specific field - `q` string — FFQL query to filter records - `sheet` string, required — Sheet ID - `exceptions` TypeCommonsRecordId[] — List of record ids to exclude from deletion - `snapshotLabel` string — If specified, a snapshot will be generated with this label - TypeJobsFileJobConfig - `driver` 'csv', required — The driver to use for extracting data from the file - `options` object — The options to use for extracting data from the file - `detectedHeaderRow` integer — The row number of the header row detected at extraction time - TypeJobsPipelineJobConfig - `sourceSheetId` string, required — Sheet ID - `destinationSheetId` string, required — Sheet ID - `runbookId` string — Runbook ID - TypeJobsExportJobConfig - `options` TypeJobsExportOptions, required - `versionId` string — Version ID - `commitId` string — Commit ID - `sortField` string — Name of field by which to sort records - `sortDirection` 'asc' | 'desc' — Sort direction - asc (ascending) or desc (descending) - `filter` 'valid' | 'error' | 'all' | 'none' — Options to filter records - `filterField` string — Use this to narrow the valid/error filter results to a specific field - `searchValue` string — Search for the given value, returning matching rows. For exact matches, wrap the value in double quotes ("Bob"). To search for null values, send empty double quotes ("") - `searchField` string — Use this to narrow the searchValue results to a specific field - `q` string — The FFQL query to filter records - `ids` TypeCommonsRecordId[] — The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records - TypeJobsMutateJobConfig - `sheetId` string, required — Sheet ID - `mutateRecord` string, required — A JavaScript function that will be run on each record in the sheet, it should return a mutated record. - `mutationId` string — If the mutation was generated through some sort of id-ed process, this links this job and that process. - `snapshotLabel` string — If specified, a snapshot will be generated with this label - `snapshotId` string — The generated snapshotId will be stored here - `filter` 'valid' | 'error' | 'all' | 'none' — Options to filter records - `filterField` string — Use this to narrow the valid/error filter results to a specific field - `searchValue` string — Search for the given value, returning matching rows. For exact matches, wrap the value in double quotes ("Bob"). To search for null values, send empty double quotes ("") - `searchField` string — Use this to narrow the searchValue results to a specific field - `q` string - `ids` TypeCommonsRecordId[] — The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records - TypeJobsFindAndReplaceJobConfig - `filter` 'valid' | 'error' | 'all' | 'none' — Options to filter records - `filterField` string — Use this to narrow the valid/error filter results to a specific field - `searchValue` string — Search for the given value, returning matching rows. For exact matches, wrap the value in double quotes ("Bob"). To search for null values, send empty double quotes ("") - `searchField` string — Use this to narrow the searchValue results to a specific field - `q` string — The FFQL query to filter records - `ids` TypeCommonsRecordId[] — The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records - `find` union - string - integer - integer - number, double - boolean - string, date - string, date-time - string[] - `replace` union - string - integer - integer - number, double - boolean - string, date - string, date-time - string[] - `fieldKey` string, required — A unique key used to identify a field in a sheet - `snapshotLabel` string — If specified, a snapshot will be generated with this label - TypeJobsMappingProgramJobConfig - `sourceSheetId` string, required — Sheet ID - `destinationSheetId` string, required — Sheet ID - `mappingRules` object[], required - `canRecompute` boolean - TypeJobsAiGenerateBlueprintJobConfig - `spaceId` string, required — Space ID - `appId` string, required — App ID - TypeJobsAiGenerateSampleDataJobConfig - `spaceId` string, required — Space ID - `appId` string, required — App ID - TypeJobsAiGenerateBlueprintConstraintsJobConfig - `spaceId` string, required — Space ID - `workbookId` string, required — Workbook ID - TypeJobsAiGenerateConstraintJobConfig - `spaceId` string, required — Space ID - `constraints` TypePropertyStoredConstraint[], required - `validator` string, required — Must match the constraint validator name. - `version` integer — The version of the stored constraint to use. (Defaults to version 1.) - `description` string — A full description of what this constraint configuration does - `label` string — A short description of what this constraint constraint should do, example - values between 1 and 100 - `config` unknown - `description` string — A description of what the constraint to be generated should do - TypeJobsAiRuleCreationJobConfig — Configuration for AI-powered rule creation jobs that generate or replace field constraints - `label` string — Display name for the rule to be created - `prompt` string, required — The natural language description of the rule to be created - `sheetId` string, required — Sheet ID - `fieldKey` string, required — The key of the field to create/update the rule for - `index` integer — To edit an existing rule, provide the index of the constraint in the constraints array for the field and that constraint will be replaced. - TypeJobsCaptureRoutineJobConfig - `sourceJobId` string, required — Pipeline Job ID - `runbookId` string, required — Runbook ID - TypeJobsRunRunbookJobConfig - `sourceSheetId` string, required — Sheet ID - `runbookId` string, required — Runbook ID - TypeJobsMappingFromPreprocessingJobConfig - `proposal` unknown, required - `mappingJobId` string, required — Pipeline Job ID - TypeJobsEmptyObject - TypeJobsAddRecordsToDataClipJobConfig — The configuration for an add records to DataClip job - `dataClipId` string, required — Data Clip ID - `sheetId` string, required — Sheet ID - TypeJobsUpdateDataClipResolutionsJobConfig — Configuration for a data clip resolution job - `clipId` string, required — Data Clip ID - `clippedSheetId` string, required — Sheet ID - `resolveTo` 'clip' | 'main' | 'snapshot', required - `removedFromMainResolution` 'ignore' | 'restore', required - `columnField` string, required — Optional. If provided, only this column will be resolved. - `columnValue` string, required — Optional. If provided, this value in the column will be replaced with the resolution target. - TypeJobsAgentExportJobConfig — The configuration for an agent export job - `exportType` 'AUTOBUILD_INLINED' | 'SYSTEM_COMBINED' | 'SOURCE', required — The different export type formats available. - TypeJobsAgentPromotionJobConfig — The configuration for an agent promotion job - `targetEnvironmentId` string, required — Environment ID - `spaceId` string, required — Space ID - TypeJobsCompanyResearchJobConfig — The configuration for a company research job - `onboardingId` string, required — The onboarding id - `url` string — The url of the company to research - `companyName` string — The name of the company to research - TypeJobsConfigureDemoJobConfig — The configuration for an onboarding job - `companyName` string, required — The name of the company - TypeJobsBulkMutateFlagsJobConfig — The configuration for a bulk flag mutation job - `workbookId` string, required — Workbook ID - `exceptions` string[] — Record IDs to exclude from the operation - `query` string — Query string to filter records - `filter` unknown - `filterField` string — Field to filter on - `searchValue` string — Value to search for - `searchField` string — Field to search in - `q` string — General search query - `ids` string[] — Specific record IDs to target - `snapshotLabel` string — Label for snapshot before mutation - `mutation` TypeJobsFlagMutationConfig, required — Configuration for flag mutation operations - `type` 'flag', required — The type of mutation (always "flag") - `operation` 'apply' | 'update' | 'delete' | 'replace', required — The type of flag operation to perform - `flag` TypeJobsFlagMutationConfigData, required — Flag data for mutation operations - … - `flags` string[] — Array of flag slugs for delete operation - `trigger` 'manual' | 'immediate' — The type of trigger to use for this job - `status` 'created' | 'planning' | 'scheduled' | 'ready' | 'executing' | 'complete' | 'failed' | 'canceled' | 'waiting' — the status of the job - `progress` integer — the progress of the job. Whole number between 0 and 100 - `fileId` string — File ID - `mode` 'foreground' | 'background' | 'toolbarBlocking' | 'hidden' — the mode of the job - `input` object — Input parameters for this job type. - `subject` union — Subject parameters for this job type - object - `type` 'resource', required — Discriminator value: resource - `id` string, required - object - `type` 'collection', required — Discriminator value: collection - `resource` string, required - `params` object - `query` object - `outcome` object — Outcome summary of job. - `result` object — Information computed during job execution can be stored here - `info` string — Current status of job in text - `managed` boolean — Indicates if Flatfile is managing the control flow of this job or if it is being manually tracked. - `environmentId` string — Environment ID - `part` integer — The part number of this job - `partData` object — The data for this part of the job - `partExecution` 'sequential' | 'parallel' - `parentId` string — Pipeline Job ID - `predecessorIds` TypeCommonsJobId[] — The ids of the jobs that must complete before this job can start - `metadata` object — Additional metadata for the job - `id` string, required — Pipeline Job ID - `createdBy` string, required — Actor ID - `createdAt` string, date-time, required — Date the item was created - `updatedAt` string, date-time, required — Date the item was last updated - `startedAt` string, date-time — the time that the job started at - `finishedAt` string, date-time — the time that the job finished at - `outcomeAcknowledgedAt` string, date-time — the time that the job's outcome has been acknowledged by a user - `spaceId` string — Space ID - `plan` TypeJobsJobExecutionPlan, required — The execution plan for a job, for example, for a map job, the execution plan is the mapping of the source sheet to the destination sheet. - `fieldMapping` TypeJobsEdge[], required - `sourceField` union, required - object - `type` 'string', required — Discriminator value: string - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyStringConfig - … - object - `type` 'number', required — Discriminator value: number - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyNumberConfig - … - object - `type` 'boolean', required — Discriminator value: boolean - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyBooleanPropertyConfig - … - object - `type` 'date', required — Discriminator value: date - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - object - `type` 'enum', required — Discriminator value: enum - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `multi` boolean — Will allow multiple values and store / provide the values in an array if set. Not all field types support arrays. Use enum-list type instead. - `config` TypePropertyEnumPropertyConfig, required - … - object - `type` 'reference', required — Discriminator value: reference - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyReferencePropertyConfig, required - … - object - `type` 'reference-list', required — Discriminator value: reference-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyReferenceListPropertyConfig, required - … - object - `type` 'string-list', required — Discriminator value: string-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - object - `type` 'enum-list', required — Discriminator value: enum-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyEnumPropertyConfig, required - … - `destinationField` union, required - object - `type` 'string', required — Discriminator value: string - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyStringConfig - … - object - `type` 'number', required — Discriminator value: number - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyNumberConfig - … - object - `type` 'boolean', required — Discriminator value: boolean - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyBooleanPropertyConfig - … - object - `type` 'date', required — Discriminator value: date - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - object - `type` 'enum', required — Discriminator value: enum - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `multi` boolean — Will allow multiple values and store / provide the values in an array if set. Not all field types support arrays. Use enum-list type instead. - `config` TypePropertyEnumPropertyConfig, required - … - object - `type` 'reference', required — Discriminator value: reference - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyReferencePropertyConfig, required - … - object - `type` 'reference-list', required — Discriminator value: reference-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyReferenceListPropertyConfig, required - … - object - `type` 'string-list', required — Discriminator value: string-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - object - `type` 'enum-list', required — Discriminator value: enum-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyEnumPropertyConfig, required - … - `preview` string[] — A list of preview values of the data in the destination field - `enumDetails` TypeJobsEnumDetails — Only available if one or more of the destination fields is of type enum. Provides category mapping. - `mapping` TypeJobsCategoryMapping[], required — The mapping of source values to destination values - `sourceValue` union - … - `destinationValue` union - … - `unusedSourceValues` TypeJobsEnumValue[] — A list of source values that are not mapped from - union - … - `unusedDestinationValues` TypeJobsEnumValue[] — A list of destination values that are not mapped to - union - … - `metadata` TypeJobsMetadata - `certainty` 'absolute' | 'strong' | 'moderate' | 'weak' - `confidence` number, double - `source` string - `detectedDelimiter` string - `unmappedSourceFields` TypeJobsSourceField[], required - `sourceField` union, required - object - `type` 'string', required — Discriminator value: string - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyStringConfig - … - object - `type` 'number', required — Discriminator value: number - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyNumberConfig - … - object - `type` 'boolean', required — Discriminator value: boolean - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyBooleanPropertyConfig - … - object - `type` 'date', required — Discriminator value: date - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - object - `type` 'enum', required — Discriminator value: enum - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `multi` boolean — Will allow multiple values and store / provide the values in an array if set. Not all field types support arrays. Use enum-list type instead. - `config` TypePropertyEnumPropertyConfig, required - … - object - `type` 'reference', required — Discriminator value: reference - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyReferencePropertyConfig, required - … - object - `type` 'reference-list', required — Discriminator value: reference-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyReferenceListPropertyConfig, required - … - object - `type` 'string-list', required — Discriminator value: string-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - object - `type` 'enum-list', required — Discriminator value: enum-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyEnumPropertyConfig, required - … - `preview` string[] — A list of preview values of the data in the source field - `unmappedDestinationFields` TypeJobsDestinationField[], required - `destinationField` union, required - object - `type` 'string', required — Discriminator value: string - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyStringConfig - … - object - `type` 'number', required — Discriminator value: number - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyNumberConfig - … - object - `type` 'boolean', required — Discriminator value: boolean - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyBooleanPropertyConfig - … - object - `type` 'date', required — Discriminator value: date - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - object - `type` 'enum', required — Discriminator value: enum - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `multi` boolean — Will allow multiple values and store / provide the values in an array if set. Not all field types support arrays. Use enum-list type instead. - `config` TypePropertyEnumPropertyConfig, required - … - object - `type` 'reference', required — Discriminator value: reference - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyReferencePropertyConfig, required - … - object - `type` 'reference-list', required — Discriminator value: reference-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyReferenceListPropertyConfig, required - … - object - `type` 'string-list', required — Discriminator value: string-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - object - `type` 'enum-list', required — Discriminator value: enum-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyEnumPropertyConfig, required - … - `preview` string[] — A list of preview values of the data in the destination field - `programId` string --- [API](https://skmtc.net/flatfile/apis/api-reference.md) · [All operations](https://skmtc.net/flatfile/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flatfile/api-reference/revisions/9d3a9979cd96/schema)