Skip to main content

Get-HaloAppointment

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

SYNTAX

Multi (Default)

Get-HaloAppointment [-ShowAll] [-StartDate <String>] [-EndDate <String>] [-Agents <String>] [-ShowHolidays]
[-ShowProjects] [-ShowChanges] [-ShowAppointments] [-Search <String>] [-AppointmentsOnly] [-TasksOnly]
[-HideCompleted] [-TicketID <Int64>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Single

Get-HaloAppointment -AppointmentID <Int64> [-IncludeDetails] [-ProgressAction <ActionPreference>]
[<CommonParameters>]

DESCRIPTION

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

EXAMPLES

PARAMETERS

-AppointmentID

Appointment ID

Type: Int64
Parameter Sets: Single
Aliases:

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

-ShowAll

Admin override to return all appointments

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-StartDate

Return appointments with a start date greater than this value.

Type: String
Parameter Sets: Multi
Aliases: start_date

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

-EndDate

Return appointments with an end date greater than this value

Type: String
Parameter Sets: Multi
Aliases: end_date

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

-Agents

Comma separated list of agent IDs. Returns these agent's appointments

Type: String
Parameter Sets: Multi
Aliases:

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

-ShowHolidays

Include the appointment type 'holiday' in the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-ShowProjects

Include projects in the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-ShowChanges

Include change requests in the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-ShowAppointments

Include appointments in the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

Return appointments like this search string

Type: String
Parameter Sets: Multi
Aliases:

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

-AppointmentsOnly

Only return appointments in the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-TasksOnly

Only return tasks in the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-HideCompleted

Exclude completed appointments from the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-TicketID

Return appointments assigned to a particular ticket

Type: Int64
Parameter Sets: Multi
Aliases: ticket_id

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

-IncludeDetails

Whether to include extra objects 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