Get project issue type hierarchy

v1.0.0

Get the issue type hierarchy for a next-gen project.

The issue type hierarchy for a project consists of:

Epic at level 1 (optional).
One or more issue types at level 0 such as Story, Task, or Bug. Where the issue type Epic is defined, these issue types are used to break down the content of an epic.
Subtask at level -1 (optional). This issue type enables level 0 issue types to be broken down into components. Issues based on a level -1 issue type must have a parent issue.

required: Browse projects for the project.

Input

{
  "type": "object",
  "properties": {
    "projectId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "projectId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "The hierarchy of issue types within a project.",
  "properties": {
    "hierarchy": {
      "type": "array",
      "description": "Details of an issue type hierarchy level.",
      "items": {
        "type": "object",
        "description": "Details of an issue type hierarchy level.",
        "properties": {
          "entityId": {
            "type": "string",
            "format": "uuid",
            "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/)."
          },
          "issueTypes": {
            "type": "array",
            "description": "The list of issue types in the hierarchy level.",
            "items": {
              "type": "object",
              "description": "Details of an issue type.",
              "properties": {
                "avatarId": {
                  "type": "integer",
                  "format": "int64",
                  "description": "The avatar of the issue type."
                },
                "id": {
                  "type": "integer",
                  "format": "int64",
                  "description": "The ID of the issue type."
                },
                "name": {
                  "type": "string",
                  "description": "The name of the issue type."
                }
              },
              "additionalProperties": false
            }
          },
          "level": {
            "type": "integer",
            "format": "int32",
            "description": "The level of the issue type hierarchy level."
          },
          "name": {
            "type": "string",
            "description": "The name of the issue type hierarchy level."
          }
        },
        "additionalProperties": false
      }
    },
    "projectId": {
      "type": "integer",
      "format": "int64",
      "description": "The ID of the project."
    }
  },
  "additionalProperties": false
}