Page tree

This documentation relates to an older version 2.10 of the Structure Plugin for JIRA. View the current documentation home.

Skip to end of metadata
Go to start of metadata

Request

GET $baseUrl/rest/structure/1.0/structure/$id/forest
GET $baseUrl/rest/structure/1.0/structure/$id/forest?root=$root

Returns the hierarchical issue list (forest) of the specified structure.

Parameters:

$id

required

the ID of the structure

$root

optional

the ID of the pinned issue for the Pinned Issue Mode

Response

{
   "structure":100,
   "version":2981,
   "root":10001,
   "formula":"10009:0,10008:1,10006:2,10002:3,10001:4,10062:4,10070:3,10071:2,10041:2"
}

Response Fields:

structure

the ID of the structure

version

the version of the foresst

root

the pinned issue if the fixed structure view has been requested (absent otherwise)

formula

a string representation of the issue forest

Forest Formula

The forest of issues is represented by a string formula, which consists of pairs "issue ID:depth", delimited by a comma. Each pair represents a row in the fully expanded view of the forest.

ForestFormula ::= NodeSequence
NodeSequence ::= Node [ "," NodeSequence ]
Node ::= IssueID ":" Depth
IssueID ::= Integer
Depth ::= Integer
  • No labels