Get-HaloViewList
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
SYNOPSIS
Gets view list profiles from the Halo API.
SYNTAX
Multi (Default)
Get-HaloViewList [-ConnectedInstanceID <Int64>] [-Domain <String>] [-GlobalOnly] [-IsTree] [-ShowAll]
[-ShowAllForTeam <Int64>] [-ShowAllForTech <Int64>] [-ShowCounts] [-TicketAreaId <Int64>] [-Type <String>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Single
Get-HaloViewList -ViewListId <Int64> [-Domain <String>] [-ShowCounts] [-IncludeDetails]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Retrieves view list from the Halo API - supports a variety of listing parameters.
EXAMPLES
PARAMETERS
-ViewListId
View List Id.
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ConnectedInstanceID
Filter by connected instance id.
Type: Int64
Parameter Sets: Multi
Aliases: connectedinstance_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Domain
Filter by domain.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-GlobalOnly
Return global view lists only.
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-IsTree
Return only tree view lists.
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ShowAll
Show all view lists.
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ShowAllForTeam
Show all view lists for a specific team.
Type: Int64
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ShowAllForTech
Show all view lists for a specific tech.
Type: Int64
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ShowCounts
Show the counts for the view lists.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-TicketAreaId
Show all view lists for a specific ticket area.
Type: Int64
Parameter Sets: Multi
Aliases: ticketarea_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Type
Filter by the following view list type.
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IncludeDetails
Include detailed information about the view list.
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
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.