EndPoint Query Work Items
Name
query_workitems
Description
Get work items associated with the specified project and organization that are filtered by a Wiql query. (A team can optionally be specified as well.). Read more about this API here https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/wiql/query-by-wiql?view=azure-devops-rest-7.0 and here https://learn.microsoft.com/en-us/azure/devops/boards/queries/query-operators-variables?view=azure-devops
[API Help]
Parameters
Parameter |
Label |
Required |
Options |
Description |
Project |
Project Name |
YES |
|
The Name of the project.
|
Team |
Team Id or Name |
NO |
|
Id or name of the team associated with the query.
|
TimePrecision |
Use time precision |
NO |
Option |
Value |
false |
false |
true |
true |
|
Whether or not to use time precision.
|
Query |
Wiql Query |
YES |
|
The WIQL query (refer Azure DevOps Help to learn Wiql syntax. [API Help..]
|
Output Columns
Label |
DataType |
Length |
Raw |
Description |
Id |
DT_I4 |
0 |
False |
|
Title |
DT_WSTR |
1000 |
False |
|
Description |
DT_WSTR |
4000 |
False |
|
WorkItemType |
DT_WSTR |
100 |
False |
|
State |
DT_WSTR |
100 |
False |
|
Url |
DT_WSTR |
2048 |
False |
|
Tags |
DT_WSTR |
4000 |
False |
|
Revision |
DT_I4 |
0 |
False |
|
AreaPath |
DT_WSTR |
500 |
False |
|
TeamProject |
DT_WSTR |
500 |
False |
|
IterationPath |
DT_WSTR |
500 |
False |
|
Reason |
DT_WSTR |
500 |
False |
|
CreatedDate |
DT_DBTIMESTAMP |
0 |
False |
|
ChangedDate |
DT_DBTIMESTAMP |
0 |
False |
|
CommentCount |
DT_I4 |
0 |
False |
|
AssignedToDisplayName |
DT_WSTR |
500 |
False |
|
AssignedToUrl |
DT_WSTR |
2048 |
False |
|
AssignedToLinksAvatarHref |
DT_WSTR |
4000 |
False |
|
AssignedToId |
DT_WSTR |
500 |
False |
|
AssignedToUniqueName |
DT_WSTR |
500 |
False |
|
AssignedToImageUrl |
DT_WSTR |
2048 |
False |
|
AssignedToDescriptor |
DT_WSTR |
2000 |
False |
|
CreatedByDisplayName |
DT_WSTR |
500 |
False |
|
CreatedByUrl |
DT_WSTR |
2048 |
False |
|
CreatedByLinksAvatarHref |
DT_WSTR |
2048 |
False |
|
CreatedById |
DT_WSTR |
500 |
False |
|
CreatedByUniqueName |
DT_WSTR |
500 |
False |
|
CreatedByImageUrl |
DT_WSTR |
2048 |
False |
|
CreatedByDescriptor |
DT_WSTR |
2000 |
False |
|
ChangedByDisplayName |
DT_WSTR |
500 |
False |
|
ChangedByUrl |
DT_WSTR |
2048 |
False |
|
ChangedByLinksAvatarHref |
DT_WSTR |
2048 |
False |
|
ChangedById |
DT_WSTR |
500 |
False |
|
ChangedByUniqueName |
DT_WSTR |
500 |
False |
|
ChangedByImageUrl |
DT_WSTR |
2048 |
False |
|
ChangedByDescriptor |
DT_WSTR |
2000 |
False |
|
Watermark |
DT_WSTR |
500 |
False |
|
StateChangeDate |
DT_DBTIMESTAMP |
0 |
False |
|
Priority |
DT_I4 |
0 |
False |
|
Triage |
DT_WSTR |
1000 |
False |
|
StackRank |
DT_I4 |
0 |
False |
|
Blocked |
DT_WSTR |
500 |
False |
|
TaskType |
DT_WSTR |
500 |
False |
|
RequiresReview |
DT_WSTR |
100 |
False |
|
RequiresTest |
DT_WSTR |
100 |
False |
|
ActivatedDate |
DT_DBTIMESTAMP |
0 |
False |
|
ActivatedByDisplayName |
DT_WSTR |
500 |
False |
|
ActivatedByUrl |
DT_WSTR |
2048 |
False |
|
ActivatedByLinksAvatarHref |
DT_WSTR |
2048 |
False |
|
ActivatedById |
DT_WSTR |
500 |
False |
|
ActivatedByUniqueName |
DT_WSTR |
500 |
False |
|
ActivatedByImageUrl |
DT_WSTR |
2048 |
False |
|
ActivatedByDescriptor |
DT_WSTR |
2000 |
False |
|
ClosedDate |
DT_DBTIMESTAMP |
0 |
False |
|
ClosedByDisplayName |
DT_WSTR |
500 |
False |
|
ClosedByUrl |
DT_WSTR |
2048 |
False |
|
ClosedByLinksAvatarHref |
DT_WSTR |
2048 |
False |
|
ClosedById |
DT_WSTR |
500 |
False |
|
ClosedByUniqueName |
DT_WSTR |
500 |
False |
|
ClosedByImageUrl |
DT_WSTR |
2048 |
False |
|
ClosedByDescriptor |
DT_WSTR |
2000 |
False |
|
ResolvedDate |
DT_DBTIMESTAMP |
0 |
False |
|
ResolvedByDisplayName |
DT_WSTR |
500 |
False |
|
ResolvedByUrl |
DT_WSTR |
2048 |
False |
|
ResolvedByLinksAvatarHref |
DT_WSTR |
2048 |
False |
|
ResolvedById |
DT_WSTR |
500 |
False |
|
ResolvedByUniqueName |
DT_WSTR |
500 |
False |
|
ResolvedByImageUrl |
DT_WSTR |
2048 |
False |
|
ResolvedByDescriptor |
DT_WSTR |
2000 |
False |
|
ResolvedReason |
DT_WSTR |
4000 |
False |
|
AreaId |
DT_WSTR |
500 |
False |
|
IterationId |
DT_WSTR |
500 |
False |
|
RevisedDate |
DT_DBTIMESTAMP |
0 |
False |
|
RemoteLinkCount |
DT_I4 |
0 |
False |
|
RelatedLinkCount |
DT_I4 |
0 |
False |
|
HyperLinkCount |
DT_I4 |
0 |
False |
|
ExternalLinkCount |
DT_I4 |
0 |
False |
|
History |
DT_WSTR |
2000 |
False |
|
IntegrationBuild |
DT_WSTR |
500 |
False |
|
FoundIn |
DT_WSTR |
500 |
False |
|
OriginalEstimate |
DT_R4 |
0 |
False |
|
RemainingWork |
DT_R4 |
0 |
False |
|
CompletedWork |
DT_R4 |
0 |
False |
|
Size |
DT_R4 |
0 |
False |
|
Effort |
DT_R4 |
0 |
False |
|
TargetDate |
DT_DBTIMESTAMP |
0 |
False |
|
StoryPoints |
DT_R4 |
0 |
False |
|
StartDate |
DT_DBTIMESTAMP |
0 |
False |
|
FinishDate |
DT_DBTIMESTAMP |
0 |
False |
|
DueDate |
DT_DBTIMESTAMP |
0 |
False |
|
Discipline |
DT_WSTR |
500 |
False |
|
SystemInfo |
DT_WSTR |
4000 |
False |
|
Steps |
DT_WSTR |
4000 |
False |
|
ReproSteps |
DT_WSTR |
4000 |
False |
|
[$parent.referenceName$] |
DT_WSTR |
4000 |
False |
|
Input Columns
Label |
DataType |
Length |
Raw |
Description |
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. |