|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "formal_form Resource - terraform-provider-formal" |
| 4 | +subcategory: "" |
| 5 | +description: |- |
| 6 | + Forms define reusable input schemas for workflows. |
| 7 | +--- |
| 8 | + |
| 9 | +# formal_form (Resource) |
| 10 | + |
| 11 | +Forms define reusable input schemas for workflows. |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | +<!-- schema generated by tfplugindocs --> |
| 16 | +## Schema |
| 17 | + |
| 18 | +### Required |
| 19 | + |
| 20 | +- `field` (Block List, Min: 1) List of fields that define the form schema. (see [below for nested schema](#nestedblock--field)) |
| 21 | +- `name` (String) The name of the form. Must be unique within the organization. |
| 22 | + |
| 23 | +### Optional |
| 24 | + |
| 25 | +- `description` (String) The form description. |
| 26 | + |
| 27 | +### Read-Only |
| 28 | + |
| 29 | +- `created_at` (String) When the form was created. |
| 30 | +- `id` (String) The unique identifier of the form. |
| 31 | +- `updated_at` (String) Last update time. |
| 32 | + |
| 33 | +<a id="nestedblock--field"></a> |
| 34 | +### Nested Schema for `field` |
| 35 | + |
| 36 | +Required: |
| 37 | + |
| 38 | +- `id` (String) Unique field identifier. |
| 39 | +- `name` (String) Display name of the field. |
| 40 | +- `type` (String) Field type. |
| 41 | + |
| 42 | +Optional: |
| 43 | + |
| 44 | +- `config` (Block List, Max: 1) Optional field configuration for select-like field types. (see [below for nested schema](#nestedblock--field--config)) |
| 45 | + |
| 46 | +<a id="nestedblock--field--config"></a> |
| 47 | +### Nested Schema for `field.config` |
| 48 | + |
| 49 | +Optional: |
| 50 | + |
| 51 | +- `option` (Block List) Static options for select-like fields. (see [below for nested schema](#nestedblock--field--config--option)) |
| 52 | +- `options_source` (Block List, Max: 1) Dynamic source used to fetch options. (see [below for nested schema](#nestedblock--field--config--options_source)) |
| 53 | + |
| 54 | +<a id="nestedblock--field--config--option"></a> |
| 55 | +### Nested Schema for `field.config.option` |
| 56 | + |
| 57 | +Required: |
| 58 | + |
| 59 | +- `label` (String) Option label. |
| 60 | +- `value` (String) Option value. |
| 61 | + |
| 62 | + |
| 63 | +<a id="nestedblock--field--config--options_source"></a> |
| 64 | +### Nested Schema for `field.config.options_source` |
| 65 | + |
| 66 | +Required: |
| 67 | + |
| 68 | +- `app` (String) Service/app name used to fetch options. |
| 69 | +- `command` (Block List, Min: 1, Max: 1) Command configuration for options retrieval. (see [below for nested schema](#nestedblock--field--config--options_source--command)) |
| 70 | +- `machine_user_id` (String) Machine user used to authenticate options retrieval. |
| 71 | +- `transform` (String) CEL expression that transforms the response into options. |
| 72 | + |
| 73 | +Optional: |
| 74 | + |
| 75 | +- `input` (Map of String) Optional payload for options retrieval. |
| 76 | + |
| 77 | +<a id="nestedblock--field--config--options_source--command"></a> |
| 78 | +### Nested Schema for `field.config.options_source.command` |
| 79 | + |
| 80 | +Required: |
| 81 | + |
| 82 | +- `name` (String) Command name. |
0 commit comments