|
| 1 | +Usage Guide |
| 2 | +=========== |
| 3 | + |
| 4 | +Usage ( *XMLRPC* ) |
| 5 | +****************** |
| 6 | + |
| 7 | ++ 1. Create JSON configuration ( runtime or read from file, *read config section* ) |
| 8 | ++ 2. Instance **testlink_manager** object ``testlink_manager = TLManager(settings=my_json_config)`` |
| 9 | ++ 3. Use some *method name with prefix* '**api_**' |
| 10 | + |
| 11 | +**api_login** |
| 12 | ++++++++++++++ |
| 13 | + |
| 14 | +* **XMLRPC**: *call to method named* '*tl.checkDevKey*' |
| 15 | +* **Description** : check if dev_key it's valid |
| 16 | + |
| 17 | +**api_tprojects** |
| 18 | ++++++++++++++++++ |
| 19 | + |
| 20 | +* **XMLRPC**: *call to method named* '*tl.getProjects*' |
| 21 | +* **Description** : get all test projects |
| 22 | + |
| 23 | + |
| 24 | +**api_tproject** |
| 25 | +++++++++++++++++ |
| 26 | + |
| 27 | +* **XMLRPC**: *call to method named* '*tl.getTestProjectByName*' |
| 28 | +* **Description** : get one test project filtered by name |
| 29 | + |
| 30 | +**api_tproject_tplans** |
| 31 | ++++++++++++++++++++++++ |
| 32 | + |
| 33 | +* **XMLRPC**: *call to method named* '*tl.getProjectTestPlans*' |
| 34 | +* **Description** : get all test plans for one test project |
| 35 | + |
| 36 | +**api_tproject_tsuites_first_level** |
| 37 | +++++++++++++++++++++++++++++++++++++ |
| 38 | + |
| 39 | +* **XMLRPC**: *call to method named* '*tl.getFirstLevelTestSuitesForTestProject*' |
| 40 | +* **Description** : get all test suites on first level for one test project |
| 41 | + |
| 42 | +**api_tplan** |
| 43 | ++++++++++++++ |
| 44 | + |
| 45 | +* **XMLRPC**: *call to method named* '*tl.getTestPlanByName*' |
| 46 | +* **Description** : get one test plan filtered by project and plan names |
| 47 | + |
| 48 | +**api_tplan_platforms** |
| 49 | ++++++++++++++++++++++++ |
| 50 | + |
| 51 | +* **XMLRPC**: *call to method named* '*tl.getTestPlanPlatforms*' |
| 52 | +* **Description** : get one test plan filtered by project and plan names |
| 53 | + |
| 54 | +**api_tplan_builds** |
| 55 | +++++++++++++++++++++ |
| 56 | + |
| 57 | +* **XMLRPC**: *call to method named* '*tl.getBuildsForTestPlan*' |
| 58 | +* **Description** : get all builds for test project filtered by id |
| 59 | + |
| 60 | +**api_tplan_tsuites** |
| 61 | ++++++++++++++++++++++ |
| 62 | + |
| 63 | +* **XMLRPC**: *call to method named* '*tl.getTestSuitesForTestPlan*' |
| 64 | +* **Description** : get all test suites assigned to test plan filtered by id |
| 65 | + |
| 66 | +**api_tplan_tcases** |
| 67 | +++++++++++++++++++++ |
| 68 | + |
| 69 | +* **XMLRPC**: *call to method named* '*tl.getTestCasesForTestPlan*' |
| 70 | +* **Description** : get all test cases assigned to test plan filtered by id |
| 71 | + |
| 72 | +**api_tplan_build_latest** |
| 73 | +++++++++++++++++++++++++++ |
| 74 | + |
| 75 | +* **XMLRPC**: *call to method named* '*tl.getLatestBuildForTestPlan*' |
| 76 | +* **Description** : get latest build by choosing the maximum build id for a specific test plan id |
| 77 | + |
| 78 | +**api_tplan_totals** |
| 79 | +++++++++++++++++++++ |
| 80 | + |
| 81 | +* **XMLRPC**: *call to method named* '*tl.getTotalsForTestPlan*' |
| 82 | +* **Description** : get totals for testplan filtered by id |
| 83 | + |
| 84 | +**api_tsuite** |
| 85 | +++++++++++++++ |
| 86 | + |
| 87 | +* **XMLRPC**: *call to method named* '*tl.getTestSuiteByID*' |
| 88 | +* **Description** : get test suite filtered by id |
| 89 | + |
| 90 | +**api_tsuite_tsuites** |
| 91 | +++++++++++++++++++++++ |
| 92 | + |
| 93 | +* **XMLRPC**: *call to method named* '*tl.getTestSuitesForTestSuite*' |
| 94 | +* **Description** : get test suites down of tree for one test suite filtered by id |
| 95 | + |
| 96 | +**api_tcase** |
| 97 | ++++++++++++++ |
| 98 | + |
| 99 | +* **XMLRPC**: *call to method named* '*tl.getTestCase*' |
| 100 | +* **Description** : get test case filtered by id or external id |
| 101 | + |
| 102 | +**api_tcase_by_name** |
| 103 | ++++++++++++++++++++++ |
| 104 | + |
| 105 | +* **XMLRPC**: *call to method named* '*tl.getTestCaseIDByName*' |
| 106 | +* **Description** : get test case filtered by name |
| 107 | + |
| 108 | +**api_tcase_report** |
| 109 | +++++++++++++++++++++ |
| 110 | + |
| 111 | +* **XMLRPC**: *call to method named* '*tl.reportTCResult*' |
| 112 | +* **Description** : reports a result for a single test case |
| 113 | + |
| 114 | +**api_user_exist** |
| 115 | +++++++++++++++++++ |
| 116 | + |
| 117 | +* **XMLRPC**: *call to method named* '*tl.doesUserExist*' |
| 118 | +* **Description** : check if user name it's valid |
| 119 | + |
| 120 | +**api_about** |
| 121 | ++++++++++++++ |
| 122 | + |
| 123 | +* **XMLRPC**: *call to method named* '*tl.about*' |
| 124 | +* **Description** : get default message with author and testlink version |
| 125 | + |
| 126 | +**api_say_hello** |
| 127 | ++++++++++++++++++ |
| 128 | + |
| 129 | +* **XMLRPC**: *call to method named* '*tl.sayHello*' |
| 130 | +* **Description** : get **'Hello!'** message |
| 131 | + |
| 132 | +**api_ping** |
| 133 | +++++++++++++ |
| 134 | + |
| 135 | +* **XMLRPC**: *call to method named* '*tl.ping*' |
| 136 | +* **Description** : get **'Hello!'** message |
| 137 | + |
| 138 | +**api_ping** |
| 139 | +++++++++++++ |
| 140 | + |
| 141 | +* **XMLRPC**: *call to method named* '*tl.repeat*' |
| 142 | +* **Description** : get **You said: 'your message here'** as message |
0 commit comments