Functions/Get-AtwsProduct.ps1
|
#Requires -Version 5.0 <# .COPYRIGHT Copyright (c) Hugo Klemmestad. All rights reserved. Licensed under the MIT license. See https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md for license information. #> Function Get-AtwsProduct { <# .SYNOPSIS This function get one or more Product through the Autotask Web Services API. .DESCRIPTION This function creates a query based on any parameters you give and returns any resulting objects from the Autotask Web Services Api. By default the function returns any objects with properties that are Equal (-eq) to the value of the parameter. To give you more flexibility you can modify the operator by using -NotEquals [ParameterName[]], -LessThan [ParameterName[]] and so on. Possible operators for all parameters are: -NotEquals -GreaterThan -GreaterThanOrEqual -LessThan -LessThanOrEquals Additional operators for [string] parameters are: -Like (supports * or % as wildcards) -NotLike -BeginsWith -EndsWith -Contains Properties with picklists are: ProductCategory PeriodType BillingType PriceCostMethod Entities that have fields that refer to the base entity of this CmdLet: .INPUTS Nothing. This function only takes parameters. .OUTPUTS [Autotask.Product[]]. This function outputs the Autotask.Product that was returned by the API. .EXAMPLE Get-AtwsProduct -Id 0 Returns the object with Id 0, if any. .EXAMPLE Get-AtwsProduct -ProductName SomeName Returns the object with ProductName 'SomeName', if any. .EXAMPLE Get-AtwsProduct -ProductName 'Some Name' Returns the object with ProductName 'Some Name', if any. .EXAMPLE Get-AtwsProduct -ProductName 'Some Name' -NotEquals ProductName Returns any objects with a ProductName that is NOT equal to 'Some Name', if any. .EXAMPLE Get-AtwsProduct -ProductName SomeName* -Like ProductName Returns any object with a ProductName that matches the simple pattern 'SomeName*'. Supported wildcards are * and %. .EXAMPLE Get-AtwsProduct -ProductName SomeName* -NotLike ProductName Returns any object with a ProductName that DOES NOT match the simple pattern 'SomeName*'. Supported wildcards are * and %. .EXAMPLE Get-AtwsProduct -ProductCategory 'PickList Label' Returns any Products with property ProductCategory equal to the 'PickList Label'. '-PickList' is any parameter on . .EXAMPLE Get-AtwsProduct -ProductCategory 'PickList Label' -NotEquals ProductCategory Returns any Products with property ProductCategory NOT equal to the 'PickList Label'. .EXAMPLE Get-AtwsProduct -ProductCategory 'PickList Label1', 'PickList Label2' Returns any Products with property ProductCategory equal to EITHER 'PickList Label1' OR 'PickList Label2'. .EXAMPLE Get-AtwsProduct -ProductCategory 'PickList Label1', 'PickList Label2' -NotEquals ProductCategory Returns any Products with property ProductCategory NOT equal to NEITHER 'PickList Label1' NOR 'PickList Label2'. .EXAMPLE Get-AtwsProduct -Id 1234 -ProductName SomeName* -ProductCategory 'PickList Label1', 'PickList Label2' -Like ProductName -NotEquals ProductCategory -GreaterThan Id An example of a more complex query. This command returns any Products with Id GREATER THAN 1234, a ProductName that matches the simple pattern SomeName* AND that has a ProductCategory that is NOT equal to NEITHER 'PickList Label1' NOR 'PickList Label2'. .NOTES Related commands: New-AtwsProduct Set-AtwsProduct #> [CmdLetBinding(SupportsShouldProcess = $true, DefaultParameterSetName='Filter', ConfirmImpact='None', HelpURI='https://github.com/ecitsolutions/Autotask/blob/master/Docs/Get-AtwsProduct.md')] Param ( # A filter that limits the number of objects that is returned from the API [Parameter( Mandatory = $true, ValueFromRemainingArguments = $true, ParametersetName = 'Filter' )] [ValidateNotNullOrEmpty()] [string[]] $Filter, # Follow this external ID and return any external objects [Parameter( ParametersetName = 'Filter' )] [Parameter( ParametersetName = 'By_parameters' )] [Alias('GetRef')] [ValidateNotNullOrEmpty()] [ValidateSet('CostAllocationCodeID', 'DefaultInstalledProductCategoryID', 'DefaultVendorID', 'ImpersonatorCreatorResourceID', 'ProductAllocationCodeID')] [string] $GetReferenceEntityById, # Return all objects in one query [Parameter( ParametersetName = 'Get_all' )] [switch] $All, # A single user defined field can be used pr query [Parameter( ParametersetName = 'By_parameters' )] [Alias('UDF')] [ValidateNotNullOrEmpty()] [Autotask.UserDefinedField] $UserDefinedField, # Active [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Nullable[boolean][]] $Active, # Billing Type [Parameter( ParametersetName = 'By_parameters' )] [ArgumentCompleter({ param($Cmd, $Param, $Word, $Ast, $FakeBound) Get-AtwsPicklistValue -Entity Product -FieldName BillingType -Label -Quoted })] [ValidateScript({ $set = (Get-AtwsPicklistValue -Entity Product -FieldName BillingType -Label) + (Get-AtwsPicklistValue -Entity Product -FieldName BillingType -Value) if ($_ -in $set) { return $true} else { Write-Warning ('{0} is not one of {1}' -f $_, ($set -join ', ')) Return $false } })] [string[]] $BillingType, # Cost Allocation Code ID [Parameter( ParametersetName = 'By_parameters' )] [Nullable[Int][]] $CostAllocationCodeID, # Default Installed Asset Category ID [Parameter( ParametersetName = 'By_parameters' )] [Nullable[Int][]] $DefaultInstalledProductCategoryID, # Vendor Account ID [Parameter( ParametersetName = 'By_parameters' )] [Nullable[Int][]] $DefaultVendorID, # Product Description [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,2000)] [string[]] $Description, # Does Not Require Procurement [Parameter( ParametersetName = 'By_parameters' )] [Nullable[boolean][]] $DoesNotRequireProcurement, # Eligible For RMA [Parameter( ParametersetName = 'By_parameters' )] [Nullable[boolean][]] $EligibleForRma, # External ID [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,50)] [string[]] $ExternalProductID, # ProductID [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Nullable[long][]] $id, # Impersonator Creator Resource ID [Parameter( ParametersetName = 'By_parameters' )] [Nullable[Int][]] $ImpersonatorCreatorResourceID, # Internal Product ID [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,50)] [string[]] $InternalProductID, # Product Link [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,500)] [string[]] $Link, # Manufacturer Account Name [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,100)] [string[]] $ManufacturerName, # Manufacturer Product Number [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,50)] [string[]] $ManufacturerProductName, # markup_rate [Parameter( ParametersetName = 'By_parameters' )] [Nullable[double][]] $MarkupRate, # MSRP [Parameter( ParametersetName = 'By_parameters' )] [Nullable[double][]] $MSRP, # Product Name [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [ValidateLength(0,1000)] [string[]] $Name, # Period Type [Parameter( ParametersetName = 'By_parameters' )] [ArgumentCompleter({ param($Cmd, $Param, $Word, $Ast, $FakeBound) Get-AtwsPicklistValue -Entity Product -FieldName PeriodType -Label -Quoted })] [ValidateScript({ $set = (Get-AtwsPicklistValue -Entity Product -FieldName PeriodType -Label) + (Get-AtwsPicklistValue -Entity Product -FieldName PeriodType -Value) if ($_ -in $set) { return $true} else { Write-Warning ('{0} is not one of {1}' -f $_, ($set -join ', ')) Return $false } })] [string[]] $PeriodType, # Price Cost Method [Parameter( ParametersetName = 'By_parameters' )] [ArgumentCompleter({ param($Cmd, $Param, $Word, $Ast, $FakeBound) Get-AtwsPicklistValue -Entity Product -FieldName PriceCostMethod -Label -Quoted })] [ValidateScript({ $set = (Get-AtwsPicklistValue -Entity Product -FieldName PriceCostMethod -Label) + (Get-AtwsPicklistValue -Entity Product -FieldName PriceCostMethod -Value) if ($_ -in $set) { return $true} else { Write-Warning ('{0} is not one of {1}' -f $_, ($set -join ', ')) Return $false } })] [string[]] $PriceCostMethod, # Allocation Code ID [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Nullable[Int][]] $ProductAllocationCodeID, # Product Category [Parameter( ParametersetName = 'By_parameters' )] [ArgumentCompleter({ param($Cmd, $Param, $Word, $Ast, $FakeBound) Get-AtwsPicklistValue -Entity Product -FieldName ProductCategory -Label -Quoted })] [ValidateScript({ $set = (Get-AtwsPicklistValue -Entity Product -FieldName ProductCategory -Label) + (Get-AtwsPicklistValue -Entity Product -FieldName ProductCategory -Value) if ($_ -in $set) { return $true} else { Write-Warning ('{0} is not one of {1}' -f $_, ($set -join ', ')) Return $false } })] [string[]] $ProductCategory, # Is Serialized [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Nullable[boolean][]] $Serialized, # Product SKU [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,50)] [string[]] $SKU, # Unit Cost [Parameter( ParametersetName = 'By_parameters' )] [Nullable[double][]] $UnitCost, # Unit Price [Parameter( ParametersetName = 'By_parameters' )] [Nullable[double][]] $UnitPrice, # Vendor Product Number [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,50)] [string[]] $VendorProductNumber, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Active', 'BillingType', 'CostAllocationCodeID', 'DefaultInstalledProductCategoryID', 'DefaultVendorID', 'Description', 'DoesNotRequireProcurement', 'EligibleForRma', 'ExternalProductID', 'id', 'ImpersonatorCreatorResourceID', 'InternalProductID', 'Link', 'ManufacturerName', 'ManufacturerProductName', 'MarkupRate', 'MSRP', 'Name', 'PeriodType', 'PriceCostMethod', 'ProductAllocationCodeID', 'ProductCategory', 'Serialized', 'SKU', 'UnitCost', 'UnitPrice', 'VendorProductNumber')] [string[]] $NotEquals, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Active', 'BillingType', 'CostAllocationCodeID', 'DefaultInstalledProductCategoryID', 'DefaultVendorID', 'Description', 'DoesNotRequireProcurement', 'EligibleForRma', 'ExternalProductID', 'id', 'ImpersonatorCreatorResourceID', 'InternalProductID', 'Link', 'ManufacturerName', 'ManufacturerProductName', 'MarkupRate', 'MSRP', 'Name', 'PeriodType', 'PriceCostMethod', 'ProductAllocationCodeID', 'ProductCategory', 'Serialized', 'SKU', 'UnitCost', 'UnitPrice', 'VendorProductNumber')] [string[]] $IsNull, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Active', 'BillingType', 'CostAllocationCodeID', 'DefaultInstalledProductCategoryID', 'DefaultVendorID', 'Description', 'DoesNotRequireProcurement', 'EligibleForRma', 'ExternalProductID', 'id', 'ImpersonatorCreatorResourceID', 'InternalProductID', 'Link', 'ManufacturerName', 'ManufacturerProductName', 'MarkupRate', 'MSRP', 'Name', 'PeriodType', 'PriceCostMethod', 'ProductAllocationCodeID', 'ProductCategory', 'Serialized', 'SKU', 'UnitCost', 'UnitPrice', 'VendorProductNumber')] [string[]] $IsNotNull, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('BillingType', 'CostAllocationCodeID', 'DefaultInstalledProductCategoryID', 'DefaultVendorID', 'Description', 'ExternalProductID', 'id', 'ImpersonatorCreatorResourceID', 'InternalProductID', 'Link', 'ManufacturerName', 'ManufacturerProductName', 'MarkupRate', 'MSRP', 'Name', 'PeriodType', 'PriceCostMethod', 'ProductAllocationCodeID', 'ProductCategory', 'SKU', 'UnitCost', 'UnitPrice', 'UserDefinedField', 'VendorProductNumber')] [string[]] $GreaterThan, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('BillingType', 'CostAllocationCodeID', 'DefaultInstalledProductCategoryID', 'DefaultVendorID', 'Description', 'ExternalProductID', 'id', 'ImpersonatorCreatorResourceID', 'InternalProductID', 'Link', 'ManufacturerName', 'ManufacturerProductName', 'MarkupRate', 'MSRP', 'Name', 'PeriodType', 'PriceCostMethod', 'ProductAllocationCodeID', 'ProductCategory', 'SKU', 'UnitCost', 'UnitPrice', 'UserDefinedField', 'VendorProductNumber')] [string[]] $GreaterThanOrEquals, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('BillingType', 'CostAllocationCodeID', 'DefaultInstalledProductCategoryID', 'DefaultVendorID', 'Description', 'ExternalProductID', 'id', 'ImpersonatorCreatorResourceID', 'InternalProductID', 'Link', 'ManufacturerName', 'ManufacturerProductName', 'MarkupRate', 'MSRP', 'Name', 'PeriodType', 'PriceCostMethod', 'ProductAllocationCodeID', 'ProductCategory', 'SKU', 'UnitCost', 'UnitPrice', 'UserDefinedField', 'VendorProductNumber')] [string[]] $LessThan, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('BillingType', 'CostAllocationCodeID', 'DefaultInstalledProductCategoryID', 'DefaultVendorID', 'Description', 'ExternalProductID', 'id', 'ImpersonatorCreatorResourceID', 'InternalProductID', 'Link', 'ManufacturerName', 'ManufacturerProductName', 'MarkupRate', 'MSRP', 'Name', 'PeriodType', 'PriceCostMethod', 'ProductAllocationCodeID', 'ProductCategory', 'SKU', 'UnitCost', 'UnitPrice', 'UserDefinedField', 'VendorProductNumber')] [string[]] $LessThanOrEquals, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Description', 'ExternalProductID', 'InternalProductID', 'Link', 'ManufacturerName', 'ManufacturerProductName', 'Name', 'PeriodType', 'SKU', 'UserDefinedField', 'VendorProductNumber')] [string[]] $Like, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Description', 'ExternalProductID', 'InternalProductID', 'Link', 'ManufacturerName', 'ManufacturerProductName', 'Name', 'PeriodType', 'SKU', 'UserDefinedField', 'VendorProductNumber')] [string[]] $NotLike, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Description', 'ExternalProductID', 'InternalProductID', 'Link', 'ManufacturerName', 'ManufacturerProductName', 'Name', 'PeriodType', 'SKU', 'UserDefinedField', 'VendorProductNumber')] [string[]] $BeginsWith, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Description', 'ExternalProductID', 'InternalProductID', 'Link', 'ManufacturerName', 'ManufacturerProductName', 'Name', 'PeriodType', 'SKU', 'UserDefinedField', 'VendorProductNumber')] [string[]] $EndsWith, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Description', 'ExternalProductID', 'InternalProductID', 'Link', 'ManufacturerName', 'ManufacturerProductName', 'Name', 'PeriodType', 'SKU', 'UserDefinedField', 'VendorProductNumber')] [string[]] $Contains, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('UserDefinedField')] [string[]] $IsThisDay ) begin { $entityName = 'Product' # Enable modern -Debug behavior if ($PSCmdlet.MyInvocation.BoundParameters['Debug'].IsPresent) { $DebugPreference = 'Continue' } else { # Respect configured preference $DebugPreference = $Script:Atws.Configuration.DebugPref } Write-Debug ('{0}: Begin of function' -F $MyInvocation.MyCommand.Name) if (!($PSCmdlet.MyInvocation.BoundParameters['Verbose'].IsPresent)) { # No local override of central preference. Load central preference $VerbosePreference = $Script:Atws.Configuration.VerbosePref } $result = [collections.generic.list[psobject]]::new() $iterations = [collections.generic.list[psobject]]::new() } process { # Parameterset Get_All has a single parameter: -All # Set the Filter manually to get every single object of this type if ($PSCmdlet.ParameterSetName -eq 'Get_all') { $Filter = @('id', '-ge', 0) $iterations.Add($Filter) } # So it is not -All. If Filter does not exist it has to be By_parameters elseif (-not ($Filter)) { Write-Debug ('{0}: Query based on parameters, parsing' -F $MyInvocation.MyCommand.Name) # What is the highest number of values for a parameter and is it higher than 200? $max = $PSBoundParameters.Values[0].length | Measure-Object -Maximum # If the count is less than or equal to 200 we pass PSBoundParameters as is if ($max.Maximum -le 200) { [collections.generic.list[string]]$Filter = ConvertTo-AtwsFilter -BoundParameters $PSBoundParameters -EntityName $entityName $iterations.Add($Filter) } # More than 200 values. This will cause a SQL query nested too much error. Break a single parameter # into segments and create multiple queries with max 200 values else { # Find the parameter with the $max.Maximum number of items foreach ($param in $PSCmdlet.MyInvocation.BoundParameters.GetEnumerator() ) { # When we have found the right parameter, stop iterating if ($param.Value.length -eq $max.Maximum) { break } } # Deduplicate the value list or the same ID may be included in more than 1 query $outerLoop = $PSCmdlet.MyInvocation.BoundParameters.$($param.key) | Sort-Object -Unique Write-Verbose ('{0}: Received {1} objects containing {2} unique values for parameter {3}' -f $MyInvocation.MyCommand.Name, $count, $outerLoop.Count, $param.key) for ($s = 0; $s -lt $outerLoop.count; $s += 200) { $e = $s + 199 if ($e -ge $outerLoop.count) { $e = $outerLoop.count - 1 } # Make writable of BoundParameters $BoundParameters = $PSCmdlet.MyInvocation.BoundParameters # make a selection $BoundParameters.$($param.key) = $outerLoop[$s .. $e] Write-Verbose ('{0}: Asking for {1} values {2} to {3}' -f $MyInvocation.MyCommand.Name, $param, $s, $e) # Convert named parameters to a filter definition that can be parsed to QueryXML [collections.generic.list[string]]$Filter = ConvertTo-AtwsFilter -BoundParameters $BoundParameters -EntityName $entityName $iterations.Add($Filter) } } } # Not parameters, nor Get_all. There are only three parameter sets, so now we know # that we were passed a Filter else { Write-Debug ('{0}: Query based on manual filter, parsing' -F $MyInvocation.MyCommand.Name) # Parse the filter string and expand variables in _this_ scope (dot-sourcing) # or the variables will not be available and expansion will fail $Filter = . Update-AtwsFilter -Filterstring $Filter $iterations.Add($Filter) } # Prepare shouldProcess comments $caption = $MyInvocation.MyCommand.Name $verboseDescription = '{0}: About to query the Autotask Web API for {1}(s).' -F $caption, $entityName $verboseWarning = '{0}: About to query the Autotask Web API for {1}(s). Do you want to continue?' -F $caption, $entityName # Lets do it and say we didn't! if ($PSCmdlet.ShouldProcess($verboseDescription, $verboseWarning, $caption)) { foreach ($Filter in $iterations) { try { # Make the query and pass the optional parameters to Get-AtwsData # Force list even if result is only 1 object to be compatible with addrange() [collections.generic.list[psobject]]$response = Get-AtwsData -Entity $entityName -Filter $Filter ` -NoPickListLabel:$NoPickListLabel.IsPresent ` -GetReferenceEntityById $GetReferenceEntityById } catch { # Write a debug message with detailed information to developers $reason = ("{0}: {1}" -f $_.CategoryInfo.Category, $_.CategoryInfo.Reason) $message = "{2}: {0}`r`n`r`nLine:{1}`r`n`r`nScript stacktrace:`r`n{3}" -f $_.Exception.Message, $_.InvocationInfo.Line, $reason, $_.ScriptStackTrace Write-Debug $message # Pass on the error $PSCmdlet.ThrowTerminatingError($_) return } # Add response to result - if there are any response to add if ($response.count -gt 0) { $result.AddRange($response) } Write-Verbose ('{0}: Number of entities returned by base query: {1}' -F $MyInvocation.MyCommand.Name, $result.Count) } } } end { Write-Debug ('{0}: End of function' -F $MyInvocation.MyCommand.Name) if ($result) { Return [array]$result } } } |