REST Resource: projects.locations.instances.formDynamicParameters

Resource: FormDynamicParameter

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

JSON representation 
{
  "name": string,
  "relatedCustomFieldId": string,
  "relatedCustomField": {
    object (CustomField)
  },
  "id": string,
  "formType": enum (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 (int64 format)

Required. The customer field id that this parameter is related to.
relatedCustomField

object (CustomField)

Output only. The custom field that this parameter is related to.
id

string (int64 format)

Output only. Unique numeric ID for the FormDynamicParameter.
formType

enum (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 (CustomFieldType),
  "scopes": string,
  "description": string,

  // Union field type_options can be only one of the following:
  "radioButtonOptions": {
    object (RadioButtonOptions)
  },
  "multipleOptions": {
    object (MultipleOptions)
  }
  // End of list of possible types for union field type_options.
}
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 (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.
Union field type_options. Options specific to certain field types. type_options can be only one of the following:
radioButtonOptions

object (RadioButtonOptions)

Options for RADIO_BUTTON type.
multipleOptions

object (MultipleOptions)

Options for LIST or MULTIPLE_CHOICE_LIST types.

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 (CustomFieldOption)
    }
  ]
}
Fields
values[]

string

Required. The list of available options.
orderedValues[]

object (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.

Methods

get

 Gets a single FormDynamicParameter by its resource name.

list

 Lists all FormDynamicParameters defined in the instance.

saveForm

 Saves the complete set of dynamic parameters for a specific form type.