TriliumNext-Powershell-Module/public/Get-TriliumAttachment.ps1 at main · ptmorris1/TriliumNext-Powershell-Module · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
function Get-TriliumAttachment {
    <#
    .SYNOPSIS
    Retrieves metadata for a specific Trilium Notes attachment by its ID.

    .DESCRIPTION
    Gets the metadata (properties and details) for a Trilium Notes attachment using the provided attachment ID. This does not return the raw file or binary content, but rather the attachment's metadata as a PowerShell object. Requires prior authentication with Connect-TriliumAuth.

    .PARAMETER AttachmentID
    The unique ID of the attachment to retrieve metadata for. This value can be found in the note's attachment metadata or via Find-TriliumNote.

        Required?                    true
        Position?                    0
        Accept pipeline input?       false
        Accept wildcard characters?  false

    .PARAMETER SkipCertCheck
    If specified, skips SSL certificate validation for the request. Useful for self-signed certificates or development environments.

        Required?                    false
        Position?                    Named
        Accept pipeline input?       false
        Accept wildcard characters?  false

    .OUTPUTS
    System.Object
    Returns the attachment metadata as a PowerShell object. This includes properties such as attachmentId, mime, title, ownerId, size, and other details, but not the file or binary content itself.

    .EXAMPLE
    Get-TriliumAttachment -AttachmentID "evnnmvHTCgIn"
    Retrieves the metadata for the attachment with the specified ID and outputs it as a PowerShell object.

    .EXAMPLE
    Get-TriliumAttachment -AttachmentID "evnnmvHTCgIn" -SkipCertCheck
    Retrieves the attachment metadata while skipping SSL certificate validation.

    .NOTES
    - Requires authentication via Connect-TriliumAuth.
    - This function returns only the metadata for the attachment, not the file or binary content. To download the actual content, use Get-TriliumAttachmentContent.
    - If the attachment is not found or an error occurs, the function returns the error response from the server.
    - For more information on finding attachment IDs, see Get-TriliumAttachment.

    .LINK
    https://github.com/ptmorris1/TriliumNext-Powershell-Module
    #>
    [CmdletBinding()]
    param (
        # Attachment ID to retrieve
        [Parameter(Mandatory = $True)][ValidateNotNullOrEmpty()][string]$AttachmentID,
        [switch]$SkipCertCheck
    )
    begin {
        if (!$global:TriliumCreds) { Write-Error -Message 'Need to run: Connect-TriliumAuth'; exit }
    }
    process {
        try {
            if ($SkipCertCheck -eq $true) {
                $PSDefaultParameterValues = @{'Invoke-RestMethod:SkipCertificateCheck' = $true }
            }
            $TriliumHeaders = @{}
            $TriliumHeaders.Add('Authorization', "$($TriliumCreds.Authorization)")
            $uri = "$($TriliumCreds.URL)/attachments/$AttachmentID"
            Invoke-RestMethod -Uri $uri -Headers $TriliumHeaders -SkipHeaderValidation
        } catch {
            $_.Exception.Response
        }
    }
    end {
        return
    }
}