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
    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

    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
    • 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