Get-HaloAttachment
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
SYNOPSIS
Gets attachments from the Halo API.
SYNTAX
Multi (Default)
Get-HaloAttachment -TicketID <Int64> [-ActionID <Int64>] [-Type <Int64>] [-UniqueID <Int64>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
SinglePath
Get-HaloAttachment -AttachmentID <Int64> -OutPath <String> [-ProgressAction <ActionPreference>]
[<CommonParameters>]
SingleFile
Get-HaloAttachment -AttachmentID <Int64> -OutFile <String> [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Single
Get-HaloAttachment -AttachmentID <Int64> [-IncludeDetails] [-AsBase64] [-GetToken]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Retrieves attachments from the Halo API - supports a variety of filtering parameters.
EXAMPLES
PARAMETERS
-AttachmentID
Attachment ID
Type: Int64
Parameter Sets: SinglePath, SingleFile, Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-TicketID
Returns attachments from the ticket ID specified
Type: Int64
Parameter Sets: Multi
Aliases: ticket_id
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ActionID
Returns attachments from the action ID specified (requires ticket_id)
Type: Int64
Parameter Sets: Multi
Aliases: action_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Type
Returns attachments of the specified type
Type: Int64
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-UniqueID
Returns an attachment with the unique ID specified
Type: Int64
Parameter Sets: Multi
Aliases: unique_id
Required: False
Position: Named
Default value: 0
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
-OutFile
Allow Writing Directly to File, using the specified path and file name eg c:\temp\myfile.txt
Type: String
Parameter Sets: SingleFile
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OutPath
Allow Writing Directly to File, using the specified path and the original file name eg c:\temp\
Type: String
Parameter Sets: SinglePath
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AsBase64
Return the attachment as a base64 encoded string
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-GetToken
Get the token for accessing the image using the token parameter(s).
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.