| 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 |
npm install testit-api-clientPlease follow the installation instruction and execute the following JS code:
import {
AttachmentsApi,
AttachmentsApiApiKeys,
RequestDetailedFile
} from 'testit-api-client';
import { readFileSync } from 'fs';
import { basename } from 'path';
const attachmentsApi = new AttachmentsApi("Your TMS address");
attachmentsApi.setApiKey(
AttachmentsApiApiKeys['Bearer or PrivateToken'],
"PrivateToken " + "Your private token");
const file: RequestDetailedFile = {
value: readFileSync("Path to file"),
options: {
filename: basename("Path to file")
}
};
const attachment = await attachmentsApi.apiV2AttachmentsPost(file)
.then((response) => {
return response.body;
})
.catch((response) => {
console.log(response.data);
});All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AttachmentsApi | apiV2AttachmentsIdDelete | DELETE /api/v2/attachments/{id} | Delete attachment file |
| AttachmentsApi | apiV2AttachmentsIdGet | GET /api/v2/attachments/{id} | Download attachment file |
| AttachmentsApi | apiV2AttachmentsIdMetadataGet | GET /api/v2/attachments/{id}/metadata | Get attachment metadata |
| AttachmentsApi | apiV2AttachmentsOccupiedFileStorageSizeGet | GET /api/v2/attachments/occupiedFileStorageSize | Get size of attachments storage in bytes |
| AttachmentsApi | apiV2AttachmentsPost | POST /api/v2/attachments | Upload new attachment file |
| AutoTestsApi | apiV2AutoTestsFlakyBulkPost | POST /api/v2/autoTests/flaky/bulk | Set "Flaky" status for multiple autotests |
| AutoTestsApi | apiV2AutoTestsIdPatch | PATCH /api/v2/autoTests/{id} | Patch auto test |
| AutoTestsApi | apiV2AutoTestsIdTestResultsSearchPost | POST /api/v2/autoTests/{id}/testResults/search | Get test results history for autotest |
| AutoTestsApi | apiV2AutoTestsIdWorkItemsChangedIdGet | GET /api/v2/autoTests/{id}/workItems/changed/id | Get identifiers of changed linked work items |
| AutoTestsApi | apiV2AutoTestsIdWorkItemsChangedWorkItemIdApprovePost | POST /api/v2/autoTests/{id}/workItems/changed/{workItemId}/approve | Approve changes to work items linked to autotest |
| AutoTestsApi | apiV2AutoTestsSearchPost | POST /api/v2/autoTests/search | Search for autotests |
| AutoTestsApi | createAutoTest | POST /api/v2/autoTests | Create autotest |
| AutoTestsApi | createMultiple | POST /api/v2/autoTests/bulk | Create multiple autotests |
| AutoTestsApi | deleteAutoTest | DELETE /api/v2/autoTests/{id} | Delete autotest |
| AutoTestsApi | deleteAutoTestLinkFromWorkItem | DELETE /api/v2/autoTests/{id}/workItems | Unlink autotest from work item |
| AutoTestsApi | getAllAutoTests | GET /api/v2/autoTests | |
| AutoTestsApi | getAutoTestAverageDuration | GET /api/v2/autoTests/{id}/averageDuration | Get average autotest duration |
| AutoTestsApi | getAutoTestById | GET /api/v2/autoTests/{id} | Get autotest by internal or global ID |
| AutoTestsApi | getAutoTestChronology | GET /api/v2/autoTests/{id}/chronology | Get autotest chronology |
| AutoTestsApi | getTestRuns | GET /api/v2/autoTests/{id}/testRuns | Get completed tests runs for autotests |
| AutoTestsApi | getWorkItemsLinkedToAutoTest | GET /api/v2/autoTests/{id}/workItems | Get work items linked to autotest |
| AutoTestsApi | linkAutoTestToWorkItem | POST /api/v2/autoTests/{id}/workItems | Link autotest with work items |
| AutoTestsApi | updateAutoTest | PUT /api/v2/autoTests | Update autotest |
| AutoTestsApi | updateMultiple | PUT /api/v2/autoTests/bulk | Update multiple autotests |
| BackgroundJobsApi | apiV2BackgroundJobsCompletedDelete | DELETE /api/v2/backgroundJobs/completed | Delete all completed background jobs |
| BackgroundJobsApi | apiV2BackgroundJobsGet | GET /api/v2/backgroundJobs | |
| BackgroundJobsApi | apiV2BackgroundJobsIdCancelPost | POST /api/v2/backgroundJobs/{id}/cancel | Cancel current user background job |
| BackgroundJobsApi | apiV2BackgroundJobsIdGet | GET /api/v2/backgroundJobs/{id} | Get background job by ID |
| BackgroundJobsApi | apiV2BackgroundJobsIdStatusGet | GET /api/v2/backgroundJobs/{id}/status | Get background job status by job ID |
| BackgroundJobsApi | apiV2BackgroundJobsSearchPost | POST /api/v2/backgroundJobs/search | Search for user background jobs |
| ConfigurationsApi | apiV2ConfigurationsCreateByParametersPost | POST /api/v2/configurations/createByParameters | Create configurations by parameters |
| ConfigurationsApi | apiV2ConfigurationsDeleteBulkPost | POST /api/v2/configurations/delete/bulk | Delete multiple configurations |
| ConfigurationsApi | apiV2ConfigurationsIdDelete | DELETE /api/v2/configurations/{id} | Delete configuration |
| ConfigurationsApi | apiV2ConfigurationsIdPatch | PATCH /api/v2/configurations/{id} | Patch configuration |
| ConfigurationsApi | apiV2ConfigurationsIdPurgePost | POST /api/v2/configurations/{id}/purge | Permanently delete configuration from archive |
| ConfigurationsApi | apiV2ConfigurationsIdRestorePost | POST /api/v2/configurations/{id}/restore | Restore configuration from the archive |
| ConfigurationsApi | apiV2ConfigurationsPurgeBulkPost | POST /api/v2/configurations/purge/bulk | Permanently delete multiple archived configurations |
| ConfigurationsApi | apiV2ConfigurationsPut | PUT /api/v2/configurations | Edit configuration |
| ConfigurationsApi | apiV2ConfigurationsRestoreBulkPost | POST /api/v2/configurations/restore/bulk | Restore multiple configurations from the archive |
| ConfigurationsApi | apiV2ConfigurationsSearchPost | POST /api/v2/configurations/search | Search for configurations |
| ConfigurationsApi | createConfiguration | POST /api/v2/configurations | Create Configuration |
| ConfigurationsApi | getConfigurationById | GET /api/v2/configurations/{id} | Get configuration by internal or global ID |
| CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesExistsGet | GET /api/v2/customAttributes/templates/exists | |
| CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesIdCustomAttributesExcludePost | POST /api/v2/customAttributes/templates/{id}/customAttributes/exclude | Exclude CustomAttributes from CustomAttributeTemplate |
| CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesIdCustomAttributesIncludePost | POST /api/v2/customAttributes/templates/{id}/customAttributes/include | Include CustomAttributes to CustomAttributeTemplate |
| CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesIdDelete | DELETE /api/v2/customAttributes/templates/{id} | Delete CustomAttributeTemplate |
| CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesIdGet | GET /api/v2/customAttributes/templates/{id} | Get CustomAttributeTemplate by ID |
| CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesNameGet | GET /api/v2/customAttributes/templates/{name} | Get CustomAttributeTemplate by name |
| CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesPost | POST /api/v2/customAttributes/templates | Create CustomAttributeTemplate |
| CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesPut | PUT /api/v2/customAttributes/templates | Update custom attributes template |
| CustomAttributeTemplatesApi | apiV2CustomAttributesTemplatesSearchPost | POST /api/v2/customAttributes/templates/search | Search CustomAttributeTemplates |
| CustomAttributesApi | apiV2CustomAttributesExistsGet | GET /api/v2/customAttributes/exists | |
| CustomAttributesApi | apiV2CustomAttributesGlobalIdDelete | DELETE /api/v2/customAttributes/global/{id} | Delete global attribute |
| CustomAttributesApi | apiV2CustomAttributesGlobalIdPut | PUT /api/v2/customAttributes/global/{id} | Edit global attribute |
| CustomAttributesApi | apiV2CustomAttributesGlobalPost | POST /api/v2/customAttributes/global | Create global attribute |
| CustomAttributesApi | apiV2CustomAttributesIdGet | GET /api/v2/customAttributes/{id} | Get attribute |
| CustomAttributesApi | apiV2CustomAttributesSearchPost | POST /api/v2/customAttributes/search | Search for attributes |
| NotificationsApi | apiV2NotificationsCountGet | GET /api/v2/notifications/count | Get unread Notifications total in last 7 days |
| NotificationsApi | apiV2NotificationsGet | GET /api/v2/notifications | Get all Notifications for current User |
| NotificationsApi | apiV2NotificationsIdReadPost | POST /api/v2/notifications/{id}/read | Set Notification as read |
| NotificationsApi | apiV2NotificationsReadPost | POST /api/v2/notifications/read | Set all Notifications as read |
| NotificationsApi | apiV2NotificationsSearchPost | POST /api/v2/notifications/search | Search Notifications for current User |
| ParametersApi | apiV2ParametersBulkPost | POST /api/v2/parameters/bulk | Create multiple parameters |
| ParametersApi | apiV2ParametersBulkPut | PUT /api/v2/parameters/bulk | Update multiple parameters |
| ParametersApi | apiV2ParametersGroupsGet | GET /api/v2/parameters/groups | Get parameters as group |
| ParametersApi | apiV2ParametersKeyNameNameExistsGet | GET /api/v2/parameters/key/name/{name}/exists | Check existence parameter key in system |
| ParametersApi | apiV2ParametersKeyValuesGet | GET /api/v2/parameters/{key}/values | Get all parameter key values |
| ParametersApi | apiV2ParametersKeysGet | GET /api/v2/parameters/keys | Get all parameter keys |
| ParametersApi | apiV2ParametersSearchGroupsPost | POST /api/v2/parameters/search/groups | Search for parameters as group |
| ParametersApi | apiV2ParametersSearchPost | POST /api/v2/parameters/search | Search for parameters |
| ParametersApi | createParameter | POST /api/v2/parameters | Create parameter |
| ParametersApi | deleteByName | DELETE /api/v2/parameters/name/{name} | Delete parameter by name |
| ParametersApi | deleteByParameterKeyId | DELETE /api/v2/parameters/keyId/{keyId} | Delete parameters by parameter key identifier |
| ParametersApi | deleteParameter | DELETE /api/v2/parameters/{id} | Delete parameter |
| ParametersApi | getAllParameters | GET /api/v2/parameters | Get all parameters |
| ParametersApi | getParameterById | GET /api/v2/parameters/{id} | Get parameter by ID |
| ParametersApi | updateParameter | PUT /api/v2/parameters | Update parameter |
| ProjectAttributeTemplatesApi | apiV2ProjectsProjectIdAttributesTemplatesSearchPost | POST /api/v2/projects/{projectId}/attributes/templates/search | Search for custom attributes templates |
| ProjectAttributeTemplatesApi | apiV2ProjectsProjectIdAttributesTemplatesTemplateIdDelete | DELETE /api/v2/projects/{projectId}/attributes/templates/{templateId} | Delete CustomAttributeTemplate from Project |
| ProjectAttributeTemplatesApi | apiV2ProjectsProjectIdAttributesTemplatesTemplateIdPost | POST /api/v2/projects/{projectId}/attributes/templates/{templateId} | Add CustomAttributeTemplate to Project |
| ProjectAttributesApi | createProjectsAttribute | POST /api/v2/projects/{projectId}/attributes | Create project attribute |
| ProjectAttributesApi | deleteProjectsAttribute | DELETE /api/v2/projects/{projectId}/attributes/{attributeId} | Delete project attribute |
| ProjectAttributesApi | getAttributeByProjectId | GET /api/v2/projects/{projectId}/attributes/{attributeId} | Get project attribute |
| ProjectAttributesApi | getAttributesByProjectId | GET /api/v2/projects/{projectId}/attributes | Get project attributes |
| ProjectAttributesApi | searchAttributesInProject | POST /api/v2/projects/{projectId}/attributes/search | Search for attributes used in the project |
| ProjectAttributesApi | updateProjectsAttribute | PUT /api/v2/projects/{projectId}/attributes | Edit attribute of the project |
| ProjectConfigurationsApi | getConfigurationsByProjectId | GET /api/v2/projects/{projectId}/configurations | Get project configurations |
| ProjectSectionsApi | getSectionsByProjectId | GET /api/v2/projects/{projectId}/sections | Get project sections |
| ProjectSettingsApi | apiV2ProjectsProjectIdSettingsAutotestsPost | POST /api/v2/projects/{projectId}/settings/autotests | Set autotest project settings. |
| ProjectSettingsApi | getAutotestProjectSettings | GET /api/v2/projects/{projectId}/settings/autotests | Get autotest project settings. |
| ProjectTestPlanAttributesApi | createCustomAttributeTestPlanProjectRelations | POST /api/v2/projects/{projectId}/testPlans/attributes | Add attributes to project's test plans |
| ProjectTestPlanAttributesApi | deleteCustomAttributeTestPlanProjectRelations | DELETE /api/v2/projects/{projectId}/testPlans/attributes/{attributeId} | Delete attribute from project's test plans |
| ProjectTestPlanAttributesApi | getCustomAttributeTestPlanProjectRelations | GET /api/v2/projects/{projectId}/testPlans/attributes | Get project's test plan attributes |
| ProjectTestPlanAttributesApi | searchTestPlanAttributesInProject | POST /api/v2/projects/{projectId}/testPlans/attributes/search | Search for attributes used in the project test plans |
| ProjectTestPlanAttributesApi | updateCustomAttributeTestPlanProjectRelations | PUT /api/v2/projects/{projectId}/testPlans/attributes | Update attribute of project's test plans |
| ProjectTestPlansApi | apiV2ProjectsProjectIdTestPlansAnalyticsGet | GET /api/v2/projects/{projectId}/testPlans/analytics | Get TestPlans analytics |
| ProjectTestPlansApi | apiV2ProjectsProjectIdTestPlansDeleteBulkPost | POST /api/v2/projects/{projectId}/testPlans/delete/bulk | Delete multiple test plans |
| ProjectTestPlansApi | apiV2ProjectsProjectIdTestPlansNameExistsGet | GET /api/v2/projects/{projectId}/testPlans/{name}/exists | Checks if TestPlan exists with the specified name exists for the project |
| ProjectTestPlansApi | apiV2ProjectsProjectIdTestPlansPurgeBulkPost | POST /api/v2/projects/{projectId}/testPlans/purge/bulk | Permanently delete multiple archived test plans |
| ProjectTestPlansApi | apiV2ProjectsProjectIdTestPlansRestoreBulkPost | POST /api/v2/projects/{projectId}/testPlans/restore/bulk | Restore multiple test plans |
| ProjectTestPlansApi | apiV2ProjectsProjectIdTestPlansSearchPost | POST /api/v2/projects/{projectId}/testPlans/search | Get Project TestPlans with analytics |
| ProjectWorkItemsApi | apiV2ProjectsProjectIdWorkItemsSearchGroupedPost | POST /api/v2/projects/{projectId}/workItems/search/grouped | Search for work items and group results by attribute |
| ProjectWorkItemsApi | apiV2ProjectsProjectIdWorkItemsSearchIdPost | POST /api/v2/projects/{projectId}/workItems/search/id | Search for work items and extract IDs only |
| ProjectWorkItemsApi | apiV2ProjectsProjectIdWorkItemsSearchPost | POST /api/v2/projects/{projectId}/workItems/search | Search for work items |
| ProjectWorkItemsApi | apiV2ProjectsProjectIdWorkItemsTagsGet | GET /api/v2/projects/{projectId}/workItems/tags | Get WorkItems Tags |
| ProjectWorkItemsApi | getWorkItemsByProjectId | GET /api/v2/projects/{projectId}/workItems | Get project work items |
| ProjectsApi | addGlobaAttributesToProject | POST /api/v2/projects/{id}/globalAttributes | Add global attributes to project |
| ProjectsApi | apiV2ProjectsDemoPost | POST /api/v2/projects/demo | |
| ProjectsApi | apiV2ProjectsIdDelete | DELETE /api/v2/projects/{id} | Archive project |
| ProjectsApi | apiV2ProjectsIdFailureClassesGet | GET /api/v2/projects/{id}/failureClasses | Get failure classes |
| ProjectsApi | apiV2ProjectsIdFavoritePut | PUT /api/v2/projects/{id}/favorite | Mark Project as favorite |
| ProjectsApi | apiV2ProjectsIdFiltersGet | GET /api/v2/projects/{id}/filters | Get Project filters |
| ProjectsApi | apiV2ProjectsIdPatch | PATCH /api/v2/projects/{id} | Patch project |
| ProjectsApi | apiV2ProjectsIdPurgePost | POST /api/v2/projects/{id}/purge | Purge the project |
| ProjectsApi | apiV2ProjectsIdRestorePost | POST /api/v2/projects/{id}/restore | Restore archived project |
| ProjectsApi | apiV2ProjectsIdTestPlansAttributeAttributeIdDelete | DELETE /api/v2/projects/{id}/testPlans/attribute/{attributeId} | Delete attribute from project's test plans |
| ProjectsApi | apiV2ProjectsIdTestPlansAttributePut | PUT /api/v2/projects/{id}/testPlans/attribute | Update attribute of project's test plans |
| ProjectsApi | apiV2ProjectsIdTestRunsActiveGet | GET /api/v2/projects/{id}/testRuns/active | Get active Project TestRuns |
| ProjectsApi | apiV2ProjectsIdTestRunsFullGet | GET /api/v2/projects/{id}/testRuns/full | Get Project TestRuns full models |
| ProjectsApi | apiV2ProjectsNameNameExistsGet | GET /api/v2/projects/name/{name}/exists | |
| ProjectsApi | apiV2ProjectsPurgeBulkPost | POST /api/v2/projects/purge/bulk | Purge multiple projects |
| ProjectsApi | apiV2ProjectsRestoreBulkPost | POST /api/v2/projects/restore/bulk | Restore multiple projects |
| ProjectsApi | apiV2ProjectsSearchPost | POST /api/v2/projects/search | Search for projects |
| ProjectsApi | createProject | POST /api/v2/projects | Create project |
| ProjectsApi | deleteProjectAutoTests | DELETE /api/v2/projects/{id}/autoTests | Delete all autotests from project |
| ProjectsApi | getAllProjects | GET /api/v2/projects | Get all projects |
| ProjectsApi | getAutoTestsNamespaces | GET /api/v2/projects/{id}/autoTestsNamespaces | Get namespaces of autotests in project |
| ProjectsApi | getProjectById | GET /api/v2/projects/{id} | Get project by ID |
| ProjectsApi | getTestPlansByProjectId | GET /api/v2/projects/{id}/testPlans | Get project test plans |
| ProjectsApi | getTestRunsByProjectId | GET /api/v2/projects/{id}/testRuns | Get project test runs |
| ProjectsApi | updateProject | PUT /api/v2/projects | Update project |
| SearchApi | apiV2SearchGlobalSearchPost | POST /api/v2/search/globalSearch | |
| SectionsApi | apiV2SectionsIdPatch | PATCH /api/v2/sections/{id} | Patch section |
| SectionsApi | createSection | POST /api/v2/sections | Create section |
| SectionsApi | deleteSection | DELETE /api/v2/sections/{id} | Delete section |
| SectionsApi | getSectionById | GET /api/v2/sections/{id} | Get section |
| SectionsApi | getWorkItemsBySectionId | GET /api/v2/sections/{id}/workItems | Get section work items |
| SectionsApi | move | POST /api/v2/sections/move | Move section with all work items into another section |
| SectionsApi | rename | POST /api/v2/sections/rename | Rename section |
| SectionsApi | updateSection | PUT /api/v2/sections | Update section |
| TagsApi | apiV2TagsDelete | DELETE /api/v2/tags | Delete tags |
| TagsApi | apiV2TagsGet | GET /api/v2/tags | Get all Tags |
| TagsApi | apiV2TagsIdDelete | DELETE /api/v2/tags/{id} | Delete tag |
| TagsApi | apiV2TagsPost | POST /api/v2/tags | Create tag |
| TagsApi | apiV2TagsPut | PUT /api/v2/tags | Update tag |
| TagsApi | apiV2TagsSearchGet | GET /api/v2/tags/search | Search tags |
| TagsApi | apiV2TagsTestPlansTagsGet | GET /api/v2/tags/testPlansTags | Get all Tags that are used in TestPlans |
| TestPlansApi | addTestPointsWithSections | POST /api/v2/testPlans/{id}/test-points/withSections | Add test-points to TestPlan with sections |
| TestPlansApi | addWorkItemsWithSections | POST /api/v2/testPlans/{id}/workItems/withSections | Add WorkItems to TestPlan with Sections as TestSuites |
| TestPlansApi | apiV2TestPlansIdAnalyticsGet | GET /api/v2/testPlans/{id}/analytics | Get analytics by TestPlan |
| TestPlansApi | apiV2TestPlansIdAutobalancePost | POST /api/v2/testPlans/{id}/autobalance | Distribute test points between the users |
| TestPlansApi | apiV2TestPlansIdConfigurationsGet | GET /api/v2/testPlans/{id}/configurations | Get TestPlan configurations |
| TestPlansApi | apiV2TestPlansIdExportTestPointsXlsxPost | POST /api/v2/testPlans/{id}/export/testPoints/xlsx | Export TestPoints from TestPlan in xls format |
| TestPlansApi | apiV2TestPlansIdExportTestResultHistoryXlsxPost | POST /api/v2/testPlans/{id}/export/testResultHistory/xlsx | Export TestResults history from TestPlan in xls format |
| TestPlansApi | apiV2TestPlansIdHistoryGet | GET /api/v2/testPlans/{id}/history | Get TestPlan history |
| TestPlansApi | apiV2TestPlansIdLinksGet | GET /api/v2/testPlans/{id}/links | Get Links of TestPlan |
| TestPlansApi | apiV2TestPlansIdPatch | PATCH /api/v2/testPlans/{id} | Patch test plan |
| TestPlansApi | apiV2TestPlansIdSummariesGet | GET /api/v2/testPlans/{id}/summaries | Get summary by TestPlan |
| TestPlansApi | apiV2TestPlansIdTestPointsLastResultsGet | GET /api/v2/testPlans/{id}/testPoints/lastResults | Get TestPoints with last result from TestPlan |
| TestPlansApi | apiV2TestPlansIdTestPointsResetPost | POST /api/v2/testPlans/{id}/testPoints/reset | Reset TestPoints status of TestPlan |
| TestPlansApi | apiV2TestPlansIdTestPointsTesterDelete | DELETE /api/v2/testPlans/{id}/testPoints/tester | Unassign users from multiple test points |
| TestPlansApi | apiV2TestPlansIdTestPointsTesterUserIdPost | POST /api/v2/testPlans/{id}/testPoints/tester/{userId} | Assign user as a tester to multiple test points |
| TestPlansApi | apiV2TestPlansIdTestRunsGet | GET /api/v2/testPlans/{id}/testRuns | Get TestRuns of TestPlan |
| TestPlansApi | apiV2TestPlansIdTestRunsSearchPost | POST /api/v2/testPlans/{id}/testRuns/search | Search TestRuns of TestPlan |
| TestPlansApi | apiV2TestPlansIdTestRunsTestResultsLastModifiedModifiedDateGet | GET /api/v2/testPlans/{id}/testRuns/testResults/lastModified/modifiedDate | Get last modification date of test plan's test results |
| TestPlansApi | apiV2TestPlansIdUnlockRequestPost | POST /api/v2/testPlans/{id}/unlock/request | Send unlock TestPlan notification |
| TestPlansApi | apiV2TestPlansShortsPost | POST /api/v2/testPlans/shorts | Get TestPlans short models by Project identifiers |
| TestPlansApi | clone | POST /api/v2/testPlans/{id}/clone | Clone TestPlan |
| TestPlansApi | complete | POST /api/v2/testPlans/{id}/complete | Complete TestPlan |
| TestPlansApi | createTestPlan | POST /api/v2/testPlans | Create TestPlan |
| TestPlansApi | deleteTestPlan | DELETE /api/v2/testPlans/{id} | Delete TestPlan |
| TestPlansApi | getTestPlanById | GET /api/v2/testPlans/{id} | Get TestPlan by Id |
| TestPlansApi | getTestSuitesById | GET /api/v2/testPlans/{id}/testSuites | Get TestSuites Tree By Id |
| TestPlansApi | pause | POST /api/v2/testPlans/{id}/pause | Pause TestPlan |
| TestPlansApi | purgeTestPlan | POST /api/v2/testPlans/{id}/purge | Permanently delete test plan from archive |
| TestPlansApi | restoreTestPlan | POST /api/v2/testPlans/{id}/restore | Restore TestPlan |
| TestPlansApi | start | POST /api/v2/testPlans/{id}/start | Start TestPlan |
| TestPlansApi | updateTestPlan | PUT /api/v2/testPlans | Update TestPlan |
| TestPointsApi | apiV2TestPointsIdTestRunsGet | GET /api/v2/testPoints/{id}/testRuns | Get all test runs which use test point |
| TestPointsApi | apiV2TestPointsIdWorkItemGet | GET /api/v2/testPoints/{id}/workItem | Get work item represented by test point |
| TestPointsApi | apiV2TestPointsSearchIdPost | POST /api/v2/testPoints/search/id | Search for test points and extract IDs only |
| TestPointsApi | apiV2TestPointsSearchPost | POST /api/v2/testPoints/search | Search for test points |
| TestResultsApi | apiV2TestResultsExternalProjectsExternalProjectIdDefectsExternalFormsPost | POST /api/v2/testResults/external-projects/{externalProjectId}/defects/external-forms | |
| TestResultsApi | apiV2TestResultsExternalProjectsExternalProjectIdDefectsPost | POST /api/v2/testResults/external-projects/{externalProjectId}/defects | |
| TestResultsApi | apiV2TestResultsIdAggregatedGet | GET /api/v2/testResults/{id}/aggregated | Get test result by ID aggregated with previous results |
| TestResultsApi | apiV2TestResultsIdAttachmentsAttachmentIdPut | PUT /api/v2/testResults/{id}/attachments/{attachmentId} | Attach file to the test result |
| TestResultsApi | apiV2TestResultsIdAttachmentsInfoGet | GET /api/v2/testResults/{id}/attachments/info | Get test result attachments meta-information |
| TestResultsApi | apiV2TestResultsIdGet | GET /api/v2/testResults/{id} | Get test result by ID |
| TestResultsApi | apiV2TestResultsIdPut | PUT /api/v2/testResults/{id} | Edit test result by ID |
| TestResultsApi | apiV2TestResultsIdRerunsGet | GET /api/v2/testResults/{id}/reruns | Get reruns |
| TestResultsApi | apiV2TestResultsSearchPost | POST /api/v2/testResults/search | Search for test results |
| TestResultsApi | apiV2TestResultsStatisticsFilterPost | POST /api/v2/testResults/statistics/filter | Search for test results and extract statistics |
| TestResultsApi | createAttachment | POST /api/v2/testResults/{id}/attachments | Upload and link attachment to TestResult |
| TestResultsApi | deleteAttachment | DELETE /api/v2/testResults/{id}/attachments/{attachmentId} | Remove attachment and unlink from TestResult |
| TestResultsApi | downloadAttachment | GET /api/v2/testResults/{id}/attachments/{attachmentId} | Get attachment of TestResult |
| TestResultsApi | getAttachment | GET /api/v2/testResults/{id}/attachments/{attachmentId}/info | Get Metadata of TestResult's attachment |
| TestResultsApi | getAttachments | GET /api/v2/testResults/{id}/attachments | Get all attachments of TestResult |
| TestRunsApi | apiV2TestRunsDelete | DELETE /api/v2/testRuns | Delete multiple test runs |
| TestRunsApi | apiV2TestRunsIdAutoTestsNamespacesGet | GET /api/v2/testRuns/{id}/autoTestsNamespaces | Get autotest classes and namespaces in test run |
| TestRunsApi | apiV2TestRunsIdDelete | DELETE /api/v2/testRuns/{id} | Delete test run |
| TestRunsApi | apiV2TestRunsIdPurgePost | POST /api/v2/testRuns/{id}/purge | Permanently delete test run from archive |
| TestRunsApi | apiV2TestRunsIdRerunsPost | POST /api/v2/testRuns/{id}/reruns | Manual autotests rerun in test run |
| TestRunsApi | apiV2TestRunsIdRestorePost | POST /api/v2/testRuns/{id}/restore | Restore test run from the archive |
| TestRunsApi | apiV2TestRunsIdStatisticsFilterPost | POST /api/v2/testRuns/{id}/statistics/filter | Search for the test run test results and build statistics |
| TestRunsApi | apiV2TestRunsIdTestPointsResultsGet | GET /api/v2/testRuns/{id}/testPoints/results | Get test results from the test run grouped by test points |
| TestRunsApi | apiV2TestRunsIdTestResultsBulkPut | PUT /api/v2/testRuns/{id}/testResults/bulk | Partial edit of multiple test results in the test run |
| TestRunsApi | apiV2TestRunsIdTestResultsLastModifiedModificationDateGet | GET /api/v2/testRuns/{id}/testResults/lastModified/modificationDate | Get modification date of last test result of the test run |
| TestRunsApi | apiV2TestRunsPurgeBulkPost | POST /api/v2/testRuns/purge/bulk | Permanently delete multiple test runs from archive |
| TestRunsApi | apiV2TestRunsRestoreBulkPost | POST /api/v2/testRuns/restore/bulk | Restore multiple test runs from the archive |
| TestRunsApi | apiV2TestRunsSearchPost | POST /api/v2/testRuns/search | Search for test runs |
| TestRunsApi | apiV2TestRunsUpdateMultiplePost | POST /api/v2/testRuns/updateMultiple | Update multiple test runs |
| TestRunsApi | completeTestRun | POST /api/v2/testRuns/{id}/complete | Complete TestRun |
| TestRunsApi | createAndFillByAutoTests | POST /api/v2/testRuns/byAutoTests | Create test runs based on autotests and configurations |
| TestRunsApi | createAndFillByConfigurations | POST /api/v2/testRuns/byConfigurations | Create test runs picking the needed test points |
| TestRunsApi | createAndFillByWorkItems | POST /api/v2/testRuns/byWorkItems | Create test run based on configurations and work items |
| TestRunsApi | createEmpty | POST /api/v2/testRuns | Create empty TestRun |
| TestRunsApi | getTestRunById | GET /api/v2/testRuns/{id} | Get TestRun by Id |
| TestRunsApi | setAutoTestResultsForTestRun | POST /api/v2/testRuns/{id}/testResults | Send test results to the test runs in the system |
| TestRunsApi | startTestRun | POST /api/v2/testRuns/{id}/start | Start TestRun |
| TestRunsApi | stopTestRun | POST /api/v2/testRuns/{id}/stop | Stop TestRun |
| TestRunsApi | updateEmpty | PUT /api/v2/testRuns | Update empty TestRun |
| TestSuitesApi | addTestPointsToTestSuite | POST /api/v2/testSuites/{id}/test-points | Add test-points to test suite |
| TestSuitesApi | apiV2TestSuitesIdPatch | PATCH /api/v2/testSuites/{id} | Patch test suite |
| TestSuitesApi | apiV2TestSuitesIdRefreshPost | POST /api/v2/testSuites/{id}/refresh | Refresh test suite. Only dynamic test suites are supported by this method |
| TestSuitesApi | apiV2TestSuitesIdWorkItemsPost | POST /api/v2/testSuites/{id}/workItems | Set work items for test suite |
| TestSuitesApi | apiV2TestSuitesPost | POST /api/v2/testSuites | Create test suite |
| TestSuitesApi | apiV2TestSuitesPut | PUT /api/v2/testSuites | Edit test suite |
| TestSuitesApi | deleteTestSuite | DELETE /api/v2/testSuites/{id} | Delete TestSuite |
| TestSuitesApi | getConfigurationsByTestSuiteId | GET /api/v2/testSuites/{id}/configurations | Get Configurations By Id |
| TestSuitesApi | getTestPointsById | GET /api/v2/testSuites/{id}/testPoints | Get TestPoints By Id |
| TestSuitesApi | getTestResultsById | GET /api/v2/testSuites/{id}/testResults | Get TestResults By Id |
| TestSuitesApi | getTestSuiteById | GET /api/v2/testSuites/{id} | Get TestSuite by Id |
| TestSuitesApi | searchWorkItems | POST /api/v2/testSuites/{id}/workItems/search | Search WorkItems |
| TestSuitesApi | setConfigurationsByTestSuiteId | POST /api/v2/testSuites/{id}/configurations | Set Configurations By TestSuite Id |
| UsersApi | apiV2UsersExistsGet | GET /api/v2/users/exists | |
| WebhooksApi | apiV2WebhooksDelete | DELETE /api/v2/webhooks | |
| WebhooksApi | apiV2WebhooksGet | GET /api/v2/webhooks | Get all webhooks |
| WebhooksApi | apiV2WebhooksIdDelete | DELETE /api/v2/webhooks/{id} | Delete webhook by ID |
| WebhooksApi | apiV2WebhooksIdGet | GET /api/v2/webhooks/{id} | Get webhook by ID |
| WebhooksApi | apiV2WebhooksIdPut | PUT /api/v2/webhooks/{id} | Edit webhook by ID |
| WebhooksApi | apiV2WebhooksPost | POST /api/v2/webhooks | Create webhook |
| WebhooksApi | apiV2WebhooksPut | PUT /api/v2/webhooks | |
| WebhooksApi | apiV2WebhooksSearchPost | POST /api/v2/webhooks/search | Search for webhooks |
| WebhooksApi | apiV2WebhooksSpecialVariablesGet | GET /api/v2/webhooks/specialVariables | Get special variables for webhook event type |
| WebhooksApi | apiV2WebhooksTestPost | POST /api/v2/webhooks/test | Test webhook's url |
| WebhooksLogsApi | apiV2WebhooksLogsGet | GET /api/v2/webhooks/logs | Get all webhook logs |
| WebhooksLogsApi | apiV2WebhooksLogsIdDelete | DELETE /api/v2/webhooks/logs/{id} | Delete webhook log by ID |
| WebhooksLogsApi | apiV2WebhooksLogsIdGet | GET /api/v2/webhooks/logs/{id} | Get webhook log by ID |
| WorkItemsApi | apiV2WorkItemsIdAttachmentsPost | POST /api/v2/workItems/{id}/attachments | Upload and link attachment to WorkItem |
| WorkItemsApi | apiV2WorkItemsIdCheckListTransformToTestCasePost | POST /api/v2/workItems/{id}/checkList/transformTo/testCase | Transform CheckList to TestCase |
| WorkItemsApi | apiV2WorkItemsIdHistoryGet | GET /api/v2/workItems/{id}/history | Get change history of WorkItem |
| WorkItemsApi | apiV2WorkItemsIdLikeDelete | DELETE /api/v2/workItems/{id}/like | Delete like from WorkItem |
| WorkItemsApi | apiV2WorkItemsIdLikePost | POST /api/v2/workItems/{id}/like | Set like to WorkItem |
| WorkItemsApi | apiV2WorkItemsIdLikesCountGet | GET /api/v2/workItems/{id}/likes/count | Get likes count of WorkItem |
| WorkItemsApi | apiV2WorkItemsIdLikesGet | GET /api/v2/workItems/{id}/likes | Get likes of WorkItem |
| WorkItemsApi | apiV2WorkItemsIdTestResultsHistoryGet | GET /api/v2/workItems/{id}/testResults/history | Get test results history of WorkItem |
| WorkItemsApi | apiV2WorkItemsIdVersionVersionIdActualPost | POST /api/v2/workItems/{id}/version/{versionId}/actual | Set WorkItem as actual |
| WorkItemsApi | apiV2WorkItemsMovePost | POST /api/v2/workItems/move | Move WorkItem to another section |
| WorkItemsApi | apiV2WorkItemsSearchPost | POST /api/v2/workItems/search | Search for work items |
| WorkItemsApi | apiV2WorkItemsSharedStepIdReferencesSectionsPost | POST /api/v2/workItems/{sharedStepId}/references/sections | Get SharedStep references in sections |
| WorkItemsApi | apiV2WorkItemsSharedStepIdReferencesWorkItemsPost | POST /api/v2/workItems/{sharedStepId}/references/workItems | Get SharedStep references in work items |
| WorkItemsApi | apiV2WorkItemsSharedStepsSharedStepIdReferencesGet | GET /api/v2/workItems/sharedSteps/{sharedStepId}/references | Get SharedStep references |
| WorkItemsApi | createWorkItem | POST /api/v2/workItems | Create Test Case, Checklist or Shared Step |
| WorkItemsApi | deleteAllWorkItemsFromAutoTest | DELETE /api/v2/workItems/{id}/autoTests | Delete all links AutoTests from WorkItem by Id or GlobalId |
| WorkItemsApi | deleteWorkItem | DELETE /api/v2/workItems/{id} | Delete Test Case, Checklist or Shared Step by Id or GlobalId |
| WorkItemsApi | getAutoTestsForWorkItem | GET /api/v2/workItems/{id}/autoTests | Get all AutoTests linked to WorkItem by Id or GlobalId |
| WorkItemsApi | getIterations | GET /api/v2/workItems/{id}/iterations | Get iterations by work item Id or GlobalId |
| WorkItemsApi | getWorkItemById | GET /api/v2/workItems/{id} | Get Test Case, Checklist or Shared Step by Id or GlobalId |
| WorkItemsApi | getWorkItemChronology | GET /api/v2/workItems/{id}/chronology | Get WorkItem chronology by Id or GlobalId |
| WorkItemsApi | getWorkItemVersions | GET /api/v2/workItems/{id}/versions | Get WorkItem versions |
| WorkItemsApi | purgeWorkItem | POST /api/v2/workItems/{id}/purge | Permanently delete test case, checklist or shared steps from archive |
| WorkItemsApi | restoreWorkItem | POST /api/v2/workItems/{id}/restore | Restore test case, checklist or shared steps from archive |
| WorkItemsApi | updateWorkItem | PUT /api/v2/workItems | Update Test Case, Checklist or Shared Step |
| WorkItemsCommentsApi | apiV2WorkItemsCommentsCommentIdDelete | DELETE /api/v2/workItems/comments/{commentId} | Delete WorkItem comment |
| WorkItemsCommentsApi | apiV2WorkItemsCommentsPost | POST /api/v2/workItems/comments | Create WorkItem comment |
| WorkItemsCommentsApi | apiV2WorkItemsCommentsPut | PUT /api/v2/workItems/comments | Update work item comment |
| WorkItemsCommentsApi | apiV2WorkItemsIdCommentsCountGet | GET /api/v2/workItems/{id}/comments/count | Get work item comments count |
| WorkItemsCommentsApi | apiV2WorkItemsIdCommentsGet | GET /api/v2/workItems/{id}/comments | Get work item comments |
- You can see the documentation here.
You can help to develop the project. Any contributions are greatly appreciated.
- If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
- Please make sure you check your spelling and grammar.
- Create individual PR for each suggestion.
- Please also read through the Code Of Conduct before posting your first idea as well.
Distributed under the Apache-2.0 License. See LICENSE for more information.