Get-HaloField
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 field information from the Halo API.
SYNTAX
Multi (Default)
Get-HaloField [-Kind <String>] [-IncludeDetails] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Single
Get-HaloField -FieldID <Int64> [-Kind <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Retrieves field types from the Halo API - supports a variety of filtering parameters.
EXAMPLES
PARAMETERS
-FieldID
Lookup Item ID
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Kind
Kind
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IncludeDetails
Include Details
Type: SwitchParameter
Parameter Sets: Multi
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.