Open Context Protocol is live! 🚀 Read the launch post

getRelatedWork

Get related work

Details

  • Method: GET
  • Path: /rest/api/3/version/{id}/relatedwork
  • Operation ID: getRelatedWork

Parameters

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

Response Schema

{
  "items": {
    "additionalProperties": false,
    "description": "Associated related work to a version",
    "properties": {
      "category": {
        "description": "The category of the related work",
        "type": "string"
      },
      "issueId": {
        "description": "The ID of the issue associated with the related work (if there is one). Cannot be updated via the Rest API.",
        "format": "int64",
        "readOnly": true,
        "type": "integer"
      },
      "relatedWorkId": {
        "description": "The id of the related work. For the native release note related work item, this will be null, and Rest API does not support updating it.",
        "readOnly": true,
        "type": "string"
      },
      "title": {
        "description": "The title of the related work",
        "type": "string"
      },
      "url": {
        "description": "The URL of the related work. Will be null for the native release note related work item, but is otherwise required.",
        "format": "uri",
        "type": "string"
      }
    },
    "required": [
      "category"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage

from ocp_agent import OCPAgent

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

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