TestIT.ApiClient
2.4.0
See the version list below for details.
dotnet add package TestIT.ApiClient --version 2.4.0
NuGet\Install-Package TestIT.ApiClient -Version 2.4.0
<PackageReference Include="TestIT.ApiClient" Version="2.4.0" />
paket add TestIT.ApiClient --version 2.4.0
#r "nuget: TestIT.ApiClient, 2.4.0"
// Install TestIT.ApiClient as a Cake Addin #addin nuget:?package=TestIT.ApiClient&version=2.4.0 // Install TestIT.ApiClient as a Cake Tool #tool nuget:?package=TestIT.ApiClient&version=2.4.0
Api client for Test IT TMS
Getting Started
Compatibility
Test IT | API Client |
---|---|
3.3 | 1.0 |
3.4 | 1.1 |
3.5 | 1.2 |
3.9 | 2.0 |
4.0 | 2.1 |
4.2 | 2.2 |
4.3 | 2.3 |
4.4 | 2.4 |
<a name="frameworks-supported"></a>
Frameworks supported
- .NET Core >=1.0
- .NET Framework >=4.6
<a name="installation"></a>
Installation
NuGet CLI
Install-Package TestIt.ApiClient
.NET CLI
dotnet package add TestIt.ApiClient
<a name="examples"></a>
Examples
Please follow the installation instruction and execute the following C# code:
To use the API client with a HTTP proxy, setup a System.Net.WebProxy
Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;
<a name="getting-started"></a>
Getting Started
using System.Collections.Generic;
using System.Diagnostics;
using TestIt.Client.Api;
using TestIt.Client.Client;
using TestIt.Client.Model;
namespace Example
{
public class Example
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "Your TMS address";
config.AddApiKeyPrefix("Authorization","PrivateToken");
config.AddApiKey("Authorization","Your private token");
var apiInstance = new AttachmentsApi(config);
var id = "id_example"; // Guid |
try
{
// Delete attachment file
apiInstance.ApiV2AttachmentsIdDelete(id);
}
catch (ApiException e)
{
Debug.Print("Exception when calling AttachmentsApi.ApiV2AttachmentsIdDelete: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
<a name="documentation-for-api-endpoints"></a>
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 | 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 |
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 | 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 | 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 | ApiV2ProjectsIdTestPlansPurgeBulkPost | POST /api/v2/projects/{id}/testPlans/purge/bulk | Permanently delete multiple archived test plans |
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 | 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 | 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 | 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 | DeleteProjectAutoTests | DELETE /api/v2/projects/{id}/autoTests | Delete all autotests from 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 | Import | POST /api/v2/projects/import | Import project from JSON file |
ProjectsApi | ImportToExistingProject | POST /api/v2/projects/{id}/import | Import project from JSON file into existing 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 |
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 | 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 | 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 | 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 | 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 |
<a name="documentation-for-models"></a>
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.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- JsonSubTypes (>= 2.0.1)
- Newtonsoft.Json (>= 13.0.3)
- Polly (>= 7.2.3)
- System.ComponentModel.Annotations (>= 5.0.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on TestIT.ApiClient:
Package | Downloads |
---|---|
TestIT.Adapter.Core
Test IT Core adapter |
GitHub repositories
This package is not used by any popular GitHub repositories.