Settings API - Business event processing schema table

  • Published Dec 05, 2023

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
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:bizevents-processing-pipelines.rule
GETEnvironment 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

PropertyTypeDescriptionRequired
Enabled
enabled		boolean-Required
Rule name
ruleName		text-Required
Matcher (DQL)
matcher		text

See our documentation

Required
Transformation fields
transformationFields		TransformationField[]-Required
Processor definition
script		text

See our documentation

Required
RuleTestingRuleTesting Required
The TransformationField object
PropertyTypeDescriptionRequired
Type
type		enum
The element has these enums
  • STRING
  • BOOLEAN
  • INT
  • LONG
  • DOUBLE
  • DURATION
  • TIMESTAMP
  • IPADDR
Required
Name
name		text-Required
Optional
optional		boolean-Required
Is Array
array		boolean-Required
Read-only
readonly		boolean-Required
The RuleTesting object
PropertyTypeDescriptionRequired
Event sample
sampleEvent		text

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

Required