Api client for TestGear TMS

Getting Started

Compatibility

TestGear	API Client
4.2	1.0.0

Installation

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

Examples

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

import (
	"context"
	"fmt"

	tmsclient "github.com/testgear-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	Get current user background jobs
ConfigurationsApi	ApiV2ConfigurationsCreateByParametersPost	Post /api/v2/configurations/createByParameters	Create Configurations by parameters
ConfigurationsApi	ApiV2ConfigurationsIdPatch	Patch /api/v2/configurations/{id}	Patch configuration
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
ConfigurationsApi	UpdateConfiguration	Put /api/v2/configurations	Update Configuration
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	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	ObsoleteDeleteByName	Post /api/v2/parameters/deleteByName
ParametersApi	UpdateParameter	Put /api/v2/parameters	Update parameter
ProjectsApi	AddGlobaAttributesToProject	Post /api/v2/projects/{id}/globalAttributes	Add global attributes to project
ProjectsApi	ApiV2ProjectsIdAttributesTemplatesSearchPost	Post /api/v2/projects/{id}/attributes/templates/search	Search for custom attributes templates
ProjectsApi	ApiV2ProjectsIdAttributesTemplatesTemplateIdDelete	Delete /api/v2/projects/{id}/attributes/templates/{templateId}	Delete CustomAttributeTemplate from Project
ProjectsApi	ApiV2ProjectsIdAttributesTemplatesTemplateIdPost	Post /api/v2/projects/{id}/attributes/templates/{templateId}	Add CustomAttributeTemplate to Project
ProjectsApi	ApiV2ProjectsIdFailureClassesGet	Get /api/v2/projects/{id}/failureClasses	Get Project FailureClasses
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	ApiV2ProjectsIdTestPlansAnalyticsGet	Get /api/v2/projects/{id}/testPlans/analytics	Get TestPlans analytics
ProjectsApi	ApiV2ProjectsIdTestPlansDeleteBulkPost	Post /api/v2/projects/{id}/testPlans/delete/bulk	Delete multiple test plans
ProjectsApi	ApiV2ProjectsIdTestPlansNameExistsGet	Get /api/v2/projects/{id}/testPlans/{name}/exists	Checks if TestPlan exists with the specified name exists for the project
ProjectsApi	ApiV2ProjectsIdTestPlansRestoreBulkPost	Post /api/v2/projects/{id}/testPlans/restore/bulk	Restore multiple test plans
ProjectsApi	ApiV2ProjectsIdTestPlansSearchPost	Post /api/v2/projects/{id}/testPlans/search	Get Project TestPlans with analytics
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	ApiV2ProjectsIdWorkItemsSearchIdPost	Post /api/v2/projects/{id}/workItems/search/id	Search for work items and extract IDs only
ProjectsApi	ApiV2ProjectsIdWorkItemsSearchPost	Post /api/v2/projects/{id}/workItems/search	Search for work items
ProjectsApi	ApiV2ProjectsIdWorkItemsTagsGet	Get /api/v2/projects/{id}/workItems/tags	Get WorkItems Tags
ProjectsApi	ApiV2ProjectsNameNameExistsGet	Get /api/v2/projects/name/{name}/exists
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	BackgroundImportToExistingProject	Post /api/v2/projects/{id}/import/json	Import project from JSON file into existing project in background job
ProjectsApi	BackgroundImportZipProject	Post /api/v2/projects/import/zip	Import project from Zip file in background job
ProjectsApi	BackgroundImportZipToExistingProject	Post /api/v2/projects/{id}/import/zip	Import project from Zip file into existing project in background job
ProjectsApi	CallImport	Post /api/v2/projects/import	Import project from JSON file
ProjectsApi	CreateCustomAttributeTestPlanProjectRelations	Post /api/v2/projects/{id}/testPlans/attributes	Add attributes to project's test plans
ProjectsApi	CreateProject	Post /api/v2/projects	Create project
ProjectsApi	CreateProjectsAttribute	Post /api/v2/projects/{id}/attributes	Create project attribute
ProjectsApi	DeleteCustomAttributeTestPlanProjectRelations	Delete /api/v2/projects/{id}/testPlans/attribute/{attributeId}	Delete attribute from project's test plans
ProjectsApi	DeleteProject	Delete /api/v2/projects/{id}	Delete project
ProjectsApi	DeleteProjectAutoTests	Delete /api/v2/projects/{id}/autoTests	Delete project
ProjectsApi	DeleteProjectsAttribute	Delete /api/v2/projects/{id}/attributes/{attributeId}	Delete project attribute
ProjectsApi	Export	Post /api/v2/projects/{id}/export	Export project as JSON file
ProjectsApi	ExportProjectJson	Post /api/v2/projects/{id}/export/json	Export project as JSON file in background job
ProjectsApi	ExportProjectWithTestPlansJson	Post /api/v2/projects/{id}/export/testPlans/json	Export project as JSON file with test plans in background job
ProjectsApi	ExportProjectWithTestPlansZip	Post /api/v2/projects/{id}/export/testPlans/zip	Export project as Zip file with test plans in background job
ProjectsApi	ExportProjectZip	Post /api/v2/projects/{id}/export/zip	Export project as Zip file in background job
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	GetAttributeByProjectId	Get /api/v2/projects/{id}/attributes/{attributeId}	Get project attribute
ProjectsApi	GetAttributesByProjectId	Get /api/v2/projects/{id}/attributes	Get project attributes
ProjectsApi	GetAutoTestsNamespaces	Get /api/v2/projects/{id}/autoTestsNamespaces	Get namespaces of autotests in project
ProjectsApi	GetConfigurationsByProjectId	Get /api/v2/projects/{id}/configurations	Get project configurations
ProjectsApi	GetCustomAttributeTestPlanProjectRelations	Get /api/v2/projects/{id}/testPlans/attributes	Get project's test plan attributes
ProjectsApi	GetProjectById	Get /api/v2/projects/{id}	Get project by ID
ProjectsApi	GetSectionsByProjectId	Get /api/v2/projects/{id}/sections	Get project sections
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	GetWorkItemsByProjectId	Get /api/v2/projects/{id}/workItems	Get project work items
ProjectsApi	ImportToExistingProject	Post /api/v2/projects/{id}/import	Import project from JSON file into existing project
ProjectsApi	RestoreProject	Post /api/v2/projects/{id}/restore	Restore project
ProjectsApi	SearchAttributesInProject	Post /api/v2/projects/{id}/attributes/search	Search for attributes used in the project
ProjectsApi	SearchTestPlanAttributesInProject	Post /api/v2/projects/{id}/testPlans/attributes/search	Search for attributes used in the project test plans
ProjectsApi	UpdateCustomAttributeTestPlanProjectRelations	Put /api/v2/projects/{id}/testPlans/attribute	Update attribute of project's test plans
ProjectsApi	UpdateProject	Put /api/v2/projects	Update project
ProjectsApi	UpdateProjectsAttribute	Put /api/v2/projects/{id}/attributes	Edit attribute of the project
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	ApiV2TagsGet	Get /api/v2/tags	Get all 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	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	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	ApiV2TestRunsSearchPost	Post /api/v2/testRuns/search	Search for 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	CreateTestSuite	Post /api/v2/testSuites	Create TestSuite
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	GetWorkItemsById	Get /api/v2/testSuites/{id}/workItems
TestSuitesApi	SearchWorkItems	Post /api/v2/testSuites/{id}/workItems/search	Search WorkItems
TestSuitesApi	SetConfigurationsByTestSuiteId	Post /api/v2/testSuites/{id}/configurations	Set Configurations By TestSuite Id
TestSuitesApi	SetWorkItemsByTestSuiteId	Post /api/v2/testSuites/{id}/workItems	Set WorkItems By TestSuite Id
TestSuitesApi	UpdateTestSuite	Put /api/v2/testSuites	Update TestSuite
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
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 workitems
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 workitem 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.