Skip to main content

Get-HaloOutcome

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 outcomes from the Halo API.

SYNTAX

Multi (Default)

Get-HaloOutcome [-Count <Int64>] [-Paginate] [-PageSize <Int32>] [-PageNo <Int32>] [-Order <String>]
[-OrderDesc] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Single

Get-HaloOutcome -OutcomeId <Int64> [-IncludeDetails] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Retrieves outcomes from the Halo API - supports a variety of filtering parameters.

EXAMPLES

PARAMETERS

-OutcomeId

The id of the outcome to retrieve.

Type: Int64
Parameter Sets: Single
Aliases:

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

-Count

The number of results to return.

Type: Int64
Parameter Sets: Multi
Aliases:

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

-Paginate

Enable pagination.

Type: SwitchParameter
Parameter Sets: Multi
Aliases: pageinate

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

-PageSize

The number of results per page.

Type: Int32
Parameter Sets: Multi
Aliases: page_size

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

-PageNo

The page number to return.

Type: Int32
Parameter Sets: Multi
Aliases: page_no

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

-Order

The field to order results by.

Type: String
Parameter Sets: Multi
Aliases:

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

-OrderDesc

Order results in descending order (respects the field choice in '-Order')

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
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

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