Method: calculatedFieldDefinitions.fetchAvailableTargetFields

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

Searches for fields available to be used as a TargetFieldName for a new Calculated Field. This is a custom method because it returns a derived list of fields, not standard resource data.

HTTP request


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

Path parameters

Parameters
parent

string

Required. The parent instance for the available target fields. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
pageSize

integer

Optional. Sets the size of a page of target fields.
pageToken

string

Optional. Allows the request to page through all available target fields.
filter

string

Optional. Filter string.
orderBy

string

Optional. Field to order by.

Request body

The request body must be empty.

Response body

Response message for calculatedFieldDefinitions.fetchAvailableTargetFields.

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

JSON representation 
{
  "availableTargetFields": [
    {
      object (AvailableTargetField)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
availableTargetFields[]

object (AvailableTargetField)

List of available target fields.
nextPageToken

string

Tells the client how to request the next page of target fields.
totalSize

integer

Tells the client how many target fields exist. Useful for calculating the total number of pages.

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.

AvailableTargetField

Represents an available target field that can be used for a Calculated Field Definition.

JSON representation 
{
  "fieldName": string,
  "expectedOutputType": enum (OutputType),
  "fieldType": enum (FieldType)
}
Fields
fieldName

string

Output only. A user-friendly display name for the available target field (e.g., "Case Priority").
expectedOutputType

enum (OutputType)

Output only. The expected data type of the field from the possible Output Types.
fieldType

enum (FieldType)

Output only. The kind of field: "System" or "Custom".

FieldType

The kind of field: "System" or "Custom".

Enums
FIELD_TYPE_UNSPECIFIED Default value. This value is unused.
SYSTEM The field is a system field.
CUSTOM The field is a custom field.