Skip to content

Get-HaloKBArticle

SYNOPSIS

Gets knowledgebase articles from the Halo API.

SYNTAX

Multi (Default)

1
2
Get-HaloKBArticle [-Count <Int64>] [-Search <String>] [-AdvancedSearch <String>] [-Paginate]
 [-PageSize <Int32>] [-PageNo <Int32>] [-Order <String>] [-OrderDesc] [<CommonParameters>]

Single

1
Get-HaloKBArticle -KBArticleID <Int64> [-IncludeDetails] [<CommonParameters>]

DESCRIPTION

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

EXAMPLES

Example 1

1
PS C:\> {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-AdvancedSearch

Advanced Search

1
2
3
4
5
6
7
8
9
Type: String
Parameter Sets: Multi
Aliases: advanced_search

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

-Count

Number of records to return

1
2
3
4
5
6
7
8
9
Type: Int64
Parameter Sets: Multi
Aliases:

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

-IncludeDetails

Include extra objects in the result.

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Single
Aliases:

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

-KBArticleID

Article ID

1
2
3
4
5
6
7
8
9
Type: Int64
Parameter Sets: Single
Aliases:

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

-Order

The name of the first field to order by

1
2
3
4
5
6
7
8
9
Type: String
Parameter Sets: Multi
Aliases:

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

-OrderDesc

Whether to order ascending or descending

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-PageNo

Which page to return.

1
2
3
4
5
6
7
8
9
Type: Int32
Parameter Sets: Multi
Aliases: page_no

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

-PageSize

Number of results per page.

1
2
3
4
5
6
7
8
9
Type: Int32
Parameter Sets: Multi
Aliases: page_size

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

-Paginate

Paginate results

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases: pageinate

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

-Search

Filters response based on the search string

1
2
3
4
5
6
7
8
9
Type: String
Parameter Sets: Multi
Aliases:

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