Get-HaloReport
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
SYNOPSIS
Gets reports from the Halo API.
SYNTAX
Multi (Default)
Get-HaloReport [-Count <Int64>] [-Search <String>] [-Paginate] [-PageSize <Int32>] [-PageNo <Int32>]
[-OrderBy <String>] [-OrderByDesc] [-OrderBy2 <String>] [-OrderByDesc2] [-OrderBy3 <String>] [-OrderByDesc3]
[-OrderBy4 <String>] [-OrderByDesc4] [-OrderBy5 <String>] [-OrderByDesc5] [-TicketID <Int64>]
[-ClientID <Int64>] [-SiteID <Int64>] [-UserID <Int64>] [-ReportGroupID <Int64>] [-ChartOnly]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Single
Get-HaloReport -ReportID <Int64> [-IncludeDetails] [-LoadReport] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
Retrieves reports from the Halo API - supports a variety of filtering parameters.
EXAMPLES
PARAMETERS
-ReportID
Report ID
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Count
Number of records to return
Type: Int64
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Search
Filters response based on the search string
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Paginate
Paginate results
Type: SwitchParameter
Parameter Sets: Multi
Aliases: pageinate
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-PageSize
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
Which page 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
-OrderBy
The name of the first field to order by
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OrderByDesc
Whether to order ascending or descending
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-OrderBy2
The name of the second field to order by
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OrderByDesc2
Whether to order ascending or descending
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-OrderBy3
The name of the third field to order by
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OrderByDesc3
Whether to order ascending or descending
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-OrderBy4
The name of the fourth field to order by
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OrderByDesc4
Whether to order ascending or descending
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-OrderBy5
The name of the fifth field to order by
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OrderByDesc5
Whether to order ascending or descending
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-TicketID
Filters by the specified ticket
Type: Int64
Parameter Sets: Multi
Aliases: ticket_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ClientID
Filters by the specified client
Type: Int64
Parameter Sets: Multi
Aliases: client_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-SiteID
Filters by the specified site
Type: Int64
Parameter Sets: Multi
Aliases: site_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-UserID
Filters by the specified user
Type: Int64
Parameter Sets: Multi
Aliases: user_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ReportGroupID
Filters by the specified report group
Type: Int64
Parameter Sets: Multi
Aliases: reportgroup_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ChartOnly
Whether to return only records for reports that include graphs
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
-LoadReport
Whether to include the report data 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.