Skip to main content

Get-HaloTicketRules

Generated Cmdlet Help

This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.

SYNOPSIS

Gets Halo Ticket Rules information from the Halo API.

SYNTAX

Multi (Default)

Get-HaloTicketRules [-ExcludeWorkflow] [-ShowAll] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Single

Get-HaloTicketRules -RuleID <Int64> [-IncludeDetails] [-IncludeCriteriaInfo]
[-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Retrieves Ticket Rule from the Halo API. By default it retrieves global rules AND workflow step rules. Use -ExcludeWorkflow to limit the list to only Global Rules.

EXAMPLES

PARAMETERS

-RuleID

Rule ID

Type: Int64
Parameter Sets: Single
Aliases:

Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-IncludeDetails

Include details in the response.

Type: SwitchParameter
Parameter Sets: Single
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IncludeCriteriaInfo

Include criteria info in the response.

Type: SwitchParameter
Parameter Sets: Single
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ExcludeWorkflow

Exclude Workflow Step Rules

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ShowAll

Show all rules, including those that have been deleted.

Type: SwitchParameter
Parameter Sets: Multi
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.

INPUTS

OUTPUTS

A powershell object containing the response.

NOTES