Api/Invoke-NavContainerApi.ps1
|
<#
.Synopsis Invoke Api in Container .Description Invoke an Api in a Container. .Parameter containerName Name of the container in which you want to invoke an api .Parameter tenant Name of the tenant in which context you want to invoke an api .Parameter CompanyId Id the Company in which context you want to invoke an api (Use Get-BcContainerApiCompanyId .Parameter Credential Credentials for the user making invoking the api (do not specify if using Windows auth) .Parameter APIPublisher Publisher of the custom api you want to invoke (empty for built in api) .Parameter APIGroup Group of the custom api you want to invoke (empty for built in api) .Parameter APIVersion Version of the API you want to invoke (beta, v1.0, ...) .Parameter Method API Method to invoke (GET, POST, PATCH, DELETE) .Parameter Query API Query (ex. salesInvoices?$filter=totalAmountIncludingTax gt 10000) .Parameter InFile When uploading a file through APIs, specify the file in InFile .Parameter headers Additional headers for the api (example: @{ "If-Match" = $etag } ) .Parameter body Parameters for the api (example: @{ "name" = "The Name"; "phoneNumber" = "12 34 56 78" }) .Parameter silent Include the silent switch to avoid the printout of the URL invoked .Example $result = Invoke-BcContainerApi -containerName $containerName -tenant $tenant -APIVersion "v2.0" -Query "companies?`$filter=$companyFilter" -credential $credential .Example Invoke-BcContainerApi -containerName $containerName -CompanyId $companyId -APIVersion "v2.0" -Query "customers" -credential $credential | Select-Object -ExpandProperty value .Example Invoke-BcContainerApi -containerName $containerName -CompanyId $companyId -APIVersion "v2.0" -Query "customers?`$filter=$([Uri]::EscapeDataString("number eq '10000'"))" -credential $credential | Select-Object -ExpandProperty value .Example Invoke-BcContainerApi -containerName $containerName -CompanyId $companyId -APIVersion "v2.0" -Query "salesInvoices?`$filter=$([Uri]::EscapeDataString("status eq 'Open' and totalAmountExcludingTax gt 1000.00"))" -credential $credential | Select-Object -ExpandProperty value #> function Invoke-BcContainerApi { Param ( [string] $containerName = $bcContainerHelperConfig.defaultContainerName, [Parameter(Mandatory=$false)] [string] $tenant = "default", [Parameter(Mandatory=$false)] [string] $CompanyId, [Parameter(Mandatory=$false)] [PSCredential] $credential = $null, [Parameter(Mandatory=$false)] [string] $APIPublisher = "", [Parameter(Mandatory=$false)] [string] $APIGroup = "", [Parameter(Mandatory=$true)] [string] $APIVersion, [Parameter(Mandatory=$false)] [string] $Method = "GET", [Parameter(Mandatory=$false)] [string] $Query, [Parameter(Mandatory=$false)] [string] $inFile, [Parameter(Mandatory=$false)] [hashtable] $headers = @{}, [Parameter(Mandatory=$false)] [hashtable] $body = $null, [switch] $silent, [HashTable] $bcAuthContext ) $telemetryScope = InitTelemetryScope -name $MyInvocation.InvocationName -parameterValues $PSBoundParameters -includeParameters @() try { if ($bcAuthContext) { } $customConfig = Get-BcContainerServerConfiguration -ContainerName $containerName $auth = $customConfig.ClientServicesCredentialType $parameters = @{} if ($auth -eq "Windows") { #Write-Host "Using Windows Authentication" $parameters += @{ "usedefaultcredential" = $true } } else { if ($bcAuthContext) { $bcAuthContext = Renew-BcAuthContext $bcAuthContext #Write-Host "Using AAD Authentication" $headers += @{ "Authorization" = "Bearer $($bcAuthContext.AccessToken)" } } else { if (!($credential)) { throw "You need to specify credentials when you are not using Windows Authentication" } #Write-Host "Using Basic Authentication" $parameters += @{ "credential" = $credential } } } $serverInstance = $customConfig.ServerInstance if ($customConfig.ODataServicesSSLEnabled -eq "true") { $protocol = "https://" } else { $protocol = "http://" } $ip = Get-BcContainerIpAddress -containerName $containerName if ($ip) { $url = "$($protocol)$($ip):$($customConfig.ODataServicesPort)/$($customConfig.ServerInstance)/api" } else { $url = $customconfig.PublicODataBaseUrl.Replace("/OData","/api") } $sslVerificationDisabled = ($protocol -eq "https://") if ($sslVerificationDisabled) { if ($isPsCore) { $parameters += @{ "SkipCertificateCheck" = $true } $sslVerificationDisabled = $false } else { [SslVerification]::Disable() } } if ($method -eq "POST" -and !$body) { $body = @{} } if ($APIPublisher) { $url += "/$APIPublisher" } if ($APIGroup) { $url += "/$APIGroup" } $url += "/$APIVersion" if ($companyId) { $url += "/companies($CompanyId)" } $url += "/$Query" if ($Query.Contains('?')) { $url += "&tenant=$tenant" } else { $url += "?tenant=$tenant" } if ($inFile) { $headers += @{"Content-Type" = "application/octet-stream" } $parameters += @{ "InFile" = $inFile } } else { $headers += @{"Content-Type" = "application/json" } } if ($body) { $parameters += @{ "body" = [System.Text.UTF8Encoding]::GetEncoding('UTF-8').GetBytes((ConvertTo-Json $body -Depth 100)) } } if (!$silent) { Write-Host "Invoke $Method on $url" } Invoke-RestMethod -Method $Method -uri "$url" -Headers $headers @parameters @allowUnencryptedAuthenticationParam if ($sslverificationdisabled) { [SslVerification]::Enable() } } catch { TrackException -telemetryScope $telemetryScope -errorRecord $_ throw } finally { TrackTrace -telemetryScope $telemetryScope } } Set-Alias -Name Invoke-NavContainerApi -Value Invoke-BcContainerApi Export-ModuleMember -Function Invoke-BcContainerApi -Alias Invoke-NavContainerApi |