Open Context Protocol is live! 🚀 Read the launch post

getIssueLink

Get issue link

Details

  • Method: GET
  • Path: /rest/api/3/issueLink/{linkId}
  • Operation ID: getIssueLink

Parameters

{
  "linkId": {
    "description": "The ID of the issue link.",
    "required": true,
    "location": "path",
    "type": "string"
  }
}

Response Schema

{
  "additionalProperties": false,
  "description": "Details of a link between issues.",
  "properties": {
    "id": {
      "description": "The ID of the issue link.",
      "readOnly": true,
      "type": "string"
    },
    "inwardIssue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LinkedIssue"
        }
      ],
      "description": "Provides details about the linked issue. If presenting this link in a user interface, use the `inward` field of the issue link type to label the link."
    },
    "outwardIssue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LinkedIssue"
        }
      ],
      "description": "Provides details about the linked issue. If presenting this link in a user interface, use the `outward` field of the issue link type to label the link."
    },
    "self": {
      "description": "The URL of the issue link.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IssueLinkType"
        }
      ],
      "description": "The type of link between the issues."
    }
  },
  "required": [
    "inwardIssue",
    "outwardIssue",
    "type"
  ],
  "type": "object",
  "xml": {
    "name": "issueLinks"
  }
}

Usage

from ocp_agent import OCPAgent

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

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