Get-TfsWorkItem

Gets the contents of one or more work items.

Table of Contents

1. Syntax
2. Parameters
3. Inputs
4. Outputs
5. Related Links

Syntax

Query by revision

Get-TfsWorkItem
    [-WorkItem] <object>
    [-Collection <object>]
    [-Fields <string[]>]
    [-IncludeLinks]
    [-Project <object>]
    [-Revision <int>]
    [-Server <object>]
    [-ShowWindow]
    [-Team <object>]
    [-TimePrecision]

Query by date

Get-TfsWorkItem
    [-WorkItem] <object>
    -AsOf <DateTime>
    [-Collection <object>]
    [-Fields <string[]>]
    [-IncludeLinks]
    [-Project <object>]
    [-Server <object>]
    [-Team <object>]
    [-TimePrecision]

Get deleted

Get-TfsWorkItem
    [-WorkItem <object>]
    -Deleted
    [-Collection <object>]
    [-Fields <string[]>]
    [-IncludeLinks]
    [-Project <object>]
    [-Server <object>]
    [-Team <object>]
    [-TimePrecision]

Simple query

Get-TfsWorkItem
    [-AreaPath <string>]
    [-AsOf <DateTime>]
    [-BoardColumn <string[]>]
    [-BoardColumnDone <bool>]
    [-ChangedBy <object>]
    [-ChangedDate <DateTime[]>]
    [-Collection <object>]
    [-CreatedBy <object[]>]
    [-CreatedDate <DateTime[]>]
    [-Description <string[]>]
    [-Ever]
    [-Fields <string[]>]
    [-IncludeLinks]
    [-IterationPath <string>]
    [-Priority <int[]>]
    [-Project <object>]
    [-Reason <string[]>]
    [-Server <object>]
    [-State <string[]>]
    [-StateChangeDate <DateTime[]>]
    [-Tags <string[]>]
    [-Team <object>]
    [-TimePrecision]
    [-Title <string[]>]
    [-ValueArea <string[]>]
    [-WorkItemType <string[]>]

Query by WIQL

Get-TfsWorkItem
    -Wiql <string>
    [-Collection <object>]
    [-Fields <string[]>]
    [-IncludeLinks]
    [-Project <object>]
    [-Server <object>]
    [-Team <object>]
    [-TimePrecision]

Query by saved query

Get-TfsWorkItem
    -SavedQuery <string>
    [-Collection <object>]
    [-Fields <string[]>]
    [-IncludeLinks]
    [-Project <object>]
    [-QueryParameters <Hashtable>]
    [-Server <object>]
    [-Team <object>]
    [-TimePrecision]

Query by filter

Get-TfsWorkItem
    -Where <string>
    [-Collection <object>]
    [-Fields <string[]>]
    [-IncludeLinks]
    [-Project <object>]
    [-Server <object>]
    [-Team <object>]
    [-TimePrecision]

[Go to top]

Parameters

-AreaPath

Specifies the area path to look up for in a work item. Wildcards are supported.

-AsOf

Returns the field values as they were defined in the work item revision that was the latest revision by the date specified.

-BoardColumn

Specifies the board column to look up for in a work item. Wildcards are supported.

-BoardColumnDone

Specifies whether the work item is in the sub-column Doing or Done in a board.

-ChangedBy

Specifies the name or email of the user that did the latest change to the work item.

-ChangedDate

Specifies the date of the latest change to the work item.

-Collection (Aliases: Organization)

Specifies the URL to the Team Project Collection or Azure DevOps Organization to connect to, a TfsTeamProjectCollection object (Windows PowerShell only), or a VssConnection object. You can also connect to an Azure DevOps Services organizations by simply providing its name instead of the full URL. For more details, see the Get-TfsTeamProjectCollection cmdlet. When omitted, it defaults to the connection set by Connect-TfsTeamProjectCollection (if any).

-CreatedBy

Specifies the name or email of the user that created the work item.

-CreatedDate

Specifies the date when the work item was created.

-Deleted

Gets deleted work items.

-Description

Specifies the description to look up for in a work item. Wildcards are supported.

-Ever (Aliases: WasEver)

Switches the query to historical query mode, by changing operators to “WAS EVER” where possible.

-Fields

Specifies which fields should be retrieved. When omitted, defaults to a set of standard fields that include Id, Title, Description, some state-related fields and more. To retrive all fields, pass an asterisk (‘*’) to this argument.

-IncludeLinks

Gets information about all links and attachments in the work item. When omitted, only fields are retrieved.

-IterationPath

Specifies the iteration path to look up for in a work item. Wildcards are supported.

-Priority

Specifies the priority of the work item.

-Project

Specifies the name of the Team Project, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.TeamProject object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeamProject (if any). For more details, see the Get-TfsTeamProject cmdlet.

-QueryParameters

Specifies the path of a saved query to be executed.

-Reason

Specifies the reason (field ‘System.Reason’) to look up for in a work item. Wildcards are supported.

-Revision (Aliases: rev)

B Specifies a work item revision number to retrieve. When omitted, returns the latest revision of the work item.

-SavedQuery (Aliases: QueryPath)

Specifies the path of a saved query to be executed.

-Server

Specifies the URL to the Team Foundation Server to connect to, a TfsConfigurationServer object (Windows PowerShell only), or a VssConnection object. When omitted, it defaults to the connection set by Connect-TfsConfiguration (if any). For more details, see the Get-TfsConfigurationServer cmdlet.

-ShowWindow

Opens the specified work item in the default web browser.

-State

Specifies the state (field ‘System.State’) to look up for in a work item. Wildcards are supported.

-StateChangeDate

Specifies the date of the most recent change to the state of the work item.

-Tags

Specifies the tags to look up for in a work item. When multiple tags are supplied, they are combined with an OR operator - in other works, returns work items that contain ANY ofthe supplied tags.

-Team

Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeam (if any). For more details, see the Get-TfsTeam cmdlet.

-TimePrecision

Fetches work items in “time-precision mode”: search criteria in WIQL queries take into account time information as well, not only dates.

-Title

Specifies the title to look up for in a work item. Wildcards are supported. When a wildcard is used, matches a portion of the title (uses the operator “contains” in the WIQL query). Otherwise, matches the whole field with the operator “=”, unless -Ever is also specified. In that case, uses the operator “was ever”.

-ValueArea

Specifies the Value Area (field ‘Microsoft.VSTS.Common.ValueArea’) to look up for in a work item. Wildcards are supported.

-Where

Specifies a filter clause (the portion of a WIQL query after the WHERE keyword).

-Wiql (Aliases: Query, QueryText)

Specifies a query written in WIQL (Work Item Query Language)

-WorkItem (Aliases: id)

Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.

-WorkItemType (Aliases: Type)

Specifies the work item type to look up for in a work item. Wildcards are supported.

Inputs

System.Object

Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem.

Outputs

Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem

Related Links