Dynamic/Get-AtwsChecklistLibraryChecklistItem.ps1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 |
#Requires -Version 4.0 #Version 1.6.2.15 <# .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-AtwsChecklistLibraryChecklistItem { <# .SYNOPSIS This function get one or more ChecklistLibraryChecklistItem 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: KnowledgebaseArticleID Entities that have fields that refer to the base entity of this CmdLet: .INPUTS Nothing. This function only takes parameters. .OUTPUTS [Autotask.ChecklistLibraryChecklistItem[]]. This function outputs the Autotask.ChecklistLibraryChecklistItem that was returned by the API. .EXAMPLE Get-AtwsChecklistLibraryChecklistItem -Id 0 Returns the object with Id 0, if any. .EXAMPLE Get-AtwsChecklistLibraryChecklistItem -ChecklistLibraryChecklistItemName SomeName Returns the object with ChecklistLibraryChecklistItemName 'SomeName', if any. .EXAMPLE Get-AtwsChecklistLibraryChecklistItem -ChecklistLibraryChecklistItemName 'Some Name' Returns the object with ChecklistLibraryChecklistItemName 'Some Name', if any. .EXAMPLE Get-AtwsChecklistLibraryChecklistItem -ChecklistLibraryChecklistItemName 'Some Name' -NotEquals ChecklistLibraryChecklistItemName Returns any objects with a ChecklistLibraryChecklistItemName that is NOT equal to 'Some Name', if any. .EXAMPLE Get-AtwsChecklistLibraryChecklistItem -ChecklistLibraryChecklistItemName SomeName* -Like ChecklistLibraryChecklistItemName Returns any object with a ChecklistLibraryChecklistItemName that matches the simple pattern 'SomeName*'. Supported wildcards are * and %. .EXAMPLE Get-AtwsChecklistLibraryChecklistItem -ChecklistLibraryChecklistItemName SomeName* -NotLike ChecklistLibraryChecklistItemName Returns any object with a ChecklistLibraryChecklistItemName that DOES NOT match the simple pattern 'SomeName*'. Supported wildcards are * and %. .EXAMPLE Get-AtwsChecklistLibraryChecklistItem -K <PickList Label> Returns any ChecklistLibraryChecklistItems with property K equal to the <PickList Label>. '-PickList' is any parameter on . .EXAMPLE Get-AtwsChecklistLibraryChecklistItem -K <PickList Label> -NotEquals K Returns any ChecklistLibraryChecklistItems with property K NOT equal to the <PickList Label>. .EXAMPLE Get-AtwsChecklistLibraryChecklistItem -K <PickList Label1>, <PickList Label2> Returns any ChecklistLibraryChecklistItems with property K equal to EITHER <PickList Label1> OR <PickList Label2>. .EXAMPLE Get-AtwsChecklistLibraryChecklistItem -K <PickList Label1>, <PickList Label2> -NotEquals K Returns any ChecklistLibraryChecklistItems with property K NOT equal to NEITHER <PickList Label1> NOR <PickList Label2>. .EXAMPLE Get-AtwsChecklistLibraryChecklistItem -Id 1234 -ChecklistLibraryChecklistItemName SomeName* -K <PickList Label1>, <PickList Label2> -Like ChecklistLibraryChecklistItemName -NotEquals K -GreaterThan Id An example of a more complex query. This command returns any ChecklistLibraryChecklistItems with Id GREATER THAN 1234, a ChecklistLibraryChecklistItemName that matches the simple pattern SomeName* AND that has a K that is NOT equal to NEITHER <PickList Label1> NOR <PickList Label2>. .LINK New-AtwsChecklistLibraryChecklistItem .LINK Remove-AtwsChecklistLibraryChecklistItem .LINK Set-AtwsChecklistLibraryChecklistItem #> [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('ChecklistLibraryID')] [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, # Checklist Library Checklist Item ID [Parameter( ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Nullable[long][]] $id, # Name [Parameter( ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [ValidateLength(0,255)] [string[]] $ItemName, # Important [Parameter( ParameterSetName = 'By_parameters' )] [Nullable[boolean][]] $Important, # Knowledgebase Article ID [Parameter( ParameterSetName = 'By_parameters' )] [String[]] $KnowledgebaseArticleID, # Position [Parameter( ParameterSetName = 'By_parameters' )] [Nullable[Int][]] $Position, # Checklist Library ID [Parameter( ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Nullable[Int][]] $ChecklistLibraryID, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'ItemName', 'Important', 'KnowledgebaseArticleID', 'Position', 'ChecklistLibraryID')] [String[]] $NotEquals, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'ItemName', 'Important', 'KnowledgebaseArticleID', 'Position', 'ChecklistLibraryID')] [String[]] $IsNull, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'ItemName', 'Important', 'KnowledgebaseArticleID', 'Position', 'ChecklistLibraryID')] [String[]] $IsNotNull, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'ItemName', 'KnowledgebaseArticleID', 'Position', 'ChecklistLibraryID')] [String[]] $GreaterThan, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'ItemName', 'KnowledgebaseArticleID', 'Position', 'ChecklistLibraryID')] [String[]] $GreaterThanOrEquals, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'ItemName', 'KnowledgebaseArticleID', 'Position', 'ChecklistLibraryID')] [String[]] $LessThan, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'ItemName', 'KnowledgebaseArticleID', 'Position', 'ChecklistLibraryID')] [String[]] $LessThanOrEquals, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('ItemName')] [String[]] $Like, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('ItemName')] [String[]] $NotLike, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('ItemName')] [String[]] $BeginsWith, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('ItemName')] [String[]] $EndsWith, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('ItemName')] [String[]] $Contains, [Parameter( ParameterSetName = 'By_parameters' )] [String[]] $IsThisDay ) Begin { $EntityName = 'ChecklistLibraryChecklistItem' # 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)) { $Result = Get-AtwsData -Entity $EntityName -Filter $Filter Write-Verbose ('{0}: Number of entities returned by base query: {1}' -F $MyInvocation.MyCommand.Name, $Result.Count) # Should we return an indirect object? if ( ($Result) -and ($GetReferenceEntityById)) { Write-Debug ('{0}: User has asked for external reference objects by {1}' -F $MyInvocation.MyCommand.Name, $GetReferenceEntityById) $Field = $Fields.Where({$_.Name -eq $GetReferenceEntityById}) $ResultValues = $Result | Where-Object {$null -ne $_.$GetReferenceEntityById} If ($ResultValues.Count -lt $Result.Count) { Write-Warning ('{0}: Only {1} of the {2}s in the primary query had a value in the property {3}.' -F $MyInvocation.MyCommand.Name, $ResultValues.Count, $EntityName, $GetReferenceEntityById) -WarningAction Continue } $Filter = 'id -eq {0}' -F $($ResultValues.$GetReferenceEntityById -join ' -or id -eq ') $Result = Get-Atwsdata -Entity $Field.ReferenceEntityType -Filter $Filter } ElseIf ( ($Result) -and ($GetExternalEntityByThisEntityId)) { Write-Debug ('{0}: User has asked for {1} that are referencing this result' -F $MyInvocation.MyCommand.Name, $GetExternalEntityByThisEntityId) $ReferenceInfo = $GetExternalEntityByThisEntityId -Split ':' $Filter = '{0} -eq {1}' -F $ReferenceInfo[1], $($Result.id -join (' -or {0}id -eq ' -F $ReferenceInfo[1])) $Result = Get-Atwsdata -Entity $ReferenceInfo[0] -Filter $Filter } # Do the user want labels along with index values for Picklists? ElseIf ( ($Result) -and -not ($NoPickListLabel)) { Foreach ($Field in $Fields.Where{$_.IsPickList}) { $FieldName = '{0}Label' -F $Field.Name Foreach ($Item in $Result) { $Value = ($Field.PickListValues.Where{$_.Value -eq $Item.$($Field.Name)}).Label Add-Member -InputObject $Item -MemberType NoteProperty -Name $FieldName -Value $Value -Force } } } } } End { Write-Debug ('{0}: End of function' -F $MyInvocation.MyCommand.Name) If ($Result) { Return $Result } } } |