{"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":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Create coverage view (since 4.0.0)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#003366"}}]}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"The following script will trigger the creation of a coverage view. In this example, a coverage view for the GUI requirements will be created.","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"cxhtml":"

Function

pyConfluencetrue

Main

pyConfluencetrue

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

Output (Success):

jsConfluence

Output (Error):

Red403 Your license is invalid or has expired

Red403/401 Incompatible Jira Version

Red400 No permission to create public/private views in Coverage View

Red400 Name is invalid

Red400 Json data is invalid

Red400 Filter with name ''{0}'' already exists.

Red400 Project is invalid or hasn't been assigned to the Coverage View plugin

","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 create_coverage_view(host_url, username, password, project_id, filter_name, is_public, column_data, display_fields):\n \"\"\"\n This method trigger the creation of a coverage view\n Template parameters:\n [project_id] the project the view to be created\n [filter_name] the name parameter of the view\n [is_public] the boolean parameter for the visibility of the view\n [column_data] an parameter of objects composed of column data\n\t[display_fields] the display fields for the view\n \"\"\"\n\n # The REST API path to trigger the creation of a coverage view\n path_uri = '/rest/com.easesolutions.jira.plugins.coverage/1.0/filter/saveFilter'\n\n\t# The request body\n json_data = {'projectId': project_id,\n 'name': filter_name,\n\t\t\t\t 'isPublic': is_public,\n\t\t\t\t 'columnFilterJsonObject': column_data,\n\t\t\t\t 'addedFieldsJsonArray': display_fields}\n\n # Send a POST request to trigger the creation of a coverage view\n # Return the result of the POST request\n try:\n return requests.post(host_url + path_uri, json=json_data, 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":"hardBreak"}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"text":" project_id = \"10000\"\n filter_name = \"GUI Coverage\"\n is_public = \"true\"\n\n columns = '{\"label\":\"Level 1\",\"jiraJql\":\"\",\"jiraFilterId\":\"\",\"linkTypes\":[{\"id\":\"-1\",\"directions\":{\"in\":true,\"out\":true}}],\"currentIssueTypes\":[\"-1\"],\"projects\":[\"10000,PA,Project A\",\"10002,PB,Project B\"],\"fromLevel\":-1}, ' \\\n\t'{\"label\":\"Level 2\",\"jiraJql\":\"\",\"jiraFilterId\":\"10004\",\"linkTypes\":[{\"id\":\"-1\",\"directions\":{\"in\":true,\"out\":true}}],\"currentIssueTypes\":[],\"projects\":[\"10000,PA,Project A\"],\"fromLevel\":0}, ' \\\n\t'{\"label\":\"Level 3\",\"jiraJql\":\"assignee IS NOT EMPTY\",\"jiraFilterId\":\"\",\"linkTypes\":[{\"id\":\"10001\",\"directions\":{\"in\":false,\"out\":true}}],\"currentIssueTypes\":[],\"projects\":[\"10000,PA,Project A\"],\"fromLevel\":1}'\n column_data = '{\"columns\":[' + columns + '],\"projectId\":' + project_id + ',\"fields\":[],\"folderIssueKeys\":[],\"filterId\":0,\"folderId\":0,\"folderName\":\"\",\"fromColumn\":0,\"isFiltered\":false}'\n\t\n display_fields = '[\"issuetype\",\"issuekey\",\"status\",\"priority\",\"summary\",\"assignee\",\"reporter\"]'\n\n # Store the result of the POST request to [response]\n response = create_coverage_view(HOST_URL, USERNAME, PASSWORD, project_id, filter_name, is_public, column_data, display_fields)\n\n # Check response if coverage view is created\n if response.status_code == 201:\n print response.text\n else:\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"},{"text":"(Success)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#008000"}}]},{"text":": ","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"{\"id\":\"1\",\"name\":\"GUI Coverage\"}","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Output ","type":"text"},{"text":"(Error)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff0000"}}]},{"text":": ","type":"text"}]},{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"403","localId":"2cc89f6e-6948-4504-aa5f-18f739ea5016"}},{"text":" ","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#ff0000"}}]},{"text":"Your license is invalid or has expired","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333300"}}]}]},{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"403/401","localId":"4abe087e-a8da-47ae-ad72-367a59bf19f0"}},{"text":" ","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#ff0000"}}]},{"text":"Incompatible Jira Version","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333300"}}]}]},{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"400","localId":"5354daaa-820f-4374-a65a-985615ca5e6f"}},{"text":" ","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#ff0000"}}]},{"text":"No permission to create public/private views in Coverage View","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333300"}}]}]},{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"400","localId":"6797b674-fabd-49a2-bdaf-7cab1f0b2ccb"}},{"text":" ","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#ff0000"}}]},{"text":"Name is invalid","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333300"}}]}]},{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"400","localId":"67b9ec6e-1c87-45c5-b860-da1ae2ad2c89"}},{"text":" ","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#ff0000"}}]},{"text":"Json data is invalid","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333300"}}]}]},{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"400","localId":"33f91ee3-febe-472a-9269-9926561c651e"}},{"text":" ","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#ff0000"}}]},{"text":"Filter with name ''{0}'' already exists.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333300"}}]}]},{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"400","localId":"764b3358-0da7-42f3-b4f1-645272fceba2"}},{"text":" ","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#ff0000"}}]},{"text":"Project is invalid or hasn't been assigned to the Coverage View plugin","type":"text","marks":[{"type":"textColor","attrs":{"color":"#333300"}}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]}],"version":1},"adf":"{\"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 create_coverage_view(host_url, username, password, project_id, filter_name, is_public, column_data, display_fields):\\n \\\"\\\"\\\"\\n This method trigger the creation of a coverage view\\n Template parameters:\\n [project_id] the project the view to be created\\n [filter_name] the name parameter of the view\\n [is_public] the boolean parameter for the visibility of the view\\n [column_data] an parameter of objects composed of column data\\n\\t[display_fields] the display fields for the view\\n \\\"\\\"\\\"\\n\\n # The REST API path to trigger the creation of a coverage view\\n path_uri = '/rest/com.easesolutions.jira.plugins.coverage/1.0/filter/saveFilter'\\n\\n\\t# The request body\\n json_data = {'projectId': project_id,\\n 'name': filter_name,\\n\\t\\t\\t\\t 'isPublic': is_public,\\n\\t\\t\\t\\t 'columnFilterJsonObject': column_data,\\n\\t\\t\\t\\t 'addedFieldsJsonArray': display_fields}\\n\\n # Send a POST request to trigger the creation of a coverage view\\n # Return the result of the POST request\\n try:\\n return requests.post(host_url + path_uri, json=json_data, 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\":\"hardBreak\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"python\"},\"content\":[{\"text\":\" project_id = \\\"10000\\\"\\n filter_name = \\\"GUI Coverage\\\"\\n is_public = \\\"true\\\"\\n\\n columns = '{\\\"label\\\":\\\"Level 1\\\",\\\"jiraJql\\\":\\\"\\\",\\\"jiraFilterId\\\":\\\"\\\",\\\"linkTypes\\\":[{\\\"id\\\":\\\"-1\\\",\\\"directions\\\":{\\\"in\\\":true,\\\"out\\\":true}}],\\\"currentIssueTypes\\\":[\\\"-1\\\"],\\\"projects\\\":[\\\"10000,PA,Project A\\\",\\\"10002,PB,Project B\\\"],\\\"fromLevel\\\":-1}, ' \\\\\\n\\t'{\\\"label\\\":\\\"Level 2\\\",\\\"jiraJql\\\":\\\"\\\",\\\"jiraFilterId\\\":\\\"10004\\\",\\\"linkTypes\\\":[{\\\"id\\\":\\\"-1\\\",\\\"directions\\\":{\\\"in\\\":true,\\\"out\\\":true}}],\\\"currentIssueTypes\\\":[],\\\"projects\\\":[\\\"10000,PA,Project A\\\"],\\\"fromLevel\\\":0}, ' \\\\\\n\\t'{\\\"label\\\":\\\"Level 3\\\",\\\"jiraJql\\\":\\\"assignee IS NOT EMPTY\\\",\\\"jiraFilterId\\\":\\\"\\\",\\\"linkTypes\\\":[{\\\"id\\\":\\\"10001\\\",\\\"directions\\\":{\\\"in\\\":false,\\\"out\\\":true}}],\\\"currentIssueTypes\\\":[],\\\"projects\\\":[\\\"10000,PA,Project A\\\"],\\\"fromLevel\\\":1}'\\n column_data = '{\\\"columns\\\":[' + columns + '],\\\"projectId\\\":' + project_id + ',\\\"fields\\\":[],\\\"folderIssueKeys\\\":[],\\\"filterId\\\":0,\\\"folderId\\\":0,\\\"folderName\\\":\\\"\\\",\\\"fromColumn\\\":0,\\\"isFiltered\\\":false}'\\n\\t\\n display_fields = '[\\\"issuetype\\\",\\\"issuekey\\\",\\\"status\\\",\\\"priority\\\",\\\"summary\\\",\\\"assignee\\\",\\\"reporter\\\"]'\\n\\n # Store the result of the POST request to [response]\\n response = create_coverage_view(HOST_URL, USERNAME, PASSWORD, project_id, filter_name, is_public, column_data, display_fields)\\n\\n # Check response if coverage view is created\\n if response.status_code == 201:\\n print response.text\\n else:\\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\"},{\"text\":\"(Success)\",\"type\":\"text\",\"marks\":[{\"type\":\"textColor\",\"attrs\":{\"color\":\"#008000\"}}]},{\"text\":\": \",\"type\":\"text\"}]},{\"type\":\"codeBlock\",\"attrs\":{\"language\":\"javascript\"},\"content\":[{\"text\":\"{\\\"id\\\":\\\"1\\\",\\\"name\\\":\\\"GUI Coverage\\\"}\",\"type\":\"text\"}]},{\"type\":\"heading\",\"attrs\":{\"level\":5},\"content\":[{\"text\":\"Output \",\"type\":\"text\"},{\"text\":\"(Error)\",\"type\":\"text\",\"marks\":[{\"type\":\"textColor\",\"attrs\":{\"color\":\"#ff0000\"}}]},{\"text\":\": \",\"type\":\"text\"}]},{\"type\":\"panel\",\"attrs\":{\"panelType\":\"custom\"},\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"status\",\"attrs\":{\"color\":\"red\",\"style\":\"bold\",\"text\":\"403\",\"localId\":\"2cc89f6e-6948-4504-aa5f-18f739ea5016\"}},{\"text\":\" \",\"type\":\"text\",\"marks\":[{\"type\":\"strong\"},{\"type\":\"textColor\",\"attrs\":{\"color\":\"#ff0000\"}}]},{\"text\":\"Your license is invalid or has expired\",\"type\":\"text\",\"marks\":[{\"type\":\"textColor\",\"attrs\":{\"color\":\"#333300\"}}]}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"status\",\"attrs\":{\"color\":\"red\",\"style\":\"bold\",\"text\":\"403/401\",\"localId\":\"4abe087e-a8da-47ae-ad72-367a59bf19f0\"}},{\"text\":\" \",\"type\":\"text\",\"marks\":[{\"type\":\"strong\"},{\"type\":\"textColor\",\"attrs\":{\"color\":\"#ff0000\"}}]},{\"text\":\"Incompatible Jira Version\",\"type\":\"text\",\"marks\":[{\"type\":\"textColor\",\"attrs\":{\"color\":\"#333300\"}}]}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"status\",\"attrs\":{\"color\":\"red\",\"style\":\"bold\",\"text\":\"400\",\"localId\":\"5354daaa-820f-4374-a65a-985615ca5e6f\"}},{\"text\":\" \",\"type\":\"text\",\"marks\":[{\"type\":\"strong\"},{\"type\":\"textColor\",\"attrs\":{\"color\":\"#ff0000\"}}]},{\"text\":\"No permission to create public/private views in Coverage View\",\"type\":\"text\",\"marks\":[{\"type\":\"textColor\",\"attrs\":{\"color\":\"#333300\"}}]}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"status\",\"attrs\":{\"color\":\"red\",\"style\":\"bold\",\"text\":\"400\",\"localId\":\"6797b674-fabd-49a2-bdaf-7cab1f0b2ccb\"}},{\"text\":\" \",\"type\":\"text\",\"marks\":[{\"type\":\"strong\"},{\"type\":\"textColor\",\"attrs\":{\"color\":\"#ff0000\"}}]},{\"text\":\"Name is invalid\",\"type\":\"text\",\"marks\":[{\"type\":\"textColor\",\"attrs\":{\"color\":\"#333300\"}}]}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"status\",\"attrs\":{\"color\":\"red\",\"style\":\"bold\",\"text\":\"400\",\"localId\":\"67b9ec6e-1c87-45c5-b860-da1ae2ad2c89\"}},{\"text\":\" \",\"type\":\"text\",\"marks\":[{\"type\":\"strong\"},{\"type\":\"textColor\",\"attrs\":{\"color\":\"#ff0000\"}}]},{\"text\":\"Json data is invalid\",\"type\":\"text\",\"marks\":[{\"type\":\"textColor\",\"attrs\":{\"color\":\"#333300\"}}]}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"status\",\"attrs\":{\"color\":\"red\",\"style\":\"bold\",\"text\":\"400\",\"localId\":\"33f91ee3-febe-472a-9269-9926561c651e\"}},{\"text\":\" \",\"type\":\"text\",\"marks\":[{\"type\":\"strong\"},{\"type\":\"textColor\",\"attrs\":{\"color\":\"#ff0000\"}}]},{\"text\":\"Filter with name ''{0}'' already exists.\",\"type\":\"text\",\"marks\":[{\"type\":\"textColor\",\"attrs\":{\"color\":\"#333300\"}}]}]},{\"type\":\"paragraph\",\"content\":[{\"type\":\"status\",\"attrs\":{\"color\":\"red\",\"style\":\"bold\",\"text\":\"400\",\"localId\":\"764b3358-0da7-42f3-b4f1-645272fceba2\"}},{\"text\":\" \",\"type\":\"text\",\"marks\":[{\"type\":\"strong\"},{\"type\":\"textColor\",\"attrs\":{\"color\":\"#ff0000\"}}]},{\"text\":\"Project is invalid or hasn't been assigned to the Coverage View plugin\",\"type\":\"text\",\"marks\":[{\"type\":\"textColor\",\"attrs\":{\"color\":\"#333300\"}}]}]}]},{\"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":"panel","attrs":{"panelType":"custom"},"content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Create coverage view","type":"text","marks":[{"type":"textColor","attrs":{"color":"#003366"}}]}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"The following script will trigger the creation of a coverage view. In this example, a coverage view for the GUI requirements will be created.","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"cxhtml":"

Function

pyConfluencetrue

Main

pyConfluencetrue

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

Output

View GUI Coverage has been successfully created

Create Coverage View

Create coverage view (since 4.0.0)

Create coverage view