BoardsRestClient class
Base class that should be used (derived from) to make requests to VSS REST apis
- Extends
Constructors
| Boards |
Properties
| RESOURCE_AREA_ID |
Methods
Constructor Details
BoardsRestClient(IVssRestClientOptions)
Property Details
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringProperty Value
string
Method Details
addBoardItem(NewBoardItem, string, number)
Adds a single item to a board.
function addBoardItem(item: NewBoardItem, project: string, board: number): Promise<BoardItemResponse>Parameters
- item
- NewBoardItem
Item to add to the board.
- project
-
string
Project ID or project name
- board
-
number
Board identifier.
Returns
Promise<BoardItemResponse>
createBoard(CreateBoard, string)
Add a new board for the project.
function createBoard(postedBoard: CreateBoard, project: string): Promise<BoardResponse>Parameters
- postedBoard
- CreateBoard
Board definition.
- project
-
string
Project ID or project name
Returns
Promise<BoardResponse>
createBoardColumn(BoardColumnCreate, string, number)
Creates a new column on a board.
function createBoardColumn(boardColumn: BoardColumnCreate, project: string, board: number): Promise<BoardColumnResponse>Parameters
- boardColumn
- BoardColumnCreate
Column data.
- project
-
string
Project ID or project name
- board
-
number
Board identifier.
Returns
Promise<BoardColumnResponse>
createBoardRow(BoardRowCreate, string, number)
Creates a new row on a board.
function createBoardRow(boardRow: BoardRowCreate, project: string, board: number): Promise<BoardRowResponse>Parameters
- boardRow
- BoardRowCreate
Row data.
- project
-
string
Project ID or project name
- board
-
number
Board identifier.
Returns
Promise<BoardRowResponse>
createBoardSyncAction(BoardItemStateSyncCreate, string, number, string)
Creates a new sync for a column on a board.
function createBoardSyncAction(boardSync: BoardItemStateSyncCreate, project: string, board: number, column: string): Promise<BoardItemStateSync>Parameters
- boardSync
- BoardItemStateSyncCreate
- project
-
string
Project ID or project name
- board
-
number
- column
-
string
Returns
Promise<BoardItemStateSync>
deleteBoard(string, number)
Deletes a board.
function deleteBoard(project: string, id: number): Promise<void>Parameters
- project
-
string
Project ID or project name
- id
-
number
Board identifier.
Returns
Promise<void>
deleteBoardColumn(string, number, string, boolean)
Deletes a column from a board.
function deleteBoardColumn(project: string, board: number, id: string, forceRemoveItems: boolean): Promise<void>Parameters
- project
-
string
Project ID or project name
- board
-
number
Board identifier.
- id
-
string
Column identifier.
- forceRemoveItems
-
boolean
Boolean indicating if items are to be force removed during the column delete.
Returns
Promise<void>
deleteBoardRow(string, number, string, boolean)
Deletes a row from a board.
function deleteBoardRow(project: string, board: number, id: string, forceRemoveItems: boolean): Promise<void>Parameters
- project
-
string
Project ID or project name
- board
-
number
Board identifier.
- id
-
string
Row identifier.
- forceRemoveItems
-
boolean
Boolean indicating if items are to be force removed during the row delete.
Returns
Promise<void>
getBoard(string, number)
Returns information for a board given its unique identifier.
function getBoard(project: string, id: number): Promise<BoardResponse>Parameters
- project
-
string
Project ID or project name
- id
-
number
Board's unique identifier.
Returns
Promise<BoardResponse>
getBoardColumn(string, number, string)
Gets column data for a board given its identifier.
function getBoardColumn(project: string, board: number, id: string): Promise<BoardColumnResponse>Parameters
- project
-
string
Project ID or project name
- board
-
number
Board identifier.
- id
-
string
Column identifier.
Returns
Promise<BoardColumnResponse>
getBoardColumns(string, number)
Get columns in a board.
function getBoardColumns(project: string, board: number): Promise<BoardColumnCollectionResponse>Parameters
- project
-
string
Project ID or project name
- board
-
number
Board identifier.
Returns
Promise<BoardColumnCollectionResponse>
getBoardItem(string, number, string)
Gets data for a single board's item.
function getBoardItem(project: string, board: number, id: string): Promise<BoardItemResponse>Parameters
- project
-
string
Project ID or project name
- board
-
number
Board identifier.
- id
-
string
Item identifier.
Returns
Promise<BoardItemResponse>
getBoardItems(string, number)
Get items information for a board given its identifier.
function getBoardItems(project: string, board: number): Promise<BoardItemCollectionResponse>Parameters
- project
-
string
Project ID or project name
- board
-
number
Board identifier.
Returns
Promise<BoardItemCollectionResponse>
getBoardRow(string, number, string)
Gets a row given its identifier and board.
function getBoardRow(project: string, board: number, id: string): Promise<BoardRowResponse>Parameters
- project
-
string
Project ID or project name
- board
-
number
Board identifier.
- id
-
string
Board row identifier.
Returns
Promise<BoardRowResponse>
getBoardRows(string, number)
Get rows in a board given its identifier.
function getBoardRows(project: string, board: number): Promise<BoardRowCollectionResponse>Parameters
- project
-
string
Project ID or project name
- board
-
number
Board identifier.
Returns
Promise<BoardRowCollectionResponse>
getBoards(string, number, number)
Get boards.
function getBoards(project: string, top?: number, skip?: number): Promise<BoardReference[]>Parameters
- project
-
string
Project ID or project name
- top
-
number
The maximum number of boards to get.
- skip
-
number
The number of boards to skip.
Returns
Promise<BoardReference[]>
removeBoardItem(string, number, string)
Removes an item from a board.
function removeBoardItem(project: string, board: number, id: string): Promise<void>Parameters
- project
-
string
Project ID or project name
- board
-
number
Board identifier.
- id
-
string
Board Item identifier to remove.
Returns
Promise<void>
updateBoard(UpdateBoard, string, number, String)
Updates a board.
function updateBoard(updatedBoard: UpdateBoard, project: string, id: number, eTag: String): Promise<BoardResponse>Parameters
- updatedBoard
- UpdateBoard
New board data.
- project
-
string
Project ID or project name
- id
-
number
Id of the board to update.
- eTag
-
String
Board Latest Changed Date
Returns
Promise<BoardResponse>
updateBoardColumn(BoardColumnUpdate, string, number, string, String)
Updates a board column.
function updateBoardColumn(boardColumn: BoardColumnUpdate, project: string, board: number, id: string, eTag: String): Promise<BoardColumnResponse>Parameters
- boardColumn
- BoardColumnUpdate
Column data.
- project
-
string
Project ID or project name
- board
-
number
Board identifier.
- id
-
string
Column identifier.
- eTag
-
String
Column Latest Changed Date
Returns
Promise<BoardColumnResponse>
updateBoardItem(UpdateBoardItem, string, number, string, String)
Updates a single item in a board.
function updateBoardItem(updateItemDef: UpdateBoardItem, project: string, board: number, id: string, eTag: String): Promise<BoardItemResponse>Parameters
- updateItemDef
- UpdateBoardItem
Updated item data.
- project
-
string
Project ID or project name
- board
-
number
Board identifier.
- id
-
string
Update item id.
- eTag
-
String
Item Latest Changed Date
Returns
Promise<BoardItemResponse>
updateBoardItems(BoardItemBatchOperation, string, number)
Do an operation on a batch of items.
function updateBoardItems(batchRequest: BoardItemBatchOperation, project: string, board: number): Promise<BoardItemCollectionResponse>Parameters
- batchRequest
- BoardItemBatchOperation
Data defining the batch operation.
- project
-
string
Project ID or project name
- board
-
number
The id of the board containing the items.
Returns
Promise<BoardItemCollectionResponse>
updateBoardRow(BoardRowUpdate, string, number, string, String)
Updates a board row.
function updateBoardRow(boardRow: BoardRowUpdate, project: string, board: number, id: string, eTag: String): Promise<BoardRowResponse>Parameters
- boardRow
- BoardRowUpdate
Row data.
- project
-
string
Project ID or project name
- board
-
number
Board identifier.
- id
-
string
Row identifier.
- eTag
-
String
Row Latest Changed Date
Returns
Promise<BoardRowResponse>
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for