5.0.1 • Published 10 months ago

testit-api-client v5.0.1

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
10 months ago

Api client for Test IT TMS

Test IT

Getting Started

Compatibility

Test ITAPI Client
3.41.0
3.52.0
4.03.0
4.23.1
4.33.2
4.43.3
4.54.1
4.64.2
5.05.0

Installation

npm install testit-api-client

Examples

Please 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);
  });

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
AttachmentsApiapiV2AttachmentsIdDeleteDELETE /api/v2/attachments/{id}Delete attachment file
AttachmentsApiapiV2AttachmentsIdGetGET /api/v2/attachments/{id}Download attachment file
AttachmentsApiapiV2AttachmentsOccupiedFileStorageSizeGetGET /api/v2/attachments/occupiedFileStorageSizeGet size of attachments storage in bytes
AttachmentsApiapiV2AttachmentsPostPOST /api/v2/attachmentsUpload new attachment file
AutoTestsApiapiV2AutoTestsFlakyBulkPostPOST /api/v2/autoTests/flaky/bulkSet \"Flaky\" status for multiple autotests
AutoTestsApiapiV2AutoTestsIdPatchPATCH /api/v2/autoTests/{id}Patch auto test
AutoTestsApiapiV2AutoTestsIdTestResultsSearchPostPOST /api/v2/autoTests/{id}/testResults/searchGet test results history for autotest
AutoTestsApiapiV2AutoTestsIdWorkItemsChangedIdGetGET /api/v2/autoTests/{id}/workItems/changed/idGet identifiers of changed linked work items
AutoTestsApiapiV2AutoTestsIdWorkItemsChangedWorkItemIdApprovePostPOST /api/v2/autoTests/{id}/workItems/changed/{workItemId}/approveApprove changes to work items linked to autotest
AutoTestsApiapiV2AutoTestsSearchPostPOST /api/v2/autoTests/searchSearch for autotests
AutoTestsApicreateAutoTestPOST /api/v2/autoTestsCreate autotest
AutoTestsApicreateMultiplePOST /api/v2/autoTests/bulkCreate multiple autotests
AutoTestsApideleteAutoTestDELETE /api/v2/autoTests/{id}Delete autotest
AutoTestsApideleteAutoTestLinkFromWorkItemDELETE /api/v2/autoTests/{id}/workItemsUnlink autotest from work item
AutoTestsApigetAllAutoTestsGET /api/v2/autoTests
AutoTestsApigetAutoTestAverageDurationGET /api/v2/autoTests/{id}/averageDurationGet average autotest duration
AutoTestsApigetAutoTestByIdGET /api/v2/autoTests/{id}Get autotest by internal or global ID
AutoTestsApigetAutoTestChronologyGET /api/v2/autoTests/{id}/chronologyGet autotest chronology
AutoTestsApigetTestRunsGET /api/v2/autoTests/{id}/testRunsGet completed tests runs for autotests
AutoTestsApigetWorkItemResultsGET /api/v2/autoTests/{id}/testResultHistory
AutoTestsApigetWorkItemsLinkedToAutoTestGET /api/v2/autoTests/{id}/workItemsGet work items linked to autotest
AutoTestsApilinkAutoTestToWorkItemPOST /api/v2/autoTests/{id}/workItemsLink autotest with work items
AutoTestsApiupdateAutoTestPUT /api/v2/autoTestsUpdate autotest
AutoTestsApiupdateMultiplePUT /api/v2/autoTests/bulkUpdate multiple autotests
BackgroundJobsApiapiV2BackgroundJobsGetGET /api/v2/backgroundJobs
BackgroundJobsApiapiV2BackgroundJobsIdCancelPostPOST /api/v2/backgroundJobs/{id}/cancelCancel current user background job
BackgroundJobsApiapiV2BackgroundJobsIdGetGET /api/v2/backgroundJobs/{id}Get background job by ID
BackgroundJobsApiapiV2BackgroundJobsIdStatusGetGET /api/v2/backgroundJobs/{id}/statusGet background job status by job ID
BackgroundJobsApiapiV2BackgroundJobsSearchPostPOST /api/v2/backgroundJobs/searchSearch for user background jobs
ConfigurationsApiapiV2ConfigurationsCreateByParametersPostPOST /api/v2/configurations/createByParametersCreate configurations by parameters
ConfigurationsApiapiV2ConfigurationsDeleteBulkPostPOST /api/v2/configurations/delete/bulkDelete multiple configurations
ConfigurationsApiapiV2ConfigurationsIdDeleteDELETE /api/v2/configurations/{id}Delete configuration
ConfigurationsApiapiV2ConfigurationsIdPatchPATCH /api/v2/configurations/{id}Patch configuration
ConfigurationsApiapiV2ConfigurationsIdPurgePostPOST /api/v2/configurations/{id}/purgePermanently delete configuration from archive
ConfigurationsApiapiV2ConfigurationsIdRestorePostPOST /api/v2/configurations/{id}/restoreRestore configuration from the archive
ConfigurationsApiapiV2ConfigurationsPurgeBulkPostPOST /api/v2/configurations/purge/bulkPermanently delete multiple archived configurations
ConfigurationsApiapiV2ConfigurationsPutPUT /api/v2/configurationsEdit configuration
ConfigurationsApiapiV2ConfigurationsRestoreBulkPostPOST /api/v2/configurations/restore/bulkRestore multiple configurations from the archive
ConfigurationsApiapiV2ConfigurationsSearchPostPOST /api/v2/configurations/searchSearch for configurations
ConfigurationsApicreateConfigurationPOST /api/v2/configurationsCreate Configuration
ConfigurationsApigetConfigurationByIdGET /api/v2/configurations/{id}Get configuration by internal or global ID
CustomAttributeTemplatesApiapiV2CustomAttributesTemplatesIdCustomAttributesExcludePostPOST /api/v2/customAttributes/templates/{id}/customAttributes/excludeExclude CustomAttributes from CustomAttributeTemplate
CustomAttributeTemplatesApiapiV2CustomAttributesTemplatesIdCustomAttributesIncludePostPOST /api/v2/customAttributes/templates/{id}/customAttributes/includeInclude CustomAttributes to CustomAttributeTemplate
CustomAttributeTemplatesApiapiV2CustomAttributesTemplatesIdDeleteDELETE /api/v2/customAttributes/templates/{id}Delete CustomAttributeTemplate
CustomAttributeTemplatesApiapiV2CustomAttributesTemplatesIdGetGET /api/v2/customAttributes/templates/{id}Get CustomAttributeTemplate by ID
CustomAttributeTemplatesApiapiV2CustomAttributesTemplatesNameGetGET /api/v2/customAttributes/templates/{name}Get CustomAttributeTemplate by name
CustomAttributeTemplatesApiapiV2CustomAttributesTemplatesPostPOST /api/v2/customAttributes/templatesCreate CustomAttributeTemplate
CustomAttributeTemplatesApiapiV2CustomAttributesTemplatesPutPUT /api/v2/customAttributes/templatesUpdate custom attributes template
CustomAttributeTemplatesApiapiV2CustomAttributesTemplatesSearchPostPOST /api/v2/customAttributes/templates/searchSearch CustomAttributeTemplates
CustomAttributesApiapiV2CustomAttributesGlobalIdDeleteDELETE /api/v2/customAttributes/global/{id}Delete global attribute
CustomAttributesApiapiV2CustomAttributesGlobalIdPutPUT /api/v2/customAttributes/global/{id}Edit global attribute
CustomAttributesApiapiV2CustomAttributesGlobalPostPOST /api/v2/customAttributes/globalCreate global attribute
CustomAttributesApiapiV2CustomAttributesIdGetGET /api/v2/customAttributes/{id}Get attribute
CustomAttributesApiapiV2CustomAttributesSearchPostPOST /api/v2/customAttributes/searchSearch for attributes
NotificationsApiapiV2NotificationsCountGetGET /api/v2/notifications/countGet unread Notifications total in last 7 days
NotificationsApiapiV2NotificationsGetGET /api/v2/notificationsGet all Notifications for current User
NotificationsApiapiV2NotificationsIdReadPostPOST /api/v2/notifications/{id}/readSet Notification as read
NotificationsApiapiV2NotificationsReadPostPOST /api/v2/notifications/readSet all Notifications as read
NotificationsApiapiV2NotificationsSearchPostPOST /api/v2/notifications/searchSearch Notifications for current User
ParametersApiapiV2ParametersBulkPostPOST /api/v2/parameters/bulkCreate multiple parameters
ParametersApiapiV2ParametersBulkPutPUT /api/v2/parameters/bulkUpdate multiple parameters
ParametersApiapiV2ParametersGroupsGetGET /api/v2/parameters/groupsGet parameters as group
ParametersApiapiV2ParametersKeyNameNameExistsGetGET /api/v2/parameters/key/name/{name}/existsCheck existence parameter key in system
ParametersApiapiV2ParametersKeyValuesGetGET /api/v2/parameters/{key}/valuesGet all parameter key values
ParametersApiapiV2ParametersKeysGetGET /api/v2/parameters/keysGet all parameter keys
ParametersApiapiV2ParametersSearchGroupsPostPOST /api/v2/parameters/search/groupsSearch for parameters as group
ParametersApiapiV2ParametersSearchPostPOST /api/v2/parameters/searchSearch for parameters
ParametersApicreateParameterPOST /api/v2/parametersCreate parameter
ParametersApideleteByNameDELETE /api/v2/parameters/name/{name}Delete parameter by name
ParametersApideleteByParameterKeyIdDELETE /api/v2/parameters/keyId/{keyId}Delete parameters by parameter key identifier
ParametersApideleteParameterDELETE /api/v2/parameters/{id}Delete parameter
ParametersApigetAllParametersGET /api/v2/parametersGet all parameters
ParametersApigetParameterByIdGET /api/v2/parameters/{id}Get parameter by ID
ParametersApiupdateParameterPUT /api/v2/parametersUpdate parameter
ProjectAttributeTemplatesApiapiV2ProjectsProjectIdAttributesTemplatesSearchPostPOST /api/v2/projects/{projectId}/attributes/templates/searchSearch for custom attributes templates
ProjectAttributeTemplatesApiapiV2ProjectsProjectIdAttributesTemplatesTemplateIdDeleteDELETE /api/v2/projects/{projectId}/attributes/templates/{templateId}Delete CustomAttributeTemplate from Project
ProjectAttributeTemplatesApiapiV2ProjectsProjectIdAttributesTemplatesTemplateIdPostPOST /api/v2/projects/{projectId}/attributes/templates/{templateId}Add CustomAttributeTemplate to Project
ProjectAttributesApicreateProjectsAttributePOST /api/v2/projects/{projectId}/attributesCreate project attribute
ProjectAttributesApideleteProjectsAttributeDELETE /api/v2/projects/{projectId}/attributes/{attributeId}Delete project attribute
ProjectAttributesApigetAttributeByProjectIdGET /api/v2/projects/{projectId}/attributes/{attributeId}Get project attribute
ProjectAttributesApigetAttributesByProjectIdGET /api/v2/projects/{projectId}/attributesGet project attributes
ProjectAttributesApisearchAttributesInProjectPOST /api/v2/projects/{projectId}/attributes/searchSearch for attributes used in the project
ProjectAttributesApiupdateProjectsAttributePUT /api/v2/projects/{projectId}/attributesEdit attribute of the project
ProjectConfigurationsApigetConfigurationsByProjectIdGET /api/v2/projects/{projectId}/configurationsGet project configurations
ProjectExportApiexportPOST /api/v2/projects/{projectId}/exportExport project as JSON file
ProjectExportApiexportProjectJsonPOST /api/v2/projects/{projectId}/export/jsonExport project as JSON file in background job
ProjectExportApiexportProjectWithTestPlansJsonPOST /api/v2/projects/{projectId}/export/testPlans/jsonExport project as JSON file with test plans in background job
ProjectExportApiexportProjectWithTestPlansZipPOST /api/v2/projects/{projectId}/export/testPlans/zipExport project as Zip file with test plans in background job
ProjectExportApiexportProjectZipPOST /api/v2/projects/{projectId}/export/zipExport project as Zip file in background job
ProjectImportApibackgroundImportToExistingProjectPOST /api/v2/projects/{projectId}/import/jsonImport project from JSON file into existing project in background job
ProjectImportApibackgroundImportZipToExistingProjectPOST /api/v2/projects/{projectId}/import/zipImport project from Zip file into existing project in background job
ProjectImportApiimportToExistingProjectPOST /api/v2/projects/{projectId}/importImport project from JSON file into existing project
ProjectSectionsApigetSectionsByProjectIdGET /api/v2/projects/{projectId}/sectionsGet project sections
ProjectTestPlanAttributesApicreateCustomAttributeTestPlanProjectRelationsPOST /api/v2/projects/{projectId}/testPlans/attributesAdd attributes to project's test plans
ProjectTestPlanAttributesApideleteCustomAttributeTestPlanProjectRelationsDELETE /api/v2/projects/{projectId}/testPlans/attributes/{attributeId}Delete attribute from project's test plans
ProjectTestPlanAttributesApigetCustomAttributeTestPlanProjectRelationsGET /api/v2/projects/{projectId}/testPlans/attributesGet project's test plan attributes
ProjectTestPlanAttributesApisearchTestPlanAttributesInProjectPOST /api/v2/projects/{projectId}/testPlans/attributes/searchSearch for attributes used in the project test plans
ProjectTestPlanAttributesApiupdateCustomAttributeTestPlanProjectRelationsPUT /api/v2/projects/{projectId}/testPlans/attributesUpdate attribute of project's test plans
ProjectTestPlansApiapiV2ProjectsProjectIdTestPlansAnalyticsGetGET /api/v2/projects/{projectId}/testPlans/analyticsGet TestPlans analytics
ProjectTestPlansApiapiV2ProjectsProjectIdTestPlansDeleteBulkPostPOST /api/v2/projects/{projectId}/testPlans/delete/bulkDelete multiple test plans
ProjectTestPlansApiapiV2ProjectsProjectIdTestPlansNameExistsGetGET /api/v2/projects/{projectId}/testPlans/{name}/existsChecks if TestPlan exists with the specified name exists for the project
ProjectTestPlansApiapiV2ProjectsProjectIdTestPlansPurgeBulkPostPOST /api/v2/projects/{projectId}/testPlans/purge/bulkPermanently delete multiple archived test plans
ProjectTestPlansApiapiV2ProjectsProjectIdTestPlansRestoreBulkPostPOST /api/v2/projects/{projectId}/testPlans/restore/bulkRestore multiple test plans
ProjectTestPlansApiapiV2ProjectsProjectIdTestPlansSearchPostPOST /api/v2/projects/{projectId}/testPlans/searchGet Project TestPlans with analytics
ProjectWorkItemsApiapiV2ProjectsProjectIdWorkItemsSearchGroupedPostPOST /api/v2/projects/{projectId}/workItems/search/groupedSearch for work items and group results by attribute
ProjectWorkItemsApiapiV2ProjectsProjectIdWorkItemsSearchIdPostPOST /api/v2/projects/{projectId}/workItems/search/idSearch for work items and extract IDs only
ProjectWorkItemsApiapiV2ProjectsProjectIdWorkItemsSearchPostPOST /api/v2/projects/{projectId}/workItems/searchSearch for work items
ProjectWorkItemsApiapiV2ProjectsProjectIdWorkItemsTagsGetGET /api/v2/projects/{projectId}/workItems/tagsGet WorkItems Tags
ProjectWorkItemsApigetWorkItemsByProjectIdGET /api/v2/projects/{projectId}/workItemsGet project work items
ProjectsApiaddGlobaAttributesToProjectPOST /api/v2/projects/{id}/globalAttributesAdd global attributes to project
ProjectsApiapiV2ProjectsDemoPostPOST /api/v2/projects/demo
ProjectsApiapiV2ProjectsIdDeleteDELETE /api/v2/projects/{id}Archive project
ProjectsApiapiV2ProjectsIdFailureClassesGetGET /api/v2/projects/{id}/failureClassesGet failure classes
ProjectsApiapiV2ProjectsIdFavoritePutPUT /api/v2/projects/{id}/favoriteMark Project as favorite
ProjectsApiapiV2ProjectsIdFiltersGetGET /api/v2/projects/{id}/filtersGet Project filters
ProjectsApiapiV2ProjectsIdPatchPATCH /api/v2/projects/{id}Patch project
ProjectsApiapiV2ProjectsIdPurgePostPOST /api/v2/projects/{id}/purgePurge archived project
ProjectsApiapiV2ProjectsIdRestorePostPOST /api/v2/projects/{id}/restoreRestore archived project
ProjectsApiapiV2ProjectsIdTestPlansAttributeAttributeIdDeleteDELETE /api/v2/projects/{id}/testPlans/attribute/{attributeId}Delete attribute from project's test plans
ProjectsApiapiV2ProjectsIdTestPlansAttributePutPUT /api/v2/projects/{id}/testPlans/attributeUpdate attribute of project's test plans
ProjectsApiapiV2ProjectsIdTestRunsActiveGetGET /api/v2/projects/{id}/testRuns/activeGet active Project TestRuns
ProjectsApiapiV2ProjectsIdTestRunsFullGetGET /api/v2/projects/{id}/testRuns/fullGet Project TestRuns full models
ProjectsApiapiV2ProjectsNameNameExistsGetGET /api/v2/projects/name/{name}/exists
ProjectsApiapiV2ProjectsPurgeBulkPostPOST /api/v2/projects/purge/bulkPurge multiple projects
ProjectsApiapiV2ProjectsRestoreBulkPostPOST /api/v2/projects/restore/bulkRestore multiple projects
ProjectsApiapiV2ProjectsSearchPostPOST /api/v2/projects/searchSearch for projects
ProjectsApibackgroundImportProjectPOST /api/v2/projects/import/jsonImport project from JSON file in background job
ProjectsApibackgroundImportZipProjectPOST /api/v2/projects/import/zipImport project from Zip file in background job
ProjectsApicreateProjectPOST /api/v2/projectsCreate project
ProjectsApideleteProjectAutoTestsDELETE /api/v2/projects/{id}/autoTestsDelete all autotests from project
ProjectsApiexportWithTestPlansAndConfigurationsPOST /api/v2/projects/{id}/export-by-testPlansExport project with test plans, test suites and test points as JSON file
ProjectsApigetAllProjectsGET /api/v2/projectsGet all projects
ProjectsApigetAutoTestsNamespacesGET /api/v2/projects/{id}/autoTestsNamespacesGet namespaces of autotests in project
ProjectsApigetProjectByIdGET /api/v2/projects/{id}Get project by ID
ProjectsApigetTestPlansByProjectIdGET /api/v2/projects/{id}/testPlansGet project test plans
ProjectsApigetTestRunsByProjectIdGET /api/v2/projects/{id}/testRunsGet project test runs
ProjectsApiimportPOST /api/v2/projects/importImport project from JSON file
ProjectsApiupdateProjectPUT /api/v2/projectsUpdate project
SearchApiapiV2SearchGlobalSearchPostPOST /api/v2/search/globalSearch
SectionsApiapiV2SectionsIdPatchPATCH /api/v2/sections/{id}Patch section
SectionsApicreateSectionPOST /api/v2/sectionsCreate section
SectionsApideleteSectionDELETE /api/v2/sections/{id}Delete section
SectionsApigetSectionByIdGET /api/v2/sections/{id}Get section
SectionsApigetWorkItemsBySectionIdGET /api/v2/sections/{id}/workItemsGet section work items
SectionsApimovePOST /api/v2/sections/moveMove section with all work items into another section
SectionsApirenamePOST /api/v2/sections/renameRename section
SectionsApiupdateSectionPUT /api/v2/sectionsUpdate section
TagsApiapiV2TagsDeleteDELETE /api/v2/tagsDelete tags
TagsApiapiV2TagsGetGET /api/v2/tagsGet all Tags
TagsApiapiV2TagsIdDeleteDELETE /api/v2/tags/{id}Delete tag
TagsApiapiV2TagsPostPOST /api/v2/tagsCreate tag
TagsApiapiV2TagsPutPUT /api/v2/tagsUpdate tag
TagsApiapiV2TagsSearchGetGET /api/v2/tags/searchSearch tags
TagsApiapiV2TagsTestPlansTagsGetGET /api/v2/tags/testPlansTagsGet all Tags that are used in TestPlans
TestPlansApiaddTestPointsWithSectionsPOST /api/v2/testPlans/{id}/test-points/withSectionsAdd test-points to TestPlan with sections
TestPlansApiaddWorkItemsWithSectionsPOST /api/v2/testPlans/{id}/workItems/withSectionsAdd WorkItems to TestPlan with Sections as TestSuites
TestPlansApiapiV2TestPlansIdAnalyticsGetGET /api/v2/testPlans/{id}/analyticsGet analytics by TestPlan
TestPlansApiapiV2TestPlansIdAutobalancePostPOST /api/v2/testPlans/{id}/autobalanceDistribute test points between the users
TestPlansApiapiV2TestPlansIdConfigurationsGetGET /api/v2/testPlans/{id}/configurationsGet TestPlan configurations
TestPlansApiapiV2TestPlansIdExportTestPointsXlsxPostPOST /api/v2/testPlans/{id}/export/testPoints/xlsxExport TestPoints from TestPlan in xls format
TestPlansApiapiV2TestPlansIdExportTestResultHistoryXlsxPostPOST /api/v2/testPlans/{id}/export/testResultHistory/xlsxExport TestResults history from TestPlan in xls format
TestPlansApiapiV2TestPlansIdHistoryGetGET /api/v2/testPlans/{id}/historyGet TestPlan history
TestPlansApiapiV2TestPlansIdLinksGetGET /api/v2/testPlans/{id}/linksGet Links of TestPlan
TestPlansApiapiV2TestPlansIdPatchPATCH /api/v2/testPlans/{id}Patch test plan
TestPlansApiapiV2TestPlansIdTestPointsLastResultsGetGET /api/v2/testPlans/{id}/testPoints/lastResultsGet TestPoints with last result from TestPlan
TestPlansApiapiV2TestPlansIdTestPointsResetPostPOST /api/v2/testPlans/{id}/testPoints/resetReset TestPoints status of TestPlan
TestPlansApiapiV2TestPlansIdTestPointsTesterDeleteDELETE /api/v2/testPlans/{id}/testPoints/testerUnassign users from multiple test points
TestPlansApiapiV2TestPlansIdTestPointsTesterUserIdPostPOST /api/v2/testPlans/{id}/testPoints/tester/{userId}Assign user as a tester to multiple test points
TestPlansApiapiV2TestPlansIdTestRunsGetGET /api/v2/testPlans/{id}/testRunsGet TestRuns of TestPlan
TestPlansApiapiV2TestPlansIdTestRunsSearchPostPOST /api/v2/testPlans/{id}/testRuns/searchSearch TestRuns of TestPlan
TestPlansApiapiV2TestPlansIdTestRunsTestResultsLastModifiedModifiedDateGetGET /api/v2/testPlans/{id}/testRuns/testResults/lastModified/modifiedDateGet last modification date of test plan's test results
TestPlansApiapiV2TestPlansIdUnlockRequestPostPOST /api/v2/testPlans/{id}/unlock/requestSend unlock TestPlan notification
TestPlansApiapiV2TestPlansShortsPostPOST /api/v2/testPlans/shortsGet TestPlans short models by Project identifiers
TestPlansApiclonePOST /api/v2/testPlans/{id}/cloneClone TestPlan
TestPlansApicompletePOST /api/v2/testPlans/{id}/completeComplete TestPlan
TestPlansApicreateTestPlanPOST /api/v2/testPlansCreate TestPlan
TestPlansApideleteTestPlanDELETE /api/v2/testPlans/{id}Delete TestPlan
TestPlansApigetTestPlanByIdGET /api/v2/testPlans/{id}Get TestPlan by Id
TestPlansApigetTestSuitesByIdGET /api/v2/testPlans/{id}/testSuitesGet TestSuites Tree By Id
TestPlansApipausePOST /api/v2/testPlans/{id}/pausePause TestPlan
TestPlansApipurgeTestPlanPOST /api/v2/testPlans/{id}/purgePermanently delete test plan from archive
TestPlansApirestoreTestPlanPOST /api/v2/testPlans/{id}/restoreRestore TestPlan
TestPlansApistartPOST /api/v2/testPlans/{id}/startStart TestPlan
TestPlansApiupdateTestPlanPUT /api/v2/testPlansUpdate TestPlan
TestPointsApiapiV2TestPointsIdTestRunsGetGET /api/v2/testPoints/{id}/testRunsGet all test runs which use test point
TestPointsApiapiV2TestPointsIdWorkItemGetGET /api/v2/testPoints/{id}/workItemGet work item represented by test point
TestPointsApiapiV2TestPointsSearchIdPostPOST /api/v2/testPoints/search/idSearch for test points and extract IDs only
TestPointsApiapiV2TestPointsSearchPostPOST /api/v2/testPoints/searchSearch for test points
TestResultsApiapiV2TestResultsIdAggregatedGetGET /api/v2/testResults/{id}/aggregatedGet test result by ID aggregated with previous results
TestResultsApiapiV2TestResultsIdAttachmentsAttachmentIdPutPUT /api/v2/testResults/{id}/attachments/{attachmentId}Attach file to the test result
TestResultsApiapiV2TestResultsIdAttachmentsInfoGetGET /api/v2/testResults/{id}/attachments/infoGet test result attachments meta-information
TestResultsApiapiV2TestResultsIdGetGET /api/v2/testResults/{id}Get test result by ID
TestResultsApiapiV2TestResultsIdPutPUT /api/v2/testResults/{id}Edit test result by ID
TestResultsApiapiV2TestResultsSearchPostPOST /api/v2/testResults/searchSearch for test results
TestResultsApiapiV2TestResultsStatisticsFilterPostPOST /api/v2/testResults/statistics/filterSearch for test results and extract statistics
TestResultsApicreateAttachmentPOST /api/v2/testResults/{id}/attachmentsUpload and link attachment to TestResult
TestResultsApideleteAttachmentDELETE /api/v2/testResults/{id}/attachments/{attachmentId}Remove attachment and unlink from TestResult
TestResultsApidownloadAttachmentGET /api/v2/testResults/{id}/attachments/{attachmentId}Get attachment of TestResult
TestResultsApigetAttachmentGET /api/v2/testResults/{id}/attachments/{attachmentId}/infoGet Metadata of TestResult's attachment
TestResultsApigetAttachmentsGET /api/v2/testResults/{id}/attachmentsGet all attachments of TestResult
TestRunsApiapiV2TestRunsDeleteDELETE /api/v2/testRunsDelete multiple test runs
TestRunsApiapiV2TestRunsIdDeleteDELETE /api/v2/testRuns/{id}Delete test run
TestRunsApiapiV2TestRunsIdPurgePostPOST /api/v2/testRuns/{id}/purgePermanently delete test run from archive
TestRunsApiapiV2TestRunsIdRestorePostPOST /api/v2/testRuns/{id}/restoreRestore test run from the archive
TestRunsApiapiV2TestRunsIdStatisticsFilterPostPOST /api/v2/testRuns/{id}/statistics/filterSearch for the test run test results and build statistics
TestRunsApiapiV2TestRunsIdTestPointsResultsGetGET /api/v2/testRuns/{id}/testPoints/resultsGet test results from the test run grouped by test points
TestRunsApiapiV2TestRunsIdTestResultsBulkPutPUT /api/v2/testRuns/{id}/testResults/bulkPartial edit of multiple test results in the test run
TestRunsApiapiV2TestRunsIdTestResultsLastModifiedModificationDateGetGET /api/v2/testRuns/{id}/testResults/lastModified/modificationDateGet modification date of last test result of the test run
TestRunsApiapiV2TestRunsPurgeBulkPostPOST /api/v2/testRuns/purge/bulkPermanently delete multiple test runs from archive
TestRunsApiapiV2TestRunsRestoreBulkPostPOST /api/v2/testRuns/restore/bulkRestore multiple test runs from the archive
TestRunsApiapiV2TestRunsSearchPostPOST /api/v2/testRuns/searchSearch for test runs
TestRunsApiapiV2TestRunsUpdateMultiplePostPOST /api/v2/testRuns/updateMultipleUpdate multiple test runs
TestRunsApicompleteTestRunPOST /api/v2/testRuns/{id}/completeComplete TestRun
TestRunsApicreateAndFillByAutoTestsPOST /api/v2/testRuns/byAutoTestsCreate test runs based on autotests and configurations
TestRunsApicreateAndFillByConfigurationsPOST /api/v2/testRuns/byConfigurationsCreate test runs picking the needed test points
TestRunsApicreateAndFillByWorkItemsPOST /api/v2/testRuns/byWorkItemsCreate test run based on configurations and work items
TestRunsApicreateEmptyPOST /api/v2/testRunsCreate empty TestRun
TestRunsApigetTestRunByIdGET /api/v2/testRuns/{id}Get TestRun by Id
TestRunsApisetAutoTestResultsForTestRunPOST /api/v2/testRuns/{id}/testResultsSend test results to the test runs in the system
TestRunsApistartTestRunPOST /api/v2/testRuns/{id}/startStart TestRun
TestRunsApistopTestRunPOST /api/v2/testRuns/{id}/stopStop TestRun
TestRunsApiupdateEmptyPUT /api/v2/testRunsUpdate empty TestRun
TestSuitesApiaddTestPointsToTestSuitePOST /api/v2/testSuites/{id}/test-pointsAdd test-points to test suite
TestSuitesApiapiV2TestSuitesIdPatchPATCH /api/v2/testSuites/{id}Patch test suite
TestSuitesApiapiV2TestSuitesIdRefreshPostPOST /api/v2/testSuites/{id}/refreshRefresh test suite. Only dynamic test suites are supported by this method
TestSuitesApiapiV2TestSuitesIdWorkItemsPostPOST /api/v2/testSuites/{id}/workItemsSet work items for test suite
TestSuitesApiapiV2TestSuitesPostPOST /api/v2/testSuitesCreate test suite
TestSuitesApiapiV2TestSuitesPutPUT /api/v2/testSuitesEdit test suite
TestSuitesApideleteTestSuiteDELETE /api/v2/testSuites/{id}Delete TestSuite
TestSuitesApigetConfigurationsByTestSuiteIdGET /api/v2/testSuites/{id}/configurationsGet Configurations By Id
TestSuitesApigetTestPointsByIdGET /api/v2/testSuites/{id}/testPointsGet TestPoints By Id
TestSuitesApigetTestResultsByIdGET /api/v2/testSuites/{id}/testResultsGet TestResults By Id
TestSuitesApigetTestSuiteByIdGET /api/v2/testSuites/{id}Get TestSuite by Id
TestSuitesApisearchWorkItemsPOST /api/v2/testSuites/{id}/workItems/searchSearch WorkItems
TestSuitesApisetConfigurationsByTestSuiteIdPOST /api/v2/testSuites/{id}/configurationsSet Configurations By TestSuite Id
WebhooksApiapiV2WebhooksGetGET /api/v2/webhooksGet all webhooks
WebhooksApiapiV2WebhooksIdDeleteDELETE /api/v2/webhooks/{id}Delete webhook by ID
WebhooksApiapiV2WebhooksIdGetGET /api/v2/webhooks/{id}Get webhook by ID
WebhooksApiapiV2WebhooksIdPutPUT /api/v2/webhooks/{id}Edit webhook by ID
WebhooksApiapiV2WebhooksPostPOST /api/v2/webhooksCreate webhook
WebhooksApiapiV2WebhooksSearchPostPOST /api/v2/webhooks/searchSearch for webhooks
WebhooksApiapiV2WebhooksSpecialVariablesGetGET /api/v2/webhooks/specialVariablesGet special variables for webhook event type
WebhooksApiapiV2WebhooksTestPostPOST /api/v2/webhooks/testTest webhook's url
WebhooksLogsApiapiV2WebhooksLogsGetGET /api/v2/webhooks/logsGet all webhook logs
WebhooksLogsApiapiV2WebhooksLogsIdDeleteDELETE /api/v2/webhooks/logs/{id}Delete webhook log by ID
WebhooksLogsApiapiV2WebhooksLogsIdGetGET /api/v2/webhooks/logs/{id}Get webhook log by ID
WorkItemsApiapiV2WorkItemsIdAttachmentsPostPOST /api/v2/workItems/{id}/attachmentsUpload and link attachment to WorkItem
WorkItemsApiapiV2WorkItemsIdCheckListTransformToTestCasePostPOST /api/v2/workItems/{id}/checkList/transformTo/testCaseTransform CheckList to TestCase
WorkItemsApiapiV2WorkItemsIdHistoryGetGET /api/v2/workItems/{id}/historyGet change history of WorkItem
WorkItemsApiapiV2WorkItemsIdLikeDeleteDELETE /api/v2/workItems/{id}/likeDelete like from WorkItem
WorkItemsApiapiV2WorkItemsIdLikePostPOST /api/v2/workItems/{id}/likeSet like to WorkItem
WorkItemsApiapiV2WorkItemsIdLikesCountGetGET /api/v2/workItems/{id}/likes/countGet likes count of WorkItem
WorkItemsApiapiV2WorkItemsIdLikesGetGET /api/v2/workItems/{id}/likesGet likes of WorkItem
WorkItemsApiapiV2WorkItemsIdTestResultsHistoryGetGET /api/v2/workItems/{id}/testResults/historyGet test results history of WorkItem
WorkItemsApiapiV2WorkItemsIdVersionVersionIdActualPostPOST /api/v2/workItems/{id}/version/{versionId}/actualSet WorkItem as actual
WorkItemsApiapiV2WorkItemsMovePostPOST /api/v2/workItems/moveMove WorkItem to another section
WorkItemsApiapiV2WorkItemsSearchPostPOST /api/v2/workItems/searchSearch for work items
WorkItemsApiapiV2WorkItemsSharedStepIdReferencesSectionsPostPOST /api/v2/workItems/{sharedStepId}/references/sectionsGet SharedStep references in sections
WorkItemsApiapiV2WorkItemsSharedStepIdReferencesWorkItemsPostPOST /api/v2/workItems/{sharedStepId}/references/workItemsGet SharedStep references in work items
WorkItemsApiapiV2WorkItemsSharedStepsSharedStepIdReferencesGetGET /api/v2/workItems/sharedSteps/{sharedStepId}/referencesGet SharedStep references
WorkItemsApicreateWorkItemPOST /api/v2/workItemsCreate Test Case, Checklist or Shared Step
WorkItemsApideleteAllWorkItemsFromAutoTestDELETE /api/v2/workItems/{id}/autoTestsDelete all links AutoTests from WorkItem by Id or GlobalId
WorkItemsApideleteWorkItemDELETE /api/v2/workItems/{id}Delete Test Case, Checklist or Shared Step by Id or GlobalId
WorkItemsApigetAutoTestsForWorkItemGET /api/v2/workItems/{id}/autoTestsGet all AutoTests linked to WorkItem by Id or GlobalId
WorkItemsApigetIterationsGET /api/v2/workItems/{id}/iterationsGet iterations by work item Id or GlobalId
WorkItemsApigetWorkItemByIdGET /api/v2/workItems/{id}Get Test Case, Checklist or Shared Step by Id or GlobalId
WorkItemsApigetWorkItemChronologyGET /api/v2/workItems/{id}/chronologyGet WorkItem chronology by Id or GlobalId
WorkItemsApigetWorkItemVersionsGET /api/v2/workItems/{id}/versionsGet WorkItem versions
WorkItemsApipurgeWorkItemPOST /api/v2/workItems/{id}/purgePermanently delete test case, checklist or shared steps from archive
WorkItemsApirestoreWorkItemPOST /api/v2/workItems/{id}/restoreRestore test case, checklist or shared steps from archive
WorkItemsApiupdateWorkItemPUT /api/v2/workItemsUpdate Test Case, Checklist or Shared Step
WorkItemsCommentsApiapiV2WorkItemsCommentsCommentIdDeleteDELETE /api/v2/workItems/comments/{commentId}Delete WorkItem comment
WorkItemsCommentsApiapiV2WorkItemsCommentsPostPOST /api/v2/workItems/commentsCreate WorkItem comment
WorkItemsCommentsApiapiV2WorkItemsCommentsPutPUT /api/v2/workItems/commentsUpdate work item comment
WorkItemsCommentsApiapiV2WorkItemsIdCommentsGetGET /api/v2/workItems/{id}/commentsGet work item comments

Documentation for Models

  • You can see the documentation here.

Contributing

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.

License

Distributed under the Apache-2.0 License. See LICENSE for more information.

5.0.1

10 months ago

5.0.0

1 year ago

4.2.0

1 year ago

4.1.0

2 years ago

4.0.0

2 years ago

3.3.0

2 years ago

3.2.0

2 years ago

3.1.0

2 years ago

3.0.1

2 years ago

1.0.8

2 years ago

1.0.7

2 years ago

1.0.6

2 years ago

2.0.0

3 years ago

1.0.5

3 years ago

1.0.4

3 years ago

1.0.3

3 years ago

1.0.2

3 years ago

1.0.1

4 years ago

1.0.0

4 years ago