# ProjectsApi All URIs are relative to *http://localhost* | Method | HTTP request | Description | |------------- | ------------- | -------------| | [**addGlobaAttributesToProject**](ProjectsApi.md#addGlobaAttributesToProject) | **POST** /api/v2/projects/{id}/globalAttributes | Add global attributes to project | | [**apiV2ProjectsIdAttributesTemplatesSearchPost**](ProjectsApi.md#apiV2ProjectsIdAttributesTemplatesSearchPost) | **POST** /api/v2/projects/{id}/attributes/templates/search | Search for custom attributes templates | | [**apiV2ProjectsIdAttributesTemplatesTemplateIdDelete**](ProjectsApi.md#apiV2ProjectsIdAttributesTemplatesTemplateIdDelete) | **DELETE** /api/v2/projects/{id}/attributes/templates/{templateId} | Delete CustomAttributeTemplate from Project | | [**apiV2ProjectsIdAttributesTemplatesTemplateIdPost**](ProjectsApi.md#apiV2ProjectsIdAttributesTemplatesTemplateIdPost) | **POST** /api/v2/projects/{id}/attributes/templates/{templateId} | Add CustomAttributeTemplate to Project | | [**apiV2ProjectsIdFailureClassesGet**](ProjectsApi.md#apiV2ProjectsIdFailureClassesGet) | **GET** /api/v2/projects/{id}/failureClasses | Get Project FailureClasses | | [**apiV2ProjectsIdFavoritePut**](ProjectsApi.md#apiV2ProjectsIdFavoritePut) | **PUT** /api/v2/projects/{id}/favorite | Mark Project as favorite | | [**apiV2ProjectsIdFiltersGet**](ProjectsApi.md#apiV2ProjectsIdFiltersGet) | **GET** /api/v2/projects/{id}/filters | Get Project filters | | [**apiV2ProjectsIdPatch**](ProjectsApi.md#apiV2ProjectsIdPatch) | **PATCH** /api/v2/projects/{id} | Patch project | | [**apiV2ProjectsIdTestPlansAnalyticsGet**](ProjectsApi.md#apiV2ProjectsIdTestPlansAnalyticsGet) | **GET** /api/v2/projects/{id}/testPlans/analytics | Get TestPlans analytics | | [**apiV2ProjectsIdTestPlansDeleteBulkPost**](ProjectsApi.md#apiV2ProjectsIdTestPlansDeleteBulkPost) | **POST** /api/v2/projects/{id}/testPlans/delete/bulk | Delete multiple test plans | | [**apiV2ProjectsIdTestPlansNameExistsGet**](ProjectsApi.md#apiV2ProjectsIdTestPlansNameExistsGet) | **GET** /api/v2/projects/{id}/testPlans/{name}/exists | Checks if TestPlan exists with the specified name exists for the project | | [**apiV2ProjectsIdTestPlansRestoreBulkPost**](ProjectsApi.md#apiV2ProjectsIdTestPlansRestoreBulkPost) | **POST** /api/v2/projects/{id}/testPlans/restore/bulk | Restore multiple test plans | | [**apiV2ProjectsIdTestPlansSearchPost**](ProjectsApi.md#apiV2ProjectsIdTestPlansSearchPost) | **POST** /api/v2/projects/{id}/testPlans/search | Get Project TestPlans with analytics | | [**apiV2ProjectsIdTestRunsActiveGet**](ProjectsApi.md#apiV2ProjectsIdTestRunsActiveGet) | **GET** /api/v2/projects/{id}/testRuns/active | Get active Project TestRuns | | [**apiV2ProjectsIdTestRunsFullGet**](ProjectsApi.md#apiV2ProjectsIdTestRunsFullGet) | **GET** /api/v2/projects/{id}/testRuns/full | Get Project TestRuns full models | | [**apiV2ProjectsIdWorkItemsSearchIdPost**](ProjectsApi.md#apiV2ProjectsIdWorkItemsSearchIdPost) | **POST** /api/v2/projects/{id}/workItems/search/id | Search for work items and extract IDs only | | [**apiV2ProjectsIdWorkItemsSearchPost**](ProjectsApi.md#apiV2ProjectsIdWorkItemsSearchPost) | **POST** /api/v2/projects/{id}/workItems/search | Search for work items | | [**apiV2ProjectsIdWorkItemsTagsGet**](ProjectsApi.md#apiV2ProjectsIdWorkItemsTagsGet) | **GET** /api/v2/projects/{id}/workItems/tags | Get WorkItems Tags | | [**apiV2ProjectsNameNameExistsGet**](ProjectsApi.md#apiV2ProjectsNameNameExistsGet) | **GET** /api/v2/projects/name/{name}/exists | | | [**apiV2ProjectsSearchPost**](ProjectsApi.md#apiV2ProjectsSearchPost) | **POST** /api/v2/projects/search | Search for projects | | [**backgroundImportProject**](ProjectsApi.md#backgroundImportProject) | **POST** /api/v2/projects/import/json | Import project from JSON file in background job | | [**backgroundImportToExistingProject**](ProjectsApi.md#backgroundImportToExistingProject) | **POST** /api/v2/projects/{id}/import/json | Import project from JSON file into existing project in background job | | [**backgroundImportZipProject**](ProjectsApi.md#backgroundImportZipProject) | **POST** /api/v2/projects/import/zip | Import project from Zip file in background job | | [**backgroundImportZipToExistingProject**](ProjectsApi.md#backgroundImportZipToExistingProject) | **POST** /api/v2/projects/{id}/import/zip | Import project from Zip file into existing project in background job | | [**createCustomAttributeTestPlanProjectRelations**](ProjectsApi.md#createCustomAttributeTestPlanProjectRelations) | **POST** /api/v2/projects/{id}/testPlans/attributes | Add attributes to project's test plans | | [**createProject**](ProjectsApi.md#createProject) | **POST** /api/v2/projects | Create project | | [**createProjectsAttribute**](ProjectsApi.md#createProjectsAttribute) | **POST** /api/v2/projects/{id}/attributes | Create project attribute | | [**deleteCustomAttributeTestPlanProjectRelations**](ProjectsApi.md#deleteCustomAttributeTestPlanProjectRelations) | **DELETE** /api/v2/projects/{id}/testPlans/attribute/{attributeId} | Delete attribute from project's test plans | | [**deleteProject**](ProjectsApi.md#deleteProject) | **DELETE** /api/v2/projects/{id} | Delete project | | [**deleteProjectAutoTests**](ProjectsApi.md#deleteProjectAutoTests) | **DELETE** /api/v2/projects/{id}/autoTests | Delete project | | [**deleteProjectsAttribute**](ProjectsApi.md#deleteProjectsAttribute) | **DELETE** /api/v2/projects/{id}/attributes/{attributeId} | Delete project attribute | | [**export**](ProjectsApi.md#export) | **POST** /api/v2/projects/{id}/export | Export project as JSON file | | [**exportProjectJson**](ProjectsApi.md#exportProjectJson) | **POST** /api/v2/projects/{id}/export/json | Export project as JSON file in background job | | [**exportProjectWithTestPlansJson**](ProjectsApi.md#exportProjectWithTestPlansJson) | **POST** /api/v2/projects/{id}/export/testPlans/json | Export project as JSON file with test plans in background job | | [**exportProjectWithTestPlansZip**](ProjectsApi.md#exportProjectWithTestPlansZip) | **POST** /api/v2/projects/{id}/export/testPlans/zip | Export project as Zip file with test plans in background job | | [**exportProjectZip**](ProjectsApi.md#exportProjectZip) | **POST** /api/v2/projects/{id}/export/zip | Export project as Zip file in background job | | [**exportWithTestPlansAndConfigurations**](ProjectsApi.md#exportWithTestPlansAndConfigurations) | **POST** /api/v2/projects/{id}/export-by-testPlans | Export project with test plans, test suites and test points as JSON file | | [**getAllProjects**](ProjectsApi.md#getAllProjects) | **GET** /api/v2/projects | Get all projects | | [**getAttributeByProjectId**](ProjectsApi.md#getAttributeByProjectId) | **GET** /api/v2/projects/{id}/attributes/{attributeId} | Get project attribute | | [**getAttributesByProjectId**](ProjectsApi.md#getAttributesByProjectId) | **GET** /api/v2/projects/{id}/attributes | Get project attributes | | [**getAutoTestsNamespaces**](ProjectsApi.md#getAutoTestsNamespaces) | **GET** /api/v2/projects/{id}/autoTestsNamespaces | Get namespaces of autotests in project | | [**getConfigurationsByProjectId**](ProjectsApi.md#getConfigurationsByProjectId) | **GET** /api/v2/projects/{id}/configurations | Get project configurations | | [**getCustomAttributeTestPlanProjectRelations**](ProjectsApi.md#getCustomAttributeTestPlanProjectRelations) | **GET** /api/v2/projects/{id}/testPlans/attributes | Get project's test plan attributes | | [**getProjectById**](ProjectsApi.md#getProjectById) | **GET** /api/v2/projects/{id} | Get project by ID | | [**getSectionsByProjectId**](ProjectsApi.md#getSectionsByProjectId) | **GET** /api/v2/projects/{id}/sections | Get project sections | | [**getTestPlansByProjectId**](ProjectsApi.md#getTestPlansByProjectId) | **GET** /api/v2/projects/{id}/testPlans | Get project test plans | | [**getTestRunsByProjectId**](ProjectsApi.md#getTestRunsByProjectId) | **GET** /api/v2/projects/{id}/testRuns | Get project test runs | | [**getWorkItemsByProjectId**](ProjectsApi.md#getWorkItemsByProjectId) | **GET** /api/v2/projects/{id}/workItems | Get project work items | | [**import**](ProjectsApi.md#import) | **POST** /api/v2/projects/import | Import project from JSON file | | [**importToExistingProject**](ProjectsApi.md#importToExistingProject) | **POST** /api/v2/projects/{id}/import | Import project from JSON file into existing project | | [**restoreProject**](ProjectsApi.md#restoreProject) | **POST** /api/v2/projects/{id}/restore | Restore project | | [**searchAttributesInProject**](ProjectsApi.md#searchAttributesInProject) | **POST** /api/v2/projects/{id}/attributes/search | Search for attributes used in the project | | [**searchTestPlanAttributesInProject**](ProjectsApi.md#searchTestPlanAttributesInProject) | **POST** /api/v2/projects/{id}/testPlans/attributes/search | Search for attributes used in the project test plans | | [**updateCustomAttributeTestPlanProjectRelations**](ProjectsApi.md#updateCustomAttributeTestPlanProjectRelations) | **PUT** /api/v2/projects/{id}/testPlans/attribute | Update attribute of project's test plans | | [**updateProject**](ProjectsApi.md#updateProject) | **PUT** /api/v2/projects | Update project | | [**updateProjectsAttribute**](ProjectsApi.md#updateProjectsAttribute) | **PUT** /api/v2/projects/{id}/attributes | Edit attribute of the project | # **addGlobaAttributesToProject** > addGlobaAttributesToProject(id, request\_body) Add global attributes to project <br>Use case <br>User sets project internal or global identifier and attributes identifiers <br>System search project <br>System relates global attributes with project <br>System returns no content response ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **request\_body** | [**Set**](../Models/UUID.md)| | [optional] | ### Return type null (empty response body) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **apiV2ProjectsIdAttributesTemplatesSearchPost** > List apiV2ProjectsIdAttributesTemplatesSearchPost(id, Skip, Take, OrderBy, SearchField, SearchValue, ProjectCustomAttributesTemplatesFilterModel) Search for custom attributes templates ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| | [default to null] | | **Skip** | **Integer**| Amount of items to be skipped (offset) | [optional] [default to null] | | **Take** | **Integer**| Amount of items to be taken (limit) | [optional] [default to null] | | **OrderBy** | **String**| SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] [default to null] | | **SearchField** | **String**| Property name for searching | [optional] [default to null] | | **SearchValue** | **String**| Value for searching | [optional] [default to null] | | **ProjectCustomAttributesTemplatesFilterModel** | [**ProjectCustomAttributesTemplatesFilterModel**](../Models/ProjectCustomAttributesTemplatesFilterModel.md)| | [optional] | ### Return type [**List**](../Models/ProjectCustomAttributeTemplateGetModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **apiV2ProjectsIdAttributesTemplatesTemplateIdDelete** > apiV2ProjectsIdAttributesTemplatesTemplateIdDelete(id, templateId) Delete CustomAttributeTemplate from Project <br>Use case <br>User sets project internal or global identifier <br>User sets attribute template internal identifier <br>User runs method execution <br>System delete attribute template from project ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **templateId** | **UUID**| CustomAttributeTemplate internal (UUID) identifier | [default to null] | ### Return type null (empty response body) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **apiV2ProjectsIdAttributesTemplatesTemplateIdPost** > apiV2ProjectsIdAttributesTemplatesTemplateIdPost(id, templateId) Add CustomAttributeTemplate to Project <br>Use case <br>User sets project internal or global identifier <br>User sets attribute template internal identifier <br>User runs method execution <br>System add attribute template to project ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **templateId** | **UUID**| CustomAttributeTemplate internal (UUID) identifier | [default to null] | ### Return type null (empty response body) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **apiV2ProjectsIdFailureClassesGet** > List apiV2ProjectsIdFailureClassesGet(id, isDeleted) Get Project FailureClasses <br>Use case <br>User sets project internal or global identifier <br>User runs method execution <br>System returns project failre classes ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **isDeleted** | **Boolean**| | [optional] [default to null] | ### Return type [**List**](../Models/FailureClassModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **apiV2ProjectsIdFavoritePut** > apiV2ProjectsIdFavoritePut(id) Mark Project as favorite ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | ### Return type null (empty response body) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **apiV2ProjectsIdFiltersGet** > List apiV2ProjectsIdFiltersGet(id) Get Project filters <br>Use case <br>User sets project internal or global identifier <br>User runs method execution <br>System returns project filters ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | ### Return type [**List**](../Models/FilterModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **apiV2ProjectsIdPatch** > apiV2ProjectsIdPatch(id, Operation) Patch project See <a href=\"https://www.rfc-editor.org/rfc/rfc6902\" target=\"_blank\">RFC 6902: JavaScript Object Notation (JSON) Patch</a> for details ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **UUID**| Unique or global Id of project | [default to null] | | **Operation** | [**List**](../Models/Operation.md)| | [optional] | ### Return type null (empty response body) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **apiV2ProjectsIdTestPlansAnalyticsGet** > List apiV2ProjectsIdTestPlansAnalyticsGet(id, isDeleted, mustUpdateCache, Skip, Take, OrderBy, SearchField, SearchValue) Get TestPlans analytics <br>Use case <br>User sets project internal identifier <br>User sets query params <br>User runs method execution <br>System return analytics ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **UUID**| Project internal (UUID) identifier | [default to null] | | **isDeleted** | **Boolean**| | [optional] [default to null] | | **mustUpdateCache** | **Boolean**| | [optional] [default to false] | | **Skip** | **Integer**| Amount of items to be skipped (offset) | [optional] [default to null] | | **Take** | **Integer**| Amount of items to be taken (limit) | [optional] [default to null] | | **OrderBy** | **String**| SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] [default to null] | | **SearchField** | **String**| Property name for searching | [optional] [default to null] | | **SearchValue** | **String**| Value for searching | [optional] [default to null] | ### Return type [**List**](../Models/TestPlanWithAnalyticModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **apiV2ProjectsIdTestPlansDeleteBulkPost** > List apiV2ProjectsIdTestPlansDeleteBulkPost(id, ProjectTestPlansFilterModel) Delete multiple test plans ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Unique or global ID of the project | [default to null] | | **ProjectTestPlansFilterModel** | [**ProjectTestPlansFilterModel**](../Models/ProjectTestPlansFilterModel.md)| | [optional] | ### Return type **List** ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **apiV2ProjectsIdTestPlansNameExistsGet** > Boolean apiV2ProjectsIdTestPlansNameExistsGet(id, name) Checks if TestPlan exists with the specified name exists for the project <br>Use case <br>User sets project internal or global identifier <br>User runs method execution <br>System purge delete project workitems ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **UUID**| Project internal (UUID) or global (integer) identifier | [default to null] | | **name** | **String**| TestPlan name to check | [default to null] | ### Return type **Boolean** ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **apiV2ProjectsIdTestPlansRestoreBulkPost** > apiV2ProjectsIdTestPlansRestoreBulkPost(id, ProjectTestPlansFilterModel) Restore multiple test plans ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Unique or global ID of the project | [default to null] | | **ProjectTestPlansFilterModel** | [**ProjectTestPlansFilterModel**](../Models/ProjectTestPlansFilterModel.md)| | [optional] | ### Return type null (empty response body) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **apiV2ProjectsIdTestPlansSearchPost** > List apiV2ProjectsIdTestPlansSearchPost(id, mustUpdateCache, Skip, Take, OrderBy, SearchField, SearchValue, ProjectTestPlansFilterModel) Get Project TestPlans with analytics <br>Use case <br>User sets project internal or global identifier <br>User sets request body <br>User runs method execution <br>System returns project testplans with analytics ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **mustUpdateCache** | **Boolean**| | [optional] [default to false] | | **Skip** | **Integer**| Amount of items to be skipped (offset) | [optional] [default to null] | | **Take** | **Integer**| Amount of items to be taken (limit) | [optional] [default to null] | | **OrderBy** | **String**| SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] [default to null] | | **SearchField** | **String**| Property name for searching | [optional] [default to null] | | **SearchValue** | **String**| Value for searching | [optional] [default to null] | | **ProjectTestPlansFilterModel** | [**ProjectTestPlansFilterModel**](../Models/ProjectTestPlansFilterModel.md)| | [optional] | ### Return type [**List**](../Models/TestPlanWithAnalyticModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **apiV2ProjectsIdTestRunsActiveGet** > List apiV2ProjectsIdTestRunsActiveGet(id) Get active Project TestRuns <br>Use case <br>User sets project internal or global identifier <br>User runs method execution <br>System returns active testruns ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | ### Return type [**List**](../Models/PublicTestRunModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **apiV2ProjectsIdTestRunsFullGet** > List apiV2ProjectsIdTestRunsFullGet(id, includeTestResults, mustAggregateTestResults, notStarted, inProgress, stopped, completed, createdDateFrom, createdDateTo, testPlanId, Skip, Take, OrderBy, SearchField, SearchValue) Get Project TestRuns full models <br>Use case <br>User sets project internal or global identifier <br>User sets query params <br>User runs method execution <br>System returns project test runs full models ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **includeTestResults** | **Boolean**| | [optional] [default to false] | | **mustAggregateTestResults** | **Boolean**| | [optional] [default to true] | | **notStarted** | **Boolean**| | [optional] [default to null] | | **inProgress** | **Boolean**| | [optional] [default to null] | | **stopped** | **Boolean**| | [optional] [default to null] | | **completed** | **Boolean**| | [optional] [default to null] | | **createdDateFrom** | **Date**| | [optional] [default to null] | | **createdDateTo** | **Date**| | [optional] [default to null] | | **testPlanId** | **UUID**| | [optional] [default to null] | | **Skip** | **Integer**| Amount of items to be skipped (offset) | [optional] [default to null] | | **Take** | **Integer**| Amount of items to be taken (limit) | [optional] [default to null] | | **OrderBy** | **String**| SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] [default to null] | | **SearchField** | **String**| Property name for searching | [optional] [default to null] | | **SearchValue** | **String**| Value for searching | [optional] [default to null] | ### Return type [**List**](../Models/TestRunModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **apiV2ProjectsIdWorkItemsSearchIdPost** > List apiV2ProjectsIdWorkItemsSearchIdPost(id, Skip, Take, OrderBy, SearchField, SearchValue, WorkItemSelectModel) Search for work items and extract IDs only ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Unique or global ID of the project | [default to null] | | **Skip** | **Integer**| Amount of items to be skipped (offset) | [optional] [default to null] | | **Take** | **Integer**| Amount of items to be taken (limit) | [optional] [default to null] | | **OrderBy** | **String**| SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] [default to null] | | **SearchField** | **String**| Property name for searching | [optional] [default to null] | | **SearchValue** | **String**| Value for searching | [optional] [default to null] | | **WorkItemSelectModel** | [**WorkItemSelectModel**](../Models/WorkItemSelectModel.md)| | [optional] | ### Return type **List** ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **apiV2ProjectsIdWorkItemsSearchPost** > List apiV2ProjectsIdWorkItemsSearchPost(id, Skip, Take, OrderBy, SearchField, SearchValue, WorkItemSelectModel) Search for work items ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Unique or global ID of the project | [default to null] | | **Skip** | **Integer**| Amount of items to be skipped (offset) | [optional] [default to null] | | **Take** | **Integer**| Amount of items to be taken (limit) | [optional] [default to null] | | **OrderBy** | **String**| SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] [default to null] | | **SearchField** | **String**| Property name for searching | [optional] [default to null] | | **SearchValue** | **String**| Value for searching | [optional] [default to null] | | **WorkItemSelectModel** | [**WorkItemSelectModel**](../Models/WorkItemSelectModel.md)| | [optional] | ### Return type [**List**](../Models/WorkItemShortModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **apiV2ProjectsIdWorkItemsTagsGet** > List apiV2ProjectsIdWorkItemsTagsGet(id, isDeleted) Get WorkItems Tags <br>Use case <br>User sets project internal identifier <br>User runs method execution <br>System returns work items tags ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **UUID**| Project internal (UUID) identifier | [default to null] | | **isDeleted** | **Boolean**| | [optional] [default to null] | ### Return type [**List**](../Models/TagShortModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **apiV2ProjectsNameNameExistsGet** > Boolean apiV2ProjectsNameNameExistsGet(name) ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **name** | **String**| | [default to null] | ### Return type **Boolean** ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **apiV2ProjectsSearchPost** > List apiV2ProjectsSearchPost(Skip, Take, OrderBy, SearchField, SearchValue, ProjectsFilterModel) Search for projects ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **Skip** | **Integer**| Amount of items to be skipped (offset) | [optional] [default to null] | | **Take** | **Integer**| Amount of items to be taken (limit) | [optional] [default to null] | | **OrderBy** | **String**| SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] [default to null] | | **SearchField** | **String**| Property name for searching | [optional] [default to null] | | **SearchValue** | **String**| Value for searching | [optional] [default to null] | | **ProjectsFilterModel** | [**ProjectsFilterModel**](../Models/ProjectsFilterModel.md)| | [optional] | ### Return type [**List**](../Models/ProjectModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **backgroundImportProject** > UUID backgroundImportProject(file) Import project from JSON file in background job ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **file** | **File**| | [optional] [default to null] | ### Return type **UUID** ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: multipart/form-data, application/json - **Accept**: application/json # **backgroundImportToExistingProject** > UUID backgroundImportToExistingProject(id, file) Import project from JSON file into existing project in background job ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **file** | **File**| Select file | [optional] [default to null] | ### Return type **UUID** ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: multipart/form-data - **Accept**: application/json # **backgroundImportZipProject** > UUID backgroundImportZipProject(file) Import project from Zip file in background job ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **file** | **File**| | [optional] [default to null] | ### Return type **UUID** ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: multipart/form-data, application/json - **Accept**: application/json # **backgroundImportZipToExistingProject** > UUID backgroundImportZipToExistingProject(id, file) Import project from Zip file into existing project in background job ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **file** | **File**| Select file | [optional] [default to null] | ### Return type **UUID** ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: multipart/form-data - **Accept**: application/json # **createCustomAttributeTestPlanProjectRelations** > createCustomAttributeTestPlanProjectRelations(id, request\_body) Add attributes to project's test plans <br>Use case <br>User sets project internal or global identifier and attributes identifiers <br>User runs method execution <br>System updates project and add attributes to project for test plans <br>System returns no content response ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **request\_body** | [**Set**](../Models/UUID.md)| | [optional] | ### Return type null (empty response body) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **createProject** > ProjectModel createProject(ProjectPostModel) Create project <br>Use case <br>User sets project parameters (listed in request example) and runs method execution <br>System creates project <br>System returns project model (example listed in response parameters) ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **ProjectPostModel** | [**ProjectPostModel**](../Models/ProjectPostModel.md)| | [optional] | ### Return type [**ProjectModel**](../Models/ProjectModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **createProjectsAttribute** > CustomAttributeModel createProjectsAttribute(id, CustomAttributePostModel) Create project attribute <br>Use case <br>User sets attribute parameters (listed in request example) and runs method execution <br>System search project <br>System creates attribute and relates it to the project <br>System returns project attribute properties (example listed in response parameters) ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **CustomAttributePostModel** | [**CustomAttributePostModel**](../Models/CustomAttributePostModel.md)| | [optional] | ### Return type [**CustomAttributeModel**](../Models/CustomAttributeModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **deleteCustomAttributeTestPlanProjectRelations** > deleteCustomAttributeTestPlanProjectRelations(id, attributeId) Delete attribute from project's test plans <br>Use case <br>User sets project internal or global identifier and attribute identifier <br>User runs method execution <br>System updates project and delete attribute from project for test plans <br>System returns no content response ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **attributeId** | **UUID**| | [default to null] | ### Return type null (empty response body) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **deleteProject** > deleteProject(id) Delete project <br>Use case: <br>1. User sets project internal or global identifier and runs method execution <br>2. System searches and moves requested project to archive <br>3. System responds with no content (204) result ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | ### Return type null (empty response body) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **deleteProjectAutoTests** > deleteProjectAutoTests(id) Delete project <br>Use case <br>User sets project internal or global identifier <br>User runs method execution <br>System delete all autotests from project <br>System returns no content response ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | ### Return type null (empty response body) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **deleteProjectsAttribute** > deleteProjectsAttribute(id, attributeId) Delete project attribute <br>Use case <br>User sets project identifier and runs method execution <br>User sets attribute identifier <br>User runs method execution <br>System search project <br>System search and delete attribute <br>System returns no content response ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **attributeId** | **UUID**| Project attribute internal (UUID) | [default to null] | ### Return type null (empty response body) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **export** > File export(id, includeAttachments, ProjectExportQueryModel) Export project as JSON file <br>This method exports the selected project or its part (sections, work items) to a `.json` file. <br>In the request body, you can specify sections and test cases to be exported. <br>Example of a request to export two sections and two test cases: <br> ``` curl -X POST \"http://{domain}.com/api/v2/projects/27a32ce6-d972-4ef8-bef5-51be4bf9e468/export\" \\ -H \"accept: application/json\" -H \"Authorization: PrivateToken {token}\" -H \"Content-Type: application/json-patch+json\" \\ -d \"{\\\"sectionIds\\\":[\\\"3fa85f64-5717-4562-b3fc-2c963f66afa6\\\",\\\"9fa85f64-5717-4562-b3fc-2c963f66a000\\\"],\\\"workItemIds\\\":[\\\"3fa85f64-5717-4562-b3fc-2c963f66afa6\\\",\\\"90085f64-5717-4562-b3fc-2c963f66a000\\\"]}\" ``` <br>In the response, you get: <br> - A `.zip` file with attachments and a.json file if you enable attachments export.<br /> - A `.json` file with the project if you do not enable attachments export. ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Specifies the ID of the project you want to export. | [default to null] | | **includeAttachments** | **Boolean**| Enables attachment export. | [optional] [default to false] | | **ProjectExportQueryModel** | [**ProjectExportQueryModel**](../Models/ProjectExportQueryModel.md)| | [optional] | ### Return type **File** ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **exportProjectJson** > UUID exportProjectJson(id, time-Zone-Offset-In-Minutes, ProjectExportQueryModel) Export project as JSON file in background job ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **time-Zone-Offset-In-Minutes** | **Long**| | [optional] [default to null] | | **ProjectExportQueryModel** | [**ProjectExportQueryModel**](../Models/ProjectExportQueryModel.md)| | [optional] | ### Return type **UUID** ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **exportProjectWithTestPlansJson** > UUID exportProjectWithTestPlansJson(id, time-Zone-Offset-In-Minutes, ProjectExportWithTestPlansPostModel) Export project as JSON file with test plans in background job ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **time-Zone-Offset-In-Minutes** | **Long**| | [optional] [default to null] | | **ProjectExportWithTestPlansPostModel** | [**ProjectExportWithTestPlansPostModel**](../Models/ProjectExportWithTestPlansPostModel.md)| | [optional] | ### Return type **UUID** ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **exportProjectWithTestPlansZip** > UUID exportProjectWithTestPlansZip(id, time-Zone-Offset-In-Minutes, ProjectExportWithTestPlansPostModel) Export project as Zip file with test plans in background job ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **time-Zone-Offset-In-Minutes** | **Long**| | [optional] [default to null] | | **ProjectExportWithTestPlansPostModel** | [**ProjectExportWithTestPlansPostModel**](../Models/ProjectExportWithTestPlansPostModel.md)| | [optional] | ### Return type **UUID** ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **exportProjectZip** > UUID exportProjectZip(id, time-Zone-Offset-In-Minutes, ProjectExportQueryModel) Export project as Zip file in background job ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **time-Zone-Offset-In-Minutes** | **Long**| | [optional] [default to null] | | **ProjectExportQueryModel** | [**ProjectExportQueryModel**](../Models/ProjectExportQueryModel.md)| | [optional] | ### Return type **UUID** ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **exportWithTestPlansAndConfigurations** > File exportWithTestPlansAndConfigurations(id, includeAttachments, ProjectExportWithTestPlansPostModel) Export project with test plans, test suites and test points as JSON file <br> <b>You cannot export test cases execution history.</b> <br>This method exports the project with the test library and specified test plans to another TMS instance. <br> After sending a correct request, the project is exported to a `.json` file. If you enable attachment export, the `.json` file and the attachments are placed in a `.zip` file. You can import such a project by using the `POST /api/v2/projects/import` method. ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Specifies the ID of the project you want to export. | [default to null] | | **includeAttachments** | **Boolean**| Enables attachment export. | [optional] [default to false] | | **ProjectExportWithTestPlansPostModel** | [**ProjectExportWithTestPlansPostModel**](../Models/ProjectExportWithTestPlansPostModel.md)| | [optional] | ### Return type **File** ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **getAllProjects** > List getAllProjects(isDeleted, projectName, Skip, Take, OrderBy, SearchField, SearchValue) Get all projects <br>Use case <br>[Optional] User sets isDeleted field value <br>[Optional] If User sets isDeleted field value as true, System search all deleted projects <br>[Optional] If User sets isDeleted field value as false, System search all projects which are not deleted <br>If User did not set isDeleted field value, System search all projects <br>System returns array of all found projects(listed in response model) ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **isDeleted** | **Boolean**| If result must consist of only actual/deleted parameters | [optional] [default to null] | | **projectName** | **String**| | [optional] [default to null] | | **Skip** | **Integer**| Amount of items to be skipped (offset) | [optional] [default to null] | | **Take** | **Integer**| Amount of items to be taken (limit) | [optional] [default to null] | | **OrderBy** | **String**| SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] [default to null] | | **SearchField** | **String**| Property name for searching | [optional] [default to null] | | **SearchValue** | **String**| Value for searching | [optional] [default to null] | ### Return type [**List**](../Models/ProjectModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getAttributeByProjectId** > CustomAttributeModel getAttributeByProjectId(id, attributeId) Get project attribute <br>Use case <br>User sets project internal or global identifier <br>User sets project attribute identifier <br>User runs method execution <br>System search project <br>System search project attribute <br>System returns project attribute (listed in response model) ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **attributeId** | **UUID**| Project attribute internal (UUID) or global (integer) identifier | [default to null] | ### Return type [**CustomAttributeModel**](../Models/CustomAttributeModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getAttributesByProjectId** > List getAttributesByProjectId(id, isDeleted) Get project attributes <br>Use case <br>User sets project internal or global identifier <br>[Optional] User sets isDeleted field value <br>User runs method execution <br>System search project <br>[Optional] If User sets isDeleted field value as true, System search all deleted attributes related to project <br>[Optional] If User sets isDeleted field value as false, System search all attributes related to project which are not deleted <br>[Optional] If User did not set isDeleted field value, System search all attributes related to project <br>System returns array of found attributes (listed in response model) ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **isDeleted** | [**DeletionState**](../Models/.md)| | [optional] [default to null] [enum: Any, Deleted, NotDeleted] | ### Return type [**List**](../Models/CustomAttributeModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getAutoTestsNamespaces** > List getAutoTestsNamespaces(id) Get namespaces of autotests in project <br>Use case <br>User sets project internal or global identifier and runs method execution <br>System search project <br>System search all autotest related to the project <br>System returns array of autotest with namespaces and classnames (listed in response) ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | ### Return type [**List**](../Models/AutoTestNamespaceModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getConfigurationsByProjectId** > List getConfigurationsByProjectId(id) Get project configurations <br>Use case <br>User sets project internal or global identifier <br>User runs method execution <br>System search project <br>System search all configurations related to project <br>System returns array of found configurations (listed in response model) ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | ### Return type [**List**](../Models/ConfigurationModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getCustomAttributeTestPlanProjectRelations** > List getCustomAttributeTestPlanProjectRelations(id) Get project's test plan attributes <br>Use case <br>User runs method execution <br>System returns project for test plans attributes by project identifier ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | ### Return type [**List**](../Models/CustomAttributeModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getProjectById** > ProjectModel getProjectById(id) Get project by ID <br>Use case <br>User sets project internal or global identifier and runs method execution <br>System search project <br>System returns project (example listed in response parameters) ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | ### Return type [**ProjectModel**](../Models/ProjectModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getSectionsByProjectId** > List getSectionsByProjectId(id, Skip, Take, OrderBy, SearchField, SearchValue) Get project sections <br>Use case <br>User sets project internal or global identifier and runs method execution <br>System search project <br>System search all sections related to the project <br>System returns array of sections (listed in response) ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **Skip** | **Integer**| Amount of items to be skipped (offset) | [optional] [default to null] | | **Take** | **Integer**| Amount of items to be taken (limit) | [optional] [default to null] | | **OrderBy** | **String**| SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] [default to null] | | **SearchField** | **String**| Property name for searching | [optional] [default to null] | | **SearchValue** | **String**| Value for searching | [optional] [default to null] | ### Return type [**List**](../Models/SectionModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getTestPlansByProjectId** > List getTestPlansByProjectId(id, isDeleted) Get project test plans <br>Use case <br>User sets project internal or global identifier <br>[Optional] User sets isDeleted field value <br>User runs method execution <br>System search project <br>[Optional] If User sets isDeleted field value as true, System search all deleted test plans related to project <br>[Optional] If User sets isDeleted field value as false, System search all test plans related to project which are not deleted <br>[Optional] If User did not set isDeleted field value, System search all v related to project <br>System returns array of found test plans (listed in response model) ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **isDeleted** | **Boolean**| If result must consist of only actual/archived test plans | [optional] [default to null] | ### Return type [**List**](../Models/TestPlanModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getTestRunsByProjectId** > List getTestRunsByProjectId(id, notStarted, inProgress, stopped, completed, createdDateFrom, createdDateTo, testPlanId, Skip, Take, OrderBy, SearchField, SearchValue) Get project test runs <br>Use case <br>User sets project internal or global identifier <br>User runs method execution <br>System search project <br>System search all test runs related to project <br>System returns array of found test runs (listed in response model) ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **notStarted** | **Boolean**| | [optional] [default to null] | | **inProgress** | **Boolean**| | [optional] [default to null] | | **stopped** | **Boolean**| | [optional] [default to null] | | **completed** | **Boolean**| | [optional] [default to null] | | **createdDateFrom** | **Date**| | [optional] [default to null] | | **createdDateTo** | **Date**| | [optional] [default to null] | | **testPlanId** | **UUID**| | [optional] [default to null] | | **Skip** | **Integer**| Amount of items to be skipped (offset) | [optional] [default to null] | | **Take** | **Integer**| Amount of items to be taken (limit) | [optional] [default to null] | | **OrderBy** | **String**| SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] [default to null] | | **SearchField** | **String**| Property name for searching | [optional] [default to null] | | **SearchValue** | **String**| Value for searching | [optional] [default to null] | ### Return type [**List**](../Models/TestRunV2GetModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getWorkItemsByProjectId** > List getWorkItemsByProjectId(id, isDeleted, tagNames, includeIterations, Skip, Take, OrderBy, SearchField, SearchValue) Get project work items <br>Use case <br>User sets project internal or global identifier <br>[Optional] User sets isDeleted field value <br>User runs method execution <br>System search project <br>[Optional] If User sets isDeleted field value as true, System search all deleted workitems related to project <br>[Optional] If User sets isDeleted field value as false, System search all workitems related to project which are not deleted <br>If User did not set isDeleted field value, System search all workitems related to project <br>System returns array of found workitems (listed in response model) ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **isDeleted** | **Boolean**| If result must consist of only actual/deleted work items | [optional] [default to false] | | **tagNames** | [**List**](../Models/String.md)| List of tags to filter by | [optional] [default to null] | | **includeIterations** | **Boolean**| | [optional] [default to true] | | **Skip** | **Integer**| Amount of items to be skipped (offset) | [optional] [default to null] | | **Take** | **Integer**| Amount of items to be taken (limit) | [optional] [default to null] | | **OrderBy** | **String**| SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] [default to null] | | **SearchField** | **String**| Property name for searching | [optional] [default to null] | | **SearchValue** | **String**| Value for searching | [optional] [default to null] | ### Return type [**List**](../Models/WorkItemShortModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **import** > import(includeAttachments, file) Import project from JSON file <br> <b>A project can only be exported to another TMS instance, different from the one it was imported from.</b> <br>This method imports a `.json` file with a project to the test management system. <br>In the body of the request, send the `.json` file received by the `POST /api/v2/projects/export` method: <br> ``` curl -X POST \"http://{domain.com}/api/v2/projects/import\" \\ -H \"accept: /\" -H \"Authorization: PrivateToken {token}\" -H \"Content-Type: multipart/form-data\" \\ -F \"file=@import.txt;type=text/plain\" ``` <br> In the second instance, a project with the name of the imported one is created. User attributes and the test library (along with content and structure) are imported. <br>Test plan execution history from the first instance of TMS cannot be transferred. ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **includeAttachments** | **Boolean**| Enables attachment import. | [optional] [default to false] | | **file** | **File**| Select file | [optional] [default to null] | ### Return type null (empty response body) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: multipart/form-data - **Accept**: application/json # **importToExistingProject** > importToExistingProject(id, includeAttachments, file) Import project from JSON file into existing project <br>Use case <br>User attaches project as json file taken from export or export-by-testPlans method <br>User runs method execution <br>System updates project <br>System returns no content response ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **includeAttachments** | **Boolean**| | [optional] [default to null] | | **file** | **File**| Select file | [optional] [default to null] | ### Return type null (empty response body) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: multipart/form-data - **Accept**: application/json # **restoreProject** > restoreProject(id) Restore project <br>Use case <br>User sets project internal or global identifier and runs method execution <br>System search and restores deleted project <br>System returns no content response ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | ### Return type null (empty response body) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **searchAttributesInProject** > List searchAttributesInProject(id, Skip, Take, OrderBy, SearchField, SearchValue, ProjectAttributesFilterModel) Search for attributes used in the project ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Unique or global project ID | [default to null] | | **Skip** | **Integer**| Amount of items to be skipped (offset) | [optional] [default to null] | | **Take** | **Integer**| Amount of items to be taken (limit) | [optional] [default to null] | | **OrderBy** | **String**| SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] [default to null] | | **SearchField** | **String**| Property name for searching | [optional] [default to null] | | **SearchValue** | **String**| Value for searching | [optional] [default to null] | | **ProjectAttributesFilterModel** | [**ProjectAttributesFilterModel**](../Models/ProjectAttributesFilterModel.md)| | [optional] | ### Return type [**List**](../Models/CustomAttributeGetModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **searchTestPlanAttributesInProject** > List searchTestPlanAttributesInProject(id, Skip, Take, OrderBy, SearchField, SearchValue, ProjectAttributesFilterModel) Search for attributes used in the project test plans ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Unique or global project ID | [default to null] | | **Skip** | **Integer**| Amount of items to be skipped (offset) | [optional] [default to null] | | **Take** | **Integer**| Amount of items to be taken (limit) | [optional] [default to null] | | **OrderBy** | **String**| SQL-like ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) | [optional] [default to null] | | **SearchField** | **String**| Property name for searching | [optional] [default to null] | | **SearchValue** | **String**| Value for searching | [optional] [default to null] | | **ProjectAttributesFilterModel** | [**ProjectAttributesFilterModel**](../Models/ProjectAttributesFilterModel.md)| | [optional] | ### Return type [**List**](../Models/CustomAttributeGetModel.md) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **updateCustomAttributeTestPlanProjectRelations** > updateCustomAttributeTestPlanProjectRelations(id, CustomAttributeTestPlanProjectRelationPutModel) Update attribute of project's test plans <br>Use case <br>User sets project internal or global identifier and attribute model <br>User runs method execution <br>System updates project and project attribute for test plan <br>System returns no content response ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Project internal (UUID) or global (integer) identifier | [default to null] | | **CustomAttributeTestPlanProjectRelationPutModel** | [**CustomAttributeTestPlanProjectRelationPutModel**](../Models/CustomAttributeTestPlanProjectRelationPutModel.md)| | [optional] | ### Return type null (empty response body) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **updateProject** > updateProject(ProjectPutModel) Update project <br>Use case <br>User sets project parameters (listed in request example) and runs method execution <br>System updates project <br>System returns updated project model (example listed in response parameters) ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **ProjectPutModel** | [**ProjectPutModel**](../Models/ProjectPutModel.md)| | [optional] | ### Return type null (empty response body) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **updateProjectsAttribute** > updateProjectsAttribute(id, CustomAttributePutModel) Edit attribute of the project ### Parameters |Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| | **id** | **String**| Unique or global project ID | [default to null] | | **CustomAttributePutModel** | [**CustomAttributePutModel**](../Models/CustomAttributePutModel.md)| | [optional] | ### Return type null (empty response body) ### Authorization [Bearer or PrivateToken](../README.md#Bearer or PrivateToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json