Public/Get-bConnectVariable.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
Function Get-bConnectVariable() {
    <#
        .Synopsis
            Get variables from a object.
        .Parameter Scope
            enum bConnectVariableScope.
        .Parameter Category
            Valid variable category.
        .Parameter Name
            Valid variable name.
        .Parameter ObjectGuid
            Valid GUID of an object.
        .Outputs
            ObjectVariables (see bConnect documentation for more details).
    #>


    Param (
        [Parameter(Mandatory=$true)][bConnectVariableScope]$Scope,
        [string]$Category,
        [string]$Name,
        [string]$ObjectGuid
    )

    $_connectVersion = Get-bConnectVersion
    If($_connectVersion -ge "1.0") {
        $_body = @{ Scope = $Scope.ToString() }

        If($Category) {
            $_body += @{ Category = $Category }
        }

        If($Name) {
            $_body += @{ Name = $Name }
        }

        If($ObjectGuid) {
            $_body += @{ ObjectId = $ObjectGuid }
        }

        return Invoke-bConnectGet -Controller "Variables" -Version $_connectVersion -Data $_body
    } else {
        return $false
    }
}