Endpoint Create Work Item Comment
Name
add_workitem_comment
Description
Creates work item comment for a specific WorkItem Id [API reference]
Related Tables
Parameters
| Parameter | Required | Options |
|---|---|---|
|
Name:
Label: Id Comment Id |
YES | |
|
Name:
Label: WorkItemId WorkItem Id for which you like to get comments |
YES | |
|
Name:
Label: Project Name The Name of the project. |
YES | |
|
Name:
Label: Comment Text |
||
|
Name:
Label: api-version For this API you must set 7.0-preview for now |
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_I4
|
int
|
||
| WorkItemId |
DT_I4
|
int
|
||
| Text |
DT_NTEXT
|
nvarchar(MAX)
|
||
| RenderedText |
DT_NTEXT
|
nvarchar(MAX)
|
||
| Format |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| CreatedDate |
DT_DBTIMESTAMP
|
datetime
|
||
| CreatedByUniqueName |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| CreatedById |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| CreatedByDisplayName |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| ModifiedDate |
DT_DBTIMESTAMP
|
datetime
|
||
| ModifiedByUniqueName |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| ModifiedById |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| ModifiedByDisplayName |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Url |
DT_WSTR
|
nvarchar(1000)
|
1000 |
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| WorkItemId |
DT_I4
|
int
|
||
| Text |
DT_NTEXT
|
nvarchar(MAX)
|
Examples
SSIS
Use Azure DevOps Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
API Source
| Required Parameters | |
|---|---|
| Id | Fill-in the parameter... |
| WorkItemId | Fill-in the parameter... |
| Project Name | Fill-in the parameter... |
| Optional Parameters | |
| Comment Text | |
| api-version | 7.0-preview |
API Destination
This Endpoint belongs to the WorkItemComments table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to create work item comment:
| Required Parameters | |
|---|---|
| Id | Fill-in the parameter... |
| WorkItemId | Fill-in the parameter... |
| Project Name | Fill-in the parameter... |
| Optional Parameters | |
| Comment Text | |
| api-version | 7.0-preview |
ODBC application
Use these SQL queries in your ODBC application data source:
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) = '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).