Skip to main content

Get-VSTeamWorkItemType

SYNOPSIS​

Gets a list of all Work Item Types or a single work item type.

SYNTAX​

Get-VSTeamWorkItemType -ProjectName <String> [-WorkItemType <String>] [<CommonParameters>]

DESCRIPTION​

Gets a list of all Work Item Types or a single work item type.

EXAMPLES​

Example 1​

Get-VSTeamWorkItemType -ProjectName test -WorkItemType 'Code Review Response'

This command gets a single work item type.

PARAMETERS​

-WorkItemType​

The type of work item to retrieve.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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​

System.String​

OUTPUTS​

System.Object​

NOTES​

The JSON returned has empty named items i.e. "": "To Do" This causes issues with the ConvertFrom-Json CmdLet. Therefore, all "": are replaced with "_end":

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