Skip to content

Latest commit

 

History

History
240 lines (149 loc) · 8.26 KB

SectionsApi.md

File metadata and controls

240 lines (149 loc) · 8.26 KB

SectionsApi

All URIs are relative to http://localhost

Method HTTP request Description
apiV2SectionsIdPatch PATCH /api/v2/sections/{id} Patch section
createSection POST /api/v2/sections Create section
deleteSection DELETE /api/v2/sections/{id} Delete section
getSectionById GET /api/v2/sections/{id} Get section
getWorkItemsBySectionId GET /api/v2/sections/{id}/workItems Get section work items
move POST /api/v2/sections/move Move section with all work items into another section
rename POST /api/v2/sections/rename Rename section
updateSection PUT /api/v2/sections Update section

apiV2SectionsIdPatch

apiV2SectionsIdPatch(id, Operation)

Patch section

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 Section internal (UUID) identifier [default to null]
Operation List [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

createSection

SectionWithStepsModel createSection(SectionPostModel)

Create section

 Use case   User sets section properties (listed in request example)   User runs method execution   System creates section property values   System returns section (listed in response example)

Parameters

Name Type Description Notes
SectionPostModel SectionPostModel [optional]

Return type

SectionWithStepsModel

Authorization

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

HTTP request headers

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

deleteSection

deleteSection(id)

Delete section

 Use case   User sets section identifier   User runs method execution   System search section by the identifier   System search and delete nested sections of the found section   System search and delete workitems related to the found nested sections   System deletes initial section and related workitem   System returns no content response

Parameters

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

getSectionById

SectionWithStepsModel getSectionById(id, isDeleted)

Get section

 Use case   User sets section internal (guid format) identifier   User runs method execution   System search section by the section identifier                 [Optional] If isDeleted flag equals false, deleted work items are not being searched.              If true, deleted work items are also being searched, null for all work items.                 System returns section

Parameters

Name Type Description Notes
id UUID Section internal (UUID) identifier [default to null]
isDeleted DeletionState [optional] [default to NotDeleted] [enum: Any, Deleted, NotDeleted]

Return type

SectionWithStepsModel

Authorization

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

HTTP request headers

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

getWorkItemsBySectionId

List getWorkItemsBySectionId(id, isDeleted, tagNames, includeIterations, Skip, Take, OrderBy, SearchField, SearchValue)

Get section work items

 Use case   User sets section identifier   User runs method execution   System search section by the identifier   System search work items related to the section                 [Optional] If isDeleted flag equals false, deleted work items are not being searched.              If true, deleted work items are also being searched, null for all work items.                 System returns work item collection

Parameters

Name Type Description Notes
id UUID Section internal (UUID) identifier [default to null]
isDeleted Boolean Requested section is deleted [optional] [default to false]
tagNames List List of work item tags [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
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

move

move(SectionMoveModel)

Move section with all work items into another section

Parameters

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

rename

rename(SectionRenameModel)

Rename section

 Use case   User sets section identifier and new name (listed in request example)   User runs method execution   System search section by the identifier   System updates section name using the new name   System returns no content response

Parameters

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

updateSection

updateSection(SectionPutModel)

Update section

 Use case   User sets section properties (listed in request example)   User runs method execution   System search section by the identifier   System updates section using the property values   System returns no content response

Parameters

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