Structure Plugin for JIRA - Version 2.1

Index

Child pages
  • Forest Resource - GET

Versions Compared

Old Version 2

changes.mady.by.user Igor Sereda

Saved on

compared with

New Version Current

changes.mady.by.user Igor Sereda

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

Request

Code Block
perl
perl
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

Code Block
{
   "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.

Code Block
ForestFormula ::= NodeSequence
NodeSequence ::= Node [ "," NodeSequence ]
Node ::= IssueID ":" Depth
IssueID ::= Integer
Depth ::= Integer