Method: calculatedFieldDefinitions.fetchDynamicOptions

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
  • JSON representation
• Authorization scopes
• IAM Permissions
• EntityType
• OptionStatus
  • JSON representation

Full name: projects.locations.instances.calculatedFieldDefinitions.fetchDynamicOptions

Get Dynamic Options for a target field based on Calculated Field definitions. This is a custom method.

This method evaluates calculated field definitions of type 'FILTER_OPTIONS' for a given entity (e.g. Case or Alert) and target field. It returns the list of all possible options for that field, indicating which ones are currently valid based on the formula logic. This is used by the UI to dynamically enable or disable options in dropdown menus for a specific entity like a Case or Alert. This differs from calculatedFieldDefinitions.list, which only retrieves the definitions themselves and does not evaluate formulas against a specific entity.

HTTP request

Choose a location:

africa-south1 asia-northeast1 asia-south1 asia-southeast1 asia-southeast2 australia-southeast1 europe-central2 europe-west12 europe-west2 europe-west3 europe-west6 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast2 southamerica-east1 us eu

GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{parent}/calculatedFieldDefinitions:fetchDynamicOptions

Path parameters

Parameters
parent	string Required. The parent instance. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
targetField	string Required. The full name of the field to check (e.g., CaseCustom.my_field, Case.priority).
entityId	string Required. The ID of the specific Case or Alert.
entityType	enum (EntityType) Required. The type of the entity ('CASE' or 'ALERT').

Request body

The request body must be empty.

Response body

Response message for calculatedFieldDefinitions.fetchDynamicOptions.

If successful, the response body contains data with the following structure:

JSON representation
{ "options": [ { object (OptionStatus) } ] }

Fields
options[]	object (OptionStatus) Status of each possible option.

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/chronicle
• https://www.googleapis.com/auth/chronicle.readonly

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

• chronicle.calculatedFieldDefinitions.get

For more information, see the IAM documentation.

EntityType

Enum for Entity Type.

Enums
ENTITY_TYPE_UNSPECIFIED	Default value. This value is unused.
CASE	The entity is a Case.
ALERT	The entity is an Alert.

OptionStatus

Represents the status of a single option.

JSON representation
{ "value": string, "isValid": boolean }

Fields
value	string The option value.
isValid	boolean Whether the option is valid in the current context.