Method: ontologyRecords.family

Full name: projects.locations.instances.ontologyRecords.family

Fetch ontology family.

HTTP request


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

Path parameters

Parameters
parent

string

Required. The instance into which OntologyRecords should be imported. Format: projects/{project}/locations/{location}/instances/{instance}/ontologyRecords

Query parameters

Parameters
source

string

Required. The data source (e.g., "GoogleChronicle").
product

string

Required. The product name (e.g. "RandomProductExample0").
eventName

string

Required. The event name (e.g., "IRC Connections").

Request body

The request body must be empty.

Response body

Response message for GetOntologyFamily.

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

JSON representation 
{
  "visualFamilyId": string,
  "visualFamilyName": string,
  "ontologyConfigurationLevel": enum (OntologyConfigurationLevel)
}
Fields
visualFamilyId

string (int64 format)

Output only. The visual family id of the ontology family.
visualFamilyName

string

Output only. The visual family name of the ontology family.
ontologyConfigurationLevel

enum (OntologyConfigurationLevel)

Output only. The ontology configuration level of the ontology family.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.ontologyRecords.get

For more information, see the IAM documentation.

OntologyConfigurationLevel

The ontology configuration level of the ontology family.

Enums
ONTOLOGY_CONFIGURATION_LEVEL_UNSPECIFIED The ontology configuration level is unspecified.
SOURCE The ontology configuration level is not specified.
PRODUCT The ontology configuration level is product.
EVENT_NAME The ontology configuration level is event name.