Static/Get-AtwsRole.ps1
|
#Requires -Version 4.0 #Version 1.6.4.2 <# .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-AtwsRole { <# .SYNOPSIS This function get one or more Role 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: Entities that have fields that refer to the base entity of this CmdLet: BillingItem ContractExclusionRole ContractExclusionSetExcludedRole ContractFactor ContractRate ContractRoleCost PriceListRole QuoteItem Resource ResourceRole ResourceRoleDepartment ResourceRoleQueue ResourceServiceDeskRole Task TaskSecondaryResource Ticket TicketSecondaryResource TimeEntry .INPUTS Nothing. This function only takes parameters. .OUTPUTS [Autotask.Role[]]. This function outputs the Autotask.Role that was returned by the API. .EXAMPLE Get-AtwsRole -Id 0 Returns the object with Id 0, if any. .EXAMPLE Get-AtwsRole -RoleName SomeName Returns the object with RoleName 'SomeName', if any. .EXAMPLE Get-AtwsRole -RoleName 'Some Name' Returns the object with RoleName 'Some Name', if any. .EXAMPLE Get-AtwsRole -RoleName 'Some Name' -NotEquals RoleName Returns any objects with a RoleName that is NOT equal to 'Some Name', if any. .EXAMPLE Get-AtwsRole -RoleName SomeName* -Like RoleName Returns any object with a RoleName that matches the simple pattern 'SomeName*'. Supported wildcards are * and %. .EXAMPLE Get-AtwsRole -RoleName SomeName* -NotLike RoleName Returns any object with a RoleName that DOES NOT match the simple pattern 'SomeName*'. Supported wildcards are * and %. .LINK New-AtwsRole .LINK Set-AtwsRole #> [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('QuoteItemDefaultTaxCategoryId')] [string] $GetReferenceEntityById, # Return entities of selected type that are referencing to this entity. [Parameter( ParametersetName = 'Filter' )] [Parameter( ParametersetName = 'By_parameters' )] [Alias('External')] [ValidateNotNullOrEmpty()] [ValidateSet('BillingItem:RoleID', 'ContractExclusionRole:RoleID', 'ContractExclusionSetExcludedRole:ExcludedRoleID', 'ContractFactor:RoleID', 'ContractRate:RoleID', 'ContractRoleCost:RoleID', 'PriceListRole:RoleID', 'QuoteItem:LaborID', 'Resource:DefaultServiceDeskRoleID', 'ResourceRole:RoleID', 'ResourceRoleDepartment:RoleID', 'ResourceRoleQueue:RoleID', 'ResourceServiceDeskRole:RoleID', 'Task:AssignedResourceRoleID', 'TaskSecondaryResource:RoleID', 'Ticket:AssignedResourceRoleID', 'TicketSecondaryResource:RoleID', 'TimeEntry:RoleID')] [string] $GetExternalEntityByThisEntityId, # Return all objects in one query [Parameter( ParametersetName = 'Get_all' )] [switch] $All, # Role ID [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Nullable[long][]] $id, # Name [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [ValidateLength(0,200)] [string[]] $Name, # Description [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,200)] [string[]] $Description, # System Role [Parameter( ParametersetName = 'By_parameters' )] [Nullable[boolean][]] $SystemRole, # Hourly Factor [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Nullable[decimal][]] $HourlyFactor, # Hourly Rate [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Nullable[decimal][]] $HourlyRate, # Quote Item Default Tax Category ID [Parameter( ParametersetName = 'By_parameters' )] [Nullable[Int][]] $QuoteItemDefaultTaxCategoryId, # Active [Parameter( ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Nullable[boolean][]] $Active, # Is Excluded From New Contracts [Parameter( ParametersetName = 'By_parameters' )] [Nullable[boolean][]] $IsExcludedFromNewContracts, # Role Type [Parameter( ParametersetName = 'By_parameters' )] [Nullable[Int][]] $RoleType, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('id', 'Name', 'Description', 'SystemRole', 'HourlyFactor', 'HourlyRate', 'QuoteItemDefaultTaxCategoryId', 'Active', 'IsExcludedFromNewContracts', 'RoleType')] [string[]] $NotEquals, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('id', 'Name', 'Description', 'SystemRole', 'HourlyFactor', 'HourlyRate', 'QuoteItemDefaultTaxCategoryId', 'Active', 'IsExcludedFromNewContracts', 'RoleType')] [string[]] $IsNull, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('id', 'Name', 'Description', 'SystemRole', 'HourlyFactor', 'HourlyRate', 'QuoteItemDefaultTaxCategoryId', 'Active', 'IsExcludedFromNewContracts', 'RoleType')] [string[]] $IsNotNull, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('id', 'Name', 'Description', 'HourlyFactor', 'HourlyRate', 'QuoteItemDefaultTaxCategoryId', 'RoleType')] [string[]] $GreaterThan, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('id', 'Name', 'Description', 'HourlyFactor', 'HourlyRate', 'QuoteItemDefaultTaxCategoryId', 'RoleType')] [string[]] $GreaterThanOrEquals, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('id', 'Name', 'Description', 'HourlyFactor', 'HourlyRate', 'QuoteItemDefaultTaxCategoryId', 'RoleType')] [string[]] $LessThan, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('id', 'Name', 'Description', 'HourlyFactor', 'HourlyRate', 'QuoteItemDefaultTaxCategoryId', 'RoleType')] [string[]] $LessThanOrEquals, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Name', 'Description')] [string[]] $Like, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Name', 'Description')] [string[]] $NotLike, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Name', 'Description')] [string[]] $BeginsWith, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Name', 'Description')] [string[]] $EndsWith, [Parameter( ParametersetName = 'By_parameters' )] [ValidateSet('Name', 'Description')] [string[]] $Contains, [Parameter( ParametersetName = 'By_parameters' )] [string[]] $IsThisDay ) begin { $entityName = 'Role' # 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 } } } |