Endpoint

Get Work Item Comments (by WorkItem Id)

Name

get_workitem_comments

Description

Get work item comments associated with WorkItem Id [API reference]

Parameters

Parameter	Label	Required	Description
WorkItemId	WorkItemId	YES	WorkItem Id for which you like to get comments
Project	Project Name	YES	The Name of the project.
api-version	api-version	NO	For this API you must set 7.0-preview for now

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Id	`DT_I4`	`int`		`False`
WorkItemId	`DT_I4`	`int`		`False`
Text	`DT_NTEXT`	`nvarchar(MAX)`		`False`
RenderedText	`DT_NTEXT`	`nvarchar(MAX)`		`False`
Format	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
CreatedDate	`DT_DBTIMESTAMP`	`datetime`		`False`
CreatedByUniqueName	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
CreatedById	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
CreatedByDisplayName	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
ModifiedDate	`DT_DBTIMESTAMP`	`datetime`		`False`
ModifiedByUniqueName	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
ModifiedById	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
ModifiedByDisplayName	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
Url	`DT_WSTR`	`nvarchar(1000)`	1000	`False`

If the column you are looking for is missing, consider customizing Azure DevOps Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Azure DevOps Connector in API Source component to read data or in API Destination component to read/write data:

Get Work Item Comments (by WorkItem Id) using API Source

Azure DevOps

Get Work Item Comments (by WorkItem Id)

SSIS API Source - Read from table or endpoint

Get Work Item Comments (by WorkItem Id) using API Destination

Azure DevOps

Get Work Item Comments (by WorkItem Id)

SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Get work item comments

SELECT * FROM get_workitem_comments
WHERE WorkItemId = 'abcd-1234-workitemid'
WITH
(
    "Project" = 'abcd-1234-project'
)

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get work item comments

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_workitem_comments
WHERE WorkItemId = ''abcd-1234-workitemid''
WITH
(
    "Project" = ''abcd-1234-project''
)';

EXEC (@MyQuery) AT [LS_TO_AZURE_DEVOPS_IN_GATEWAY];