---
# System prepended metadata

title: API Guide - issueMan
tags: [Guide, API]

---

## Methods that TBot can call in getTestInput().
For query and control the app under test and system under test from inside the TBot execution.

==path=API.issueMan==

## Description
issue tracker management API group

## Group Methods
1. **queryIssueTrackers**, path=API.issueMan.queryIssueTrackers
    * Description: query the list of issue trackers for the current project.
    * Return Value: a dict indicating whether the issue report is rejected. The key 'result' shows either 'success!' or 'failure!'. The key 'status' shows why the report is rejected.
2. **addIssueReport**, path=API.issueMan.addIssueReport
    * Description: issue a test report to the issue trackers. The method checks if some     * Arguments are missing and may reject the report.
    * Arguments:
        1. *player* : who wants to issue this report? The default is current test robot.
        2. *recordType* : the report type, can be action, notification, issue, verdict, userInput, comment.
        3. *verdict* : can be 'failure!', 'success!', 'inconclusive', or any other verdict the user defined.
        4. *component* : what is the module, funciton that the issue is found and concerned. Default value is python.
        5. *subject* : a few words for the issue
        6. *summary* : a few sentences for the issue.
        7. *environment* : the platform, configuraiton, environment settings, ..., etc. the the issue is observed. This is for making sure that repeated observation can be made.
        8. *contents* : details of the issue.
        9. *features* : some keywords of the issue.
        10. *diagnosis* : root cause of the issue. Good test report must suggest the cause.
        11. *suggestions* : how to fix the issue? Good test report must give suggestions for remedy.
        12. *severity* : can be 'low', 'medium', 'high', or any other descriptive phrase.
        13. *priority* : an integer between 1 and 5. The higher, the more important.
    * Return Value: a dict indicating whether the issue report is rejected. The key 'result' shows either 'success!' or 'failure!'. The key 'status' shows why the report is rejected.
3. **newIssueReportTemplate**, path=API.issueMan.newIssueReportTemplate
    * Description: create a new issue report template object so that you can save time again and again in writing duplate texts while submitting test reports.
    * Arguments:
        1. *keyArgs* : a dict for template values in the issue report template. The key names are exactly the argument names to addIssueReport().
    * Return Value: an object with a dict attribute called issueReportTemplate that you can modify and use again and again.