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

getIssueLinkTypes

Get issue link types

Details

  • Method: GET
  • Path: /rest/api/3/issueLinkType
  • Operation ID: getIssueLinkTypes

Parameters

{}

Response Schema

{
  "additionalProperties": false,
  "description": "A list of issue link type beans.",
  "properties": {
    "issueLinkTypes": {
      "description": "The issue link type bean.",
      "items": {
        "additionalProperties": false,
        "description": "This object is used as follows:\n\n *  In the [ issueLink](#api-rest-api-3-issueLink-post) resource it defines and reports on the type of link between the issues. Find a list of issue link types with [Get issue link types](#api-rest-api-3-issueLinkType-get).\n *  In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it defines and reports on issue link types.",
        "properties": {
          "id": {
            "description": "The ID of the issue link type and is used as follows:\n\n *  In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `name` isn't provided. Otherwise, read only.\n *  In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is read only.",
            "type": "string"
          },
          "inward": {
            "description": "The description of the issue link type inward link and is used as follows:\n\n *  In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only.\n *  In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only.",
            "type": "string"
          },
          "name": {
            "description": "The name of the issue link type and is used as follows:\n\n *  In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `id` isn't provided. Otherwise, read only.\n *  In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only.",
            "type": "string"
          },
          "outward": {
            "description": "The description of the issue link type outward link and is used as follows:\n\n *  In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only.\n *  In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only.",
            "type": "string"
          },
          "self": {
            "description": "The URL of the issue link type. Read only.",
            "format": "uri",
            "readOnly": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "readOnly": true,
      "type": "array",
      "xml": {
        "name": "issueLinkTypes"
      }
    }
  },
  "type": "object",
  "xml": {
    "name": "issueLinkTypes"
  }
}

Usage

from ocp_agent import OCPAgent

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

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