BaseApiBuilder

1.1.0

Powershell toolset for building Powershell wrappers for RESTful APIs

Minimum PowerShell version

5.0

There is a newer prerelease version of this module available.
See the version list below for details.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name BaseApiBuilder -RequiredVersion 1.1.0

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name BaseApiBuilder -Version 1.1.0

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

(c) 2024 LarryWisherMan. All rights reserved.

Package Details

Author(s)

  • LarryWisherMan

Functions

Close-ApiSession ConvertTo-PlainText Get-ApiWebSession Get-AuthHeaders Get-BaseUri Get-CurrentApiSession Initialize-ApiSession Initialize-AuthSession Initialize-WebRequestSession Invoke-ApiRequest New-ApiSession New-ApiUri New-FilterQuery Set-BaseUri Set-CurrentApiSession Test-ApiSession

Dependencies

This module has no dependencies.

Release Notes

## [1.1.0] - 2024-05-07

### Added
- New function `Invoke-ApiRequest` to standarized API calling with the websession
- New function `New-FilterQuery` to Construct a complete filter query string from a hashtable
- New function `Invoke-BuildCondition` to generate a query condition string dynamically based on the input field and details provided (used in `New-FilterQuery`)
- New function `Invoke-EscapeFilterValue` to escape characters that have special significance in query languages, such as backslashes (\), asterisks (*), and double quotes (") (Used in `Invoke-BuildCondition`)

FileList

Version History

Version Downloads Last updated
1.2.0-previe... 4 6/21/2024
1.1.0 (current version) 97 5/7/2024
1.1.0-previe... 4 5/7/2024
1.0.0 9 5/4/2024
0.1.0-previe... 4 5/4/2024