Skip to main content

Get-HaloService

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

SYNTAX

Multi (Default)

Get-HaloService [-Count <Int64>] [-Search <String>] [-Paginate] [-PageSize <Int32>] [-PageNo <Int32>]
[-Order <String>] [-OrderDesc] [-UserID <Int32>] [-ServiceStatusIDs <Int32[]>] [-ServiceCatalogueType <Int32>]
[-ServiceCategoryIDs <Int32[]>] [-ITILTicketType <Int32>] [-IncludeStatusInfo]
[-ProgressAction <ActionPreference>] [<CommonParameters>]

Single

Get-HaloService -ServiceID <Int64> [-IncludeDetails] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

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

EXAMPLES

PARAMETERS

-ServiceID

Service 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

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

-Order

Which field to order results based on.

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

-UserID

Filters by services accessible to the specified user.

Type: Int32
Parameter Sets: Multi
Aliases: user_id

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

-ServiceStatusIDs

Filters by the specified array of operational status IDs.

Type: Int32[]
Parameter Sets: Multi
Aliases: service_status_ids

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

-ServiceCatalogueType

Filters by the specified service catalogue.

Type: Int32
Parameter Sets: Multi
Aliases: service_catalogue_type

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

-ServiceCategoryIDs

Filters by the specified array of service category IDs.

Type: Int32[]
Parameter Sets: Multi
Aliases: service_category_ids

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

-ITILTicketType

Filters by the specified ITIL ticket type ID.

Type: Int32
Parameter Sets: Multi
Aliases: itil_ticket_type

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

-IncludeStatusInfo

Include service status information in the result.

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