< Back

Get-WorkItems

Sun Jan 19, 2020 6:08 pm

NAME Get-WorkItems



SYNOPSIS

Gets workitems given a query





SYNTAX

Get-WorkItems [-Query] <String> [[-Take] <Int32>] [[-Account] <String>] [[-Project] <String>] [<CommonParameters>]





DESCRIPTION

Get-WorkItems by running a query and returning the results





PARAMETERS

-Query <String>

The query to run



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Take <Int32>

The number of work items to show. Defaults to the 200. Max is 200.



Required? false

Position? 2

Default value 200

Accept pipeline input? false

Accept wildcard characters? false



-Account <String>

The acount name to use. Can be inherited from a config file.

If your AzureDevOps url is hello.visualstudio.com then this value should be hello.



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Project <String>

The project name to use. Can be inherited from a config file.



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-WorkItems -Query "SELECT [System.Id], [System.Title] FROM WorkItems WHERE [System.TeamProject] =

@project AND [System.AssignedTo] = 'Joe Smith'"



Gets work items assigned to current user









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-WorkItems -Query "SELECT [System.Id], [System.Title] FROM WorkItems WHERE [System.TeamProject] =

@project AND [System.AssignedTo] = 'Joe Smith'" -Take 10















RELATED LINKS

about_PsAzureDevOps