mirror of
https://github.com/snazy2000/SnipeitPS.git
synced 2025-12-13 09:52:30 +00:00
3a5d951cb9
* Add additional parameters to Get functions, especially -name wherever possible. * Add some missing function help
129 lines
3.5 KiB
PowerShell
129 lines
3.5 KiB
PowerShell
<#
|
|
.SYNOPSIS
|
|
Gets a list of Snipe-it Companies
|
|
|
|
.PARAMETER search
|
|
A text string to search the Companies data
|
|
|
|
.PARAMETER id
|
|
A id of specific Company
|
|
|
|
.PARAMETER name
|
|
Optionally restrict company results to this company name.
|
|
|
|
.PARAMETER limit
|
|
Specify the number of results you wish to return. Defaults to 50. Defines batch size for -all
|
|
|
|
.PARAMETER offset
|
|
Offset to use
|
|
|
|
.PARAMETER all
|
|
A return all results, works with -offset and other parameters
|
|
.PARAMETER url
|
|
Deprecated parameter, please use Connect-SnipeitPS instead. URL of Snipeit system.
|
|
|
|
.PARAMETER apiKey
|
|
Deprecated parameter, please use Connect-SnipeitPS instead. Users API Key for Snipeit.
|
|
|
|
.EXAMPLE
|
|
Get-SnipeitCompany
|
|
Gets all companies
|
|
|
|
.EXAMPLE
|
|
Get-SnipeitCompany -id 1
|
|
Gets specific company
|
|
|
|
#>
|
|
|
|
function Get-SnipeitCompany() {
|
|
[CmdletBinding(DefaultParameterSetName = 'Search')]
|
|
Param(
|
|
[parameter(ParameterSetName='Search')]
|
|
[string]$search,
|
|
|
|
[parameter(ParameterSetName='Get with ID')]
|
|
[int]$id,
|
|
|
|
[parameter(ParameterSetName='Search')]
|
|
[string]$name,
|
|
|
|
[parameter(ParameterSetName='Search')]
|
|
[ValidateSet("asc", "desc")]
|
|
[string]$order = "desc",
|
|
|
|
[parameter(ParameterSetName='Search')]
|
|
[int]$limit = 50,
|
|
|
|
[parameter(ParameterSetName='Search')]
|
|
[int]$offset,
|
|
|
|
[parameter(ParameterSetName='Search')]
|
|
[switch]$all = $false,
|
|
|
|
[parameter(mandatory=$false)]
|
|
[string]$url,
|
|
|
|
[parameter(mandatory=$false)]
|
|
[string]$apiKey
|
|
)
|
|
|
|
begin {
|
|
Test-SnipeitAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name
|
|
|
|
$SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters
|
|
|
|
$api = "/api/v1/companies"
|
|
|
|
if ($search -and $id ) {
|
|
Throw "[$($MyInvocation.MyCommand.Name)] Please specify only -search or -id parameter , not both "
|
|
}
|
|
|
|
if ($id) {
|
|
$api= "/api/v1/companies/$id"
|
|
}
|
|
|
|
$Parameters = @{
|
|
Api = $api
|
|
Method = 'Get'
|
|
GetParameters = $SearchParameter
|
|
}
|
|
|
|
if ($PSBoundParameters.ContainsKey('apiKey') -and '' -ne [string]$apiKey) {
|
|
Write-Warning "-apiKey parameter is deprecated, please use Connect-SnipeitPS instead."
|
|
Set-SnipeitPSLegacyApiKey -apiKey $apikey
|
|
}
|
|
|
|
if ($PSBoundParameters.ContainsKey('url') -and '' -ne [string]$url) {
|
|
Write-Warning "-url parameter is deprecated, please use Connect-SnipeitPS instead."
|
|
Set-SnipeitPSLegacyUrl -url $url
|
|
}
|
|
}
|
|
process {
|
|
if ($all) {
|
|
$offstart = $(if ($offset) {$offset} Else {0})
|
|
$callargs = $SearchParameter
|
|
$callargs.Remove('all')
|
|
|
|
while ($true) {
|
|
$callargs['offset'] = $offstart
|
|
$callargs['limit'] = $limit
|
|
$res=Get-SnipeitCompany @callargs
|
|
$res
|
|
if ($res.count -lt $limit) {
|
|
break
|
|
}
|
|
$offstart = $offstart + $limit
|
|
}
|
|
} else {
|
|
$result = Invoke-SnipeitMethod @Parameters
|
|
$result
|
|
}
|
|
}
|
|
|
|
end {
|
|
# reset legacy sessions
|
|
if ($PSBoundParameters.ContainsKey('url') -and '' -ne [string]$url -or $PSBoundParameters.ContainsKey('apiKey') -and '' -ne [string]$apiKey) {
|
|
Reset-SnipeitPSLegacyApi
|
|
}
|
|
}
|
|
}
|