{"type":"doc","content":[{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"panel","parameters":{"macroParams":{"title":{"value":"Contents"}},"macroMetadata":{"macroId":{"value":"1fe2de33-2753-4658-b660-583d6a51f7a6"},"schemaVersion":{"value":"1"},"title":"Panel"}}},"content":[{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"maxLevel":{"value":"2"},"minLevel":{"value":"2"}},"macroMetadata":{"macroId":{"value":"712c36da-c54c-4b71-80b9-056125a2cf3a"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Get all requirements path for all issues returned by a jql","type":"text","marks":[{"type":"textColor","attrs":{"color":"#003366"}}]}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"The following script will get all requirements path for all issues returned by a jql.","type":"text"}]},{"type":"paragraph","content":[{"text":"In this example, all issues under the project 'REQ' will be returned with their path.","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"

Function

pyConfluencetrue

Main

pyConfluencetrue

Refer to Constant variable for information of the following constant variable: [HOST_URL, USERNAME, PASSWORD]

Output

textConfluence

","nestedContent":{"type":"doc","content":[{"type":"expand","attrs":{"title":""},"content":[{"type":"heading","attrs":{"level":5},"content":[{"text":"Function","type":"text"}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"text":"def get_requirements_path_for_issues(host_url, username, password, jql):\n \"\"\"\n This method is used to get all requirements path for all issues returned by a jql\n Template parameters:\n [jql] the JQL statement\n \"\"\"\n\n # The REST API path to search for tree elements\n path_uri = '/rest/com.easesolutions.jira.plugins.requirements/1.0/issue/req-path/' + jql\n\n # Send a GET request to get all requirements path for all issues returned by a jql\n # Return the result of the GET\n try:\n return requests.get(host_url + path_uri, auth=HTTPBasicAuth(username, password))\n except requests.exceptions.RequestException as e:\n print e","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Main","type":"text"}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"text":"# ['project = REQ'] jql parameter to get the parent issue keys\nresponse = get_requirements_path_for_issues(HOST_URL, USERNAME, PASSWORD, 'project = REQ')\n\n# Check response if requirements path are found\nif response.status_code == 200:\n\n # Get the value of the JSON response and print in a readable JSON format\n # json dumps formats the JSON string in readable format\n json_object = json.loads(response.text)\n print json.dumps(json_object, indent=4)\n\nelse:\n print 'Error code: ', response.status_code\n print response.text","type":"text"}]},{"type":"paragraph","content":[{"text":"Refer to ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#999999"}},{"type":"em"}]},{"text":"Constant variable","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}},{"type":"link","attrs":{"href":"https://easesolutions.atlassian.net/wiki/spaces/REQ4J/pages/73334839#PythonEndpointClientExamples-Constant-variables"}},{"type":"underline"},{"type":"em"}]},{"text":" for information of the following constant variable: [HOST_URL, USERNAME, PASSWORD]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#999999"}},{"type":"em"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Output","type":"text"}]},{"type":"codeBlock","attrs":{"language":"plaintext"},"content":[{"text":"[\n { \n issueKey: \"REQ-1\",\n paths: [\n {\n projectKey: \"REQ\"\n path: \"/MyPath/Test\"\n },\n {\n projectKey: \"TEST\"\n path: \"/TestFolder\"\n }\n ]\n },\n {\n issueKey: \"REQ-2\",\n paths: []\n },\n {\n issueKey: \"REQ-3\",\n paths: [\n {\n projectKey: \"TEST\"\n path: \"/TestFolder\"\n }\n ]\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]}],"version":1},"reason":"An expand macro in a panel macro can't be created or edited in the new editor."}}},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Get Requirements Path

Get all requirements path for all issues returned by a jql