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 ID | Schema groups | Scope |
|---|---|---|
app:dynatrace.biz.flow:biz-flow-settings | - | environment |
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/app:dynatrace.biz.flow:biz-flow-settings |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/app:dynatrace.biz.flow:biz-flow-settings | |
| Environment ActiveGate | https://{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
| Property | Type | Description | Required |
|---|---|---|---|
Namename | text | Configuration Name | optional |
Descriptiondescription | text | Configuration description | optional |
Versionversion | integer | - | optional |
Configuration IDid | text | - | optional |
Stepssteps | TStepType[] | Configuration Steps | required |
Connectionsconnections | TConnectionType[] | - | required |
Correlation IDcorrelationID | text | Correlation ID | optional |
KPI LabelkpiLabel | text | - | optional |
KPIkpi | text | KPI | optional |
KPI EventkpiEvent | TKpiEventType | - | optional |
KPI UnitkpiUnit | text | - | optional |
Calculation typekpiCalculation | enum |
| optional |
Analysis typeanalysisType | enum |
| optional |
Analysis custom labelanalysisCustomLabel | text | - | optional |
Analysis UnitanalysisUnit | text | - | optional |
The TStepType object
| Property | Type | Description | Required |
|---|---|---|---|
Namename | text | - | required |
IDid | text | - | required |
Is RootisRoot | boolean | - | optional |
Eventsevents | TEventType[] | - | required |
The TConnectionType object
| Property | Type | Description | Required |
|---|---|---|---|
IDid | text | - | required |
Sourcesource | text | - | required |
Targettarget | text | - | required |
The TKpiEventType object
| Property | Type | Description | Required |
|---|---|---|---|
Namename | text | - | required |
Providerprovider | text | - | required |
The TEventType object
| Property | Type | Description | Required |
|---|---|---|---|
IDid | text | - | required |
Correlation IDcorrelationID | text | - | optional |
Namename | text | - | required |
Providerprovider | text | - | required |
Is ErrorisError | boolean | - | required |
Is DisabledisDisabled | boolean | - | required |