Versions Compared

Old Version 8

changes.mady.by.user Angelica Salazar

Saved on

compared with

New Version Current

changes.mady.by.user Angelica Salazar

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page contains general endpoints for the project tree.

...

Expand
titleGET com.easesolutions.jira.plugins.requirements/1.0/tree/{prjKey}

Request

PATH PARAMETERS

parameter

type

description

prjKey

string

project key

QUERY PARAMETERS

parameter

type

description

n

string

toggles structure numbering prefix for folder names
(0 = disabled (default), 1 = enabled)

Sample Request Path

Code Block
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD?n=0

Responses

Status
colourGreen
titlestatus 200
application/json Returned if successful.

Example

Code Block
{
   "id":-1,
   "folders":[
      {
         "name":"First",
         "id":56,
         "name_display":"First",
         "parent":-1,
         "folders":[
            {
               "name":"Third",
               "id":69,
               "name_display":"Third",
               "parent":56,
               "folders":[

               ],
               "issues":[
                  {
                     "id":132,
                     "issueId":10157,
                     "key":"AN-4",
                     "url":"http://<server-name>/browse/AN-4",
                     "summary":"Second",
                     "description":"Issue number 61",
                     "icon_url":"http://<server-name>/images/icons/issuetypes/newfeature.png",
                     "issueType":"New Feature",
                     "position":1
                  },
                  {
                     "id":131,
                     "issueId":10155,
                     "key":"AN-2",
                     "url":"http://<server-name>/browse/AN-2",
                     "summary":"Second",
                     "description":"Second",
                     "icon_url":"http://<server-name>/images/icons/issuetypes/newfeature.png",
                     "issueType":"New Feature",
                     "position":2
                  }
               ],
               "position":1
            }
         ],
         "issues":[

         ],
         "position":1
      },
      {
         "name":"Test",
         "id":67,
         "name_display":"Test",
         "parent":-1,
         "folders":[
            {
               "name":"Second",
               "id":68,
               "name_display":"Second",
               "parent":67,
               "folders":[

               ],
               "issues":[
                  {
                     "id":127,
                     "issueId":10155,
                     "key":"AN-2",
                     "url":"http://<server-name>/browse/AN-2",
                     "summary":"Second",
                     "description":"Second",
                     "icon_url":"http://<server-name>/images/icons/issuetypes/newfeature.png",
                     "issueType":"New Feature",
                     "position":1
                  },
                  {
                     "id":118,
                     "issueId":10154,
                     "key":"AN-1",
                     "url":"http://<server-name>/browse/AN-1",
                     "summary":"First",
                     "description":"First issue textasd",
                     "icon_url":"http://<server-name>/images/icons/issuetypes/newfeature.png",
                     "issueType":"New Feature",
                     "position":2
                  }
               ],
               "position":1
            }
         ],
         "issues":[

         ],
         "position":2
      },
      {
         "name":"Root",
         "id":75,
         "name_display":"Root",
         "parent":-1,
         "folders":[

         ],
         "issues":[

         ],
         "position":3
      },
      {
         "name":"Test",
         "id":70,
         "name_display":"Test",
         "parent":-1,
         "folders":[

         ],
         "issues":[

         ],
         "position":4
      }
   ],
   "issues":[

   ]
}

Status
colourRed
titlestatus 400
Returned if there is an error while processing request.

Status
colourRed
titlestatus 401
Returned if user is not logged in.

Status
colourRed
titlestatus 403
Returned if the license is invalid or has expired or incompatible JIRA version.

...

Expand
titleGET com.easesolutions.jira.plugins.requirements/1.0/search/{prjKey}

Request

PATH PARAMETERS

parameter

type

description

prjKey

string

project key

QUERY PARAMETERS

parameter

type

description

type

string

item type to search for (should be "folder")

pathSep

string

separator chars used in path (default "/")

path

string

path to search in – do not include root project folder in path

Sample Request Paths

Code Block
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/search/ABCD?type=folder&pathSep=%2F&path=Folder%20Path

Responses

Status
colourGreen
titlestatus 201
application/json Returned if successful.

Example

Code Block
{
   "folders":[
      {
         "name":"First",
         "description":"",
         "id":9,
         "name_display":"First",
         "parent":-1,
         "folders":[
            {
               "name":"Second",
               "description":"",
               "id":14,
               "name_display":"Second",
               "parent":9,
               "folders":[

               ],
               "issues":[

               ],
               "position":2,
               "hasChild":false
            }
         ],
         "issues":[

         ],
         "position":3,
         "hasChild":true
      }
   ],
   "issues":[

   ]
}

Status
colourRed
titlestatus 400
Returned if there is an error while processing request.

Status
colourRed
titlestatus 401
Returned if user is not logged in.

Status
colourRed
titlestatus 403
Returned if the license is invalid or has expired or incompatible JIRA version.

...

Expand
titleGET com.easesolutions.jira.plugins.requirements/1.0/tree/totalItemCount/{prjKey}

Request

PATH PARAMETERS

parameter

type

description

prjKey

string

project key

QUERY PARAMETERS

parameter

type

description

includePages

string

option to include pages in total count,
where default value is true. if value is set to false, only issues will be counted.

Sample Request Path

Code Block
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/totalItemCount/ABCD?includePages=false

Responses

Status
colourGreen
titlestatus 200
application/json Returned if successful.

Example

Code Block
{
   "totalItemCount":125
}

Status
colourRed
titlestatus 400
Returned if there is an error while processing request.

Status
colourRed
titlestatus 401
Returned if user is not logged in.

Status
colourRed
titlestatus 403
Returned if the license is invalid or has expired or incompatible JIRA version.

...

Expand
titlePOST com.easesolutions.jira.plugins.requirements/1.0/tree/reuse
Info

Source and target may be different projects.

Request

QUERY PARAMETERS

parameter

type

description

source

string

the source folder for reuse
(e.g. Requirements Plugin/Implementation)

target

string

the target folder for the reuse
(e.g. Requirements Plugin/Features/Baseline/Permissions)

ruleName

string

the name of the predefined reuse configuration rule to be used

Sample Request Path

Code Block
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/reuse?source=Requirements%20Plugin%2FImplementation&target=Requirements%20Plugin%2FFeatures%2FBaseline%2FPermissions&ruleName=Copy%20folder%20structure%20only

Responses

Status
colourGreen
titlestatus 200
text/plain Returned if successful.

Example

Code Block
Reuse Success

Status
colourRed
titlestatus 400
Returned if there is an error while processing request.

Status
colourRed
titlestatus 401
Returned if user is not logged in.

Status
colourRed
titlestatus 403
Returned if the license is invalid or has expired or incompatible JIRA version.

...

Expand
titlePOST com.easesolutions.jira.plugins.requirements/1.0/tree/{prjKey}/createscheduledjob

Request

PATH PARAMETERS

parameter

type

description

prjKey

string

project key

QUERY PARAMETERS

parameter

type

description

name

string

name of the scheduled job to be created

folderId

string

id of folder where issues will be imported

filter

string

JQL or JIRA filter id of issues to be imported
if value is empty, all issues from the project that do not exist in the project tree are added by default

interval

string

scheduled time interval for job (in minutes)
enter 0 as value to set execution interval to Manual.

Sample Request Paths

Code Block
https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD/createscheduledjob?name=Import%20bugs&folderId=382&filter=11000&interval=0

https://myjirainstance.com/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/ABCD/createscheduledjob?name=Import%20bugs&folderId=382&filter=project%20%3D%20TP%20AND%20issuetype%20%3D%20bug&interval=30

Responses

Status
colourGreen
titlestatus 201
text/plain Returned if successful.

Example

Code Block
Rule {name} has been successfully created

Status
colourRed
titlestatus 400
Returned if there is an error while processing request.

Status
colourRed
titlestatus 401
Returned if user is not logged in.

Status
colourRed
titlestatus 403
Returned if the license is invalid or has expired or incompatible JIRA version.

...