Skip to content

Latest commit

 

History

History
744 lines (469 loc) · 27.5 KB

WorkItemsApi.md

File metadata and controls

744 lines (469 loc) · 27.5 KB

WorkItemsApi

All URIs are relative to http://localhost

Method HTTP request Description
apiV2WorkItemsIdAttachmentsPost POST /api/v2/workItems/{id}/attachments Upload and link attachment to WorkItem
apiV2WorkItemsIdCheckListTransformToTestCasePost POST /api/v2/workItems/{id}/checkList/transformTo/testCase Transform CheckList to TestCase
apiV2WorkItemsIdHistoryGet GET /api/v2/workItems/{id}/history Get change history of WorkItem
apiV2WorkItemsIdLikeDelete DELETE /api/v2/workItems/{id}/like Delete like from WorkItem
apiV2WorkItemsIdLikePost POST /api/v2/workItems/{id}/like Set like to WorkItem
apiV2WorkItemsIdLikesCountGet GET /api/v2/workItems/{id}/likes/count Get likes count of WorkItem
apiV2WorkItemsIdLikesGet GET /api/v2/workItems/{id}/likes Get likes of WorkItem
apiV2WorkItemsIdTestResultsHistoryGet GET /api/v2/workItems/{id}/testResults/history Get test results history of WorkItem
apiV2WorkItemsIdVersionVersionIdActualPost POST /api/v2/workItems/{id}/version/{versionId}/actual Set WorkItem as actual
apiV2WorkItemsMovePost POST /api/v2/workItems/move Move WorkItem to another section
apiV2WorkItemsSearchPost POST /api/v2/workItems/search Search for work items
apiV2WorkItemsSharedStepIdReferencesSectionsPost POST /api/v2/workItems/{sharedStepId}/references/sections Get SharedStep references in sections
apiV2WorkItemsSharedStepIdReferencesWorkItemsPost POST /api/v2/workItems/{sharedStepId}/references/workItems Get SharedStep references in work items
apiV2WorkItemsSharedStepsSharedStepIdReferencesGet GET /api/v2/workItems/sharedSteps/{sharedStepId}/references Get SharedStep references
createWorkItem POST /api/v2/workItems Create Test Case, Checklist or Shared Step
deleteAllWorkItemsFromAutoTest DELETE /api/v2/workItems/{id}/autoTests Delete all links AutoTests from WorkItem by Id or GlobalId
deleteWorkItem DELETE /api/v2/workItems/{id} Delete Test Case, Checklist or Shared Step by Id or GlobalId
getAutoTestsForWorkItem GET /api/v2/workItems/{id}/autoTests Get all AutoTests linked to WorkItem by Id or GlobalId
getIterations GET /api/v2/workItems/{id}/iterations Get iterations by work item Id or GlobalId
getWorkItemById GET /api/v2/workItems/{id} Get Test Case, Checklist or Shared Step by Id or GlobalId
getWorkItemChronology GET /api/v2/workItems/{id}/chronology Get WorkItem chronology by Id or GlobalId
getWorkItemVersions GET /api/v2/workItems/{id}/versions Get WorkItem versions
purgeWorkItem POST /api/v2/workItems/{id}/purge Permanently delete test case, checklist or shared steps from archive
restoreWorkItem POST /api/v2/workItems/{id}/restore Restore test case, checklist or shared steps from archive
updateWorkItem PUT /api/v2/workItems Update Test Case, Checklist or Shared Step

apiV2WorkItemsIdAttachmentsPost

apiV2WorkItemsIdAttachmentsPost(id, file)

Upload and link attachment to WorkItem

 Use case   User sets workItemId   User attaches a file   System creates attachment and links it to the work item   System returns attachment identifier

Parameters

Name Type Description Notes
id UUID Work item internal identifier (guid format) [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

apiV2WorkItemsIdCheckListTransformToTestCasePost

WorkItemModel apiV2WorkItemsIdCheckListTransformToTestCasePost(id)

Transform CheckList to TestCase

 Use case   User sets checklist identifier   User runs method execution   System transform CheckList to TestCase

Parameters

Name Type Description Notes
id UUID [default to null]

Return type

WorkItemModel

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

apiV2WorkItemsIdHistoryGet

List apiV2WorkItemsIdHistoryGet(id, Skip, Take, OrderBy, SearchField, SearchValue)

Get change history of WorkItem

 Use case   User sets work item identifier   User runs method execution   System return change history of WorkItem

Parameters

Name Type Description Notes
id UUID [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
SearchField String Property name for searching [optional] [default to null]
SearchValue String Value for searching [optional] [default to null]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

apiV2WorkItemsIdLikeDelete

apiV2WorkItemsIdLikeDelete(id)

Delete like from WorkItem

 Use case   User sets WorkItem identifier   User runs method execution   System delete like from WorkItem

Parameters

Name Type Description Notes
id 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

apiV2WorkItemsIdLikePost

apiV2WorkItemsIdLikePost(id)

Set like to WorkItem

 Use case   User sets WorkItem identifier   User runs method execution   System set like to WorkItem

Parameters

Name Type Description Notes
id 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

apiV2WorkItemsIdLikesCountGet

Integer apiV2WorkItemsIdLikesCountGet(id)

Get likes count of WorkItem

 Use case   User sets WorkItem identifier   User runs method execution   System return likes count of WorkItem

Parameters

Name Type Description Notes
id UUID [default to null]

Return type

Integer

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

apiV2WorkItemsIdLikesGet

List apiV2WorkItemsIdLikesGet(id)

Get likes of WorkItem

 Use case   User sets WorkItem identifier   User runs method execution   System return likes of WorkItem

Parameters

Name Type Description Notes
id UUID [default to null]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

apiV2WorkItemsIdTestResultsHistoryGet

List apiV2WorkItemsIdTestResultsHistoryGet(id, from, to, configurationIds, testPlanIds, userIds, outcomes, isAutomated, automated, testRunIds, Skip, Take, OrderBy, SearchField, SearchValue)

Get test results history of WorkItem

 Use case   User sets WorkItem identifier   User runs method execution   System return test results history of WorkItem

Parameters

Name Type Description Notes
id UUID [default to null]
from Date Take results from this date [optional] [default to null]
to Date Take results until this date [optional] [default to null]
configurationIds List Identifiers of test result configurations [optional] [default to null]
testPlanIds List Identifiers of test plans which contain test results [optional] [default to null]
userIds List Identifiers of users who set test results [optional] [default to null]
outcomes List List of outcomes of test results [optional] [default to null]
isAutomated Boolean OBSOLETE: Use `Automated` instead [optional] [default to null]
automated Boolean If result must consist of only manual/automated test results [optional] [default to null]
testRunIds List Identifiers of test runs which contain test results [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
SearchField String Property name for searching [optional] [default to null]
SearchValue String Value for searching [optional] [default to null]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

apiV2WorkItemsIdVersionVersionIdActualPost

WorkItemModel apiV2WorkItemsIdVersionVersionIdActualPost(id, versionId)

Set WorkItem as actual

 Use case   User sets work item identifier   User runs method execution   System set WorkItem as actual

Parameters

Name Type Description Notes
id UUID [default to null]
versionId UUID [default to null]

Return type

WorkItemModel

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

apiV2WorkItemsMovePost

WorkItemShortModel apiV2WorkItemsMovePost(WorkItemMovePostModel)

Move WorkItem to another section

 Use case   User sets WorkItem identifier   User runs method execution   System move WorkItem to another section

Parameters

Name Type Description Notes
WorkItemMovePostModel WorkItemMovePostModel [optional]

Return type

WorkItemShortModel

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

apiV2WorkItemsSearchPost

List apiV2WorkItemsSearchPost(Skip, Take, OrderBy, SearchField, SearchValue, WorkItemSelectModel)

Search for work items

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
SearchField String Property name for searching [optional] [default to null]
SearchValue String Value for searching [optional] [default to null]
WorkItemSelectModel WorkItemSelectModel [optional]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

apiV2WorkItemsSharedStepIdReferencesSectionsPost

List apiV2WorkItemsSharedStepIdReferencesSectionsPost(sharedStepId, Skip, Take, OrderBy, SearchField, SearchValue, SharedStepReferenceSectionsQueryFilterModel)

Get SharedStep references in sections

 Use case   User sets SharedStep identifier   User runs method execution   System return SharedStep references

Parameters

Name Type Description Notes
sharedStepId UUID [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
SearchField String Property name for searching [optional] [default to null]
SearchValue String Value for searching [optional] [default to null]
SharedStepReferenceSectionsQueryFilterModel SharedStepReferenceSectionsQueryFilterModel [optional]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

apiV2WorkItemsSharedStepIdReferencesWorkItemsPost

List apiV2WorkItemsSharedStepIdReferencesWorkItemsPost(sharedStepId, Skip, Take, OrderBy, SearchField, SearchValue, SharedStepReferencesQueryFilterModel)

Get SharedStep references in work items

 Use case   User sets SharedStep identifier   User runs method execution   System return SharedStep references

Parameters

Name Type Description Notes
sharedStepId UUID [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
SearchField String Property name for searching [optional] [default to null]
SearchValue String Value for searching [optional] [default to null]
SharedStepReferencesQueryFilterModel SharedStepReferencesQueryFilterModel [optional]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

apiV2WorkItemsSharedStepsSharedStepIdReferencesGet

List apiV2WorkItemsSharedStepsSharedStepIdReferencesGet(sharedStepId)

Get SharedStep references

 Use case   User sets SharedStep identifier   User runs method execution   System return SharedStep references

Parameters

Name Type Description Notes
sharedStepId UUID [default to null]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

createWorkItem

WorkItemModel createWorkItem(WorkItemPostModel)

Create Test Case, Checklist or Shared Step

 Use case   User sets work item properties (listed in request parameters)   User runs method execution   System creates work item by identifier   System returns work item model (listed in response parameters)

Parameters

Name Type Description Notes
WorkItemPostModel WorkItemPostModel [optional]

Return type

WorkItemModel

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteAllWorkItemsFromAutoTest

deleteAllWorkItemsFromAutoTest(id)

Delete all links AutoTests from WorkItem by Id or GlobalId

 Use case   User sets work item identifier   User runs method execution   System search work item by identifier   System search and delete all autotests, related to found work item   System returns no content response

Parameters

Name Type Description Notes
id String WorkItem internal (guid format) or global(integer format) 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

deleteWorkItem

deleteWorkItem(id)

Delete Test Case, Checklist or Shared Step by Id or GlobalId

 Use case   User sets work item identifier   User runs method execution   System deletes work item   System returns no content response

Parameters

Name Type Description Notes
id String WorkItem internal (guid format) or global(integer format) 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

getAutoTestsForWorkItem

List getAutoTestsForWorkItem(id)

Get all AutoTests linked to WorkItem by Id or GlobalId

 Use case   User sets work item identifier   User runs method execution   System search work item by identifier   System search all autotests, related to found work item   System returns list of found autotests

Parameters

Name Type Description Notes
id String WorkItem internal (guid format) or global(integer format) identifier" [default to null]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getIterations

List getIterations(id, versionId, versionNumber)

Get iterations by work item Id or GlobalId

Parameters

Name Type Description Notes
id String WorkItem internal (guid format) or global(integer format) identifier" [default to null]
versionId UUID WorkItem version (guid format) identifier [optional] [default to null]
versionNumber Integer WorkItem version number (0 is the last version)" [optional] [default to null]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getWorkItemById

WorkItemModel getWorkItemById(id, versionId, versionNumber)

Get Test Case, Checklist or Shared Step by Id or GlobalId

 Use case   User sets work item identifier   [Optional] User sets work item version identifier   [Optional] User sets work item version number   User runs method execution   System search work item by identifier   [Optional] if User sets work item version identifier, system search work item version by identifier.   [Optional] if user sets work item version number, system search work item version by number   Otherwise, system search last work item version   System returns work item

Parameters

Name Type Description Notes
id String WorkItem internal (guid format) or global(integer format) identifier" [default to null]
versionId UUID WorkItem version (guid format) identifier" [optional] [default to null]
versionNumber Integer WorkItem version number (0 is the last version)" [optional] [default to null]

Return type

WorkItemModel

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getWorkItemChronology

List getWorkItemChronology(id)

Get WorkItem chronology by Id or GlobalId

 Use case   User sets work item identifier   User runs method execution   System search work item by identifier   System search test results of all autotests, related to found work item   System sort results by CompletedOn ascending, then by CreatedDate ascending   System returns sorted collection of test results

Parameters

Name Type Description Notes
id String [default to null]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getWorkItemVersions

List getWorkItemVersions(id, workItemVersionId, versionNumber)

Get WorkItem versions

 Use case   User sets work item identifier   [Optional] User sets work item version identifier   User runs method execution   System search work item by identifier                         [Optional] If User set work item version identifier, System search work item version by version identifier                      Otherwise, system search all version of work item                     System returns array of work item version models (listed in response example)

Parameters

Name Type Description Notes
id String WorkItem internal (guid format) or global(integer format) identifier" [default to null]
workItemVersionId UUID WorkItem version (guid format) identifier" [optional] [default to null]
versionNumber Integer WorkItem version (integer format) number" [optional] [default to null]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

purgeWorkItem

purgeWorkItem(id)

Permanently delete test case, checklist or shared steps from archive

Parameters

Name Type Description Notes
id String Unique or global ID of the work item [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

restoreWorkItem

restoreWorkItem(id)

Restore test case, checklist or shared steps from archive

Parameters

Name Type Description Notes
id String Unique or global ID of the work item [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

updateWorkItem

updateWorkItem(WorkItemPutModel)

Update Test Case, Checklist or Shared Step

 Use case   User sets work item properties (listed in request parameters)   User runs method execution   System updates work item by identifier   System returns updated work item model (listed in response parameters)

Parameters

Name Type Description Notes
WorkItemPutModel WorkItemPutModel [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