Settings API - Business flow schema table

Business flow (app:dynatrace.biz.flow:biz-flow-settings)

Settings for the Business flow AppEngine application.

Warning! If the following configurations are modified here, in the Settings 2.0 environment, it is likely that the Business Flow application will lose access to them or will have unexpected behaviour. It is strongly advised not to make any changes and to save them here. If you want to make changes, access Business Flow app.

Schema IDSchema groupsScope
app:dynatrace.biz.flow:biz-flow-settings-
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/app:dynatrace.biz.flow:biz-flow-settings
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/app:dynatrace.biz.flow:biz-flow-settings
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/app:dynatrace.biz.flow:biz-flow-settings

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
Name
name		text

Configuration Name

optional
Description
description		text

Configuration description

optional
Version
version		integer-optional
Configuration ID
id		text-optional
Steps
steps		TStepType[]

Configuration Steps

required
Connections
connections		TConnectionType[]-required
Correlation ID
correlationID		text

Correlation ID

optional
KPI Label
kpiLabel		text-optional
KPI
kpi		text

KPI

optional
KPI Event
kpiEvent		TKpiEventType-optional
KPI Unit
kpiUnit		text-optional
Calculation type
kpiCalculation		enum
  • sum
  • firstEvent
  • lastEvent
optional
Analysis type
analysisType		enum
  • fulfillment
  • conversion
  • other
optional
Analysis custom label
analysisCustomLabel		text-optional
Analysis Unit
analysisUnit		text-optional
The TStepType object
PropertyTypeDescriptionRequired
Name
name		text-required
ID
id		text-required
Is Root
isRoot		boolean-optional
Events
events		TEventType[]-required
The TConnectionType object
PropertyTypeDescriptionRequired
ID
id		text-required
Source
source		text-required
Target
target		text-required
The TKpiEventType object
PropertyTypeDescriptionRequired
Name
name		text-required
Provider
provider		text-required
The TEventType object
PropertyTypeDescriptionRequired
ID
id		text-required
Correlation ID
correlationID		text-optional
Name
name		text-required
Provider
provider		text-required
Is Error
isError		boolean-required
Is Disabled
isDisabled		boolean-required