Public/Get-bConnectJobInstance.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
Function Get-bConnectJobInstance() {
    <#
        .Synopsis
            Get specified jobinstance by GUID, all jobinstances of a job or all jobinstances on a endpoint.
        .Parameter JobInstanceGuid
            Valid GUID of a jobinstance.
        .Parameter JobGuid
            Valid GUID of a job.
        .Parameter EndpointGuid
            Valid GUID of a endpoint
        .Parameter Username
            Valid Username (in combination with EndpointGuid)
        .Outputs
            Array of JobInstance (see bConnect documentation for more details).
    #>


    Param (
        [string]$JobInstanceGuid,
        [string]$JobGuid,
        [string]$EndpointGuid,
        [string]$Username
    )

    $_connectVersion = Get-bConnectVersion
    If($_connectVersion -ge "1.0") {
        If($JobGuid) {
            $_body = @{
                JobId = $JobGuid
            }
        }

        If($EndpointGuid) {
            $_body = @{
                EndpointId = $EndpointGuid
            }
        }

        If($JobInstanceGuid) {
            $_body = @{
                Id = $JobInstanceGuid
            }
        }

        If($Username -and $EndpointGuid) {
            $_body = @{
                User = $Username
                EndpointId = $EndpointGuid
            }
        }

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