public/api-v1/content/Invoke-ConfluenceGetContentById.ps1

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
72
73
$ConfluenceContentExpand = @("childTypes.all","childTypes.attachment","childTypes.comment","childTypes.page",
                             "container","metadata.currentuser","metadata.properties","metadata.labels",
                             "metadata.frontend","operations","children.page","children.attachment","children.comment",
                             "restrictions.read.restrictions.user","restrictions.read.restrictions.group",
                             "restrictions.update.restrictions.user","restrictions.update.restrictions.group",
                             "history","history.lastUpdated","history.previousVersion","history.contributors",
                             "history.nextVersion","ancestors","body","version","descendants.page",
                             "descendants.attachment","descendants.comment","space")

#https://developer.atlassian.com/cloud/confluence/rest/#api-content-id-get
function Invoke-ConfluenceGetContentById {
    [CmdletBinding()]
    param (
        # The Id of the content to retrieve
        [Parameter(Mandatory,Position=0,ValueFromPipeline,ValueFromPipelineByPropertyName)]
        [Alias("ContentId")]
        [int32]
        $Id,

        # Status of content to retrieve
        [Parameter(Position=1,ValueFromPipelineByPropertyName)]
        [ValidateSet("current", "trashed", "any", "draft")]
        [string]
        $Status = "current",

        # The version number to return
        [Parameter(Position=2,ValueFromPipelineByPropertyName)]
        [int32]
        $Version,

        # Used to expand additional attributes
        [Parameter(Position=3,ValueFromPipelineByPropertyName)]
        [ValidateScript({ Compare-StringArraySubset $ConfluenceContentExpand $_ })]
        [string[]]
        $Expand,

        # Set this flag to render embeded contents as the version they were when the content was saved
        [Parameter(ValueFromPipelineByPropertyName)]
        [switch]
        $EmbedRenderAtSave,

        # Set this flag to triggered the "viewed" event for the content
        [Parameter(ValueFromPipelineByPropertyName)]
        [switch]
        $TriggerView,

        # The AtlassianContext object to use for the request (use New-AtlassianContext)
        [Parameter()]
        [object]
        $RequestContext
    )
    begin {
        $results = @()
    }
    process {
        $functionPath = "/wiki/rest/api/content/$Id"
        $verb = "GET"

        $query = New-PACRestMethodQueryParams @{
            status = $Status
            embeddedContentRender = IIF $EmbedRenderAtSave "version-at-save" "current"
        }
        if($PSBoundParameters.ContainsKey("Version")){$query.Add("version",$Version)}
        if($PSBoundParameters.ContainsKey("Expand")){$query.Add("expand",$Expand -join ",")}
        if($TriggerView){$query.Add("trigger","viewed")}

        $method = New-PACRestMethod $functionPath $verb $query
        $results += $method.Invoke($RequestContext)
    }
    end {
        $results
    }
}