mirror of
https://github.com/snazy2000/SnipeitPS.git
synced 2025-12-16 19:25:47 +00:00
d0e8b3f443
Add missing parameters and help to Get functions. Mostly searching by name, but also searching by custom fields for assets.
154 lines
4.2 KiB
PowerShell
154 lines
4.2 KiB
PowerShell
<#
|
|
.SYNOPSIS
|
|
Gets a list of Snipe-it Departments
|
|
|
|
.PARAMETER search
|
|
A text string to search the Departments data
|
|
|
|
.PARAMETER id
|
|
A id of specific Department
|
|
|
|
.PARAMETER name
|
|
Optionally restrict department results to this department name.
|
|
|
|
.PARAMETER manager_id
|
|
Optionally restrict department results to this manager ID.
|
|
|
|
.PARAMETER company_id
|
|
Optionally restrict department results to this company ID.
|
|
|
|
.PARAMETER location_id
|
|
Optionally restrict department results to this location ID.
|
|
|
|
.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-SnipeitDepartment
|
|
|
|
.EXAMPLE
|
|
Get-SnipeitDepartment -search Department1
|
|
|
|
.EXAMPLE
|
|
Get-SnipeitDepartment -id 1
|
|
|
|
#>
|
|
|
|
function Get-SnipeitDepartment() {
|
|
[CmdletBinding(DefaultParameterSetName = 'Search')]
|
|
Param(
|
|
[parameter(ParameterSetName='Search')]
|
|
[string]$search,
|
|
|
|
[parameter(ParameterSetName='Get with ID')]
|
|
[int]$id,
|
|
|
|
[parameter(ParameterSetName='Search')]
|
|
[string]$name,
|
|
|
|
[parameter(ParameterSetName='Search')]
|
|
[int]$manager_id,
|
|
|
|
[parameter(ParameterSetName='Search')]
|
|
[int]$company_id,
|
|
|
|
[parameter(ParameterSetName='Search')]
|
|
[int]$location_id,
|
|
|
|
[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(ParameterSetName='Search')]
|
|
[ValidateSet('id', 'name', 'image', 'users_count', 'created_at')]
|
|
[string]$sort = "created_at",
|
|
|
|
[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/departments"
|
|
|
|
if ($search -and $id ) {
|
|
Throw "[$($MyInvocation.MyCommand.Name)] Please specify only -search or -id parameter , not both "
|
|
}
|
|
|
|
if ($id) {
|
|
$api= "/api/v1/departments/$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-SnipeitDepartment @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
|
|
}
|
|
}
|
|
}
|
|
|