ReportingServicesTools

0.0.2.8

Functions/CatalogItems/Rest/Out-RsRestCatalogItem.ps1

# Copyright (c) 2016 Microsoft Corporation. All Rights Reserved.
# Licensed under the MIT License (MIT)

function Out-RsRestCatalogItem
{
    <#
        .SYNOPSIS
            This command downloads catalog items from a report server to disk. It is for SQL Server Reporting Service 2016 and later.
        
        .DESCRIPTION
            This command downloads catalog items from a report server to disk. It is for SQL Server Reporting Service 2016 and later.
        
        .PARAMETER RsItem
            Path to catalog item to download.
        
        .PARAMETER Destination
            Folder to download catalog item to.
        
        .PARAMETER ApiVersion
            Specify the version of REST Endpoint to use. Valid values are: "v1.0".
            NOTE: v1.0 of REST Endpoint is not supported by Microsoft.

        .PARAMETER ReportPortalUri
            Specify the Report Portal URL to your SQL Server Reporting Services Instance.
        
        .PARAMETER Credential
            Specify the credentials to use when connecting to the Report Server.

        .PARAMETER WebSession
            Specify the session to be used when making calls to REST Endpoint.

        .EXAMPLE
            Out-RsCatalogItem -RsItem /Report -Destination C:\reports
            
            Description
            -----------
            Downloads the catalog item 'Report' to folder 'C:\reports' from v1.0 REST Endpoint located at http://localhost/reports.

        .EXAMPLE
            Out-RsCatalogItem -RsItem /Report -Destination C:\reports -ApiVersion 'v1.0'
            
            Description
            -----------
            Downloads the catalog item 'Report' to folder 'C:\reports' from v1.0 REST Endpoint located at http://localhost/reports.

        .EXAMPLE
            Out-RsCatalogItem -WebSession $mySession -RsItem /Report -Destination C:\reports
            
            Description
            -----------
            Downloads the catalog item 'Report' to folder 'C:\reports' from v1.0 REST Endpoint.

        .EXAMPLE
            Out-RsCatalogItem -ReportPortalUri 'http://myserver/reports' -RsItem '/Report' -Destination 'C:\reports'
            
            Description
            -----------
            Downloads the catalog item found at '/Report' to folder 'C:\reports' from v1.0 REST Endpoint located at http://myserver/reports.
    #>

    [CmdletBinding()]
    param (
        [Alias('ItemPath', 'Path', 'RsFolder')]
        [Parameter(Mandatory = $True, ValueFromPipeline = $true)]
        [string[]]
        $RsItem,
        
        [ValidateScript({ Test-Path $_ -PathType Container})]
        [Parameter(Mandatory = $True)]
        [string]
        $Destination,

        [ValidateSet("v1.0")]
        [string]
        $ApiVersion = "v1.0",
        
        [string]
        $ReportPortalUri,
        
        [Alias('ReportServerCredentials')]
        [System.Management.Automation.PSCredential]
        $Credential,

        [Microsoft.PowerShell.Commands.WebRequestSession]
        $WebSession
    )

    Begin
    {
        $WebSession = New-RsRestSessionHelper -BoundParameters $PSBoundParameters
        $ReportPortalUri = Get-RsPortalUriHelper -WebSession $WebSession
        $DestinationFullPath = Convert-Path $Destination
        $catalogItemsByPathApi = $ReportPortalUri + "api/$ApiVersion/CatalogItemByPath(path=@path)?@path=%27{0}%27"
        $catalogItemContentApi = $ReportPortalUri + "api/$ApiVersion/CatalogItems({0})/Content/$value"
    }
    Process
    {
        foreach ($item in $RsItem)
        {
            try
            {
                Write-Verbose "Fetching item metadata from server..."
                $url = [string]::Format($catalogItemsByPathApi, $item)
                if ($Credential -ne $null)
                {
                    $response = Invoke-WebRequest -Uri $url -Method Get -WebSession $WebSession -Credential $Credential -Verbose:$false
                }
                else
                {
                    $response = Invoke-WebRequest -Uri $url -Method Get -WebSession $WebSession -UseDefaultCredentials -Verbose:$false
                }
            }
            catch
            {
                throw (New-Object System.Exception("Error while trying to fetch metadata for $item! Exception: $($_.Exception.Message)", $_.Exception))
            }

            Write-Verbose "Parsing item metadata..."
            $itemInfo = ConvertFrom-Json $response.Content
            if ($itemInfo.Type -ne 'MobileReport')
            {
                $itemId = $itemInfo.Id
                $fileName = $itemInfo.Name + (Get-FileExtension -TypeName $itemInfo.Type)
            }
            else
            {
                $packageIdProperty = $itemInfo.Properties | Where-Object { $_.Name -eq 'PackageId' }
                if ($packageIdProperty -ne $null)
                {
                    $itemId = $packageIdProperty.Value
                }
                else
                {
                    throw "Unable to determine Id for $item!"
                }

                $packageNameProperty = $itemInfo.Properties | Where-Object { $_.Name -eq 'PackageName' }
                if ($packageNameProperty -ne $null)
                {
                    $fileName = $packageNameProperty.Value
                }
                else
                {
                    $fileName = $itemInfo.Name + '.rsmobile'
                }
            }

            try
            {
                Write-Verbose "Downloading item from server..."
                $url = [string]::Format($catalogItemContentApi, $itemId)
                if ($Credential -ne $null)
                {
                    $response = Invoke-WebRequest -Uri $url -Method Get -WebSession $WebSession -Credential $Credential -Verbose:$false
                }
                else
                {
                    $response = Invoke-WebRequest -Uri $url -Method Get -WebSession $WebSession -UseDefaultCredentials -Verbose:$false
                }
            }
            catch
            {
                throw (New-Object System.Exception("Error while downloading $item! Exception: $($_.Exception.Message)", $_.Exception))
            }

            Write-Verbose "Writing content to $destinationFilePath..."
            $destinationFilePath = Join-Path -Path $DestinationFullPath -ChildPath $fileName
            [System.IO.File]::WriteAllBytes($destinationFilePath, $response.Content)
            Write-Verbose "$item was downloaded to $destinationFilePath successfully!"
        }
    }
}