Skip to main content

Get-HaloWorkday

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

SYNTAX

Multi (Default)

Get-HaloWorkday [-ShowAll] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Single

Get-HaloWorkday -WorkdayID <Int64> [-IncludeDetails] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

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

EXAMPLES

PARAMETERS

-WorkdayID

Workday Item ID

Type: Int64
Parameter Sets: Single
Aliases:

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

-ShowAll

Show All

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.

INPUTS

OUTPUTS

A powershell object containing the response.

NOTES