Package org.touchbit.testrail4j.jackson2.feign.client

Interface TestRailClient

public interface TestRailClient
This class explains how to access and use TestRail's API to integrate automated tests, submit test results and automate various aspects of TestRail. API: Results getResults(Long, GetResultsQueryMap) getResultsForCase(Long, Long, GetResultsQueryMap) getResultsForRun(Long) getResultsForRun(Long, GetResultsQueryMap) addResult(TRResult, Long) addResults(TRResults, Long) addResultForCase(TRResult, Long, Long) addResultsForCases(TRResults, Long) Default getResults(Long) getResults(TRTest) getResults(TRTest, GetResultsQueryMap) getResultsForCase(Long, Long) getResultsForCase(TRRun, TRCase) getResultsForCase(TRRun, TRCase, GetResultsQueryMap) getResultsForRun(TRRun) getResultsForRun(TRRun, GetResultsQueryMap) addResult(TRResult, TRTest) addResults(TRResults, TRRun) addResultForCase(TRResult, TRRun, TRCase) addResultsForCases(TRResults, TRRun) API: Cases getCase(Long) getCases(Long, GetCasesQueryMap) addCase(TRCase, Long) updateCase(TRCase, Long) deleteCase(Long) Default getCase(TRCase) getCases(TRProject) getCases(TRProject, GetCasesQueryMap) getCases(Long) addCase(TRCase, TRSection) updateCase(TRCase) deleteCase(TRCase) API: Projects getProject(Long) getProjects(GetProjectsQueryMap) addProject(TRProject) updateProject(TRProject, Long) deleteProject(Long) Default getProject(TRProject) getProjects() updateProject(TRProject) deleteProject(TRProject) API: Get run getRun(Long) getRuns(Long, GetRunsQueryMap) addRun(TRRun, Long) updateRun(TRRun, Long) closeRun(Long) deleteRun(Long) Default getRun(TRRun) getRuns(Long) getRuns(TRProject) getRuns(TRProject, GetRunsQueryMap) addRun(TRRun, TRProject) updateRun(TRRun) closeRun(TRRun) deleteRun(TRRun) API: Suites getSuite(Long) getSuites(Long) addSuite(TRSuite, Long) updateSuite(TRSuite, Long) deleteSuite(Long) Default getSuite(TRSuite) getSuites(TRProject) addSuite(TRSuite, TRProject) updateSuite(TRSuite) deleteSuite(TRSuite) API: Sections addSection(TRSection, Long) getSection(Long) getSections(Long, GetSectionsQueryMap) updateSection(TRSection, Long) deleteSection(Long) Default addSection(TRSection, TRProject) getSection(TRSection) getSections(Long) getSections(TRProject) getSections(TRProject, GetSectionsQueryMap) updateSection(TRSection) deleteSection(TRSection) API: Tests getTest(Long) getTests(Long, GetTestsQueryMap) Default getTest(TRTest) getTests(Long) getTests(TRRun) getTests(TRRun, GetTestsQueryMap) Case fields getCaseFields() addCaseField(TRCaseField) Case fields getCaseTypes() API: Configs getConfigs(Long) addConfigGroup(TRProjectConfigGroup, Long) updateConfigGroup(TRProjectConfigGroup, Long) deleteConfigGroup(Long) addConfig(TRProjectConfig, Long) updateConfig(TRProjectConfig, Long) deleteConfig(Long) Default getConfigs(TRProject) addConfigGroup(TRProjectConfigGroup, TRProject) updateConfigGroup(TRProjectConfigGroup) deleteConfigGroup(TRProjectConfigGroup) addConfig(TRProjectConfig, TRProjectConfigGroup) updateConfig(TRProjectConfig) deleteConfig(TRProjectConfig) API: Milestones getMilestone(Long) getMilestones(Long) addMilestone(TRMilestone, Long) updateMilestone(TRMilestone, Long) deleteMilestone(Long) Default getMilestone(TRMilestone) getMilestones(TRProject) getMilestones(Long, GetMilestonesQueryMap) getMilestones(TRProject, GetMilestonesQueryMap) addMilestone(TRMilestone, TRProject) updateMilestone(TRMilestone) deleteMilestone(TRMilestone) API: Priorities getPriorities() API: Users getUsers() getUser(Long) getUserByEmail(String) Default getUser(TRUser) getUserByEmail(TRUser) API: Templates getTemplates(Long) Default getTemplates(TRProject) API: Statuses getStatuses() API: Results fields getResultFields() API: Plans getPlan(Long) getPlans(Long) addPlan(TRPlan, Long) updatePlan(TRPlan, Long) closePlan(Long) deletePlan(Long) addPlanEntry(TRPlanEntry, Long) updatePlanEntry(TRPlanEntry, Long, String) deletePlanEntry(Long, String) Default getPlan(TRPlan) getPlans(TRProject) getPlans(Long, GetPlansQueryMap) getPlans(TRProject, GetPlansQueryMap) addPlan(TRPlan, TRProject) updatePlan(TRPlan) closePlan(TRPlan) deletePlan(TRPlan) addPlanEntry(TRPlanEntry, TRPlan) updatePlanEntry(TRPlanEntry, TRPlan) deletePlanEntry(TRPlan, TRPlanEntry) Created by Oleg Shaburov on 11.11.2018 shaburov.o.a@gmail.com

  • Method Details

    • getResults

      List<org.touchbit.testrail4j.jackson2.model.TRResult> getResults​(Long testID, org.touchbit.testrail4j.core.query.GetResultsQueryMap queryMap)
      TestRailClient
      Parameters:
      testID - is the ID of the test
      queryMap - is the request filter. See GetResultsQueryMap The latest 10 results for test with ID 1 and statuses 4 or 5 (Retest, Failed) GET index.php?/api/v2/get_results/1&status_id=4,5&limit=10
      Returns:
      a list of test TRResults for a test. Custom fields are also included in the response and use their system name prefixed with 'custom_' as their field identifier. Please see add_result for a full list of available custom field types. [ { "assignedto_id": 1, "comment": "This test failed: ..", "created_by": 1, "created_on": 1393851801, "defects": "TR-1", "elapsed": "5m", "id": 1, "status_id": 5, "test_id": 1, "version": "1.0RC1", "custom_step_results": [ { "content": "Step 1", "expected": "Expected Result 1", "actual": "Actual Result 1", "status_id": 1 } ] } ]
      See Also:
      API: Get results Get the latest 10 results for test with ID 1 and statuses 4 or 5 (Retest, Failed) GET /index.php/api/v2/get_results/1&status_id=4,5&limit=10

    • getResults

      default List<org.touchbit.testrail4j.jackson2.model.TRResult> getResults​(org.touchbit.testrail4j.jackson2.model.TRTest trTest, org.touchbit.testrail4j.core.query.GetResultsQueryMap queryMap)
      See getResults(Long, GetResultsQueryMap)

    • getResults

      default List<org.touchbit.testrail4j.jackson2.model.TRResult> getResults​(Long testID)
      See getResults(Long, GetResultsQueryMap)

    • getResults

      default List<org.touchbit.testrail4j.jackson2.model.TRResult> getResults​(org.touchbit.testrail4j.jackson2.model.TRTest trTest)
      See getResults(Long, GetResultsQueryMap)

    • getResultsForCase

      List<org.touchbit.testrail4j.jackson2.model.TRResult> getResultsForCase​(Long runID, Long caseID, org.touchbit.testrail4j.core.query.GetResultsQueryMap queryMap)
      TestRailClient
      Parameters:
      runID - is the ID of the test run
      caseID - is the ID of the test case
      queryMap - is the request filter. See GetResultsQueryMap
      Returns:
      This method uses the same response format as getResults(Long, GetResultsQueryMap).
      See Also:
      API: Get results for case Returns a list of test results for a test run and case combination. The difference to get_results is that this method expects a test run + test case instead of a test. In TestRail, tests are part of a test run and the test cases are part of the related test suite. So, when you create a new test run, TestRail creates a test for each test case found in the test suite of the run. You can therefore think of a test as an “instance” of a test case which can have test results, comments and a test status. Please also see TestRail's getting started guide for more details about the differences between test cases and tests. All results for test run with ID 1 and test case with ID 2 GET index.php?/api/v2/get_results_for_case/1/2

    • getResultsForCase

      default List<org.touchbit.testrail4j.jackson2.model.TRResult> getResultsForCase​(Long runID, Long caseID)
      See getResultsForCase(Long, Long, GetResultsQueryMap)

    • getResultsForCase

      default List<org.touchbit.testrail4j.jackson2.model.TRResult> getResultsForCase​(org.touchbit.testrail4j.jackson2.model.TRRun run, org.touchbit.testrail4j.jackson2.model.TRCase caze)
      See getResultsForCase(Long, Long, GetResultsQueryMap)

    • getResultsForCase

      default List<org.touchbit.testrail4j.jackson2.model.TRResult> getResultsForCase​(org.touchbit.testrail4j.jackson2.model.TRRun run, org.touchbit.testrail4j.jackson2.model.TRCase caze, org.touchbit.testrail4j.core.query.GetResultsQueryMap queryMap)
      See getResultsForCase(Long, Long, GetResultsQueryMap)

    • getResultsForRun

      List<org.touchbit.testrail4j.jackson2.model.TRResult> getResultsForRun​(Long runID, org.touchbit.testrail4j.core.query.GetResultsQueryMap queryMap)
      TestRailClient
      Parameters:
      runID - is the ID of the test run
      queryMap - is the request filter. See GetResultsQueryMap
      Returns:
      a list of test TRResults for a test run.
      See Also:
      API: Get results for run Returns a list of test results for a test run.

    • getResultsForRun

      default List<org.touchbit.testrail4j.jackson2.model.TRResult> getResultsForRun​(org.touchbit.testrail4j.jackson2.model.TRRun run, org.touchbit.testrail4j.core.query.GetResultsQueryMap queryMap)
      See getResultsForRun(Long, GetResultsQueryMap)

    • getResultsForRun

      default List<org.touchbit.testrail4j.jackson2.model.TRResult> getResultsForRun​(Long runID)
      See getResultsForRun(Long, GetResultsQueryMap)

    • getResultsForRun

      default List<org.touchbit.testrail4j.jackson2.model.TRResult> getResultsForRun​(org.touchbit.testrail4j.jackson2.model.TRRun run)
      See getResultsForRun(Long, GetResultsQueryMap)

    • addResult

      org.touchbit.testrail4j.jackson2.model.TRResult addResult​(org.touchbit.testrail4j.jackson2.model.TRResult result, Long testID)
      TestRailClient
      Parameters:
      testID - is the ID of the test the result should be added to
      Returns:
      the new test TRResult using the same response format as getResults(Long, GetResultsQueryMap), but with a single result instead of a list of results.
      See Also:
      API: Add result Adds a new test result, comment or assigns a test. It's recommended to use add_results instead if you plan to add results for multiple tests. Request example

    • addResult

      default org.touchbit.testrail4j.jackson2.model.TRResult addResult​(org.touchbit.testrail4j.jackson2.model.TRResult result, org.touchbit.testrail4j.jackson2.model.TRTest test)
      See addResult(TRResult, Long)

    • addResultForCase

      org.touchbit.testrail4j.jackson2.model.TRResult addResultForCase​(org.touchbit.testrail4j.jackson2.model.TRResult result, Long runID, Long caseID)
      TestRailClient
      Parameters:
      runID - is the ID of the test run
      caseID - is the ID of the test case
      Returns:
      the new test TRResult using the same response format as getResults(Long, GetResultsQueryMap), but with a single result instead of a list of results.
      See Also:
      API: Add result for case Adds a new test result, comment or assigns a test (for a test run and case combination). It's recommended to use TestRailClient#addResultsForCases(TRResults, Long) instead if you plan to add results for multiple test cases. The difference to TestRailClient#addResult(TRResult, Long) is that this method expects a test run + test case instead of a test. In TestRail, tests are part of a test run and the test cases are part of the related test suite. So, when you create a new test run, TestRail creates a test for each test case found in the test suite of the run. You can therefore think of a test as an “instance” of a test case which can have test results, comments and a test status. Please also see TestRail's getting started guide for more details about the differences between test cases and tests.

    • addResultForCase

      default org.touchbit.testrail4j.jackson2.model.TRResult addResultForCase​(org.touchbit.testrail4j.jackson2.model.TRResult result, org.touchbit.testrail4j.jackson2.model.TRRun run, org.touchbit.testrail4j.jackson2.model.TRCase caze)
      See addResultForCase(TRResult, Long, Long)

    • addResults

      List<org.touchbit.testrail4j.jackson2.model.TRResult> addResults​(org.touchbit.testrail4j.jackson2.model.TRResults results, Long runID)
      TestRailClient
      Parameters:
      runID - is ID of the test run the results should be added to
      Returns:
      the new test TRResults using the same response format as getResults(Long, GetResultsQueryMap) and in the same order as the list of the request.
      See Also:
      API: Add results Adds one or more new test results, comments or assigns one or more tests. Ideal for test automation to bulk-add multiple test results in one step. This method expects an array of test results (via the 'results' field, please see below). Each test result must specify the test ID and can pass in the same fields as TestRailClient#addResult(TRResult, Long), namely all test related system and custom fields. Please note that all referenced tests must belong to the same test run. The following listing shows a typical example request. In addition to the test, you need to specify at least one of the status, comment or assignee fields for each result. { "results": [ { "test_id": 101, "status_id": 5, "comment": "This test failed", "defects": "TR-7" } ] }

    • addResults

      default List<org.touchbit.testrail4j.jackson2.model.TRResult> addResults​(org.touchbit.testrail4j.jackson2.model.TRResults results, org.touchbit.testrail4j.jackson2.model.TRRun run)
      See addResults(TRResults, Long)

    • addResultsForCases

      List<org.touchbit.testrail4j.jackson2.model.TRResult> addResultsForCases​(org.touchbit.testrail4j.jackson2.model.TRResults results, Long runID)
      TestRailClient
      Parameters:
      runID - the test run the results should be added to
      Returns:
      the new test TRResults using the same response format as getResults(Long, GetResultsQueryMap) and in the same order as the list of the request.
      See Also:
      API: Add results for cases Adds one or more new test results, comments or assigns one or more tests (using the case IDs). Ideal for test automation to bulk-add multiple test results in one step. This method expects an array of test results (via the 'results' field, please see below). Each test result must specify the test case ID and can pass in the same fields as TestRailClient#addResult(TRResult, Long), namely all test related system and custom fields. The difference to add_results is that this method expects test case IDs instead of test IDs. Please see TestRailClient#addResultForCase(TRResult, Long, Long) for details. Please note that all referenced tests must belong to the same test run. The following listing shows a typical example request. In addition to the test case, you need to specify at least one of the status, comment or assignee fields for each result. { "results": [ { "case_id": 1, "status_id": 5, "comment": "This test failed", "defects": "TR-7" } ] }

    • addResultsForCases

      default List<org.touchbit.testrail4j.jackson2.model.TRResult> addResultsForCases​(org.touchbit.testrail4j.jackson2.model.TRResults results, org.touchbit.testrail4j.jackson2.model.TRRun run)
      See addResultsForCases(TRResults, Long)

    • getCase

      org.touchbit.testrail4j.jackson2.model.TRCase getCase​(Long caseID)
      TestRailClient
      Parameters:
      caseID - is the ID of the test case
      Returns:
      an existing test case. { "created_by": 5, "created_on": 1392300984, "estimate": "1m 5s", "estimate_forecast": null, "id": 1, "milestone_id": 7, "priority_id": 2, "refs": "RF-1, RF-2", "section_id": 1, "suite_id": 1, "title": "Change document attributes (author, title, organization)", "type_id": 4, "updated_by": 1, "updated_on": 1393586511 }
      See Also:
      API: Get case

    • getCase

      default org.touchbit.testrail4j.jackson2.model.TRCase getCase​(org.touchbit.testrail4j.jackson2.model.TRCase caze)
      See getCase(Long)

    • getCases

      List<org.touchbit.testrail4j.jackson2.model.TRCase> getCases​(Long projectID, org.touchbit.testrail4j.core.query.GetCasesQueryMap queryMap)
      TestRailClient
      Parameters:
      projectID - is the ID of the project
      queryMap - is the following optional parameters and filters GetCasesFilter
      Returns:
      a list of TRCase for a test suite or specific section in a test suite. [ { "id": 1, "title": "..", .. }, { "id": 2, "title": "..", .. } ]
      See Also:
      API: Get cases For example get all test cases for project with ID 1, suite with ID 2 and priority 3 or 4 GET /index.php/api/v2/get_cases/1&suite_id=2&priority_id=3,4

    • getCases

      default List<org.touchbit.testrail4j.jackson2.model.TRCase> getCases​(Long projectID)
      See getCases(Long, GetCasesQueryMap)

    • getCases

      default List<org.touchbit.testrail4j.jackson2.model.TRCase> getCases​(org.touchbit.testrail4j.jackson2.model.TRProject project)
      See getCases(Long, GetCasesQueryMap)

    • getCases

      default List<org.touchbit.testrail4j.jackson2.model.TRCase> getCases​(org.touchbit.testrail4j.jackson2.model.TRProject project, org.touchbit.testrail4j.core.query.GetCasesQueryMap queryMap)
      See getCases(Long, GetCasesQueryMap)

    • addCase

      org.touchbit.testrail4j.jackson2.model.TRCase addCase​(org.touchbit.testrail4j.jackson2.model.TRCase aCase, Long sectionID)
      TestRailClient
      Parameters:
      sectionID - is the ID of the section the test case should be added to
      aCase - is the TRCase
      Returns:
      If successful, this method returns the new test case using the same response format as getCase(Long).
      See Also:
      API: Add case Creates a new test case.

    • addCase

      default org.touchbit.testrail4j.jackson2.model.TRCase addCase​(org.touchbit.testrail4j.jackson2.model.TRCase aCase, org.touchbit.testrail4j.jackson2.model.TRSection section)
      See addCase(TRCase, Long)

    • updateCase

      org.touchbit.testrail4j.jackson2.model.TRCase updateCase​(org.touchbit.testrail4j.jackson2.model.TRCase caze, Long caseID)
      TestRailClient
      Parameters:
      caseID - is the ID of the test case
      caze - is the TRCase
      Returns:
      If successful, this method returns the new test case using the same response format as getCase(Long).
      See Also:
      API: Update case Updates an existing test case (partial updates are supported, i.e. you can submit and update specific fields only). This method supports the same POST fields as TestRailClient#addCase(TRCase, Long) (except section_id).

    • updateCase

      default org.touchbit.testrail4j.jackson2.model.TRCase updateCase​(org.touchbit.testrail4j.jackson2.model.TRCase caze)
      See updateCase(TRCase, Long)

    • deleteCase

      void deleteCase​(Long caseID)
      TestRailClient
      Parameters:
      caseID - is the ID of the test case
      See Also:
      API: Delete case Deletes an existing test case.

    • deleteCase

      default void deleteCase​(org.touchbit.testrail4j.jackson2.model.TRCase caze)
      See deleteCase(Long)

    • getProject

      org.touchbit.testrail4j.jackson2.model.TRProject getProject​(Long projectID)
      TestRailClient
      Parameters:
      projectID - is the ID of the project
      Returns:
      an existing TRProject. { "announcement": "announcement", "completed_on": null, "id": 1, "suite_mode": 3, "is_completed": false, "name": "Datahub", "show_announcement": true, "url": "http://localhost/testrail/index.php?/projects/overview/1" }
      See Also:
      API: Get projects

    • getProject

      default org.touchbit.testrail4j.jackson2.model.TRProject getProject​(org.touchbit.testrail4j.jackson2.model.TRProject project)
      See getProject(Long)

    • getProjects

      List<org.touchbit.testrail4j.jackson2.model.TRProject> getProjects​(org.touchbit.testrail4j.core.query.GetProjectsQueryMap queryMap)
      TestRailClient
      Parameters:
      queryMap - is the request filter
      Returns:
      The response includes an array of projects. Each project in this list follows the same format as getProject(Long) [ { "id": 1, "name": "DataHub", .. }, { "id": 2, "name": "Writer", .. } ]
      See Also:
      API: Get project Returns the list of available projects.

    • getProjects

      default List<org.touchbit.testrail4j.jackson2.model.TRProject> getProjects()
      See getProjects(GetProjectsQueryMap)

    • addProject

      org.touchbit.testrail4j.jackson2.model.TRProject addProject​(org.touchbit.testrail4j.jackson2.model.TRProject project)
      TestRailClient
      Parameters:
      project - is the request body. The following POST fields are supported: name, announcement, show_announcement, suite_mode.
      Returns:
      If successful, this method returns the new TRProject using the same response format as getProject(Long). { "id": 1, "name": "DataHub", .. }
      See Also:
      API: Add project Creates a new project (admin status required).

    • updateProject

      org.touchbit.testrail4j.jackson2.model.TRProject updateProject​(org.touchbit.testrail4j.jackson2.model.TRProject project, Long projectID)
      TestRailClient
      Parameters:
      projectID - is the ID of the project
      project - is the request body.
      Returns:
      If successful, this method returns the new TRProject using the same response format as getProject(Long). { "id": 1, "name": "DataHub", .. }
      See Also:
      API: Update project Updates an existing project (admin status required; partial updates are supported, i.e. you can submit and update specific fields only).

    • updateProject

      default org.touchbit.testrail4j.jackson2.model.TRProject updateProject​(org.touchbit.testrail4j.jackson2.model.TRProject project)
      See updateProject(TRProject, Long)

    • deleteProject

      void deleteProject​(Long projectID)
      TestRailClient
      Parameters:
      projectID - is the ID of the project
      See Also:
      API: Delete project Deletes an existing project (admin status required).

    • deleteProject

      default void deleteProject​(org.touchbit.testrail4j.jackson2.model.TRProject project)
      See deleteProject(Long)

    • getRun

      org.touchbit.testrail4j.jackson2.model.TRRun getRun​(Long runID)
      TestRailClient
      Parameters:
      runID - is the ID of the test run
      Returns:
      an existing test TRRun { "assignedto_id": 6, "blocked_count": 0, "completed_on": null, "config": "Firefox, Ubuntu 12", "config_ids": [ 2, 6 ], "created_by": 1, "created_on": 1393845644, "custom_status1_count": 0, "custom_status2_count": 0, "custom_status3_count": 0, "custom_status4_count": 0, "custom_status5_count": 0, "custom_status6_count": 0, "custom_status7_count": 0, "description": null, "failed_count": 2, "id": 81, "include_all": false, "is_completed": false, "milestone_id": 7, "name": "File Formats", "passed_count": 2, "plan_id": 80, "project_id": 1, "retest_count": 1, "suite_id": 4, "untested_count": 3, "url": "http:///testrail/index.php?/runs/view/81" }
      See Also:
      API: Get run

    • getRun

      default org.touchbit.testrail4j.jackson2.model.TRRun getRun​(org.touchbit.testrail4j.jackson2.model.TRRun run)
      See getRun(Long)

    • getRuns

      List<org.touchbit.testrail4j.jackson2.model.TRRun> getRuns​(Long projectID, org.touchbit.testrail4j.core.query.GetRunsQueryMap queryMap)
      TestRailClient
      Parameters:
      projectID - is the ID of the project
      queryMap - is a request filter GetRunsQueryMap All active test runs for project with ID 1 created by user with ID 1 or 2 GET index.php?/api/v2/get_runs/1&is_completed=0&created_by=1,2
      Returns:
      Returns a list of test TRRuns for a project. Only returns those test runs that are not part of a test plan (please see get_plans/get_plan for this).
      See Also:
      API: Get Runs All active test runs for project with ID 1 created by user with ID 1 or 2 GET index.php?/api/v2/get_runs/1&is_completed=0&created_by=1,2

    • getRuns

      default List<org.touchbit.testrail4j.jackson2.model.TRRun> getRuns​(Long projectID)
      See getRuns(Long, GetRunsQueryMap)

    • getRuns

      default List<org.touchbit.testrail4j.jackson2.model.TRRun> getRuns​(org.touchbit.testrail4j.jackson2.model.TRProject project)
      See getRuns(Long, GetRunsQueryMap)

    • getRuns

      default List<org.touchbit.testrail4j.jackson2.model.TRRun> getRuns​(org.touchbit.testrail4j.jackson2.model.TRProject project, org.touchbit.testrail4j.core.query.GetRunsQueryMap queryMap)
      See getRuns(Long, GetRunsQueryMap)

    • addRun

      org.touchbit.testrail4j.jackson2.model.TRRun addRun​(org.touchbit.testrail4j.jackson2.model.TRRun run, Long projectID)
      TestRailClient
      Parameters:
      run - is the request body (TRRun)
      projectID - is the ID of the test run
      Returns:
      If successful, this method returns the new test TRRun using the same response format as getRun(Long).
      See Also:
      API: Add run Creates a new test run. Also see the following example which shows how to create a new test run including a custom test case selection: { "suite_id": 1, "name": "This is a new test run", "assignedto_id": 5, "include_all": false, "case_ids": [1, 2, 3, 4, 7, 8] }

    • addRun

      default org.touchbit.testrail4j.jackson2.model.TRRun addRun​(org.touchbit.testrail4j.jackson2.model.TRRun run, org.touchbit.testrail4j.jackson2.model.TRProject project)
      See addRun(TRRun, Long)

    • updateRun

      org.touchbit.testrail4j.jackson2.model.TRRun updateRun​(org.touchbit.testrail4j.jackson2.model.TRRun run, Long runID)
      TestRailClient
      Parameters:
      run - is the request body (TRRun)
      runID - is the ID of the test run
      Returns:
      If successful, this method returns the updated test TRRun using the same response format as getRun(Long)}.
      See Also:
      API: Update run Updates an existing test run (partial updates are supported, i.e. you can submit and update specific fields only). With the exception of the suite_id and assignedto_id fields, this method supports the same POST fields as TestRailClient#addRun(TRRun, Long). Request example Also see the following example which shows how to update the description and test case selection of a test run: { "description": "A description for the test run", "include_all": true } The following example updates a test run to use a manual test case selection: { "include_all": false, "case_ids": [1, 2, 3, 5, 8] }

    • updateRun

      default org.touchbit.testrail4j.jackson2.model.TRRun updateRun​(org.touchbit.testrail4j.jackson2.model.TRRun run)
      See updateRun(TRRun, Long)

    • closeRun

      org.touchbit.testrail4j.jackson2.model.TRRun closeRun​(Long runID)
      TestRailClient
      Parameters:
      runID - is the ID of the test run
      Returns:
      If successful, this method returns the updated test TRRun using the same response format as getRun(Long)}.
      See Also:
      API: Close run Closes an existing test run and archives its tests & results.

    • closeRun

      default org.touchbit.testrail4j.jackson2.model.TRRun closeRun​(org.touchbit.testrail4j.jackson2.model.TRRun run)
      See closeRun(Long)

    • deleteRun

      void deleteRun​(Long runID)
      TestRailClient
      Parameters:
      runID - is the ID of the test run
      See Also:
      API: Delete run Deletes an existing test run.

    • deleteRun

      default void deleteRun​(org.touchbit.testrail4j.jackson2.model.TRRun run)
      See deleteRun(Long)

    • getSuite

      org.touchbit.testrail4j.jackson2.model.TRSuite getSuite​(Long suiteID)
      TestRailClient
      Parameters:
      suiteID - is the ID of the test suite
      Returns:
      an existing test TRSuite. { "description": "description", "id": 1, "name": "Setup & Installation", "project_id": 1, "url": "http:///testrail/index.php?/suites/view/1" }
      See Also:
      API: Get suite

    • getSuite

      default org.touchbit.testrail4j.jackson2.model.TRSuite getSuite​(org.touchbit.testrail4j.jackson2.model.TRSuite suite)
      See getSuite(Long)

    • getSuites

      List<org.touchbit.testrail4j.jackson2.model.TRSuite> getSuites​(Long projectID)
      TestRailClient
      Parameters:
      projectID - is the ID of the project
      Returns:
      The response includes an array of test suite. Each test suite in this list follows the same format as getSuite(Long). [ { "id": 1, "name": "Setup & Installation", .. }, { "id": 2, "name": "Document Editing", .. } ]
      See Also:
      API: Get suites

    • getSuites

      default List<org.touchbit.testrail4j.jackson2.model.TRSuite> getSuites​(org.touchbit.testrail4j.jackson2.model.TRProject project)
      See getSuites(Long)

    • addSuite

      org.touchbit.testrail4j.jackson2.model.TRSuite addSuite​(org.touchbit.testrail4j.jackson2.model.TRSuite suite, Long projectID)
      TestRailClient
      Parameters:
      projectID - is the ID of the project
      Returns:
      If successful, this method returns the new test suite using the same response format as getSuite(Long).
      See Also:
      API: Add suite Creates a new test suite.

    • addSuite

      default org.touchbit.testrail4j.jackson2.model.TRSuite addSuite​(org.touchbit.testrail4j.jackson2.model.TRSuite suite, org.touchbit.testrail4j.jackson2.model.TRProject project)
      See addSuite(TRSuite, Long)

    • updateSuite

      org.touchbit.testrail4j.jackson2.model.TRSuite updateSuite​(org.touchbit.testrail4j.jackson2.model.TRSuite suite, Long suiteID)
      TestRailClient
      Parameters:
      suiteID - is the ID of the test suite
      Returns:
      If successful, this method returns the new test suite using the same response format as getSuite(Long).
      See Also:
      API: Update suite Updates an existing test suite (partial updates are supported, i.e. you can submit and update specific fields only).

    • updateSuite

      default org.touchbit.testrail4j.jackson2.model.TRSuite updateSuite​(org.touchbit.testrail4j.jackson2.model.TRSuite suite)
      See updateSuite(TRSuite, Long)

    • deleteSuite

      void deleteSuite​(Long suiteID)
      TestRailClient
      Parameters:
      suiteID - is the ID of the test suite
      See Also:
      API: Delete suite Deletes an existing test suite.

    • deleteSuite

      default void deleteSuite​(org.touchbit.testrail4j.jackson2.model.TRSuite suite)
      See deleteSuite(Long)

    • addSection

      org.touchbit.testrail4j.jackson2.model.TRSection addSection​(org.touchbit.testrail4j.jackson2.model.TRSection section, Long projectID)
      TestRailClient
      Parameters:
      projectID - is the ID of the project
      section - is the request body
      Returns:
      If successful, this method returns the new section using the same response format as getSection(Long).
      See Also:
      API: Add section

    • addSection

      default org.touchbit.testrail4j.jackson2.model.TRSection addSection​(org.touchbit.testrail4j.jackson2.model.TRSection section, org.touchbit.testrail4j.jackson2.model.TRProject project)
      See addSection(TRSection, Long)

    • getSection

      org.touchbit.testrail4j.jackson2.model.TRSection getSection​(Long sectionID)
      TestRailClient
      Parameters:
      sectionID - is the ID of the section
      Returns:
      for the following fields are included in the response see TRSection Please see below for a typical response { "depth": 0, "description": null, "display_order": 1, "id": 1, "name": "Prerequisites", "parent_id": null, "suite_id": 1 } The depth, display_order and parent fields determine the hierarchy of the sections in a test suite. The depth field is 0 for all sections on the root level and greater than 0 for all child sections. The depth field therefore resembles the level in the section hierarchy.
      See Also:
      API: Get section Returns an existing section.

    • getSection

      default org.touchbit.testrail4j.jackson2.model.TRSection getSection​(org.touchbit.testrail4j.jackson2.model.TRSection section)
      See getSection(Long)

    • getSections

      List<org.touchbit.testrail4j.jackson2.model.TRSection> getSections​(Long projectID, org.touchbit.testrail4j.core.query.GetSectionsQueryMap queryMap)
      TestRailClient
      Parameters:
      projectID - is the ID of the project
      queryMap - is the request filter GetSectionsQueryMap
      Returns:
      a list of sections for a project and test suite. [ { "depth": 0, "display_order": 1, "id": 1, "name": "Prerequisites", "parent_id": null, "suite_id": 1 }, .. ]
      See Also:
      API: Get sections

    • getSections

      default List<org.touchbit.testrail4j.jackson2.model.TRSection> getSections​(Long projectID)
      See getSections(Long, GetSectionsQueryMap)

    • getSections

      default List<org.touchbit.testrail4j.jackson2.model.TRSection> getSections​(org.touchbit.testrail4j.jackson2.model.TRProject project)
      See getSections(Long, GetSectionsQueryMap)

    • getSections

      default List<org.touchbit.testrail4j.jackson2.model.TRSection> getSections​(org.touchbit.testrail4j.jackson2.model.TRProject project, org.touchbit.testrail4j.core.query.GetSectionsQueryMap queryMap)
      See getSections(Long, GetSectionsQueryMap)

    • updateSection

      org.touchbit.testrail4j.jackson2.model.TRSection updateSection​(org.touchbit.testrail4j.jackson2.model.TRSection section, Long sectionID)
      TestRailClient
      Parameters:
      sectionID - is the ID of the section
      section - is the following POST fields are supported: description, name; See TRSection
      Returns:
      If successful, this method returns the updated section using the same response format as getSection(Long).
      See Also:
      API: Update section Updates an existing section (partial updates are supported, i.e. you can submit and update specific fields only).

    • updateSection

      default org.touchbit.testrail4j.jackson2.model.TRSection updateSection​(org.touchbit.testrail4j.jackson2.model.TRSection section)
      See updateSection(TRSection, Long)

    • deleteSection

      void deleteSection​(Long sectionID)
      TestRailClient
      Parameters:
      sectionID - is the ID of the section
      See Also:
      API: Delete section Deletes an existing section.

    • deleteSection

      default void deleteSection​(org.touchbit.testrail4j.jackson2.model.TRSection section)
      See deleteSection(Long)

    • getTest

      org.touchbit.testrail4j.jackson2.model.TRTest getTest​(Long testID)
      TestRailClient
      Parameters:
      testID - is the ID of the test
      Returns:
      an existing test.
      See Also:
      API: Get test If you interested in the test results rather than the tests, please see get_results instead. Please see below for a typical example response: { "assignedto_id": 1, "case_id": 1, "custom_expected": "..", "custom_preconds": "..", "custom_steps_separated": [ { "content": "Step 2", "expected": "Expected Result 2" } ], "estimate": "1m 5s", "estimate_forecast": null, "id": 100, "priority_id": 2, "run_id": 1, "status_id": 5, "title": "Verify line spacing on multi-page document", "type_id": 4 } Custom fields of test cases are also included in the response and use their system name prefixed with 'custom_' as their field identifier. Please see TestRailClient#addCase(TRCase, Long) for a full list of available custom field types.

    • getTest

      default org.touchbit.testrail4j.jackson2.model.TRTest getTest​(org.touchbit.testrail4j.jackson2.model.TRTest test)
      See getTest(Long)

    • getTests

      List<org.touchbit.testrail4j.jackson2.model.TRTest> getTests​(Long runID, org.touchbit.testrail4j.core.query.GetTestsQueryMap queryMap)
      TestRailClient
      Parameters:
      runID - is the ID of the test run
      queryMap - is the following filters All test cases for test run with ID 1 and status 4, 5 (Retest and Failed) GET index.php?/api/v2/get_tests/1&status_id=4,5
      Returns:
      a list of tests for a test run. The response includes an array of tests. Each test in this list follows the same format as getTest(Long). [ { "id": 1, "title": "Test conditional formatting with basic value range", } ]
      See Also:
      API: Get tests

    • getTests

      default List<org.touchbit.testrail4j.jackson2.model.TRTest> getTests​(Long runID)
      See getTests(Long, GetTestsQueryMap)

    • getTests

      default List<org.touchbit.testrail4j.jackson2.model.TRTest> getTests​(org.touchbit.testrail4j.jackson2.model.TRRun run)
      See getTests(Long, GetTestsQueryMap)

    • getTests

      default List<org.touchbit.testrail4j.jackson2.model.TRTest> getTests​(org.touchbit.testrail4j.jackson2.model.TRRun run, org.touchbit.testrail4j.core.query.GetTestsQueryMap queryMap)
      See getTests(Long, GetTestsQueryMap)

    • getCaseFields

      List<org.touchbit.testrail4j.jackson2.model.TRCaseField> getCaseFields()
      TestRailClient
      Returns:
      a list of available test case custom fields TRCaseField. The response includes an array of custom field definitions. Please see below for a typical response: [ { "configs": [ { "context": { "is_global": true, "project_ids": null }, "id": "..", "options": { "default_value": "", "format": "markdown", "is_required": false, "rows": "5" } } ], "description": "The preconditions of this test case. ..", "display_order": 1, "id": 1, "label": "Preconditions", "name": "preconds", "system_name": "custom_preconds", "type_id": 3 } ] The following list shows the available custom field types (type_id field): FieldTypes
      See Also:
      API: Get case fields

    • addCaseField

      void addCaseField​(org.touchbit.testrail4j.jackson2.model.TRCaseField caseField)
      TestRailClient
      Parameters:
      caseField - is the request body
      See Also:
      API: Add case field Creates a new test case custom field. The returned object is not available until the correction of the defect https://discuss.gurock.com/t/bug-api-different-types-of-returned-data-for-case-fields-configs/10598

    • getCaseTypes

      List<org.touchbit.testrail4j.jackson2.model.TRCaseType> getCaseTypes()
      TestRailClient
      Returns:
      a list of available case types. The response includes an array of test case types. Each case type has a unique ID and a name. The is_default field is true for the default case type and false otherwise.
      See Also:
      API: Get case types

    • getConfigs

      List<org.touchbit.testrail4j.jackson2.model.TRProjectConfigGroup> getConfigs​(Long projectID)
      TestRailClient
      Parameters:
      projectID - is the ID of the project
      Returns:
      a list of available configurations TRProjectConfigGroup, grouped by configuration groups (requires TestRail 3.1 or later).
      See Also:
      API: Get configs

    • getConfigs

      default List<org.touchbit.testrail4j.jackson2.model.TRProjectConfigGroup> getConfigs​(org.touchbit.testrail4j.jackson2.model.TRProject project)
      See getConfigs(Long)

    • addConfigGroup

      org.touchbit.testrail4j.jackson2.model.TRProjectConfigGroup addConfigGroup​(org.touchbit.testrail4j.jackson2.model.TRProjectConfigGroup cGroup, Long projectID)
      TestRailClient
      Parameters:
      projectID - is the ID of the project the configuration group should be added to
      cGroup - is the request body
      Returns:
      new TRProjectConfigGroup
      See Also:
      API: Add config group

    • addConfigGroup

      default org.touchbit.testrail4j.jackson2.model.TRProjectConfigGroup addConfigGroup​(org.touchbit.testrail4j.jackson2.model.TRProjectConfigGroup cGroup, org.touchbit.testrail4j.jackson2.model.TRProject project)
      See addConfigGroup(TRProjectConfigGroup, Long)

    • updateConfigGroup

      org.touchbit.testrail4j.jackson2.model.TRProjectConfigGroup updateConfigGroup​(org.touchbit.testrail4j.jackson2.model.TRProjectConfigGroup cGroup, Long configGroupID)
      TestRailClient
      Parameters:
      configGroupID - the ID of the configuration group
      cGroup - is the request body
      Returns:
      updated TRProjectConfigGroup
      See Also:
      API: Update config group Updates an existing configuration group (requires TestRail 5.2 or later).

    • updateConfigGroup

      default org.touchbit.testrail4j.jackson2.model.TRProjectConfigGroup updateConfigGroup​(org.touchbit.testrail4j.jackson2.model.TRProjectConfigGroup cGroup)
      See updateConfigGroup(TRProjectConfigGroup, Long)

    • deleteConfigGroup

      void deleteConfigGroup​(Long configGroupID)
      TestRailClient
      Parameters:
      configGroupID - the ID of the configuration group
      See Also:
      API: Delete config group Deletes an existing configuration group and its configurations (requires TestRail 5.2 or later). Please note: Deleting a configuration group cannot be undone and also permanently deletes all configurations in this group. It does not, however, affect closed test plans/runs, or active test plans/runs unless they are updated.

    • deleteConfigGroup

      default void deleteConfigGroup​(org.touchbit.testrail4j.jackson2.model.TRProjectConfigGroup cGroup)
      See deleteConfigGroup(Long)

    • addConfig

      org.touchbit.testrail4j.jackson2.model.TRProjectConfig addConfig​(org.touchbit.testrail4j.jackson2.model.TRProjectConfig config, Long configGroupID)
      TestRailClient
      Parameters:
      configGroupID - The ID of the configuration group the configuration should be added to
      config - the TRProjectConfig request body
      Returns:
      a new configuration TRProjectConfig
      See Also:
      API: Add config Creates a new configuration (requires TestRail 5.2 or later).

    • addConfig

      default org.touchbit.testrail4j.jackson2.model.TRProjectConfig addConfig​(org.touchbit.testrail4j.jackson2.model.TRProjectConfig config, org.touchbit.testrail4j.jackson2.model.TRProjectConfigGroup cGroup)
      See addConfig(TRProjectConfig, Long)

    • updateConfig

      org.touchbit.testrail4j.jackson2.model.TRProjectConfig updateConfig​(org.touchbit.testrail4j.jackson2.model.TRProjectConfig config, Long configID)
      TestRailClient
      Parameters:
      configID - the ID of the configuration
      config - the TRProjectConfig request body
      Returns:
      updated configuration TRProjectConfig
      See Also:
      API: Update config Updates an existing configuration (requires TestRail 5.2 or later).

    • updateConfig

      default org.touchbit.testrail4j.jackson2.model.TRProjectConfig updateConfig​(org.touchbit.testrail4j.jackson2.model.TRProjectConfig config)
      See updateConfig(TRProjectConfig, Long)

    • deleteConfig

      void deleteConfig​(Long configID)
      TestRailClient
      Parameters:
      configID - the ID of the configuration
      See Also:
      API: Delete config Deletes an existing configuration (requires TestRail 5.2 or later). Please note: Deleting a configuration cannot be undone. It does not, however, affect closed test plans/runs, or active test plans/runs unless they are updated.

    • deleteConfig

      default void deleteConfig​(org.touchbit.testrail4j.jackson2.model.TRProjectConfig config)
      See deleteConfig(Long)

    • getMilestone

      org.touchbit.testrail4j.jackson2.model.TRMilestone getMilestone​(Long milestoneID)
      TestRailClient
      Parameters:
      milestoneID - is the ID of the milestone
      Returns:
      an existing milestone TRMilestone
      See Also:
      API: Get milestone

    • getMilestone

      default org.touchbit.testrail4j.jackson2.model.TRMilestone getMilestone​(org.touchbit.testrail4j.jackson2.model.TRMilestone milestone)
      See getMilestone(Long)

    • getMilestones

      List<org.touchbit.testrail4j.jackson2.model.TRMilestone> getMilestones​(Long projectID, org.touchbit.testrail4j.core.query.GetMilestonesQueryMap queryMap)
      TestRailClient
      Parameters:
      projectID - is the ID of the project
      Returns:
      the list of TRMilestone for a project.
      See Also:
      API: Get milestones

    • getMilestones

      default List<org.touchbit.testrail4j.jackson2.model.TRMilestone> getMilestones​(Long projectID)
      See getMilestones(Long, GetMilestonesQueryMap)

    • getMilestones

      default List<org.touchbit.testrail4j.jackson2.model.TRMilestone> getMilestones​(org.touchbit.testrail4j.jackson2.model.TRProject project)
      See getMilestones(Long, GetMilestonesQueryMap)

    • getMilestones

      default List<org.touchbit.testrail4j.jackson2.model.TRMilestone> getMilestones​(org.touchbit.testrail4j.jackson2.model.TRProject project, org.touchbit.testrail4j.core.query.GetMilestonesQueryMap queryMap)
      See getMilestones(Long, GetMilestonesQueryMap)

    • addMilestone

      org.touchbit.testrail4j.jackson2.model.TRMilestone addMilestone​(org.touchbit.testrail4j.jackson2.model.TRMilestone milestone, Long projectID)
      TestRailClient
      Parameters:
      projectID - is the ID of the project the milestone should be added to
      milestone - is the request body TRMilestone
      Returns:
      a new TRMilestone
      See Also:
      API: Add milestone Creates a new milestone.

    • addMilestone

      default org.touchbit.testrail4j.jackson2.model.TRMilestone addMilestone​(org.touchbit.testrail4j.jackson2.model.TRMilestone milestone, org.touchbit.testrail4j.jackson2.model.TRProject project)
      See addMilestone(TRMilestone, Long)

    • updateMilestone

      org.touchbit.testrail4j.jackson2.model.TRMilestone updateMilestone​(org.touchbit.testrail4j.jackson2.model.TRMilestone milestone, Long milestoneID)
      TestRailClient
      Parameters:
      milestoneID - is the ID of the milestone
      milestone - is the request body TRMilestone Request fields is_completed - True if a milestone is considered completed and false otherwise is_started - True if a milestone is considered started and false otherwise parent_id - The ID of the parent milestone, if any (for sub-milestones) (available since TestRail 5.3) start_on - The scheduled start date of the milestone (as UNIX timestamp) (available since TestRail 5.3)
      Returns:
      updated TRMilestone
      See Also:
      API: Update milestone Updates an existing milestone (partial updates are supported, i.e. you can submit and update specific fields only).

    • updateMilestone

      default org.touchbit.testrail4j.jackson2.model.TRMilestone updateMilestone​(org.touchbit.testrail4j.jackson2.model.TRMilestone milestone)
      See updateMilestone(TRMilestone, Long)

    • deleteMilestone

      void deleteMilestone​(Long milestoneID)
      TestRailClient
      See Also:
      API: Delete milestone Deletes an existing milestone.

    • deleteMilestone

      default void deleteMilestone​(org.touchbit.testrail4j.jackson2.model.TRMilestone milestone)
      See deleteMilestone(Long)

    • getPriorities

      List<org.touchbit.testrail4j.jackson2.model.TRPriority> getPriorities()
      TestRailClient
      Returns:
      a list of available TRPriority. The response include an array of priorities. Each priority has a unique ID, a name and a short version of the name. The priority field determines the order of the priorities. The is_default field is true for the default priority and false otherwise. [ { "id": 1, "is_default": false, "name": "1 - Don't Test", "priority": 1, "short_name": "1 - Don't" } ]
      See Also:
      API: Get priorities

    • getUser

      org.touchbit.testrail4j.jackson2.model.TRUser getUser​(Long userID)
      TestRailClient
      Parameters:
      userID - is the ID of the user
      Returns:
      an existing TRUser.
      See Also:
      API: Get user

    • getUser

      default org.touchbit.testrail4j.jackson2.model.TRUser getUser​(org.touchbit.testrail4j.jackson2.model.TRUser user)
      See getUser(Long)

    • getUserByEmail

      org.touchbit.testrail4j.jackson2.model.TRUser getUserByEmail​(String email)
      TestRailClient
      Parameters:
      email - is the email address to get the user for
      Returns:
      an existing TRUser by his/her email address.
      See Also:
      API: Get user by email

    • getUserByEmail

      default org.touchbit.testrail4j.jackson2.model.TRUser getUserByEmail​(org.touchbit.testrail4j.jackson2.model.TRUser user)
      See getUserByEmail(String)

    • getUsers

      List<org.touchbit.testrail4j.jackson2.model.TRUser> getUsers()
      TestRailClient
      Returns:
      a list of TRUsers.
      See Also:
      API: Get users

    • getTemplates

      List<org.touchbit.testrail4j.jackson2.model.TRTemplate> getTemplates​(Long projectID)
      TestRailClient
      Parameters:
      projectID - is the ID of the project
      Returns:
      a list of available TRTemplates (requires TestRail 5.2 or later).
      See Also:
      API: Get templates Returns a list of available templates (requires TestRail 5.2 or later). The response includes an array of templates (field layouts). Each template has a unique ID and a name. The is_default field is true for the default template and false otherwise.

    • getTemplates

      default List<org.touchbit.testrail4j.jackson2.model.TRTemplate> getTemplates​(org.touchbit.testrail4j.jackson2.model.TRProject project)
      See getTemplates(Long)

    • getStatuses

      List<org.touchbit.testrail4j.jackson2.model.TRStatus> getStatuses()
      TestRailClient
      Returns:
      a list of available test TRStatuses. The returned response includes all system and custom statuses
      See Also:
      API: Get statuses

    • getResultFields

      List<org.touchbit.testrail4j.jackson2.model.TRResultField> getResultFields()
      TestRailClient
      Returns:
      a list of available test result custom fields TRResultField. The response includes an array of custom field definitions. A custom field can have different configurations and options per project which is indicated by the configs field. To check if a custom field is applicable to a specific project (and to find out the field options for this project), the context of the field configuration must either be global (is_global) or include the ID of the project in project_ids.
      See Also:
      API: Get result fields

    • getPlan

      org.touchbit.testrail4j.jackson2.model.TRPlan getPlan​(Long planID)
      TestRailClient
      Parameters:
      planID - is the ID of the test plan
      Returns:
      an existing test plan TRPlan. The entries field includes an array of test plan entries. A test plan entry is a group of test runs that belong to the same test suite (just like in the user interface). Each group can have a variable amount of test runs and also supports configurations.
      See Also:
      API: Get plan

    • getPlan

      default org.touchbit.testrail4j.jackson2.model.TRPlan getPlan​(org.touchbit.testrail4j.jackson2.model.TRPlan plan)
      See getPlan(Long)

    • getPlans

      List<org.touchbit.testrail4j.jackson2.model.TRPlan> getPlans​(Long projectID, org.touchbit.testrail4j.core.query.GetPlansQueryMap queryMap)
      TestRailClient
      Parameters:
      projectID - is the ID of the project
      queryMap - is the request filter
      Returns:
      a list of test TRPlan for a project.
      See Also:
      API: Get plans

    • getPlans

      default List<org.touchbit.testrail4j.jackson2.model.TRPlan> getPlans​(Long projectID)
      See getPlans(Long, GetPlansQueryMap)

    • getPlans

      default List<org.touchbit.testrail4j.jackson2.model.TRPlan> getPlans​(org.touchbit.testrail4j.jackson2.model.TRProject project)
      See getPlans(Long, GetPlansQueryMap)

    • getPlans

      default List<org.touchbit.testrail4j.jackson2.model.TRPlan> getPlans​(org.touchbit.testrail4j.jackson2.model.TRProject project, org.touchbit.testrail4j.core.query.GetPlansQueryMap queryMap)
      See getPlans(Long, GetPlansQueryMap)

    • addPlan

      org.touchbit.testrail4j.jackson2.model.TRPlan addPlan​(org.touchbit.testrail4j.jackson2.model.TRPlan plan, Long projectID)
      TestRailClient
      Parameters:
      projectID - is the ID of the project the test plan should be added to
      plan - is the request body
      Returns:
      a new test TRPlan.
      See Also:
      API: Add plan Creates a new test plan. Request fields The following POST fields are supported: name - The name of the test plan (required) description - The description of the test plan milestone_id - The ID of the milestone to link to the test plan entries - An array of objects describing the test runs of the plan, see the example below and add_plan_entry

    • addPlan

      default org.touchbit.testrail4j.jackson2.model.TRPlan addPlan​(org.touchbit.testrail4j.jackson2.model.TRPlan plan, org.touchbit.testrail4j.jackson2.model.TRProject project)
      See addPlan(TRPlan, Long)

    • updatePlan

      org.touchbit.testrail4j.jackson2.model.TRPlan updatePlan​(org.touchbit.testrail4j.jackson2.model.TRPlan plan, Long planID)
      TestRailClient
      Parameters:
      planID - is the ID of the plan
      Returns:
      the updated test TRPlan.
      See Also:
      API: Update plan Updates an existing test plan (partial updates are supported, i.e. you can submit and update specific fields only).

    • updatePlan

      default org.touchbit.testrail4j.jackson2.model.TRPlan updatePlan​(org.touchbit.testrail4j.jackson2.model.TRPlan plan)
      See updatePlan(TRPlan, Long)

    • closePlan

      org.touchbit.testrail4j.jackson2.model.TRPlan closePlan​(Long planID)
      TestRailClient
      Parameters:
      planID - is the ID of the plan
      Returns:
      the closed test TRPlan.
      See Also:
      API: Close plan Closes an existing test plan and archives its test runs & results.

    • closePlan

      default org.touchbit.testrail4j.jackson2.model.TRPlan closePlan​(org.touchbit.testrail4j.jackson2.model.TRPlan plan)
      See closePlan(Long)

    • deletePlan

      void deletePlan​(Long planID)
      TestRailClient
      Parameters:
      planID - is the ID of the plan
      See Also:
      API: Delete plan Deletes an existing test plan.

    • deletePlan

      default void deletePlan​(org.touchbit.testrail4j.jackson2.model.TRPlan plan)
      See deletePlan(Long)

    • addPlanEntry

      org.touchbit.testrail4j.jackson2.model.TRPlanEntry addPlanEntry​(org.touchbit.testrail4j.jackson2.model.TRPlanEntry entry, Long planID)
      TestRailClient
      Parameters:
      planID - is the ID of the plan the test runs should be added to
      entry - is the request body. The following POST fields are supported: suite_id, name, description, assignedto_id, include_all, case_ids, config_ids, runs
      Returns:
      the new test plan entry including test runs
      See Also:
      API: Add plan entry Adds one or more new test TRRuns to a test TRPlan.

    • addPlanEntry

      default org.touchbit.testrail4j.jackson2.model.TRPlanEntry addPlanEntry​(org.touchbit.testrail4j.jackson2.model.TRPlanEntry entry, org.touchbit.testrail4j.jackson2.model.TRPlan plan)
      See addPlanEntry(TRPlanEntry, Long)

    • updatePlanEntry

      org.touchbit.testrail4j.jackson2.model.TRPlanEntry updatePlanEntry​(org.touchbit.testrail4j.jackson2.model.TRPlanEntry entry, Long planID, String entryID)
      TestRailClient
      Parameters:
      planID - is the ID of the test plan
      entryID - is the ID of the test plan entry (note: not the test run ID)
      entry - is the request body. The following POST fields are supported: name, description, assignedto_id, include_all, case_ids
      Returns:
      the updated test @TRPlanEntry including test runs
      See Also:
      API: Update plan entry

    • updatePlanEntry

      default org.touchbit.testrail4j.jackson2.model.TRPlanEntry updatePlanEntry​(org.touchbit.testrail4j.jackson2.model.TRPlanEntry entry, org.touchbit.testrail4j.jackson2.model.TRPlan plan)
      See updatePlanEntry(TRPlanEntry, Long, String)

    • deletePlanEntry

      void deletePlanEntry​(Long planID, String entryID)
      TestRailClient
      Parameters:
      planID - is the ID of the test plan
      entryID - is the ID of the test plan entry (note: not the test run ID)
      See Also:
      API: Delete plan entry Deletes one or more existing test runs from a plan.

    • deletePlanEntry

      default void deletePlanEntry​(org.touchbit.testrail4j.jackson2.model.TRPlan plan, org.touchbit.testrail4j.jackson2.model.TRPlanEntry entry)
      See deletePlanEntry(Long, String)