REST Resource: projects.locations.instances.customFields

Resource: 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
  ]
}
Fields
values[]

string

Required. The list of available options.

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

batchGet

 Batch gets multiple CustomFields.

create

 Create a CustomField.

delete

 Delete a CustomField.

get

 Get a CustomField.

list

 Lists custom fields.

patch

 Update a CustomField.