Open Context Protocol is live! 🚀 Read the launch post
getVersionRelatedIssues

getVersionRelatedIssues

Get version’s related issues count

Details

  • Method: GET
  • Path: /rest/api/3/version/{id}/relatedIssueCounts
  • Operation ID: getVersionRelatedIssues

Parameters

{
  "id": {
    "description": "The ID of the version.",
    "required": true,
    "location": "path",
    "type": "string"
  }
}

Response Schema

{
  "additionalProperties": false,
  "description": "Various counts of issues within a version.",
  "properties": {
    "customFieldUsage": {
      "description": "List of custom fields using the version.",
      "items": {
        "additionalProperties": false,
        "description": "List of custom fields using the version.",
        "properties": {
          "customFieldId": {
            "description": "The ID of the custom field.",
            "format": "int64",
            "readOnly": true,
            "type": "integer"
          },
          "fieldName": {
            "description": "The name of the custom field.",
            "readOnly": true,
            "type": "string"
          },
          "issueCountWithVersionInCustomField": {
            "description": "Count of the issues where the custom field contains the version.",
            "format": "int64",
            "readOnly": true,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "readOnly": true,
      "type": "array"
    },
    "issueCountWithCustomFieldsShowingVersion": {
      "description": "Count of issues where a version custom field is set to the version.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "issuesAffectedCount": {
      "description": "Count of issues where the `affectedVersion` is set to the version.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "issuesFixedCount": {
      "description": "Count of issues where the `fixVersion` is set to the version.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "self": {
      "description": "The URL of these count details.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    }
  },
  "type": "object",
  "xml": {
    "name": "version"
  }
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('jira')

# Call this tool
result = await agent.call_tool('getVersionRelatedIssues', {
    # Add required parameters here
})