testit-api-client

v7.2.0

Published

4 days ago

Api client for Test IT TMS

0High
0Medium
0Low

testit

Api client for Test IT TMS

Getting Started

Compatibility

| Test IT | API Client | |---------|-----------------| | 3.4 | 1.0 | | 3.5 | 2.0 | | 4.0 | 3.0 | | 4.2 | 3.1 | | 4.3 | 3.2 | | 4.4 | 3.3 | | 4.5 | 4.1 | | 4.6 | 4.2 | | 5.0 | 5.0 | | 5.2 | 5.1 | | 5.2.2 | 5.2.1-TMS-5.2.2 | | 5.3 | 6.0.1-TMS-5.3 | | 5.4 | 6.2.0-TMS-5.4 | | 5.4.1 | 6.2.2-TMS-5.4.1 | | 5.5 | 6.4.0-TMS-5.5 | | 5.6 | 7.1.0-TMS-5.6 | | Cloud | 7.2.0 + |

For current versions, see the releases tab.
Starting with 5.2, we have added a TMS postscript, which means that the utility is compatible with a specific enterprise version.
If you are in doubt about which version to use, check with the support staff. [email protected]

For new versions

On the new version generation please run npm run fix for models fixing

Installation

npm install testit-api-client

How to run

var TestitApiClient = require('testit-api-client');

var defaultClient = TestitApiClient.ApiClient.instance;
defaultClient.basePath = 'https://team-xxx.testit.software';
var auth = defaultClient.authentications['Bearer or PrivateToken'];
auth.apiKeyPrefix = "PrivateToken"
auth.apiKey = "xxxxxx"

async function get() {
    var api = new TestitApiClient.ProjectsApi()
    try {
        var res = await api.getAllProjects()
        console.log(res)
    }
    catch (e) {
        console.log(e)
    }
}

get()

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- TestitApiClient.AttachmentsApi | apiV2AttachmentsIdDelete | DELETE /api/v2/attachments/{id} | Delete attachment file TestitApiClient.AttachmentsApi | apiV2AttachmentsIdGet | GET /api/v2/attachments/{id} | Download attachment file TestitApiClient.AttachmentsApi | apiV2AttachmentsIdMetadataGet | GET /api/v2/attachments/{id}/metadata | Get attachment metadata TestitApiClient.AttachmentsApi | apiV2AttachmentsOccupiedFileStorageSizeGet | GET /api/v2/attachments/occupiedFileStorageSize | Get size of attachments storage in bytes TestitApiClient.AttachmentsApi | apiV2AttachmentsPost | POST /api/v2/attachments | Upload new attachment file TestitApiClient.AutoTestsApi | apiV2AutoTestsDelete | DELETE /api/v2/autoTests | Delete autotests TestitApiClient.AutoTestsApi | apiV2AutoTestsFlakyBulkPost | POST /api/v2/autoTests/flaky/bulk | Set "Flaky" status for multiple autotests TestitApiClient.AutoTestsApi | apiV2AutoTestsIdPatch | PATCH /api/v2/autoTests/{id} | Patch auto test TestitApiClient.AutoTestsApi | apiV2AutoTestsIdTestResultsSearchPost | POST /api/v2/autoTests/{id}/testResults/search | Get test results history for autotest TestitApiClient.AutoTestsApi | apiV2AutoTestsIdWorkItemsChangedIdGet | GET /api/v2/autoTests/{id}/workItems/changed/id | Get identifiers of changed linked work items TestitApiClient.AutoTestsApi | apiV2AutoTestsIdWorkItemsChangedWorkItemIdApprovePost | POST /api/v2/autoTests/{id}/workItems/changed/{workItemId}/approve | Approve changes to work items linked to autotest TestitApiClient.AutoTestsApi | apiV2AutoTestsSearchPost | POST /api/v2/autoTests/search | Search for autotests TestitApiClient.AutoTestsApi | createAutoTest | POST /api/v2/autoTests | Create autotest TestitApiClient.AutoTestsApi | createMultiple | POST /api/v2/autoTests/bulk | Create multiple autotests TestitApiClient.AutoTestsApi | deleteAutoTest | DELETE /api/v2/autoTests/{id} | Delete autotest TestitApiClient.AutoTestsApi | deleteAutoTestLinkFromWorkItem | DELETE /api/v2/autoTests/{id}/workItems | Unlink autotest from work item TestitApiClient.AutoTestsApi | getAllAutoTests | GET /api/v2/autoTests | TestitApiClient.AutoTestsApi | getAutoTestAverageDuration | GET /api/v2/autoTests/{id}/averageDuration | Get average autotest duration TestitApiClient.AutoTestsApi | getAutoTestById | GET /api/v2/autoTests/{id} | Get autotest by internal or global ID TestitApiClient.AutoTestsApi | getAutoTestChronology | GET /api/v2/autoTests/{id}/chronology | Get autotest chronology TestitApiClient.AutoTestsApi | getTestRuns | GET /api/v2/autoTests/{id}/testRuns | Get completed tests runs for autotests TestitApiClient.AutoTestsApi | getWorkItemsLinkedToAutoTest | GET /api/v2/autoTests/{id}/workItems | Get work items linked to autotest TestitApiClient.AutoTestsApi | linkAutoTestToWorkItem | POST /api/v2/autoTests/{id}/workItems | Link autotest with work items TestitApiClient.AutoTestsApi | updateAutoTest | PUT /api/v2/autoTests | Update autotest TestitApiClient.AutoTestsApi | updateMultiple | PUT /api/v2/autoTests/bulk | Update multiple autotests TestitApiClient.BackgroundJobsApi | apiV2BackgroundJobsCompletedDelete | DELETE /api/v2/backgroundJobs/completed | Delete all completed background jobs TestitApiClient.BackgroundJobsApi | apiV2BackgroundJobsGet | GET /api/v2/backgroundJobs | TestitApiClient.BackgroundJobsApi | apiV2BackgroundJobsIdCancelPost | POST /api/v2/backgroundJobs/{id}/cancel | Cancel current user background job TestitApiClient.BackgroundJobsApi | apiV2BackgroundJobsIdGet | GET /api/v2/backgroundJobs/{id} | Get background job by ID TestitApiClient.BackgroundJobsApi | apiV2BackgroundJobsIdStatusGet | GET /api/v2/backgroundJobs/{id}/status | Get background job status by job ID TestitApiClient.BackgroundJobsApi | apiV2BackgroundJobsSearchPost | POST /api/v2/backgroundJobs/search | Search for user background jobs TestitApiClient.ConfigurationsApi | apiV2ConfigurationsCreateByParametersPost | POST /api/v2/configurations/createByParameters | Create configurations by parameters TestitApiClient.ConfigurationsApi | apiV2ConfigurationsDeleteBulkPost | POST /api/v2/configurations/delete/bulk | Delete multiple configurations TestitApiClient.ConfigurationsApi | apiV2ConfigurationsIdDelete | DELETE /api/v2/configurations/{id} | Delete configuration TestitApiClient.ConfigurationsApi | apiV2ConfigurationsIdPatch | PATCH /api/v2/configurations/{id} | Patch configuration TestitApiClient.ConfigurationsApi | apiV2ConfigurationsIdPurgePost | POST /api/v2/configurations/{id}/purge | Permanently delete configuration from archive TestitApiClient.ConfigurationsApi | apiV2ConfigurationsIdRestorePost | POST /api/v2/configurations/{id}/restore | Restore configuration from the archive TestitApiClient.ConfigurationsApi | apiV2ConfigurationsPurgeBulkPost | POST /api/v2/configurations/purge/bulk | Permanently delete multiple archived configurations TestitApiClient.ConfigurationsApi | apiV2ConfigurationsPut | PUT /api/v2/configurations | Edit configuration TestitApiClient.ConfigurationsApi | apiV2ConfigurationsRestoreBulkPost | POST /api/v2/configurations/restore/bulk | Restore multiple configurations from the archive TestitApiClient.ConfigurationsApi | apiV2ConfigurationsSearchPost | POST /api/v2/configurations/search | Search for configurations TestitApiClient.ConfigurationsApi | createConfiguration | POST /api/v2/configurations | Create Configuration TestitApiClient.ConfigurationsApi | getConfigurationById | GET /api/v2/configurations/{id} | Get configuration by internal or global ID TestitApiClient.CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesExistsGet | GET /api/v2/customAttributes/templates/exists | TestitApiClient.CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesIdCustomAttributesExcludePost | POST /api/v2/customAttributes/templates/{id}/customAttributes/exclude | Exclude CustomAttributes from CustomAttributeTemplate TestitApiClient.CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesIdCustomAttributesIncludePost | POST /api/v2/customAttributes/templates/{id}/customAttributes/include | Include CustomAttributes to CustomAttributeTemplate TestitApiClient.CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesIdDelete | DELETE /api/v2/customAttributes/templates/{id} | Delete CustomAttributeTemplate TestitApiClient.CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesIdGet | GET /api/v2/customAttributes/templates/{id} | Get CustomAttributeTemplate by ID TestitApiClient.CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesNameGet | GET /api/v2/customAttributes/templates/{name} | Get CustomAttributeTemplate by name TestitApiClient.CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesPost | POST /api/v2/customAttributes/templates | Create CustomAttributeTemplate TestitApiClient.CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesPut | PUT /api/v2/customAttributes/templates | Update custom attributes template TestitApiClient.CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesSearchPost | POST /api/v2/customAttributes/templates/search | Search CustomAttributeTemplates TestitApiClient.CustomAttributesApi | apiV2CustomAttributesExistsGet | GET /api/v2/customAttributes/exists | TestitApiClient.CustomAttributesApi | apiV2CustomAttributesGlobalIdDelete | DELETE /api/v2/customAttributes/global/{id} | Delete global attribute TestitApiClient.CustomAttributesApi | apiV2CustomAttributesGlobalIdPut | PUT /api/v2/customAttributes/global/{id} | Edit global attribute TestitApiClient.CustomAttributesApi | apiV2CustomAttributesGlobalPost | POST /api/v2/customAttributes/global | Create global attribute TestitApiClient.CustomAttributesApi | apiV2CustomAttributesIdGet | GET /api/v2/customAttributes/{id} | Get attribute TestitApiClient.CustomAttributesApi | apiV2CustomAttributesSearchPost | POST /api/v2/customAttributes/search | Search for attributes TestitApiClient.ExternalIssuesApi | apiV2ExternalIssuesSuggestionsPost | POST /api/v2/external-issues/suggestions | Returns list of suggestions from available external issues TestitApiClient.NotificationsApi | apiV2NotificationsCountGet | GET /api/v2/notifications/count | Get unread Notifications total in last 7 days TestitApiClient.NotificationsApi | apiV2NotificationsGet | GET /api/v2/notifications | Get all Notifications for current User TestitApiClient.NotificationsApi | apiV2NotificationsIdReadPost | POST /api/v2/notifications/{id}/read | Set Notification as read TestitApiClient.NotificationsApi | apiV2NotificationsReadPost | POST /api/v2/notifications/read | Set all Notifications as read TestitApiClient.NotificationsApi | apiV2NotificationsSearchPost | POST /api/v2/notifications/search | Search Notifications for current User TestitApiClient.ParametersApi | apiV2ParametersBulkPost | POST /api/v2/parameters/bulk | Create multiple parameters TestitApiClient.ParametersApi | apiV2ParametersBulkPut | PUT /api/v2/parameters/bulk | Update multiple parameters TestitApiClient.ParametersApi | apiV2ParametersGroupsGet | GET /api/v2/parameters/groups | Get parameters as group TestitApiClient.ParametersApi | apiV2ParametersKeyNameNameExistsGet | GET /api/v2/parameters/key/name/{name}/exists | Check existence parameter key in system TestitApiClient.ParametersApi | apiV2ParametersKeyValuesGet | GET /api/v2/parameters/{key}/values | Get all parameter key values TestitApiClient.ParametersApi | apiV2ParametersKeysGet | GET /api/v2/parameters/keys | Get all parameter keys TestitApiClient.ParametersApi | apiV2ParametersSearchGroupsPost | POST /api/v2/parameters/search/groups | Search for parameters as group TestitApiClient.ParametersApi | apiV2ParametersSearchPost | POST /api/v2/parameters/search | Search for parameters TestitApiClient.ParametersApi | createParameter | POST /api/v2/parameters | Create parameter TestitApiClient.ParametersApi | deleteByName | DELETE /api/v2/parameters/name/{name} | Delete parameter by name TestitApiClient.ParametersApi | deleteByParameterKeyId | DELETE /api/v2/parameters/keyId/{keyId} | Delete parameters by parameter key identifier TestitApiClient.ParametersApi | deleteParameter | DELETE /api/v2/parameters/{id} | Delete parameter TestitApiClient.ParametersApi | getAllParameters | GET /api/v2/parameters | Get all parameters TestitApiClient.ParametersApi | getParameterById | GET /api/v2/parameters/{id} | Get parameter by ID TestitApiClient.ParametersApi | updateParameter | PUT /api/v2/parameters | Update parameter TestitApiClient.ProjectAttributeTemplatesApi | apiV2ProjectsProjectIdAttributesTemplatesSearchPost | POST /api/v2/projects/{projectId}/attributes/templates/search | Search for custom attributes templates TestitApiClient.ProjectAttributeTemplatesApi | apiV2ProjectsProjectIdAttributesTemplatesTemplateIdDelete | DELETE /api/v2/projects/{projectId}/attributes/templates/{templateId} | Delete CustomAttributeTemplate from Project TestitApiClient.ProjectAttributeTemplatesApi | apiV2ProjectsProjectIdAttributesTemplatesTemplateIdPost | POST /api/v2/projects/{projectId}/attributes/templates/{templateId} | Add CustomAttributeTemplate to Project TestitApiClient.ProjectAttributesApi | createProjectsAttribute | POST /api/v2/projects/{projectId}/attributes | Create project attribute TestitApiClient.ProjectAttributesApi | deleteProjectsAttribute | DELETE /api/v2/projects/{projectId}/attributes/{attributeId} | Delete project attribute TestitApiClient.ProjectAttributesApi | getAttributeByProjectId | GET /api/v2/projects/{projectId}/attributes/{attributeId} | Get project attribute TestitApiClient.ProjectAttributesApi | getAttributesByProjectId | GET /api/v2/projects/{projectId}/attributes | Get project attributes TestitApiClient.ProjectAttributesApi | searchAttributesInProject | POST /api/v2/projects/{projectId}/attributes/search | Search for attributes used in the project TestitApiClient.ProjectAttributesApi | updateProjectsAttribute | PUT /api/v2/projects/{projectId}/attributes | Edit attribute of the project TestitApiClient.ProjectConfigurationsApi | getConfigurationsByProjectId | GET /api/v2/projects/{projectId}/configurations | Get project configurations TestitApiClient.ProjectSectionsApi | getSectionsByProjectId | GET /api/v2/projects/{projectId}/sections | Get project sections TestitApiClient.ProjectSettingsApi | apiV2ProjectsProjectIdSettingsAutotestsPost | POST /api/v2/projects/{projectId}/settings/autotests | Set autotest project settings. TestitApiClient.ProjectSettingsApi | getAutotestProjectSettings | GET /api/v2/projects/{projectId}/settings/autotests | Get autotest project settings. TestitApiClient.ProjectTestPlanAttributesApi | createCustomAttributeTestPlanProjectRelations | POST /api/v2/projects/{projectId}/testPlans/attributes | Add attributes to project's test plans TestitApiClient.ProjectTestPlanAttributesApi | deleteCustomAttributeTestPlanProjectRelations | DELETE /api/v2/projects/{projectId}/testPlans/attributes/{attributeId} | Delete attribute from project's test plans TestitApiClient.ProjectTestPlanAttributesApi | getCustomAttributeTestPlanProjectRelations | GET /api/v2/projects/{projectId}/testPlans/attributes | Get project's test plan attributes TestitApiClient.ProjectTestPlanAttributesApi | searchTestPlanAttributesInProject | POST /api/v2/projects/{projectId}/testPlans/attributes/search | Search for attributes used in the project test plans TestitApiClient.ProjectTestPlanAttributesApi | updateCustomAttributeTestPlanProjectRelations | PUT /api/v2/projects/{projectId}/testPlans/attributes | Update attribute of project's test plans TestitApiClient.ProjectTestPlanTestPointsApi | apiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAutotestsRerunPost | POST /api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/autotests/rerun | Rerun autotests. TestitApiClient.ProjectTestPlanTestPointsApi | apiV2ProjectsProjectIdTestPlansTestPlanIdTestPointsAutotestsRunPost | POST /api/v2/projects/{projectId}/test-plans/{testPlanId}/test-points/autotests/run | Run autotests. TestitApiClient.ProjectTestPlansApi | apiV2ProjectsProjectIdTestPlansAnalyticsGet | GET /api/v2/projects/{projectId}/testPlans/analytics | Get TestPlans analytics TestitApiClient.ProjectTestPlansApi | apiV2ProjectsProjectIdTestPlansDeleteBulkPost | POST /api/v2/projects/{projectId}/testPlans/delete/bulk | Delete multiple test plans TestitApiClient.ProjectTestPlansApi | apiV2ProjectsProjectIdTestPlansNameExistsGet | GET /api/v2/projects/{projectId}/testPlans/{name}/exists | Checks if TestPlan exists with the specified name exists for the project TestitApiClient.ProjectTestPlansApi | apiV2ProjectsProjectIdTestPlansPurgeBulkPost | POST /api/v2/projects/{projectId}/testPlans/purge/bulk | Permanently delete multiple archived test plans TestitApiClient.ProjectTestPlansApi | apiV2ProjectsProjectIdTestPlansRestoreBulkPost | POST /api/v2/projects/{projectId}/testPlans/restore/bulk | Restore multiple test plans TestitApiClient.ProjectTestPlansApi | apiV2ProjectsProjectIdTestPlansSearchPost | POST /api/v2/projects/{projectId}/testPlans/search | Get Project TestPlans with analytics TestitApiClient.ProjectWorkItemsApi | apiV2ProjectsProjectIdWorkItemsSearchGroupedPost | POST /api/v2/projects/{projectId}/workItems/search/grouped | Search for work items and group results by attribute TestitApiClient.ProjectWorkItemsApi | apiV2ProjectsProjectIdWorkItemsSearchIdPost | POST /api/v2/projects/{projectId}/workItems/search/id | Search for work items and extract IDs only TestitApiClient.ProjectWorkItemsApi | apiV2ProjectsProjectIdWorkItemsSearchPost | POST /api/v2/projects/{projectId}/workItems/search | Search for work items TestitApiClient.ProjectWorkItemsApi | apiV2ProjectsProjectIdWorkItemsSearchWorkItemIdIndexPost | POST /api/v2/projects/{projectId}/workItems/search/{workItemId}/index | Get work item index (position) in a collection by its id. TestitApiClient.ProjectWorkItemsApi | apiV2ProjectsProjectIdWorkItemsTagsGet | GET /api/v2/projects/{projectId}/workItems/tags | Get WorkItems Tags TestitApiClient.ProjectWorkItemsApi | getWorkItemsByProjectId | GET /api/v2/projects/{projectId}/workItems | Get project work items TestitApiClient.ProjectsApi | addGlobalAttributesToProject | POST /api/v2/projects/{id}/globalAttributes | Add global attributes to project TestitApiClient.ProjectsApi | apiV2ProjectsDemoPost | POST /api/v2/projects/demo | TestitApiClient.ProjectsApi | apiV2ProjectsIdDelete | DELETE /api/v2/projects/{id} | Archive project TestitApiClient.ProjectsApi | apiV2ProjectsIdFailureClassesGet | GET /api/v2/projects/{id}/failureClasses | Get failure classes TestitApiClient.ProjectsApi | apiV2ProjectsIdFavoritePut | PUT /api/v2/projects/{id}/favorite | Mark Project as favorite TestitApiClient.ProjectsApi | apiV2ProjectsIdFiltersGet | GET /api/v2/projects/{id}/filters | Get Project filters TestitApiClient.ProjectsApi | apiV2ProjectsIdPatch | PATCH /api/v2/projects/{id} | Patch project TestitApiClient.ProjectsApi | apiV2ProjectsIdPurgePost | POST /api/v2/projects/{id}/purge | Purge the project TestitApiClient.ProjectsApi | apiV2ProjectsIdRestorePost | POST /api/v2/projects/{id}/restore | Restore archived project TestitApiClient.ProjectsApi | apiV2ProjectsIdTestPlansAttributeAttributeIdDelete | DELETE /api/v2/projects/{id}/testPlans/attribute/{attributeId} | Delete attribute from project's test plans TestitApiClient.ProjectsApi | apiV2ProjectsIdTestPlansAttributePut | PUT /api/v2/projects/{id}/testPlans/attribute | Update attribute of project's test plans TestitApiClient.ProjectsApi | apiV2ProjectsIdTestRunsFullGet | GET /api/v2/projects/{id}/testRuns/full | Get Project TestRuns full models TestitApiClient.ProjectsApi | apiV2ProjectsNameNameExistsGet | GET /api/v2/projects/name/{name}/exists | TestitApiClient.ProjectsApi | apiV2ProjectsPurgeBulkPost | POST /api/v2/projects/purge/bulk | Purge multiple projects TestitApiClient.ProjectsApi | apiV2ProjectsRestoreBulkPost | POST /api/v2/projects/restore/bulk | Restore multiple projects TestitApiClient.ProjectsApi | apiV2ProjectsSearchPost | POST /api/v2/projects/search | Search for projects TestitApiClient.ProjectsApi | apiV2ProjectsShortsPost | POST /api/v2/projects/shorts | Get projects short models TestitApiClient.ProjectsApi | createProject | POST /api/v2/projects | Create project TestitApiClient.ProjectsApi | deleteProjectAutoTests | DELETE /api/v2/projects/{id}/autoTests | Delete all autotests from project TestitApiClient.ProjectsApi | getAllProjects | GET /api/v2/projects | Get all projects TestitApiClient.ProjectsApi | getAutoTestsNamespaces | GET /api/v2/projects/{id}/autoTestsNamespaces | Get namespaces of autotests in project TestitApiClient.ProjectsApi | getProjectById | GET /api/v2/projects/{id} | Get project by ID TestitApiClient.ProjectsApi | getTestPlansByProjectId | GET /api/v2/projects/{id}/testPlans | Get project test plans TestitApiClient.ProjectsApi | getTestRunsByProjectId | GET /api/v2/projects/{id}/testRuns | Get project test runs TestitApiClient.ProjectsApi | updateProject | PUT /api/v2/projects | Update project TestitApiClient.SearchApi | apiV2SearchGlobalSearchPost | POST /api/v2/search/globalSearch | TestitApiClient.SectionsApi | apiV2SectionsIdPatch | PATCH /api/v2/sections/{id} | Patch section TestitApiClient.SectionsApi | createSection | POST /api/v2/sections | Create section TestitApiClient.SectionsApi | deleteSection | DELETE /api/v2/sections/{id} | Delete section TestitApiClient.SectionsApi | getSectionById | GET /api/v2/sections/{id} | Get section TestitApiClient.SectionsApi | getWorkItemsBySectionId | GET /api/v2/sections/{id}/workItems | Get section work items TestitApiClient.SectionsApi | move | POST /api/v2/sections/move | Move section with all work items into another section TestitApiClient.SectionsApi | rename | POST /api/v2/sections/rename | Rename section TestitApiClient.SectionsApi | updateSection | PUT /api/v2/sections | Update section TestitApiClient.TagsApi | apiV2TagsDelete | DELETE /api/v2/tags | Delete tags TestitApiClient.TagsApi | apiV2TagsIdDelete | DELETE /api/v2/tags/{id} | Delete tag TestitApiClient.TagsApi | apiV2TagsPost | POST /api/v2/tags | Create tag TestitApiClient.TagsApi | apiV2TagsPut | PUT /api/v2/tags | Update tag TestitApiClient.TagsApi | apiV2TagsSearchGet | GET /api/v2/tags/search | Search tags TestitApiClient.TagsApi | apiV2TagsTestPlansTagsGet | GET /api/v2/tags/testPlansTags | Get all Tags that are used in TestPlans TestitApiClient.TestPlansApi | addTestPointsWithSections | POST /api/v2/testPlans/{id}/test-points/withSections | Add test-points to TestPlan with sections TestitApiClient.TestPlansApi | addWorkItemsWithSections | POST /api/v2/testPlans/{id}/workItems/withSections | Add WorkItems to TestPlan with Sections as TestSuites TestitApiClient.TestPlansApi | apiV2TestPlansIdAnalyticsGet | GET /api/v2/testPlans/{id}/analytics | Get analytics by TestPlan TestitApiClient.TestPlansApi | apiV2TestPlansIdAutobalancePost | POST /api/v2/testPlans/{id}/autobalance | Distribute test points between the users TestitApiClient.TestPlansApi | apiV2TestPlansIdConfigurationsGet | GET /api/v2/testPlans/{id}/configurations | Get TestPlan configurations TestitApiClient.TestPlansApi | apiV2TestPlansIdExportTestPointsXlsxPost | POST /api/v2/testPlans/{id}/export/testPoints/xlsx | Export TestPoints from TestPlan in xls format TestitApiClient.TestPlansApi | apiV2TestPlansIdExportTestResultHistoryXlsxPost | POST /api/v2/testPlans/{id}/export/testResultHistory/xlsx | Export TestResults history from TestPlan in xls format TestitApiClient.TestPlansApi | apiV2TestPlansIdHistoryGet | GET /api/v2/testPlans/{id}/history | Get TestPlan history TestitApiClient.TestPlansApi | apiV2TestPlansIdLinksGet | GET /api/v2/testPlans/{id}/links | Get Links of TestPlan TestitApiClient.TestPlansApi | apiV2TestPlansIdPatch | PATCH /api/v2/testPlans/{id} | Patch test plan TestitApiClient.TestPlansApi | apiV2TestPlansIdSummariesGet | GET /api/v2/testPlans/{id}/summaries | Get summary by TestPlan TestitApiClient.TestPlansApi | apiV2TestPlansIdTestPointsLastResultsGet | GET /api/v2/testPlans/{id}/testPoints/lastResults | Get TestPoints with last result from TestPlan TestitApiClient.TestPlansApi | apiV2TestPlansIdTestPointsResetPost | POST /api/v2/testPlans/{id}/testPoints/reset | Reset TestPoints status of TestPlan TestitApiClient.TestPlansApi | apiV2TestPlansIdTestPointsTesterDelete | DELETE /api/v2/testPlans/{id}/testPoints/tester | Unassign users from multiple test points TestitApiClient.TestPlansApi | apiV2TestPlansIdTestPointsTesterUserIdPost | POST /api/v2/testPlans/{id}/testPoints/tester/{userId} | Assign user as a tester to multiple test points TestitApiClient.TestPlansApi | apiV2TestPlansIdTestRunsGet | GET /api/v2/testPlans/{id}/testRuns | Get TestRuns of TestPlan TestitApiClient.TestPlansApi | apiV2TestPlansIdTestRunsSearchPost | POST /api/v2/testPlans/{id}/testRuns/search | Search TestRuns of TestPlan TestitApiClient.TestPlansApi | apiV2TestPlansIdTestRunsTestResultsLastModifiedModifiedDateGet | GET /api/v2/testPlans/{id}/testRuns/testResults/lastModified/modifiedDate | Get last modification date of test plan's test results TestitApiClient.TestPlansApi | apiV2TestPlansIdUnlockRequestPost | POST /api/v2/testPlans/{id}/unlock/request | Send unlock TestPlan notification TestitApiClient.TestPlansApi | apiV2TestPlansShortsPost | POST /api/v2/testPlans/shorts | Get TestPlans short models by Project identifiers TestitApiClient.TestPlansApi | clone | POST /api/v2/testPlans/{id}/clone | Clone TestPlan TestitApiClient.TestPlansApi | complete | POST /api/v2/testPlans/{id}/complete | Complete TestPlan TestitApiClient.TestPlansApi | createTestPlan | POST /api/v2/testPlans | Create TestPlan TestitApiClient.TestPlansApi | deleteTestPlan | DELETE /api/v2/testPlans/{id} | Delete TestPlan TestitApiClient.TestPlansApi | getTestPlanById | GET /api/v2/testPlans/{id} | Get TestPlan by Id TestitApiClient.TestPlansApi | getTestSuitesById | GET /api/v2/testPlans/{id}/testSuites | Get TestSuites Tree By Id TestitApiClient.TestPlansApi | pause | POST /api/v2/testPlans/{id}/pause | Pause TestPlan TestitApiClient.TestPlansApi | purgeTestPlan | POST /api/v2/testPlans/{id}/purge | Permanently delete test plan from archive TestitApiClient.TestPlansApi | restoreTestPlan | POST /api/v2/testPlans/{id}/restore | Restore TestPlan TestitApiClient.TestPlansApi | start | POST /api/v2/testPlans/{id}/start | Start TestPlan TestitApiClient.TestPlansApi | updateTestPlan | PUT /api/v2/testPlans | Update TestPlan TestitApiClient.TestPointsApi | apiV2TestPointsIdTestRunsGet | GET /api/v2/testPoints/{id}/testRuns | Get all test runs which use test point TestitApiClient.TestPointsApi | apiV2TestPointsIdWorkItemGet | GET /api/v2/testPoints/{id}/workItem | Get work item represented by test point TestitApiClient.TestPointsApi | apiV2TestPointsSearchIdPost | POST /api/v2/testPoints/search/id | Search for test points and extract IDs only TestitApiClient.TestPointsApi | apiV2TestPointsSearchPost | POST /api/v2/testPoints/search | Search for test points TestitApiClient.TestResultsApi | apiV2TestResultsExternalProjectsExternalProjectIdDefectsExternalFormsPost | POST /api/v2/testResults/external-projects/{externalProjectId}/defects/external-forms | TestitApiClient.TestResultsApi | apiV2TestResultsExternalProjectsExternalProjectIdDefectsPost | POST /api/v2/testResults/external-projects/{externalProjectId}/defects | TestitApiClient.TestResultsApi | apiV2TestResultsIdAggregatedGet | GET /api/v2/testResults/{id}/aggregated | Get test result by ID aggregated with previous results TestitApiClient.TestResultsApi | apiV2TestResultsIdAttachmentsAttachmentIdPut | PUT /api/v2/testResults/{id}/attachments/{attachmentId} | Attach file to the test result TestitApiClient.TestResultsApi | apiV2TestResultsIdAttachmentsInfoGet | GET /api/v2/testResults/{id}/attachments/info | Get test result attachments meta-information TestitApiClient.TestResultsApi | apiV2TestResultsIdGet | GET /api/v2/testResults/{id} | Get test result by ID TestitApiClient.TestResultsApi | apiV2TestResultsIdPut | PUT /api/v2/testResults/{id} | Edit test result by ID TestitApiClient.TestResultsApi | apiV2TestResultsIdRerunsGet | GET /api/v2/testResults/{id}/reruns | Get reruns TestitApiClient.TestResultsApi | apiV2TestResultsSearchPost | POST /api/v2/testResults/search | Search for test results TestitApiClient.TestResultsApi | apiV2TestResultsStatisticsFilterPost | POST /api/v2/testResults/statistics/filter | Search for test results and extract statistics TestitApiClient.TestResultsApi | createAttachment | POST /api/v2/testResults/{id}/attachments | Upload and link attachment to TestResult TestitApiClient.TestResultsApi | deleteAttachment | DELETE /api/v2/testResults/{id}/attachments/{attachmentId} | Remove attachment and unlink from TestResult TestitApiClient.TestResultsApi | downloadAttachment | GET /api/v2/testResults/{id}/attachments/{attachmentId} | Get attachment of TestResult TestitApiClient.TestResultsApi | getAttachment | GET /api/v2/testResults/{id}/attachments/{attachmentId}/info | Get Metadata of TestResult's attachment TestitApiClient.TestResultsApi | getAttachments | GET /api/v2/testResults/{id}/attachments | Get all attachments of TestResult TestitApiClient.TestRunsApi | apiV2TestRunsDelete | DELETE /api/v2/testRuns | Delete multiple test runs TestitApiClient.TestRunsApi | apiV2TestRunsIdAutoTestsNamespacesGet | GET /api/v2/testRuns/{id}/autoTestsNamespaces | Get autotest classes and namespaces in test run TestitApiClient.TestRunsApi | apiV2TestRunsIdDelete | DELETE /api/v2/testRuns/{id} | Delete test run TestitApiClient.TestRunsApi | apiV2TestRunsIdPurgePost | POST /api/v2/testRuns/{id}/purge | Permanently delete test run from archive TestitApiClient.TestRunsApi | apiV2TestRunsIdRerunsPost | POST /api/v2/testRuns/{id}/reruns | Manual autotests rerun in test run TestitApiClient.TestRunsApi | apiV2TestRunsIdRestorePost | POST /api/v2/testRuns/{id}/restore | Restore test run from the archive TestitApiClient.TestRunsApi | apiV2TestRunsIdStatisticsFilterPost | POST /api/v2/testRuns/{id}/statistics/filter | Search for the test run test results and build statistics TestitApiClient.TestRunsApi | apiV2TestRunsIdTestPointsResultsGet | GET /api/v2/testRuns/{id}/testPoints/results | Get test results from the test run grouped by test points TestitApiClient.TestRunsApi | apiV2TestRunsIdTestResultsBulkPut | PUT /api/v2/testRuns/{id}/testResults/bulk | Partial edit of multiple test results in the test run TestitApiClient.TestRunsApi | apiV2TestRunsIdTestResultsLastModifiedModificationDateGet | GET /api/v2/testRuns/{id}/testResults/lastModified/modificationDate | Get modification date of last test result of the test run TestitApiClient.TestRunsApi | apiV2TestRunsPurgeBulkPost | POST /api/v2/testRuns/purge/bulk | Permanently delete multiple test runs from archive TestitApiClient.TestRunsApi | apiV2TestRunsRestoreBulkPost | POST /api/v2/testRuns/restore/bulk | Restore multiple test runs from the archive TestitApiClient.TestRunsApi | apiV2TestRunsSearchPost | POST /api/v2/testRuns/search | Search for test runs TestitApiClient.TestRunsApi | apiV2TestRunsUpdateMultiplePost | POST /api/v2/testRuns/updateMultiple | Update multiple test runs TestitApiClient.TestRunsApi | completeTestRun | POST /api/v2/testRuns/{id}/complete | Complete TestRun TestitApiClient.TestRunsApi | createAndFillByAutoTests | POST /api/v2/testRuns/byAutoTests | Create test runs based on autotests and configurations TestitApiClient.TestRunsApi | createAndFillByConfigurations | POST /api/v2/testRuns/byConfigurations | Create test runs picking the needed test points TestitApiClient.TestRunsApi | createAndFillByWorkItems | POST /api/v2/testRuns/byWorkItems | Create test run based on configurations and work items TestitApiClient.TestRunsApi | createEmpty | POST /api/v2/testRuns | Create empty TestRun TestitApiClient.TestRunsApi | getTestRunById | GET /api/v2/testRuns/{id} | Get TestRun by Id TestitApiClient.TestRunsApi | setAutoTestResultsForTestRun | POST /api/v2/testRuns/{id}/testResults | Send test results to the test runs in the system TestitApiClient.TestRunsApi | startTestRun | POST /api/v2/testRuns/{id}/start | Start TestRun TestitApiClient.TestRunsApi | stopTestRun | POST /api/v2/testRuns/{id}/stop | Stop TestRun TestitApiClient.TestRunsApi | updateEmpty | PUT /api/v2/testRuns | Update empty TestRun TestitApiClient.TestStatusesApi | apiV2TestStatusesCodeCodeExistsGet | GET /api/v2/testStatuses/code/{code}/exists | TestitApiClient.TestStatusesApi | apiV2TestStatusesIdDelete | DELETE /api/v2/testStatuses/{id} | TestitApiClient.TestStatusesApi | apiV2TestStatusesIdGet | GET /api/v2/testStatuses/{id} | TestitApiClient.TestStatusesApi | apiV2TestStatusesIdPut | PUT /api/v2/testStatuses/{id} | TestitApiClient.TestStatusesApi | apiV2TestStatusesNameNameExistsGet | GET /api/v2/testStatuses/name/{name}/exists | TestitApiClient.TestStatusesApi | apiV2TestStatusesPost | POST /api/v2/testStatuses | TestitApiClient.TestStatusesApi | apiV2TestStatusesSearchPost | POST /api/v2/testStatuses/search | TestitApiClient.TestSuitesApi | addTestPointsToTestSuite | POST /api/v2/testSuites/{id}/test-points | Add test-points to test suite TestitApiClient.TestSuitesApi | apiV2TestSuitesIdPatch | PATCH /api/v2/testSuites/{id} | Patch test suite TestitApiClient.TestSuitesApi | apiV2TestSuitesIdRefreshPost | POST /api/v2/testSuites/{id}/refresh | Refresh test suite. Only dynamic test suites are supported by this method TestitApiClient.TestSuitesApi | apiV2TestSuitesIdWorkItemsPost | POST /api/v2/testSuites/{id}/workItems | Set work items for test suite TestitApiClient.TestSuitesApi | apiV2TestSuitesPost | POST /api/v2/testSuites | Create test suite TestitApiClient.TestSuitesApi | apiV2TestSuitesPut | PUT /api/v2/testSuites | Edit test suite TestitApiClient.TestSuitesApi | deleteTestSuite | DELETE /api/v2/testSuites/{id} | Delete TestSuite TestitApiClient.TestSuitesApi | getConfigurationsByTestSuiteId | GET /api/v2/testSuites/{id}/configurations | Get Configurations By Id TestitApiClient.TestSuitesApi | getTestPointsById | GET /api/v2/testSuites/{id}/testPoints | Get TestPoints By Id TestitApiClient.TestSuitesApi | getTestResultsById | GET /api/v2/testSuites/{id}/testResults | Get TestResults By Id TestitApiClient.TestSuitesApi | getTestSuiteById | GET /api/v2/testSuites/{id} | Get TestSuite by Id TestitApiClient.TestSuitesApi | searchWorkItems | POST /api/v2/testSuites/{id}/workItems/search | Search WorkItems TestitApiClient.TestSuitesApi | setConfigurationsByTestSuiteId | POST /api/v2/testSuites/{id}/configurations | Set Configurations By TestSuite Id TestitApiClient.UsersApi | apiV2UsersExistsGet | GET /api/v2/users/exists | TestitApiClient.WebhooksApi | apiV2WebhooksDelete | DELETE /api/v2/webhooks | TestitApiClient.WebhooksApi | apiV2WebhooksGet | GET /api/v2/webhooks | Get all webhooks TestitApiClient.WebhooksApi | apiV2WebhooksIdDelete | DELETE /api/v2/webhooks/{id} | Delete webhook by ID TestitApiClient.WebhooksApi | apiV2WebhooksIdGet | GET /api/v2/webhooks/{id} | Get webhook by ID TestitApiClient.WebhooksApi | apiV2WebhooksIdPut | PUT /api/v2/webhooks/{id} | Edit webhook by ID TestitApiClient.WebhooksApi | apiV2WebhooksPost | POST /api/v2/webhooks | Create webhook TestitApiClient.WebhooksApi | apiV2WebhooksPut | PUT /api/v2/webhooks | TestitApiClient.WebhooksApi | apiV2WebhooksSearchPost | POST /api/v2/webhooks/search | Search for webhooks TestitApiClient.WebhooksApi | apiV2WebhooksSpecialVariablesGet | GET /api/v2/webhooks/specialVariables | Get special variables for webhook event type TestitApiClient.WebhooksApi | apiV2WebhooksTestPost | POST /api/v2/webhooks/test | Test webhook's url TestitApiClient.WebhooksLogsApi | apiV2WebhooksLogsGet | GET /api/v2/webhooks/logs | Get last webhook logs TestitApiClient.WebhooksLogsApi | apiV2WebhooksLogsIdDelete | DELETE /api/v2/webhooks/logs/{id} | Delete webhook log by ID TestitApiClient.WebhooksLogsApi | apiV2WebhooksLogsIdGet | GET /api/v2/webhooks/logs/{id} | Get webhook log by ID TestitApiClient.WorkItemsApi | apiV2WorkItemsIdAttachmentsPost | POST /api/v2/workItems/{id}/attachments | Upload and link attachment to WorkItem TestitApiClient.WorkItemsApi | apiV2WorkItemsIdCheckListTransformToTestCasePost | POST /api/v2/workItems/{id}/checkList/transformTo/testCase | Transform CheckList to TestCase TestitApiClient.WorkItemsApi | apiV2WorkItemsIdHistoryGet | GET /api/v2/workItems/{id}/history | Get change history of WorkItem TestitApiClient.WorkItemsApi | apiV2WorkItemsIdLikeDelete | DELETE /api/v2/workItems/{id}/like | Delete like from WorkItem TestitApiClient.WorkItemsApi | apiV2WorkItemsIdLikePost | POST /api/v2/workItems/{id}/like | Set like to WorkItem TestitApiClient.WorkItemsApi | apiV2WorkItemsIdLikesCountGet | GET /api/v2/workItems/{id}/likes/count | Get likes count of WorkItem TestitApiClient.WorkItemsApi | apiV2WorkItemsIdLikesGet | GET /api/v2/workItems/{id}/likes | Get likes of WorkItem TestitApiClient.WorkItemsApi | apiV2WorkItemsIdTestResultsHistoryGet | GET /api/v2/workItems/{id}/testResults/history | Get test results history of WorkItem TestitApiClient.WorkItemsApi | apiV2WorkItemsIdVersionVersionIdActualPost | POST /api/v2/workItems/{id}/version/{versionId}/actual | Set WorkItem as actual TestitApiClient.WorkItemsApi | apiV2WorkItemsLinksUrlsSearchPost | POST /api/v2/workItems/links/urls/search | TestitApiClient.WorkItemsApi | apiV2WorkItemsMovePost | POST /api/v2/workItems/move | Move WorkItem to another section TestitApiClient.WorkItemsApi | apiV2WorkItemsPost | POST /api/v2/workItems | Creates work item TestitApiClient.WorkItemsApi | apiV2WorkItemsSearchPost | POST /api/v2/workItems/search | Search for work items TestitApiClient.WorkItemsApi | apiV2WorkItemsSharedStepIdReferencesSectionsPost | POST /api/v2/workItems/{sharedStepId}/references/sections | Get SharedStep references in sections TestitApiClient.WorkItemsApi | apiV2WorkItemsSharedStepIdReferencesWorkItemsPost | POST /api/v2/workItems/{sharedStepId}/references/workItems | Get SharedStep references in work items TestitApiClient.WorkItemsApi | apiV2WorkItemsSharedStepsSharedStepIdReferencesGet | GET /api/v2/workItems/sharedSteps/{sharedStepId}/references | Get SharedStep references TestitApiClient.WorkItemsApi | deleteAllWorkItemsFromAutoTest | DELETE /api/v2/workItems/{id}/autoTests | Delete all links AutoTests from WorkItem by Id or GlobalId TestitApiClient.WorkItemsApi | deleteWorkItem | DELETE /api/v2/workItems/{id} | Delete Test Case, Checklist or Shared Step by Id or GlobalId TestitApiClient.WorkItemsApi | getAutoTestsForWorkItem | GET /api/v2/workItems/{id}/autoTests | Get all AutoTests linked to WorkItem by Id or GlobalId TestitApiClient.WorkItemsApi | getIterations | GET /api/v2/workItems/{id}/iterations | Get iterations by work item Id or GlobalId TestitApiClient.WorkItemsApi | getWorkItemById | GET /api/v2/workItems/{id} | Get Test Case, Checklist or Shared Step by Id or GlobalId TestitApiClient.WorkItemsApi | getWorkItemChronology | GET /api/v2/workItems/{id}/chronology | Get WorkItem chronology by Id or GlobalId TestitApiClient.WorkItemsApi | getWorkItemVersions | GET /api/v2/workItems/{id}/versions | Get WorkItem versions TestitApiClient.WorkItemsApi | purgeWorkItem | POST /api/v2/workItems/{id}/purge | Permanently delete test case, checklist or shared steps from archive TestitApiClient.WorkItemsApi | restoreWorkItem | POST /api/v2/workItems/{id}/restore | Restore test case, checklist or shared steps from archive TestitApiClient.WorkItemsApi | updateWorkItem | PUT /api/v2/workItems | Update Test Case, Checklist or Shared Step TestitApiClient.WorkItemsCommentsApi | apiV2WorkItemsCommentsCommentIdDelete | DELETE /api/v2/workItems/comments/{commentId} | Delete WorkItem comment TestitApiClient.WorkItemsCommentsApi | apiV2WorkItemsCommentsPost | POST /api/v2/workItems/comments | Create WorkItem comment TestitApiClient.WorkItemsCommentsApi | apiV2WorkItemsCommentsPut | PUT /api/v2/workItems/comments | Update work item comment TestitApiClient.WorkItemsCommentsApi | apiV2WorkItemsIdCommentsCountGet | GET /api/v2/workItems/{id}/comments/count | Get work item comments count TestitApiClient.WorkItemsCommentsApi | apiV2WorkItemsIdCommentsGet | GET /api/v2/workItems/{id}/comments | Get work item comments TestitApiClient.WorkflowsApi | apiV2WorkflowsIdDelete | DELETE /api/v2/workflows/{id} | TestitApiClient.WorkflowsApi | apiV2WorkflowsIdGet | GET /api/v2/workflows/{id} | TestitApiClient.WorkflowsApi | apiV2WorkflowsIdPatch | PATCH /api/v2/workflows/{id} | TestitApiClient.WorkflowsApi | apiV2WorkflowsIdProjectsSearchPost | POST /api/v2/workflows/{id}/projects/search | TestitApiClient.WorkflowsApi | apiV2WorkflowsIdPut | PUT /api/v2/workflows/{id} | TestitApiClient.WorkflowsApi | apiV2WorkflowsNameNameExistsGet | GET /api/v2/workflows/name/{name}/exists | TestitApiClient.WorkflowsApi | apiV2WorkflowsPost | POST /api/v2/workflows | TestitApiClient.WorkflowsApi | apiV2WorkflowsSearchPost | POST /api/v2/workflows/search |

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Api client for Test IT TMS

Getting Started

Compatibility

For new versions

Installation

How to run

Documentation for API Endpoints

Documentation for Models