Method: calculatedFieldDefinitions.validateDependency

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

Validate a potential dependency for a Calculated Field formula. This custom method is used, for example, by the frontend Formula Builder UI when a user selects a field to be used within a formula. The RPC checks if the provided new dependency field is valid to be included as a dependency. The primary validation is to ensure the field is NOT the target of any other existing Calculated Field Definition. The response will indicate if the field is a permissible dependency.

HTTP request


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

Path parameters

Parameters
parent

string

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

Query parameters

Parameters
newDependencyField

string

Required. The field name to validate as a potential dependency. e.g., CaseCustom.potential_dependency_field

Request body

The request body must be empty.

Response body

Response message for calculatedFieldDefinitions.validateDependency.

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

JSON representation 
{
  "isValid": boolean,
  "reason": string
}
Fields
isValid

boolean

Whether the field is a valid dependency.
reason

string

Reason if the field is not a valid dependency.

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.