Endpoint

Create Work Item Comment

Name

add_workitem_comment

Description

Creates work item comment for a specific WorkItem Id [API reference]

Related Tables

WorkItemComments

Parameters

Parameter	Label	Required	Description
Id	Id	YES	Comment Id
WorkItemId	WorkItemId	YES	WorkItem Id for which you like to get comments
Project	Project Name	YES	The Name of the project.
Text	Comment Text	NO
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
WorkItemId	`DT_I4`	`int`		`False`
Text	`DT_NTEXT`	`nvarchar(MAX)`		`False`

Required columns that you need to supply are bolded.

Examples

SSIS

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

Insert into WorkItemComments table using API Destination

This Endpoint belongs to WorkItemComments table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Azure DevOps

WorkItemComments

Insert

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Create work item comment

SELECT * FROM add_workitem_comment
WHERE Id = 'abcd-1234-id'
AND WorkItemId = 'abcd-1234-workitemid'
WITH
(
    "Project" = 'abcd-1234-project'
)

Create work item comment

INSERT INTO WorkItemComments(WorkItemId, Text)
VALUES(6455, 'Adding <strong>html comment</strong> - created on <<FUN_NOW>>')
WITH(Project='ProductTesting')

add_workitem_comment endpoint belongs to WorkItemComments table(s), and can therefore be used via those table(s).

SQL Server

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

Create work item comment

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

EXEC (@MyQuery) AT [LS_TO_AZURE_DEVOPS_IN_GATEWAY];

Create work item comment

DECLARE @MyQuery NVARCHAR(MAX) = 'INSERT INTO WorkItemComments(WorkItemId, Text)
VALUES(6455, ''Adding <strong>html comment</strong> - created on <<FUN_NOW>>'')
WITH(Project=''ProductTesting'')';

EXEC (@MyQuery) AT [LS_TO_AZURE_DEVOPS_IN_GATEWAY];

add_workitem_comment endpoint belongs to WorkItemComments table(s), and can therefore be used via those table(s).