Dynamic/Get-AtwsSalesOrder.ps1
|
#Requires -Version 4.0 #Version 1.6.4.3 <# .COPYRIGHT Copyright (c) ECIT Solutions AS. All rights reserved. Licensed under the MIT license. See https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md for license information. #> Function Get-AtwsSalesOrder { <# .SYNOPSIS This function get one or more SalesOrder 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: Status Entities that have fields that refer to the base entity of this CmdLet: Opportunity PurchaseOrderItem .INPUTS Nothing. This function only takes parameters. .OUTPUTS [Autotask.SalesOrder[]]. This function outputs the Autotask.SalesOrder that was returned by the API. .EXAMPLE Get-AtwsSalesOrder -Id 0 Returns the object with Id 0, if any. .EXAMPLE Get-AtwsSalesOrder -SalesOrderName SomeName Returns the object with SalesOrderName 'SomeName', if any. .EXAMPLE Get-AtwsSalesOrder -SalesOrderName 'Some Name' Returns the object with SalesOrderName 'Some Name', if any. .EXAMPLE Get-AtwsSalesOrder -SalesOrderName 'Some Name' -NotEquals SalesOrderName Returns any objects with a SalesOrderName that is NOT equal to 'Some Name', if any. .EXAMPLE Get-AtwsSalesOrder -SalesOrderName SomeName* -Like SalesOrderName Returns any object with a SalesOrderName that matches the simple pattern 'SomeName*'. Supported wildcards are * and %. .EXAMPLE Get-AtwsSalesOrder -SalesOrderName SomeName* -NotLike SalesOrderName Returns any object with a SalesOrderName that DOES NOT match the simple pattern 'SomeName*'. Supported wildcards are * and %. .EXAMPLE Get-AtwsSalesOrder -S <PickList Label> Returns any SalesOrders with property S equal to the <PickList Label>. '-PickList' is any parameter on . .EXAMPLE Get-AtwsSalesOrder -S <PickList Label> -NotEquals S Returns any SalesOrders with property S NOT equal to the <PickList Label>. .EXAMPLE Get-AtwsSalesOrder -S <PickList Label1>, <PickList Label2> Returns any SalesOrders with property S equal to EITHER <PickList Label1> OR <PickList Label2>. .EXAMPLE Get-AtwsSalesOrder -S <PickList Label1>, <PickList Label2> -NotEquals S Returns any SalesOrders with property S NOT equal to NEITHER <PickList Label1> NOR <PickList Label2>. .EXAMPLE Get-AtwsSalesOrder -Id 1234 -SalesOrderName SomeName* -S <PickList Label1>, <PickList Label2> -Like SalesOrderName -NotEquals S -GreaterThan Id An example of a more complex query. This command returns any SalesOrders with Id GREATER THAN 1234, a SalesOrderName that matches the simple pattern SomeName* AND that has a S that is NOT equal to NEITHER <PickList Label1> NOR <PickList Label2>. .LINK Set-AtwsSalesOrder #> [CmdLetBinding(SupportsShouldProcess = $true, DefaultParameterSetName='Filter', ConfirmImpact='None')] 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('AccountID', 'BillToCountryID', 'BusinessDivisionSubdivisionID', 'Contact', 'OpportunityID', 'OwnerResourceID', 'ShipToCountryID')] [string] $GetReferenceEntityById, # Return entities of selected type that are referencing to this entity. [Parameter( ParametersetName = 'Filter' )] [Parameter( ParametersetName = 'By_parameters' )] [Alias('External')] [ValidateNotNullOrEmpty()] [ValidateSet('Opportunity:SalesOrderID', 'PurchaseOrderItem:SalesOrderID')] [string] $GetExternalEntityByThisEntityId, # Return all objects in one query [Parameter( ParametersetName = 'Get_all' )] [switch] $All, # Sales Order ID [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Nullable[Int][]] $id, # Client ID [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Nullable[Int][]] $AccountID, # Title [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [ValidateLength(0,128)] [string[]] $Title, # Status [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [string[]] $Status, # Contact ID [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Nullable[Int][]] $Contact, # Owner [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Nullable[Int][]] $OwnerResourceID, # Sales Order Date [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Nullable[datetime][]] $SalesOrderDate, # Promised Due Date [Parameter( ParametersetName = 'By_parameters' )] [Nullable[datetime][]] $PromisedDueDate, # Bill to Address1 [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,150)] [string[]] $BillToAddress1, # Bill to Address2 [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,150)] [string[]] $BillToAddress2, # Bill to City [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,50)] [string[]] $BillToCity, # Bill to County [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,50)] [string[]] $BillToState, # Bill to Postal Code [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,50)] [string[]] $BillToPostalCode, # Bill to Country [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,100)] [string[]] $BillToCountry, # Ship to Address1 [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,150)] [string[]] $ShipToAddress1, # Ship to Address2 [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,150)] [string[]] $ShipToAddress2, # Ship to City [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,50)] [string[]] $ShipToCity, # Ship to County [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,50)] [string[]] $ShipToState, # Ship to Postal Code [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,50)] [string[]] $ShipToPostalCode, # Ship to Country [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,100)] [string[]] $ShipToCountry, # Opportunity ID [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Nullable[Int][]] $OpportunityID, # Additional Bill To Address Information [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,100)] [string[]] $AdditionalBillToAddressInformation, # Additional Ship To Address Information [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,100)] [string[]] $AdditionalShipToAddressInformation, # Bill To Country ID [Parameter( ParametersetName = 'By_parameters' )] [Nullable[Int][]] $BillToCountryID, # Ship To Country ID [Parameter( ParametersetName = 'By_parameters' )] [Nullable[Int][]] $ShipToCountryID, # Business Division Subdivision ID [Parameter( ParametersetName = 'By_parameters' )] [Nullable[Int][]] $BusinessDivisionSubdivisionID, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('id', 'AccountID', 'Title', 'Status', 'Contact', 'OwnerResourceID', 'SalesOrderDate', 'PromisedDueDate', 'BillToAddress1', 'BillToAddress2', 'BillToCity', 'BillToState', 'BillToPostalCode', 'BillToCountry', 'ShipToAddress1', 'ShipToAddress2', 'ShipToCity', 'ShipToState', 'ShipToPostalCode', 'ShipToCountry', 'OpportunityID', 'AdditionalBillToAddressInformation', 'AdditionalShipToAddressInformation', 'BillToCountryID', 'ShipToCountryID', 'BusinessDivisionSubdivisionID')] [string[]] $NotEquals, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('id', 'AccountID', 'Title', 'Status', 'Contact', 'OwnerResourceID', 'SalesOrderDate', 'PromisedDueDate', 'BillToAddress1', 'BillToAddress2', 'BillToCity', 'BillToState', 'BillToPostalCode', 'BillToCountry', 'ShipToAddress1', 'ShipToAddress2', 'ShipToCity', 'ShipToState', 'ShipToPostalCode', 'ShipToCountry', 'OpportunityID', 'AdditionalBillToAddressInformation', 'AdditionalShipToAddressInformation', 'BillToCountryID', 'ShipToCountryID', 'BusinessDivisionSubdivisionID')] [string[]] $IsNull, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('id', 'AccountID', 'Title', 'Status', 'Contact', 'OwnerResourceID', 'SalesOrderDate', 'PromisedDueDate', 'BillToAddress1', 'BillToAddress2', 'BillToCity', 'BillToState', 'BillToPostalCode', 'BillToCountry', 'ShipToAddress1', 'ShipToAddress2', 'ShipToCity', 'ShipToState', 'ShipToPostalCode', 'ShipToCountry', 'OpportunityID', 'AdditionalBillToAddressInformation', 'AdditionalShipToAddressInformation', 'BillToCountryID', 'ShipToCountryID', 'BusinessDivisionSubdivisionID')] [string[]] $IsNotNull, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('id', 'AccountID', 'Title', 'Status', 'Contact', 'OwnerResourceID', 'SalesOrderDate', 'PromisedDueDate', 'BillToAddress1', 'BillToAddress2', 'BillToCity', 'BillToState', 'BillToPostalCode', 'BillToCountry', 'ShipToAddress1', 'ShipToAddress2', 'ShipToCity', 'ShipToState', 'ShipToPostalCode', 'ShipToCountry', 'OpportunityID', 'AdditionalBillToAddressInformation', 'AdditionalShipToAddressInformation', 'BillToCountryID', 'ShipToCountryID', 'BusinessDivisionSubdivisionID')] [string[]] $GreaterThan, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('id', 'AccountID', 'Title', 'Status', 'Contact', 'OwnerResourceID', 'SalesOrderDate', 'PromisedDueDate', 'BillToAddress1', 'BillToAddress2', 'BillToCity', 'BillToState', 'BillToPostalCode', 'BillToCountry', 'ShipToAddress1', 'ShipToAddress2', 'ShipToCity', 'ShipToState', 'ShipToPostalCode', 'ShipToCountry', 'OpportunityID', 'AdditionalBillToAddressInformation', 'AdditionalShipToAddressInformation', 'BillToCountryID', 'ShipToCountryID', 'BusinessDivisionSubdivisionID')] [string[]] $GreaterThanOrEquals, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('id', 'AccountID', 'Title', 'Status', 'Contact', 'OwnerResourceID', 'SalesOrderDate', 'PromisedDueDate', 'BillToAddress1', 'BillToAddress2', 'BillToCity', 'BillToState', 'BillToPostalCode', 'BillToCountry', 'ShipToAddress1', 'ShipToAddress2', 'ShipToCity', 'ShipToState', 'ShipToPostalCode', 'ShipToCountry', 'OpportunityID', 'AdditionalBillToAddressInformation', 'AdditionalShipToAddressInformation', 'BillToCountryID', 'ShipToCountryID', 'BusinessDivisionSubdivisionID')] [string[]] $LessThan, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('id', 'AccountID', 'Title', 'Status', 'Contact', 'OwnerResourceID', 'SalesOrderDate', 'PromisedDueDate', 'BillToAddress1', 'BillToAddress2', 'BillToCity', 'BillToState', 'BillToPostalCode', 'BillToCountry', 'ShipToAddress1', 'ShipToAddress2', 'ShipToCity', 'ShipToState', 'ShipToPostalCode', 'ShipToCountry', 'OpportunityID', 'AdditionalBillToAddressInformation', 'AdditionalShipToAddressInformation', 'BillToCountryID', 'ShipToCountryID', 'BusinessDivisionSubdivisionID')] [string[]] $LessThanOrEquals, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Title', 'BillToAddress1', 'BillToAddress2', 'BillToCity', 'BillToState', 'BillToPostalCode', 'BillToCountry', 'ShipToAddress1', 'ShipToAddress2', 'ShipToCity', 'ShipToState', 'ShipToPostalCode', 'ShipToCountry', 'AdditionalBillToAddressInformation', 'AdditionalShipToAddressInformation')] [string[]] $Like, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Title', 'BillToAddress1', 'BillToAddress2', 'BillToCity', 'BillToState', 'BillToPostalCode', 'BillToCountry', 'ShipToAddress1', 'ShipToAddress2', 'ShipToCity', 'ShipToState', 'ShipToPostalCode', 'ShipToCountry', 'AdditionalBillToAddressInformation', 'AdditionalShipToAddressInformation')] [string[]] $NotLike, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Title', 'BillToAddress1', 'BillToAddress2', 'BillToCity', 'BillToState', 'BillToPostalCode', 'BillToCountry', 'ShipToAddress1', 'ShipToAddress2', 'ShipToCity', 'ShipToState', 'ShipToPostalCode', 'ShipToCountry', 'AdditionalBillToAddressInformation', 'AdditionalShipToAddressInformation')] [string[]] $BeginsWith, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Title', 'BillToAddress1', 'BillToAddress2', 'BillToCity', 'BillToState', 'BillToPostalCode', 'BillToCountry', 'ShipToAddress1', 'ShipToAddress2', 'ShipToCity', 'ShipToState', 'ShipToPostalCode', 'ShipToCountry', 'AdditionalBillToAddressInformation', 'AdditionalShipToAddressInformation')] [string[]] $EndsWith, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Title', 'BillToAddress1', 'BillToAddress2', 'BillToCity', 'BillToState', 'BillToPostalCode', 'BillToCountry', 'ShipToAddress1', 'ShipToAddress2', 'ShipToCity', 'ShipToState', 'ShipToPostalCode', 'ShipToCountry', 'AdditionalBillToAddressInformation', 'AdditionalShipToAddressInformation')] [string[]] $Contains, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('SalesOrderDate', 'PromisedDueDate')] [string[]] $IsThisDay ) begin { $entityName = 'SalesOrder' # 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 } } 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) } # 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) # Convert named parameters to a filter definition that can be parsed to QueryXML [string[]]$Filter = ConvertTo-AtwsFilter -BoundParameters $PSBoundParameters -EntityName $entityName } # 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 } # 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)) { # Make the query and pass the optional parameters to Get-AtwsData $result = Get-AtwsData -Entity $entityName -Filter $Filter ` -NoPickListLabel:$NoPickListLabel.IsPresent ` -GetReferenceEntityById $GetReferenceEntityById ` -GetExternalEntityByThisEntityId $GetExternalEntityByThisEntityId 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 $result } } } |