Public/Get-SnipeitAccessory.ps1
|
<# .SYNOPSIS Gets a list of Snipe-it Accessories .DESCRIPTION Gets a list of Snipe-it Accessories .PARAMETER search A text string to search the Accessory data .PARAMETER user_id Return Accessories checked out to user id .PARAMETER id A id of specific Accessory .PARAMETER company_id Optionally restrict Accessory results to this company_id field .PARAMETER category_id Optionally restrict Accessory results to this category_id field .PARAMETER manufacturer_id Optionally restrict Accessory results to this manufacturer_id field .PARAMETER supplier_id Optionally restrict Accessory results to this supplier_id field .PARAMETER limit Specify the number of results you wish to return. Defaults to 50. Defines batch size for -all .PARAMETER offset Result 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-SnipeitAccessory -search Keyboard .EXAMPLE Get-SnipeitAccessory -id 1 .EXAMPLE Get-SnipeitAccessory -user_id 1 Get accessories checked out to user ID 1 #> function Get-SnipeitAccessory() { [CmdletBinding(DefaultParameterSetName = 'Search')] Param( [parameter(ParameterSetName='Search')] [string]$search, [parameter(ParameterSetName='Get by ID')] [int]$id, [parameter(ParameterSetName='Accessories checked out to user id')] [int]$user_id, [parameter(ParameterSetName='Search')] [int]$company_id, [parameter(ParameterSetName='Search')] [int]$category_id, [parameter(ParameterSetName='Search')] [int]$manufacturer_id, [parameter(ParameterSetName='Search')] [int]$supplier_id, [parameter(ParameterSetName='Search')] [string]$sort = "created_at", [parameter(ParameterSetName='Search')] [ValidateSet("asc", "desc")] [string]$order = "desc", [parameter(ParameterSetName='Search')] [int]$limit = 50, [parameter(ParameterSetName='Search')] [int]$offset, [parameter(ParameterSetName='Search')] [parameter(ParameterSetName='Accessories checked out to user id')] [switch]$all = $false, [parameter(mandatory = $false)] [string]$url, [parameter(mandatory = $false)] [string]$apiKey ) begin { Test-SnipeitAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name switch($PsCmdlet.ParameterSetName) { 'Search' {$api = "/api/v1/accessories"} 'Get by ID' {$api= "/api/v1/accessories/$id"} 'Accessories checked out to user id' {$api = "/api/v1/users/$user_id/accessories"} } $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $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-SnipeitAccessory @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 } } } |