Issues

Get issue adf limit report

Changed on

Returns all issues whose ADF (rich text) field data breaches the universal ADF size limit.

Unlike the issue limit report, which reports issues breaching per-issue entity count limits, this endpoint reports issues whose ADF field byte size exceeds that limit. The reported ADF field types are comment_adf, worklog_adf, customfield_adf, description_adf and environment_adf. The reported value for each issue is the number of breaching entities for that field (always 1 for the single-value description and environment fields).

Permissions required:

get/rest/api/2/issue/limit/adf/report

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/issue/limit/adf/report
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: read:jira-work)

Query parameters

isReturningKeysboolean

Return issue keys instead of issue ids in the response.

Usage: Add ?isReturningKeys=true to the end of the path to request issue keys.

fieldTypestring[]

Restrict the report to the given ADF field types. Defaults to every ADF field type.

For sites with a high issue volume, consider requesting field types individually to avoid timeouts.

Usage: Add ?fieldType=comment_adf&fieldType=worklog_adf to the end of the path to report on comments and worklogs only.

Response

Returned if the request is successful.

entitiesBreachingLimitobject

For each field, the ids of the individual entities breaching the limit, grouped by the id or key of the issue they belong to. Fields that hold a single value, such as description and environment, map to an empty list because the issue itself identifies the breaching content

issuesApproachingLimitobject

A list of ids of issues approaching the limit and their field count

issuesBreachingLimitobject

A list of ids of issues breaching the limit and their field count

limitsobject

The fields and their defined limits

Changes