{"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":"2d85affc-a2d6-4f88-afdc-467bf129287d"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Get complete tree structure for an existing project","type":"text","marks":[{"type":"textColor","attrs":{"color":"#003366"}}]}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"

","block-inline":true,"nestedContent":{"type":"doc","content":[{"type":"rule"}],"version":1}}}}]},{"type":"paragraph","content":[{"text":"The following script will get the complete tree structure with the information of the found folders. In this example, the script will get the tree structure of project 'SC' and display the number prefix of each folders.","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"

Function to get complete tree structure

pyConfluencetrue

Function to print folder structure

pyConfluencetrue

Main

pyConfluencetrue

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

Output

textConfluence

Raw JSON response

textConfluence

","block-inline":true,"nestedContent":{"type":"doc","content":[{"type":"expand","attrs":{"title":""},"content":[{"type":"heading","attrs":{"level":5},"content":[{"text":"Function to get complete tree structure","type":"text","marks":[{"type":"textColor","attrs":{"color":"#808080"}}]}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"text":"def get_project_tree(host_url, username, password, project_key, n):\n \"\"\"\n This method is used to search for tree elements\n Template parameters:\n [project_key] the project key\n Query parameters:\n [element_path] the path to search in\n \"\"\"\n\n # The REST API path to search for tree elements\n path_uri = '/rest/com.easesolutions.jira.plugins.requirements/1.0/tree/' + project_key + '?'\n\n # The field-value pair/s that will be added to the query string\n number_prefix_field_value = 'n=' + str(n)\n\n # The query string to be added to the URI\n query_string = number_prefix_field_value\n\n # Send a GET request to search for tree elements\n # Return result of the GET request\n try:\n return requests.get(host_url + path_uri + query_string, auth=HTTPBasicAuth(username, password))\n except requests.exceptions.RequestException as e:\n print e","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Function to print folder structure","type":"text","marks":[{"type":"textColor","attrs":{"color":"#808080"}}]}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"text":"def print_folder_structure(folders):\n # If folder has values then print the information of the folder\n if folders:\n print '\\n%s %s' % ('Display name: ', folders[0]['name_display'])\n print '%s %s' % ('Folder ID: ', folders[0]['id'])\n print '%s %s' % ('Parent folder ID: ', folders[0]['parent'])\n\n # Perform recursion if there is a folder under this folder\n sub_folders = folders[0]['folders']\n print_folder_structure(sub_folders)","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Main","type":"text"}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"text":"# ['SC'] project key parameter for the project to search the element\n# Store the result of the POST request to [response]\nresponse = get_project_tree(HOST_URL, USERNAME, PASSWORD, 'SC', 1)\n\n# Check response if element info is returned\nif response.status_code == 200:\n\n # Get the value of the JSON response\n # Pass the result to print_folder_structure method to print the folder structure of the found element\n json_object = json.loads(response.text)\n folders = json_object['folders']\n print_folder_structure(folders)\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":"/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","marks":[{"type":"textColor","attrs":{"color":"#808080"}}]}]},{"type":"codeBlock","attrs":{"language":"plaintext"},"content":[{"text":"Display name: 1 GUI Specs\nFolder ID: 1\nParent folder ID: -1\n\nDisplay name: 1.1 Panel UI\nFolder ID: 2\nParent folder ID: 1","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Raw JSON response","type":"text","marks":[{"type":"textColor","attrs":{"color":"#808080"}}]}]},{"type":"codeBlock","attrs":{"language":"plaintext"},"content":[{"text":"{\n \"id\": -1,\n \"folders\": [\n {\n \"name\": \"GUI Specs\",\n \"description\": \"\",\n \"id\": 1,\n \"name_display\": \"1 GUI Specs\",\n \"parent\": -1,\n \"folders\": [\n {\n \"name\": \"Panel UI\",\n \"description\": \"\",\n \"id\": 2,\n \"name_display\": \"1.1 Panel UI\",\n \"parent\": 1,\n \"folders\": [],\n \"issues\": [],\n \"position\": 1\n }\n ],\n \"issues\": [],\n \"position\": 1\n }\n ],\n \"issues\": []\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"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Get Project Tree Structure

Get complete tree structure for an existing project