• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Issue-tracking for releases

Settings API - Issue-tracking for releases schema table

Issue-tracking for releases (builtin:issue-tracking.integration)

Query any issue-tracking system to pull issue statistics for monitored entities into Dynatrace for release analysis. For details, see Issue-tracking integration.

Schema IDSchema groupsScope
builtin:issue-tracking.integration
  • group:cloud-automation.releases
  • group:cloud-automation
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:issue-tracking.integration
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:issue-tracking.integration
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:issue-tracking.integration

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

PropertyLabelTypeDescriptionRequired
enabledEnabledboolean-required
issuelabelIssue labeltext

Set a label to identify these issues, for example, release_blocker or non-critical

required
issuequeryIssue querytext

You can use the following placeholders to automatically insert values from the Release monitoring page in your query: {NAME}, {VERSION}, {STAGE}, {PRODUCT}.

required
issuethemeIssue typeenum

Select the issue type to be displayed.

required
issuetrackersystemIssue-tracking systemenum

Select the issue-tracking system you want to query.

required
urlTarget URLtext

For Jira, use the base URL (for example, https://jira.yourcompany.com); for GitHub, use the repository URL (for example, https://github.com/org/repo); for GitLab, use the specific project API for a single project (for example, https://gitlab.com/api/v4/projects/:projectId), and the specific group API for a multiple projects (for example, https://gitlab.com/api/v4/groups/:groupId); for ServiceNow, use your company instance URL (for example, https://yourinstance.service-now.com/)

required
usernameUsernametext-required
passwordPasswordsecret-optional
tokenTokensecret-optional

Request body objects

The FlagDefaultTrue object
PropertyLabelTypeDescriptionRequired
enabledEnabledboolean-required