Open Context Protocol is live! 🚀 Read the launch post

getHierarchy

Get project issue type hierarchy

Details

  • Method: GET
  • Path: /rest/api/3/project/{projectId}/hierarchy
  • Operation ID: getHierarchy

Parameters

{
  "projectId": {
    "description": "The ID of the project.",
    "required": true,
    "location": "path",
    "type": "integer",
    "format": "int64"
  }
}

Response Schema

{
  "additionalProperties": false,
  "description": "The hierarchy of issue types within a project.",
  "properties": {
    "hierarchy": {
      "description": "Details of an issue type hierarchy level.",
      "items": {
        "additionalProperties": false,
        "description": "Details of an issue type hierarchy level.",
        "properties": {
          "entityId": {
            "description": "The ID of the issue type hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/).",
            "format": "uuid",
            "readOnly": true,
            "type": "string"
          },
          "issueTypes": {
            "description": "The list of issue types in the hierarchy level.",
            "items": {
              "additionalProperties": false,
              "description": "Details of an issue type.",
              "properties": {
                "avatarId": {
                  "description": "The avatar of the issue type.",
                  "format": "int64",
                  "readOnly": true,
                  "type": "integer"
                },
                "id": {
                  "description": "The ID of the issue type.",
                  "format": "int64",
                  "readOnly": true,
                  "type": "integer"
                },
                "name": {
                  "description": "The name of the issue type.",
                  "readOnly": true,
                  "type": "string"
                }
              },
              "type": "object"
            },
            "readOnly": true,
            "type": "array"
          },
          "level": {
            "description": "The level of the issue type hierarchy level.",
            "format": "int32",
            "readOnly": true,
            "type": "integer"
          },
          "name": {
            "description": "The name of the issue type hierarchy level.",
            "readOnly": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "readOnly": true,
      "type": "array"
    },
    "projectId": {
      "description": "The ID of the project.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    }
  },
  "type": "object"
}

Usage

from ocp_agent import OCPAgent

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

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