{"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 suspect configuration","type":"text","marks":[{"type":"textColor","attrs":{"color":"#003366"}}]}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"The following script will create a suspect configuration on a give project.","type":"text"}]},{"type":"paragraph","content":[{"text":"In this example, the script will create a suspect for project Sand Castle 'SC'. Refer to the parameters in Main for the settings that will be set in the suspect.","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"type":"inlineExtension","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

","block-inline":true,"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_suspect(host_url, username, password, project_key, config_name, notify_assignee, notify_reporter,\n notify_project_lead, user_keys, link_type_ids, use_all_link_types, field, stream, scope):\n \"\"\"\n This method allows to create suspect configuration on a project\n \"\"\"\n\n # The REST API path to allow the creation of suspect configuration for a project\n path_uri = '/rest/com.easesolutions.jira.plugins.requirements/1.0/{}/suspectconfiguration'.format(project_key)\n\n # The request body\n json_data = {'configName': config_name, 'notifyAssignee': notify_assignee, 'notifyReporter': notify_reporter,\n 'notifyProjectLead': notify_project_lead, 'userKeys': [user_keys], 'linkTypeIds': [link_type_ids],\n 'useAllLinktypes': use_all_link_types, 'suspectConfigItems': [{'field': field, 'stream': stream}],\n 'scope': scope}\n\n # Send and return 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":"codeBlock","attrs":{"language":"python"},"content":[{"text":"# ['SC'] the project key parameter where the suspect will be configured\n# ['SC_Suspect'] suspect configuration name\n# [False] true to notify assignee, otherwise false\n# [False] true to notify reporter, otherwise false\n# [False] true to notify project lead, otherwise false\n# ['admin'] List of users to be notified if suspect is triggered\n# ['10002'] Define the link types that should be affected\n# [False] true if use all link types, otherwise false\n# ['assignee']Input the fieldId that trigger a suspect. Add to trigger on any field change.\n# ['up'] Define if a change in an issue will trigger suspect to downstream relationships only or in both directions.\n# Note: \"stream\" and \"scope\" must always have the same value.\n\nresponse = create_suspect(HOST_URL, USERNAME, PASSWORD, 'SC', 'SC_Suspect', False, False, False, \"admin\",\n \"10002\", False, \"assignee\", \"up\", \"up\")\n\nif response.status_code == 200:\n print response.text\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":"#Create/Update/Get/Deletesuspectconfiguration-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":"Suspect Configuration saved for SC","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"}]},{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Update suspect configuration","type":"text","marks":[{"type":"textColor","attrs":{"color":"#003366"}}]}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"The following script will udpate a suspect configuration on a give project.","type":"text"}]},{"type":"paragraph","content":[{"text":"In this example, the script will update a suspect for project Sand Castle 'SC'. Refer to the parameters in Main for the settings that will be set in the suspect.","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"type":"inlineExtension","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

","block-inline":true,"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 update_suspect(host_url, username, password, project_key, suspect_id, config_name, notify_assignee,\n notify_reporter, notify_project_lead, user_keys, link_type_ids, use_all_link_types,\n field, stream, scope):\n \"\"\"\n This method allows to update suspect configuration on a project\n \"\"\"\n\n # The REST API path to allow update of suspect configuration for a project\n path_uri = '/rest/com.easesolutions.jira.plugins.requirements/1.0/{}/suspectconfiguration/{}'.\\\n format(project_key, suspect_id)\n\n # The request body\n json_data = {'configName': config_name, 'notifyAssignee': notify_assignee, 'notifyReporter': notify_reporter,\n 'notifyProjectLead': notify_project_lead, 'userKeys': [user_keys], 'linkTypeIds': [link_type_ids],\n 'useAllLinktypes': use_all_link_types, 'suspectConfigItems': [{'field': field, 'stream': stream}],\n 'scope': scope}\n # Send and return the PUT request\n try:\n return requests.put(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":"codeBlock","attrs":{"language":"python"},"content":[{"text":"# ['SC'] the project key parameter where the suspect will be configured\n# [17] The suspect configuration id to be updated\n# ['SC_Suspect_Update'] suspect configuration name\n# [True] true to notify assignee, otherwise false\n# [False] true to notify reporter, otherwise false\n# [False] true to notify project lead, otherwise false\n# ['admin'] List of users to be notified if suspect is triggered\n# ['10002'] Define the link types that should be affected\n# [False] true if use all link types, otherwise false\n# ['assignee']Input the fieldId that trigger a suspect. Add to trigger on any field change.\n# ['up'] Define if a change in an issue will trigger suspect to downstream relationships only or in both directions.\n# Note: \"stream\" and \"scope\" must always have the same value.\n\nresponse = update_suspect(HOST_URL, USERNAME, PASSWORD, 'SC', 17, 'SC_Suspect_Update', True, False, False, \"admin\",\n \"10002\", False, \"assignee\", \"up\", \"up\")\n\nif response.status_code == 200:\n print response.text\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":"#Create/Update/Get/Deletesuspectconfiguration-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":"Suspect Configuration saved for SC","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"}]},{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Get all suspect configuration of a project","type":"text","marks":[{"type":"textColor","attrs":{"color":"#003366"}}]}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"The following script will get all suspect configuration on a give project.","type":"text"}]},{"type":"paragraph","content":[{"text":"In this example, the script will get all suspect for project Sand Castle 'SC'.","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","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

","block-inline":true,"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_suspect(host_url, username, password, project_key):\n \"\"\"\n This method allows to get all suspect configuration on a project\n \"\"\"\n\n # The REST API path to get all suspect configuration of a project\n path_uri = '/rest/com.easesolutions.jira.plugins.requirements/1.0/{}/suspectconfigurations'.format(project_key)\n\n # Send and return the GET request\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":"# ['SC'] the project key parameter where all suspect configuration will be fetched\n\nresponse = get_suspect(HOST_URL, USERNAME, PASSWORD, 'SC')\n\nif response.status_code == 200:\n parsed = json.loads(response.text)\n print json.dumps(parsed, indent=4, sort_keys=True)\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":"#Create/Update/Get/Deletesuspectconfiguration-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 \"configId\": 17, \n \"configName\": \"SC_Suspect_Update\", \n \"linkTypeIds\": [\n \"10002\"\n ], \n \"notifyAssignee\": true, \n \"notifyProjectLead\": false, \n \"notifyReporter\": false, \n \"projectId\": 10000, \n \"scope\": \"up\", \n \"suspectConfigItems\": [\n {\n \"field\": \"assignee\", \n \"stream\": \"up\"\n }\n ], \n \"useAllLinktypes\": false, \n \"userKeys\": [\n \"admin\"\n ]\n }, \n {\n \"configId\": 18, \n \"configName\": \"SC_Suspect\", \n \"linkTypeIds\": [\n \"10002\"\n ], \n \"notifyAssignee\": false, \n \"notifyProjectLead\": false, \n \"notifyReporter\": false, \n \"projectId\": 10000, \n \"scope\": \"up\", \n \"suspectConfigItems\": [\n {\n \"field\": \"assignee\", \n \"stream\": \"up\"\n }\n ], \n \"useAllLinktypes\": false, \n \"userKeys\": [\n \"admin\"\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"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Delete suspect configuration ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#003366"}}]}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"The following script will delete a suspect configuration on a give project.","type":"text"}]},{"type":"paragraph","content":[{"text":"In this example, the script will delete the suspect configuration with id 17 on project Sand Castle 'SC'.","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","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