Get-HaloStatus
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
SYNOPSIS
Gets statuses from the Halo API.
SYNTAX
Multi (Default)
Get-HaloStatus [-Type <String>] [-ShowCounts] [-Domain <String>] [-ViewID <Int32>] [-ExcludePending]
[-ExcludeClosed] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Single
Get-HaloStatus -StatusID <Int64> [-IncludeDetails] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Retrieves statuses types from the Halo API - supports a variety of filtering parameters.
EXAMPLES
PARAMETERS
-StatusID
Status ID
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Type
Filter by Status type e.g. 'ticket' returns all ticket statuses
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ShowCounts
Show the count of tickets in the results.
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Domain
Filter counts to a specific domain: reqs = tickets, opps = opportunities and prjs = projects.
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ViewID
Filter counts to a specific view ID.
Type: Int32
Parameter Sets: Multi
Aliases: view_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ExcludePending
Exclude the pending closure status from the response
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ExcludeClosed
Exclude the closed status from the response
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-IncludeDetails
Include extra objects in the result.
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.