Method: mappingRules.test

Full name: projects.locations.instances.ontologyRecords.mappingRules.test

Validates the logic of a specific mapping rule by applying it to a sample raw data field name and value. Returns the resulting transformed values for verification.

HTTP request


POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{name}:test

Path parameters

Parameters
name

string

Required. The resource name of the MappingRule to test. Format: projects/{project}/locations/{location}/instances/{instance}/ontologyRecords/{ontologyRecord}/mappingRules/{mappingRule}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "rawDataFieldName": string,
  "rawDataFieldValue": string
}
Fields
rawDataFieldName

string

Required. The name of the field in the raw data.
rawDataFieldValue

string

Required. The value of the field in the raw data.

Response body

Response message for mappingRules.test.

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

JSON representation 
{
  "result": [
    string
  ]
}
Fields
result[]

string

The result of the test.

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 name resource:

  • chronicle.mappingRules.get

For more information, see the IAM documentation.