Dynamic/Get-AtwsAttachmentInfo.ps1
|
#Requires -Version 4.0 #Version 1.6.2.17 <# .COPYRIGHT Copyright (c) Office Center Hønefoss AS. All rights reserved. Based on code from Jan Egil Ring (Crayon). Licensed under the MIT license. See https://github.com/officecenter/Autotask/blob/master/LICENSE.md for license information. #> Function Get-AtwsAttachmentInfo { <# .SYNOPSIS This function get one or more AttachmentInfo 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: ParentType Type Publish Entities that have fields that refer to the base entity of this CmdLet: .INPUTS Nothing. This function only takes parameters. .OUTPUTS [Autotask.AttachmentInfo[]]. This function outputs the Autotask.AttachmentInfo that was returned by the API. .EXAMPLE Get-AtwsAttachmentInfo -Id 0 Returns the object with Id 0, if any. .EXAMPLE Get-AtwsAttachmentInfo -AttachmentInfoName SomeName Returns the object with AttachmentInfoName 'SomeName', if any. .EXAMPLE Get-AtwsAttachmentInfo -AttachmentInfoName 'Some Name' Returns the object with AttachmentInfoName 'Some Name', if any. .EXAMPLE Get-AtwsAttachmentInfo -AttachmentInfoName 'Some Name' -NotEquals AttachmentInfoName Returns any objects with a AttachmentInfoName that is NOT equal to 'Some Name', if any. .EXAMPLE Get-AtwsAttachmentInfo -AttachmentInfoName SomeName* -Like AttachmentInfoName Returns any object with a AttachmentInfoName that matches the simple pattern 'SomeName*'. Supported wildcards are * and %. .EXAMPLE Get-AtwsAttachmentInfo -AttachmentInfoName SomeName* -NotLike AttachmentInfoName Returns any object with a AttachmentInfoName that DOES NOT match the simple pattern 'SomeName*'. Supported wildcards are * and %. .EXAMPLE Get-AtwsAttachmentInfo -ParentType <PickList Label> Returns any AttachmentInfos with property ParentType equal to the <PickList Label>. '-PickList' is any parameter on . .EXAMPLE Get-AtwsAttachmentInfo -ParentType <PickList Label> -NotEquals ParentType Returns any AttachmentInfos with property ParentType NOT equal to the <PickList Label>. .EXAMPLE Get-AtwsAttachmentInfo -ParentType <PickList Label1>, <PickList Label2> Returns any AttachmentInfos with property ParentType equal to EITHER <PickList Label1> OR <PickList Label2>. .EXAMPLE Get-AtwsAttachmentInfo -ParentType <PickList Label1>, <PickList Label2> -NotEquals ParentType Returns any AttachmentInfos with property ParentType NOT equal to NEITHER <PickList Label1> NOR <PickList Label2>. .EXAMPLE Get-AtwsAttachmentInfo -Id 1234 -AttachmentInfoName SomeName* -ParentType <PickList Label1>, <PickList Label2> -Like AttachmentInfoName -NotEquals ParentType -GreaterThan Id An example of a more complex query. This command returns any AttachmentInfos with Id GREATER THAN 1234, a AttachmentInfoName that matches the simple pattern SomeName* AND that has a ParentType that is NOT equal to NEITHER <PickList Label1> NOR <PickList Label2>. #> [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('AttachedByContactID', 'AttachedByResourceID', 'OpportunityID')] [String] $GetReferenceEntityById, # Return entities of selected type that are referencing to this entity. [Parameter( ParameterSetName = 'Filter' )] [Parameter( ParameterSetName = 'By_parameters' )] [Alias('External')] [ValidateNotNullOrEmpty()] [String] $GetExternalEntityByThisEntityId, # Return all objects in one query [Parameter( ParameterSetName = 'Get_all' )] [Switch] $All, # Do not add descriptions for all picklist attributes with values [Parameter( ParameterSetName = 'Filter' )] [Parameter( ParameterSetName = 'Get_all' )] [Parameter( ParameterSetName = 'By_parameters' )] [Switch] $NoPickListLabel, # Attachment ID [Parameter( ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Nullable[long][]] $id, # Parent ID [Parameter( ParameterSetName = 'By_parameters' )] [Nullable[long][]] $ParentID, # Parent Type [Parameter( ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [String[]] $ParentType, # Type [Parameter( ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [String[]] $Type, # Title [Parameter( ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [ValidateLength(0,255)] [string[]] $Title, # File Name [Parameter( ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [ValidateLength(0,255)] [string[]] $FullPath, # Attach Date [Parameter( ParameterSetName = 'By_parameters' )] [Nullable[datetime][]] $AttachDate, # Attached By Contact [Parameter( ParameterSetName = 'By_parameters' )] [Nullable[long][]] $AttachedByContactID, # Attached By Resource [Parameter( ParameterSetName = 'By_parameters' )] [Nullable[long][]] $AttachedByResourceID, # Publish [Parameter( ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [String[]] $Publish, # Content Type [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(0,100)] [string[]] $ContentType, # Opportunity ID [Parameter( ParameterSetName = 'By_parameters' )] [Nullable[long][]] $OpportunityID, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'ParentID', 'ParentType', 'Type', 'Title', 'FullPath', 'AttachDate', 'AttachedByContactID', 'AttachedByResourceID', 'Publish', 'ContentType', 'OpportunityID')] [String[]] $NotEquals, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'ParentID', 'ParentType', 'Type', 'Title', 'FullPath', 'AttachDate', 'AttachedByContactID', 'AttachedByResourceID', 'Publish', 'ContentType', 'OpportunityID')] [String[]] $IsNull, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'ParentID', 'ParentType', 'Type', 'Title', 'FullPath', 'AttachDate', 'AttachedByContactID', 'AttachedByResourceID', 'Publish', 'ContentType', 'OpportunityID')] [String[]] $IsNotNull, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'ParentID', 'ParentType', 'Type', 'Title', 'FullPath', 'AttachDate', 'AttachedByContactID', 'AttachedByResourceID', 'Publish', 'ContentType', 'OpportunityID')] [String[]] $GreaterThan, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'ParentID', 'ParentType', 'Type', 'Title', 'FullPath', 'AttachDate', 'AttachedByContactID', 'AttachedByResourceID', 'Publish', 'ContentType', 'OpportunityID')] [String[]] $GreaterThanOrEquals, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'ParentID', 'ParentType', 'Type', 'Title', 'FullPath', 'AttachDate', 'AttachedByContactID', 'AttachedByResourceID', 'Publish', 'ContentType', 'OpportunityID')] [String[]] $LessThan, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'ParentID', 'ParentType', 'Type', 'Title', 'FullPath', 'AttachDate', 'AttachedByContactID', 'AttachedByResourceID', 'Publish', 'ContentType', 'OpportunityID')] [String[]] $LessThanOrEquals, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('Type', 'Title', 'FullPath', 'ContentType')] [String[]] $Like, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('Type', 'Title', 'FullPath', 'ContentType')] [String[]] $NotLike, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('Type', 'Title', 'FullPath', 'ContentType')] [String[]] $BeginsWith, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('Type', 'Title', 'FullPath', 'ContentType')] [String[]] $EndsWith, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('Type', 'Title', 'FullPath', 'ContentType')] [String[]] $Contains, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('AttachDate')] [String[]] $IsThisDay ) Begin { $EntityName = 'AttachmentInfo' # Enable modern -Debug behavior If ($PSCmdlet.MyInvocation.BoundParameters['Debug'].IsPresent) {$DebugPreference = 'Continue'} Write-Debug ('{0}: Begin of function' -F $MyInvocation.MyCommand.Name) } Process { If ($PSCmdlet.ParameterSetName -eq 'Get_all') { $Filter = @('id', '-ge', 0) } 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 $Filter = ConvertTo-AtwsFilter -BoundParameters $PSBoundParameters -EntityName $EntityName } Else { Write-Debug ('{0}: Query based on manual filter, parsing' -F $MyInvocation.MyCommand.Name) $Filter = . Update-AtwsFilter -FilterString $Filter } $Caption = $MyInvocation.MyCommand.Name $VerboseDescrition = '{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 If ($PSCmdlet.ShouldProcess($VerboseDescrition, $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 } } } |