Api client for Test IT TMS

Getting Started

Compatibility

Test IT	API Client
4.2	1.0.0
4.3	1.1.0
4.4	1.2.0
4.5	1.3.0
4.6	1.4.0
5.0	2.0.2

Installation

go get github.com/testit-tms/api-client-golang

Examples

Please follow the installation instruction and execute the following Golang code:

import (
	"context"
	"fmt"

	tmsclient "github.com/testit-tms/api-client-golang"
)

const (
	host   = "Your TMS address"
	key    = "Your private token"
	scheme = "https or http"
)

func main() {
	ctx := context.WithValue(context.Background(), tmsclient.ContextAPIKeys, map[string]tmsclient.APIKey{
		"Bearer or PrivateToken": {
			Key:    key,
			Prefix: "PrivateToken",
		},
	})

	configuration := tmsclient.NewConfiguration()
	configuration.Host = host
	configuration.Scheme = scheme
	apiClient := tmsclient.NewAPIClient(configuration)

	id := "123"

	_, err := apiClient.AttachmentsApi.ApiV2AttachmentsIdDelete(ctx, id).Execute()
	if err != nil {
		fmt.Println(err)
	}
}

Documentation for API Endpoints

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	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	GetWorkItemResults	Get /api/v2/autoTests/{id}/testResultHistory
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	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	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	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
ProjectExportAPI	Export	Post /api/v2/projects/{projectId}/export	Export project as JSON file
ProjectExportAPI	ExportProjectJson	Post /api/v2/projects/{projectId}/export/json	Export project as JSON file in background job
ProjectExportAPI	ExportProjectWithTestPlansJson	Post /api/v2/projects/{projectId}/export/testPlans/json	Export project as JSON file with test plans in background job
ProjectExportAPI	ExportProjectWithTestPlansZip	Post /api/v2/projects/{projectId}/export/testPlans/zip	Export project as Zip file with test plans in background job
ProjectExportAPI	ExportProjectZip	Post /api/v2/projects/{projectId}/export/zip	Export project as Zip file in background job
ProjectImportAPI	BackgroundImportToExistingProject	Post /api/v2/projects/{projectId}/import/json	Import project from JSON file into existing project in background job
ProjectImportAPI	BackgroundImportZipToExistingProject	Post /api/v2/projects/{projectId}/import/zip	Import project from Zip file into existing project in background job
ProjectImportAPI	ImportToExistingProject	Post /api/v2/projects/{projectId}/import	Import project from JSON file into existing project
ProjectSectionsAPI	GetSectionsByProjectId	Get /api/v2/projects/{projectId}/sections	Get project sections
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 archived 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	BackgroundImportProject	Post /api/v2/projects/import/json	Import project from JSON file in background job
ProjectsAPI	BackgroundImportZipProject	Post /api/v2/projects/import/zip	Import project from Zip file in background job
ProjectsAPI	CallImport	Post /api/v2/projects/import	Import project from JSON file
ProjectsAPI	CreateProject	Post /api/v2/projects	Create project
ProjectsAPI	DeleteProjectAutoTests	Delete /api/v2/projects/{id}/autoTests	Delete all autotests from project
ProjectsAPI	ExportWithTestPlansAndConfigurations	Post /api/v2/projects/{id}/export-by-testPlans	Export project with test plans, test suites and test points as JSON file
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	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	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	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	ApiV2TestRunsIdDelete	Delete /api/v2/testRuns/{id}	Delete test run
TestRunsAPI	ApiV2TestRunsIdPurgePost	Post /api/v2/testRuns/{id}/purge	Permanently delete test run from archive
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
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	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	ApiV2WorkItemsIdCommentsGet	Get /api/v2/workItems/{id}/comments	Get 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.