{"type":"doc","content":[{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"com.easesolutions.jira.plugins.requirements/1.0/issue/req-path/jql","type":"text","marks":[{"type":"link","attrs":{"href":"#RESTAPI:Issues-1"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Get all requirement paths for all issues returned by a specific JQL query.","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-warning","text":":warning:","shortName":":warning:"}},{"text":" Known issue: Does not work for JQL using path delimiters. ","type":"text"},{"type":"hardBreak"},{"text":"Fixed in ","type":"text"},{"text":"com.easesolutions.jira.plugins.requirements/1.0/issue/req-path","type":"text","marks":[{"type":"em"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"POST","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"com.easesolutions.jira.plugins.requirements/1.0/issue/req-path","type":"text","marks":[{"type":"link","attrs":{"href":"#RESTAPI:Issues-2"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"neutral","style":"bold","text":"4.2.0","localId":"ba2e8e03-5ed3-4444-a587-08f811246b7f"}},{"text":" Get all requirement paths for all issues returned by a specific JQL query.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"1"},"legacyAnchorId":{"value":"RESTAPI:Issues-1"}},"macroMetadata":{"macroId":{"value":"e6d8f859-6d7f-47dc-872c-c0525d65d1f4"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"panel","parameters":{"macroParams":{"titleColor":{"value":"#FFFFFF"},"titleBGColor":{"value":"#6c809a"},"title":{"value":"com.easesolutions.jira.plugins.requirements/1.0/issue/req-path/jql"}},"macroMetadata":{"macroId":{"value":"6f052818-762f-4a53-b312-ef49757bad62"},"schemaVersion":{"value":"1"},"title":"Panel"}}},"content":[{"type":"paragraph","content":[{"text":"Get all requirement paths for all issues returned by the given JQL query.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Since an issue can be part of multiple project trees there may exist more than one requirement path for an issue.","type":"text"},{"type":"hardBreak"},{"text":"This function lists all requirements paths for an issue for all project trees that contain this issue.","type":"text"},{"type":"hardBreak"},{"text":"The set of issues to return the requirement paths for is determined by the given JQL query.","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"Click here for details...

REQUEST

#f6f5f5

GET

/rest/com.easesolutions.jira.plugins.requirements/1.0/issue/req-path/jql

PARAMETERS

parameter	type	description
jql*	string	the JQL statement

RESPONSES

GreenSTATUS 200 - Returned if a requirements path for an issue is found

javaExample Response

RedSTATUS 400 - Returned if the JQL is invalid

RedSTATUS 401 - Returned if invalid user credentials, or the user has no permission

RedSTATUS 403 - Returned if the license is invalid or has expired, or incompatible JIRA version

","nestedContent":{"type":"doc","content":[{"type":"expand","attrs":{"title":"Click here for details..."},"content":[{"type":"heading","attrs":{"level":5},"content":[{"text":"REQUEST","type":"text","marks":[{"type":"textColor","attrs":{"color":"#003366"}}]}]},{"type":"panel","attrs":{"panelColor":"#f6f5f5","panelType":"custom"},"content":[{"type":"heading","attrs":{"level":5},"content":[{"text":"GET","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"/rest/com.easesolutions.jira.plugins.requirements/1.0/issue/req-path/jql","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"rule"},{"type":"heading","attrs":{"level":5},"content":[{"text":"PARAMETERS","type":"text","marks":[{"type":"textColor","attrs":{"color":"#003366"}}]}]},{"type":"table","attrs":{"layout":"wide"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[142.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"parameter","type":"text","marks":[{"type":"textColor","attrs":{"color":"#808080"}}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"type","type":"text","marks":[{"type":"textColor","attrs":{"color":"#808080"}}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[530.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"description","type":"text","marks":[{"type":"textColor","attrs":{"color":"#808080"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[142.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"jql","type":"text","marks":[{"type":"strong"}]},{"text":"*","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff0000"}},{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"string","type":"text","marks":[{"type":"em"},{"type":"textColor","attrs":{"color":"#808080"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[530.0]},"content":[{"type":"paragraph","content":[{"text":"the JQL statement","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"rule"},{"type":"heading","attrs":{"level":5},"content":[{"text":"RESPONSES","type":"text","marks":[{"type":"textColor","attrs":{"color":"#003366"}}]}]},{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"STATUS 200","localId":"744d1f0c-9190-4e47-9e70-f0bc69f7fe79"}},{"text":" - Returned if a requirements path for an issue is found","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example Response","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"[\n\t{ \n\t\tissueKey: \"TEST-1\",\n\t\tpaths: [\n\t\t\t{\n\t\t\t\tprojectKey: \"TEST\"\n\t\t\t\tpath: \"/MyPath/Test\"\n\t\t\t},\n\t\t\t{\n\t\t\t\tprojectKey: \"PROD\"\n\t\t\t\tpath: \"/TestFolder\"\n\t\t\t}\n\t\t]\n\t},\n\t{\n\t\tissueKey: \"TEST-2\",\n\t\tpaths: []\n\t},\n\t{\n\t\tissueKey: \"TEST-3\",\n\t\tpaths: [\n\t\t\t{\n\t\t\t\tprojectKey: \"TEST\"\n\t\t\t\tpath: \"/TestFolder\"\n\t\t\t}\n\t\t]\n\t}\n]","type":"text"}]},{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"STATUS 400","localId":"b3c503c4-a8d3-4d1f-a97e-332e5e383d46"}},{"text":" ","type":"text"},{"text":"- Returned if the JQL is invalid","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"STATUS 401","localId":"7ee84ade-71a7-4067-8780-0b955c868342"}},{"text":" ","type":"text"},{"text":"- Returned if invalid user credentials, or the user has no permission","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"STATUS 403","localId":"e251cfca-dc7d-408a-8b4b-02015f1ef1f7"}},{"text":" ","type":"text"},{"text":"- Returned if the license is invalid or has expired, or incompatible JIRA version","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}],"version":1},"reason":"An expand macro in a rich body macro can't be created or edited in the new editor."}}},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"2"},"legacyAnchorId":{"value":"RESTAPI:Issues-2"}},"macroMetadata":{"macroId":{"value":"fa356702-1e9c-42d2-b69a-fd939083d703"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"panel","parameters":{"macroParams":{"titleColor":{"value":"#FFFFFF"},"titleBGColor":{"value":"#6c809a"},"title":{"value":"com.easesolutions.jira.plugins.requirements/1.0/issue/req-path"}},"macroMetadata":{"macroId":{"value":"41ea4eae-3eae-471f-8192-6c3b69f9c51b"},"schemaVersion":{"value":"1"},"title":"Panel"}}},"content":[{"type":"paragraph","content":[{"text":"Get all requirement paths for all issues returned by the given JQL query. ","type":"text"},{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" Supports JQL with path delimiters","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Since an issue can be part of multiple project trees there may exist more than one requirement path for an issue.","type":"text"},{"type":"hardBreak"},{"text":"This function lists all requirements paths for an issue for all project trees that contain this issue.","type":"text"},{"type":"hardBreak"},{"text":"The set of issues to return the requirement paths for is determined by the given JQL query.","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"Click here for details...

REQUEST

#f6f5f5

POST

/rest/com.easesolutions.jira.plugins.requirements/1.0/issue/req-path

PARAMETERS

parameter	type	description
jql*	string	the JQL statement

RESPONSES

GreenSTATUS 200 - Returned if a requirements path for an issue is found

javaExample Response

RedSTATUS 400 - Returned if the JQL is invalid

RedSTATUS 401 - Returned if invalid user credentials, or the user has no permission

RedSTATUS 403 - Returned if the license is invalid or has expired, or incompatible JIRA version

","nestedContent":{"type":"doc","content":[{"type":"expand","attrs":{"title":"Click here for details..."},"content":[{"type":"heading","attrs":{"level":5},"content":[{"text":"REQUEST","type":"text","marks":[{"type":"textColor","attrs":{"color":"#003366"}}]}]},{"type":"panel","attrs":{"panelColor":"#f6f5f5","panelType":"custom"},"content":[{"type":"heading","attrs":{"level":5},"content":[{"text":"POST","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"/rest/com.easesolutions.jira.plugins.requirements/1.0/issue/req-path","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"rule"},{"type":"heading","attrs":{"level":5},"content":[{"text":"PARAMETERS","type":"text","marks":[{"type":"textColor","attrs":{"color":"#003366"}}]}]},{"type":"table","attrs":{"layout":"wide"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[142.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"parameter","type":"text","marks":[{"type":"textColor","attrs":{"color":"#808080"}}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"type","type":"text","marks":[{"type":"textColor","attrs":{"color":"#808080"}}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[530.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"description","type":"text","marks":[{"type":"textColor","attrs":{"color":"#808080"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[142.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"jql","type":"text","marks":[{"type":"strong"}]},{"text":"*","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff0000"}},{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"string","type":"text","marks":[{"type":"em"},{"type":"textColor","attrs":{"color":"#808080"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[530.0]},"content":[{"type":"paragraph","content":[{"text":"the JQL statement","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"rule"},{"type":"heading","attrs":{"level":5},"content":[{"text":"RESPONSES","type":"text","marks":[{"type":"textColor","attrs":{"color":"#003366"}}]}]},{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"STATUS 200","localId":"3ac27875-5502-4272-849f-02548bba6e95"}},{"text":" - Returned if a requirements path for an issue is found","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example Response","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"[\n\t{ \n\t\tissueKey: \"TEST-1\",\n\t\tpaths: [\n\t\t\t{\n\t\t\t\tprojectKey: \"TEST\"\n\t\t\t\tpath: \"/MyPath/Test\"\n\t\t\t},\n\t\t\t{\n\t\t\t\tprojectKey: \"PROD\"\n\t\t\t\tpath: \"/TestFolder\"\n\t\t\t}\n\t\t]\n\t},\n\t{\n\t\tissueKey: \"TEST-2\",\n\t\tpaths: []\n\t},\n\t{\n\t\tissueKey: \"TEST-3\",\n\t\tpaths: [\n\t\t\t{\n\t\t\t\tprojectKey: \"TEST\"\n\t\t\t\tpath: \"/TestFolder\"\n\t\t\t}\n\t\t]\n\t}\n]","type":"text"}]},{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"STATUS 400","localId":"72633c6b-4a57-4e6c-b19c-a0e8b8fe5cc4"}},{"text":" ","type":"text"},{"text":"- Returned if the JQL is invalid","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"STATUS 401","localId":"3b287baf-9dfa-4b4a-b20f-5d724f154315"}},{"text":" ","type":"text"},{"text":"- Returned if invalid user credentials, or the user has no permission","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"STATUS 403","localId":"b77e9d18-53af-49b8-827b-e07aaf2fb58c"}},{"text":" ","type":"text"},{"text":"- Returned if the license is invalid or has expired, or incompatible JIRA version","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}],"version":1},"reason":"An expand macro in a rich body macro can't be created or edited in the new editor."}}},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

REST API: Issues