Functions/CatalogItems/Rest/Write-RsRestCatalogItem.ps1
|
# Copyright (c) 2016 Microsoft Corporation. All Rights Reserved. # Licensed under the MIT License (MIT) function Write-RsRestCatalogItem { <# .SYNOPSIS This command uploads an item from disk to a report server. It is for SQL Server Reporting Service 2016 and later. .DESCRIPTION This command uploads an item from disk to a report server. It is for SQL Server Reporting Service 2016 and later. Currently, we only support uploading Reports, DataSources, DataSets and Mobile Reports. .PARAMETER Path Path to item to upload on disk. .PARAMETER RsFolder Folder on reportserver to upload the item to. .PARAMETER Overwrite Overwrite the old entry, if an existing catalog item with same name exists at the specified destination. .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 Write-RsRestCatalogItem -Path 'c:\reports\monthlyreport.rdl' -RsFolder '/monthlyreports' Description ----------- Uploads the report 'monthlyreport.rdl' to folder '/monthlyreports' to v1.0 REST Endpoint located at http://localhost/reports/. .EXAMPLE Write-RsRestCatalogItem -Path 'c:\reports\monthlyreport.rdl' -RsFolder '/monthlyreports' -ApiVersion 'v1.0' Description ----------- Uploads the report 'monthlyreport.rdl' to folder '/monthlyreports' to v1.0 REST Endpoint located at http://localhost/reports/. .EXAMPLE Write-RsRestCatalogItem -WebSession $mySession -Path 'c:\reports\monthlyreport.rdl' -RsFolder '/monthlyreports' Description ----------- Uploads the report 'monthlyreport.rdl' to folder '/monthlyreports' to v1.0 REST Endpoint. .EXAMPLE Write-RsRestCatalogItem -ReportPortalUri 'http://myserver/reports' -Path 'c:\reports\monthlyreport.rdl' -RsFolder '/monthlyreports' Description ----------- Uploads the report 'monthlyreport.rdl' to folder '/monthlyreports' to v1.0 REST Endpoint located at http://myserver/reports. #> [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'Medium')] param( [Parameter(Mandatory = $True, ValueFromPipeline = $true)] [string[]] $Path, [Alias('DestinationFolder')] [Parameter(Mandatory = $True)] [string] $RsFolder, [Alias('Override')] [switch] $Overwrite, [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 $catalogItemsUri = $ReportPortalUri + "api/$ApiVersion/CatalogItems" $catalogItemsByPathApi = $ReportPortalUri + "api/$ApiVersion/CatalogItemByPath(path=@path)?@path=%27{0}%27" $catalogItemsUpdateUri = $ReportPortalUri + "api/$ApiVersion/CatalogItems({0})" } Process { foreach ($item in $Path) { if (!(Test-Path $item)) { throw "No item found at the specified path: $item!" } $EntirePath = Convert-Path $item $item = Get-Item $EntirePath $itemType = Get-ItemType $item.Extension $itemName = $item.BaseName $itemPath = "" if ($RsFolder -eq "/") { $itemPath = "/$itemName" } else { $itemPath = "$RsFolder/$itemName" } Write-Verbose "Reading file content..." if ($itemType -ne 'DataSource') { $bytes = [System.IO.File]::ReadAllBytes($EntirePath) $payload = @{ "@odata.type" = "#Model.$itemType"; "Content" = [System.Convert]::ToBase64String($bytes); "ContentType"=""; "Name" = $itemName; "Path" = $itemPath; } } else { [xml] $dataSourceXml = Get-Content -Path $EntirePath if ($item.Extension -eq '.rsds') { if ($dataSourceXml -eq $null -or $dataSourceXml.DataSourceDefinition -eq $null -or $dataSourceXml.DataSourceDefinition.Extension -eq $null -or $dataSourceXml.DataSourceDefinition.ConnectString -eq $null) { throw 'Invalid data source file!' } $connectionString = $dataSourceXml.DataSourceDefinition.ConnectString $dataSourceType = $dataSourceXml.DataSourceDefinition.Extension $credentialRetrieval = "none" $enabled = "true" -like $content.DataSourceDefinition.Enabled } elseif ($item.Extension -eq '.rds') { if ($dataSourceXml -eq $null -or $dataSourceXml.RptDataSource -eq $null -or $dataSourceXml.RptDataSource.Name -eq $null -or $dataSourceXml.RptDataSource.ConnectionProperties -eq $null -or $dataSourceXml.RptDataSource.ConnectionProperties.ConnectString -eq $null -or $dataSourceXml.RptDataSource.ConnectionProperties.Extension -eq $null) { throw 'Invalid data source file!' } $itemName = $dataSourceXml.RptDataSource.Name $itemPath = $itemPath.Substring(0, $itemPath.LastIndexOf('/') + 1) + $itemName $enabled = $true $connectionProperties = $dataSourceXml.RptDataSource.ConnectionProperties $connectionString = $connectionProperties.ConnectString $dataSourceType = $connectionProperties.Extension $credentialRetrieval = "none" if ($connectionProperties.Prompt -ne $null) { $credentialRetrieval = "prompt" $prompt = $connectionProperties.Prompt } elseif ($connectionProperties.IntegratedSecurity -eq $true) { $credentialRetrieval = "integrated" } } $payload = @{ "@odata.type" = "#Model.$itemType"; "Path" = $itemPath; "Name" = $itemName; "Description" = ""; "DataSourceType" = $dataSourceType; "ConnectionString" = $connectionString; "CredentialRetrieval" = $credentialRetrieval; "CredentialsByUser" = $null; "CredentialsInServer" = $null; "Hidden" = $false; "IsConnectionStringOverridden" = $true; "IsEnabled" = $enabled; } if ($credentialRetrieval -eq "Prompt") { $payload["CredentialsByUser"] = @{ "DisplayText" = $prompt; "UseAsWindowsCredentials" = $true; } } } try { Write-Verbose "Uploading $EntirePath to $RsFolder..." $payloadJson = ConvertTo-Json $payload if ($Credential -ne $null) { Invoke-WebRequest -Uri $catalogItemsUri -Method Post -WebSession $WebSession -Body $payloadJson -ContentType "application/json" -Credential $Credential -Verbose:$false | Out-Null } else { Invoke-WebRequest -Uri $catalogItemsUri -Method Post -WebSession $WebSession -Body $payloadJson -ContentType "application/json" -UseDefaultCredentials -Verbose:$false | Out-Null } Write-Verbose "$EntirePath was uploaded to $RsFolder successfully!" } catch { if ($_.Exception.Response -ne $null -and $_.Exception.Response.StatusCode -eq 409 -and $Overwrite) { try { Write-Verbose "$itemName already exists at $RsFolder. Retrieving id in order to overwrite it..." $uri = [String]::Format($catalogItemsByPathApi, $itemPath) if ($Credential -ne $null) { $response = Invoke-WebRequest -Uri $uri -Method Get -WebSession $WebSession -Credential $Credential -Verbose:$false } else { $response = Invoke-WebRequest -Uri $uri -Method Get -WebSession $WebSession -UseDefaultCredentials -Verbose:$false } # parsing response to get Id $itemInfo = ConvertFrom-Json $response.Content $itemId = $itemInfo.Id Write-Verbose "Overwriting $itemName at $itemPath..." $uri = [String]::Format($catalogItemsUpdateUri, $itemId) if ($Credential -ne $null) { Invoke-WebRequest -Uri $uri -Method Put -WebSession $WebSession -Body $payloadJson -ContentType "application/json" -Credential $Credential -Verbose:$false | Out-Null } else { Invoke-WebRequest -Uri $uri -Method Put -WebSession $WebSession -Body $payloadJson -ContentType "application/json" -UseDefaultCredentials -Verbose:$false | Out-Null } Write-Verbose "$EntirePath was uploaded to $RsFolder successfully!" } catch { throw (New-Object System.Exception("Failed to create catalog item: $($_.Exception.Message)", $_.Exception)) } return } throw (New-Object System.Exception("Failed to create catalog item: $($_.Exception.Message)", $_.Exception)) } } } } |