Functions/Get-DqChecks.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
Function Get-DqChecks
{
  <#
    .SYNOPSIS
      Deze functie haalt alle controles op uit een DQ Monitor Webservice.
   
    .DESCRIPTION
      De Get-DqChecks functie haalt een lijst op van controles die bekend zijn bij de DQ Monitor Webservice.
      Voordat deze functie gebruikt wordt, zorg ervoor dat de Context is gezet via functie Set-DqContext.
   
    .PARAMETER CustomOnly
      Optioneel: Indicatie dat alleen een lijst met eigen gemaakte controles van de klant opgehaald moeten worden.
 
    .PARAMETER IncludeStatement
      Optioneel: Indicatie dat ook het T-SQL statement opgehaald moet worden. Deze flag werkt alleen in combinatie met 'CustomOnly'.
       
    .INPUTS
      Geen.
   
    .OUTPUTS
      Array met JSON objecten die controles representeren.
     
    .EXAMPLE
      PS> Get-DqChecks
      {}
   
    .EXAMPLE
      PS> Get-DqChecks -CustomOnly
      {}
 
    .LINK
      Set-DqContext
  #>

  
  [OutputType([Array])]
  [CmdletBinding()]
  Param(
    [Parameter(Mandatory=$False)]
    [Switch] $CustomOnly,

    [Parameter(Mandatory=$False)]
    [Switch] $IncludeStatement
  )

  Validate-Context

  If ($CustomOnly.IsPresent -and $CustomOnly)
  {
    Write-Verbose "Ophalen aanwezige klantencontroles van DQ Monitor API..."
  }
  Else 
  {
    Write-Verbose "Ophalen alle controles van DQ Monitor API..."
  }

  $Response = Invoke-WebRequest -UseBasicParsing -Uri $DqContext.GetCheckControllerUrl() -Method Get -Header $DqContext.Headers -ErrorAction Stop
  $Checks = $Response.Content | ConvertFrom-Json | Select -ExpandProperty Checks

  If ($CustomOnly.IsPresent -and $CustomOnly)
  {
    $CustomChecks = @($Checks | Where-Object { $_.IsCustom -eq $True })
    Write-Verbose "Totaal $($Checks.Count) controle(s) gevonden waarvan $($CustomChecks.Count) klantencontrole(s)."
    $Checks = $CustomChecks

    If ($IncludeStatement.IsPresent -and $IncludeStatement)
    {
      Write-Verbose "T-SQL statements worden ook opgehaald voor de lijst van klantencontroles..."
      ForEach($Check in $Checks)
      {
        $Response = Invoke-WebRequest -UseBasicParsing -Uri "$($DqContext.GetCheckControllerUrl())/$($Check.Id)" -Method Get -Header $DqContext.Headers -ErrorAction Stop
        $CheckDetailed = $Response.Content | ConvertFrom-Json | Select -ExpandProperty Check
        $Check.Statement = $CheckDetailed.Statement
      }
    }
  }
  Else 
  {
    Write-Verbose "$($Checks.Count) controle(s) gevonden."
  }

  Return [Array] ($Checks | Sort-Object { $_.Name })
}