Try it free

Settings API - Ingest primary Grail tag processing rules schema table

  • Published Jul 20, 2026

Ingest primary Grail tag processing rules (builtin:openpipeline.primary-grail-tag)

Global rules for primary Grail tag extraction and processing during ingest

Schema IDSchema groupsScope
builtin:openpipeline.primary-grail-tag-
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:openpipeline.primary-grail-tag
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:openpipeline.primary-grail-tag
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:openpipeline.primary-grail-tag

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyTypeDescriptionRequired
Rule name
ruleName		text

A descriptive name for this rule

Required
Primary tag field name
primaryTagFieldName		text

The unique target identifier within the primary_tags namespace. Must be unique across all rules.

Required
Matching condition
matchingCondition		text

A DQL expression that determines which records this rule applies to

Required
Keep fields
keepFields		boolean

Whether to keep (true) or drop (false) the source field

Required
Source fields
sourceFields		PrimaryGrailTagSourceField[]

Ordered list of source fields to consider. The first field that exist should be considered a source value for the primary tag

Required
Enabled
enabled		boolean

Whether this rule is active

Required
The PrimaryGrailTagSourceField object
PropertyTypeDescriptionRequired
Field expression
fieldExpression		text

A DQL field access expression identifying the source field

Required