- [Resource: FormDynamicParameter](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#FormDynamicParameter)
  - [JSON representation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#FormDynamicParameter.SCHEMA_REPRESENTATION)
- [FormType](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#FormType)
- [CustomField](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#CustomField)
  - [JSON representation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#CustomField.SCHEMA_REPRESENTATION)
- [RadioButtonOptions](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#RadioButtonOptions)
  - [JSON representation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#RadioButtonOptions.SCHEMA_REPRESENTATION)
- [MultipleOptions](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#MultipleOptions)
  - [JSON representation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#MultipleOptions.SCHEMA_REPRESENTATION)
- [CustomFieldOption](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#CustomFieldOption)
  - [JSON representation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#CustomFieldOption.SCHEMA_REPRESENTATION)
- [CustomFieldType](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#CustomFieldType)
- [ControllingCalculatedFieldDefinition](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#ControllingCalculatedFieldDefinition)
  - [JSON representation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#ControllingCalculatedFieldDefinition.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#METHODS_SUMMARY)

## Resource: FormDynamicParameter

A Form Dynamic Parameter is a parameter that can be used in a form.

| JSON representation |
|---|
| ``` { "name": string, "relatedCustomFieldId": string, "relatedCustomField": { object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#CustomField`) }, "id": string, "formType": enum (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#FormType`), "order": integer } ``` |

| Fields ||
|---|---|
| `name` | `string` Output only. Identifier. The resource name of the FormDynamicParameter. Format: projects/{project}/locations/{location}/instances/{instance}/formDynamicParameters/{formDynamicParameter} |
| `relatedCustomFieldId` | `string (https://developers.google.com/discovery/v1/type-format format)` Required. The customer field id that this parameter is related to. |
| `relatedCustomField` | ``object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#CustomField`)`` Output only. The custom field that this parameter is related to. |
| `id` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. Unique numeric ID for the FormDynamicParameter. |
| `formType` | ``enum (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#FormType`)`` Required. The type of the form this parameter belongs to. |
| `order` | `integer` Required. The order of the parameter in the form. |

## FormType

The types of forms the parameters can belong to.

| Enums ||
|---|---|
| `INVALID` | The form type is unspecified/invalid. |
| `CLOSE_CASE` | Close case form. |

## CustomField

This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. Represents a Custom Field definition.

| JSON representation |
|---|
| ``` { "name": string, "displayName": string, "type": enum (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#CustomFieldType`), "scopes": string, "description": string, "controllingCalculatedFieldDefinitions": [ { object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#ControllingCalculatedFieldDefinition`) } ], "id": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "radioButtonOptions": { object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#RadioButtonOptions`) }, "multipleOptions": { object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#MultipleOptions`) } // End of mutually exclusive fields. } ``` |

| Fields ||
|---|---|
| `name` | `string` Identifier. The unique name(ID) of the CustomField. Format: projects/{project}/locations/{location}/instances/{instance}/customFields/{customField} |
| `displayName` | `string` Required. A unique display name for the custom field. Maximum length of 255 characters. |
| `type` | ``enum (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#CustomFieldType`)`` Required. The type of the custom field. |
| `scopes` | `string` Required. Array of allowed scopes for the custom field. |
| `description` | `string` Optional. Optional description of the custom field. Maximum length of 1024 characters. |
| `controllingCalculatedFieldDefinitions[]` | ``object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#ControllingCalculatedFieldDefinition`)`` Output only. Calculated fields that control this custom field. Maximum of one per scope (Case and Alert). |
| `id` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. The id of the custom field. |
| Options specific to certain field types. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `radioButtonOptions` | ``object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#RadioButtonOptions`)`` Options for RADIO_BUTTON type. |
| `multipleOptions` | ``object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#MultipleOptions`)`` Options for LIST or MULTIPLE_CHOICE_LIST types. |
| End of mutually exclusive fields. ||

## RadioButtonOptions

Options for RadioButton type custom fields.

| JSON representation |
|---|
| ``` { "firstOption": string, "secondOption": string } ``` |

| Fields ||
|---|---|
| `firstOption` | `string` Required. The label for the first radio button option. |
| `secondOption` | `string` Required. The label for the second radio button option. |

## MultipleOptions

Options for List and MultipleChoiceList type custom fields.

| JSON representation |
|---|
| ``` { "values": [ string ], "orderedValues": [ { object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#CustomFieldOption`) } ] } ``` |

| Fields ||
|---|---|
| `values[]` | `string` Required. The list of available options. |
| `orderedValues[]` | ``object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters#CustomFieldOption`)`` Required. The list of available options in the order they should be displayed. |

## CustomFieldOption

An option for a custom field. This is used to specify the order in which the options should be displayed in the UI.

| JSON representation |
|---|
| ``` { "orderIndex": integer, "value": string } ``` |

| Fields ||
|---|---|
| `orderIndex` | `integer` Required. The list of available options. |
| `value` | `string` Required. The list of available options in the order they should be displayed. |

## CustomFieldType

Enum representing the type of the custom field.

| Enums ||
|---|---|
| `CUSTOM_FIELD_TYPE_UNSPECIFIED` | Unspecified custom field type. |
| `FREE_TEXT` | Free text input. |
| `RADIO_BUTTON` | Radio button selection (binary choice). |
| `LIST` | Dropdown list selection (single choice). |
| `MULTIPLE_CHOICE_LIST` | Multiple choice list selection. |
| `DATE_TIME` | Date and time input. |

## ControllingCalculatedFieldDefinition

A calculated field that dynamically controls a custom field.

| JSON representation |
|---|
| ``` { "scope": string, "calculatedFieldDefinition": string } ``` |

| Fields ||
|---|---|
| `scope` | `string` Output only. The scope this calculated field controls (Case or Alert) |
| `calculatedFieldDefinition` | `string` Output only. The resource name of the calculated field definition. Format: projects/{project}/locations/{location}/instances/{instance}/calculatedFieldDefinitions/{calculatedFieldDefinition} |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters/get` | Gets a single FormDynamicParameter by its resource name. |
| ### `https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters/list` | Lists all FormDynamicParameters defined in the instance. |
| ### `https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.formDynamicParameters/saveForm` | Saves the complete set of dynamic parameters for a specific form type. |