• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Business event processing

Settings API - Business event processing schema table

Business event processing (builtin:bizevents-processing-pipelines.rule)

Incoming business events can be transformed through processing rules using this syntax. Note that rules are processed sequentially, making the order important; a different rule order could give different results.

Schema IDSchema groupsScope
builtin:bizevents-processing-pipelines.rule
  • group:business-analytics
  • group:business-analytics.ingest-pipeline
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:bizevents-processing-pipelines.rule
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:bizevents-processing-pipelines.rule
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:bizevents-processing-pipelines.rule

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

PropertyLabelTypeDescriptionRequired
enabledEnabledboolean-required
ruleNameRule nametext-required
matcherMatcher (DQL)text

See our documentation

required
transformationFieldsTransformation fieldslist-required
scriptProcessor definitiontext

See our documentation

required
RuleTesting-RuleTesting required

Request body objects

The TransformationField object
PropertyLabelTypeDescriptionRequired
typeTypeenum-required
nameNametext-required
optionalOptionalboolean-required
arrayIs Arrayboolean-required
readonlyRead-onlyboolean-required
The RuleTesting object
PropertyLabelTypeDescriptionRequired
sampleEventEvent sampletext

Sample event to use for the test run. Only JSON format is supported.

required