Edit

Analyze API metadata validation telemetry

APPLIES TO: Business Central 2024 release wave 2 and later

API metadata validation telemetry gathers data about errors that occur when Business Central validates API page metadata during API generation. These errors help identify configuration issues with API pages that prevent them from being exposed correctly.

API metadata conflicting API path

Occurs when two or more API pages attempt to use the same API path, creating a conflict.

General dimensions

Dimension Description or value
message Web service conflicting API path: {path} for group {groupId}, object type {objectType}, object ID {objectId}, package ID {packageId}
severityLevel 3 (Error)

Custom dimensions

Dimension Description or value
aadTenantId Specifies the Microsoft Entra tenant ID used for Microsoft Entra authentication. For on-premises, if you aren't using Microsoft Entra authentication, this value is common.
component Dynamics 365 Business Central Server
componentVersion Specifies the version number of the component that emits telemetry.
environmentName Specifies the name of the tenant environment. Learn more in Managing Environments.
environmentType Specifies the environment type for the tenant, such as Production or Sandbox. Learn more in Environment Types.
eventId RT0048

Sample KQL code

traces
| where timestamp > ago(60d)
| where customDimensions.eventId == 'RT0048'
| project timestamp
, message
, aadTenantId = customDimensions.aadTenantId
, environmentName = customDimensions.environmentName
, environmentType = customDimensions.environmentType

API metadata circular API pages

Occurs when API pages have circular references through navigation properties, creating an infinite loop in the metadata hierarchy.

General dimensions

Dimension Description or value
message Web service metadata circular API pages
severityLevel 3 (Error)

Custom dimensions

Dimension Description or value
aadTenantId Specifies the Microsoft Entra tenant ID used for Microsoft Entra authentication. For on-premises, if you aren't using Microsoft Entra authentication, this value is common.
component Dynamics 365 Business Central Server
componentVersion Specifies the version number of the component that emits telemetry.
environmentName Specifies the name of the tenant environment. Learn more in Managing Environments.
environmentType Specifies the environment type for the tenant, such as Production or Sandbox. Learn more in Environment Types.
eventId RT00049
pagesHierarchy Specifies the hierarchy of pages that caused the circular reference.

Sample KQL code

traces
| where timestamp > ago(60d)
| where customDimensions.eventId == 'RT00049'
| project timestamp
, message
, aadTenantId = customDimensions.aadTenantId
, environmentName = customDimensions.environmentName
, pagesHierarchy = customDimensions.pagesHierarchy

API metadata invalid root entity

Occurs when an API page defines an invalid root entity.

General dimensions

Dimension Description or value
message Web service metadata invalid root entity
severityLevel 3 (Error)

Custom dimensions

Dimension Description or value
aadTenantId Specifies the Microsoft Entra tenant ID used for Microsoft Entra authentication. For on-premises, if you aren't using Microsoft Entra authentication, this value is common.
component Dynamics 365 Business Central Server
componentVersion Specifies the version number of the component that emits telemetry.
environmentName Specifies the name of the tenant environment. Learn more in Managing Environments.
environmentType Specifies the environment type for the tenant, such as Production or Sandbox. Learn more in Environment Types.
eventId RT0050

Sample KQL code

traces
| where timestamp > ago(60d)
| where customDimensions.eventId == 'RT0050'
| project timestamp
, message
, aadTenantId = customDimensions.aadTenantId
, environmentName = customDimensions.environmentName

API metadata conflicting navigation property

Occurs when an API page has conflicting navigation properties with the same name but different targets.

General dimensions

Dimension Description or value
message Web service metadata conflicting navigation property
severityLevel 3 (Error)

Custom dimensions

Dimension Description or value
aadTenantId Specifies the Microsoft Entra tenant ID used for Microsoft Entra authentication. For on-premises, if you aren't using Microsoft Entra authentication, this value is common.
component Dynamics 365 Business Central Server
componentVersion Specifies the version number of the component that emits telemetry.
environmentName Specifies the name of the tenant environment. Learn more in Managing Environments.
environmentType Specifies the environment type for the tenant, such as Production or Sandbox. Learn more in Environment Types.
eventId RT0051

Sample KQL code

traces
| where timestamp > ago(60d)
| where customDimensions.eventId == 'RT0051'
| project timestamp
, message
, aadTenantId = customDimensions.aadTenantId
, environmentName = customDimensions.environmentName

To learn more about how to set up alerting on Business Central telemetry, see Alert on Telemetry.

Monitoring and Analyzing Telemetry
Enable Sending Telemetry to Application Insights
API Page Type