Skip to main content

Show-VSTeamWorkItem

SYNOPSIS​

Opens the work item in the default browser.

SYNTAX​

Show-VSTeamWorkItem -Id <Int32> -ProjectName <String> [<CommonParameters>]

DESCRIPTION​

Opens the work item in the default browser.

EXAMPLES​

Example 1​

Show-VSTeamWorkItem -ProjectName Demo -Id 3

This command will open a web browser with the summary of work item 3.

PARAMETERS​

-Id​

Specifies work item by ID.

Type: Int32
Parameter Sets: (All)
Aliases: WorkItemID

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-ProjectName​

Specifies the team project for which this function operates.

You can tab complete from a list of available projects.

You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

vsteam_lib.WorkItem​

NOTES​

You can pipe the WorkItem ID to this function.

Prerequisites:

Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.

tips:

  • check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo
  • use Set-VSTeamDefaultProject to set default project for every call
  • use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.
  • use Profiles to load an account and the correct version

Add-VSTeamWorkItem

Get-VSTeamWorkItem