Atlassian: Get version's related issues count

Atlassian projectVersions.getVersionRelatedIssues: arguments, response, policy and SDK examples.

← Project versions operations · Get started

Operation atlassian.getversionrelatedissues

Provider route: GET /{cloudId}/rest/api/3/version/{id}/relatedIssueCounts. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["projectVersions"]["getVersionRelatedIssues"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.projectVersions.getVersionRelatedIssues(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.project_versions.get_version_related_issues(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.cloudId`	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
`path.id`	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Get version’s related issues count — response body

Referenced models: Get version’s related issues count — response body

Schemas

Get version's related issues count — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Various counts of issues within a version.
`customFieldUsage`	JSON	Optional
`customFieldUsage (anyOf 1)`	array	Alternative	List of custom fields using the version. Read only: true
`customFieldUsage (anyOf 1)[]`	Model	Each item	Expand Get version's related issues count — response body — custom Field Usage List of custom fields using the version item
`customFieldUsage (anyOf 2)`	null	Alternative
`issueCountWithCustomFieldsShowingVersion`	JSON	Optional
`issueCountWithCustomFieldsShowingVersion (anyOf 1)`	JSON	Alternative
`issueCountWithCustomFieldsShowingVersion (anyOf 1) (anyOf 1)`	integer	Alternative	Count of issues where a version custom field is set to the version. Format: int64 Read only: true
`issueCountWithCustomFieldsShowingVersion (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`issueCountWithCustomFieldsShowingVersion (anyOf 2)`	null	Alternative
`issuesAffectedCount`	JSON	Optional
`issuesAffectedCount (anyOf 1)`	JSON	Alternative
`issuesAffectedCount (anyOf 1) (anyOf 1)`	integer	Alternative	Count of issues where the `affectedVersion` is set to the version. Format: int64 Read only: true
`issuesAffectedCount (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`issuesAffectedCount (anyOf 2)`	null	Alternative
`issuesFixedCount`	JSON	Optional
`issuesFixedCount (anyOf 1)`	JSON	Alternative
`issuesFixedCount (anyOf 1) (anyOf 1)`	integer	Alternative	Count of issues where the `fixVersion` is set to the version. Format: int64 Read only: true
`issuesFixedCount (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`issuesFixedCount (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of these count details. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative

Referenced models: Get version's related issues count — response body — custom Field Usage List of custom fields using the version item

Get version's related issues count — response body — custom Field Usage List of custom fields using the version item

Field	Type	Presence	Description and constraints
`$`	object	Root	List of custom fields using the version.
`customFieldId`	JSON	Optional
`customFieldId (anyOf 1)`	JSON	Alternative
`customFieldId (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the custom field. Format: int64 Read only: true
`customFieldId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`customFieldId (anyOf 2)`	null	Alternative
`fieldName`	JSON	Optional
`fieldName (anyOf 1)`	string	Alternative	The name of the custom field. Read only: true
`fieldName (anyOf 2)`	null	Alternative
`issueCountWithVersionInCustomField`	JSON	Optional
`issueCountWithVersionInCustomField (anyOf 1)`	JSON	Alternative
`issueCountWithVersionInCustomField (anyOf 1) (anyOf 1)`	integer	Alternative	Count of the issues where the custom field contains the version. Format: int64 Read only: true
`issueCountWithVersionInCustomField (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`issueCountWithVersionInCustomField (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.getversionrelatedissues. Catalog operation: getversionrelatedissues. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["read:jira-work"]

Official provider source

Report an issue with this page