functions/workflow-templates/Get-TssWorkflowInstance.ps1
|
function Get-TssWorkflowInstance { <# .SYNOPSIS Get the workflow instances of a workflow template .DESCRIPTION Workflow templates define the approval steps of secret access requests and secret erase requests. Managing them requires the Administer Workflows permission and a Secret Workflow license. Returns the workflow instances (one per request that runs through the template) with their state, current step and times. .PARAMETER TssSession TssSession object created by New-TssSession for authentication .PARAMETER Id Workflow template ID .EXAMPLE $session = New-TssSession -SecretServer https://alpha -Credential $ssCred Get-TssWorkflowInstance -TssSession $session -Id 4 Get the workflow instances of workflow template 4 .LINK https://thycotic-ps.github.io/thycotic.secretserver/commands/workflow-templates/Get-TssWorkflowInstance .LINK https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/workflow-templates/Get-TssWorkflowInstance.ps1 .NOTES Requires TssSession object returned by New-TssSession #> [CmdletBinding()] [OutputType('Thycotic.PowerShell.WorkflowTemplates.Instance[]')] param ( [Parameter(Mandatory, ValueFromPipeline, Position = 0)] [Thycotic.PowerShell.Authentication.Session] $TssSession, [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [Alias('WorkflowTemplateId')] [int[]] $Id ) begin { $tssParams = $PSBoundParameters $invokeParams = . $GetInvokeApiParams $TssSession } process { Get-TssInvocation $PSCmdlet.MyInvocation if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) { Compare-TssVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation foreach ($currentId in $Id) { $restResponse = $null $uri = $TssSession.ApiUrl, 'workflows', 'instances', 'template', $currentId -join '/' $invokeParams.Uri = $uri $invokeParams.Method = 'GET' Write-Verbose "Performing the operation $($invokeParams.Method) $uri" try { $apiResponse = Invoke-TssApi @invokeParams $restResponse = . $ProcessResponse $apiResponse } catch { Write-Warning 'Issue with Get-TssWorkflowInstance request' $err = $_ . $ErrorHandling $err } if ($restResponse) { [Thycotic.PowerShell.WorkflowTemplates.Instance[]](. $FilterTssResponse $restResponse ([Thycotic.PowerShell.WorkflowTemplates.Instance])) } } } else { Write-Warning 'No valid session found' } } } |