Get-AMWorkflow

NAME Get-AMWorkflow



SYNOPSIS

Gets AutoMate Enterprise workflows.





SYNTAX

Get-AMWorkflow [[-Name] <String>] [-FilterSet <Hashtable[]>] [-FilterSetMode <String>] [-SortProperty <String[]>]

[-SortDescending] [-Connection <Object>] [<CommonParameters>]



Get-AMWorkflow [-InputObject <Object>] [[-Name] <String>] [-FilterSet <Hashtable[]>] [-FilterSetMode <String>]

[-Parent] [-SortProperty <String[]>] [-SortDescending] [-Connection <Object>] [<CommonParameters>]



Get-AMWorkflow [[-Name] <String>] [-ID <String>] [-FilterSet <Hashtable[]>] [-FilterSetMode <String>]

[-SortProperty <String[]>] [-SortDescending] [-Connection <Object>] [<CommonParameters>]





DESCRIPTION

Get-AMWorkflow gets workflow objects from AutoMate Enterprise. Get-AMWorkflow can receive items on the pipeline

and return related objects.





PARAMETERS

-InputObject <Object>

The object(s) use in search for workflows.



Required? false

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Name <String>

The name of the workflow (case sensitive). Wildcard characters can be escaped using the ` character. If

using escaped wildcards, the string

must be wrapped in single quotes. For example: Get-AMWorkflow -Name '`[Test`]'



Required? false

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ID <String>

The ID of the workflow.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-FilterSet <Hashtable[]>

The parameters to filter the search on. Supply hashtable(s) with the following properties: Property,

Operator, Value.

Valid values for the Operator are: =, !=, <, >, contains (default - no need to supply Operator when using

'contains')



Required? false

Position? named

Default value @()

Accept pipeline input? false

Accept wildcard characters? false



-FilterSetMode <String>

If multiple filter sets are provided, FilterSetMode determines if the filter sets should be evaluated with an

AND or an OR



Required? false

Position? named

Default value And

Accept pipeline input? false

Accept wildcard characters? false



-Parent [<SwitchParameter>]

Get workflows that contain the specified workflow. This parameter is only used when a workflow is piped in.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-SortProperty <String[]>

The object property to sort results on. Do not use ConnectionAlias, since it is a custom property added by

this module, and not exposed in the API.



Required? false

Position? named

Default value Name

Accept pipeline input? false

Accept wildcard characters? false



-SortDescending [<SwitchParameter>]

If specified, this will sort the output on the specified SortProperty in descending order. Otherwise,

ascending order is assumed.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Connection <Object>

The AutoMate Enterprise management server.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

Workflows related to the following objects can be retrieved by this function:

Workflow

Task

Process

Condition

Folder

Agent

AgentGroup





OUTPUTS

Workflow





-------------------------- EXAMPLE 1 --------------------------



PS C:\\># Get workflow "My Workflow"



Get-AMWorkflow "My Workflow"









-------------------------- EXAMPLE 2 --------------------------



PS C:\\># Get sub-workflows in workflow "My Workflow"



Get-AMWorkflow "My Workflow" | Get-AMWorkflow









-------------------------- EXAMPLE 3 --------------------------



PS C:\\># Get workflows in folder "My Folder"



Get-AMFolder "My Folder" -Type TASKS | Get-AMWorkflow









-------------------------- EXAMPLE 4 --------------------------



PS C:\\># Get workflows using a filter set



Get-AMWorkflow -FilterSet @{ Property = "Name"; Value = "FTP"}









-------------------------- EXAMPLE 5 --------------------------



PS C:\\># Get workflows that have started in the last hour



Get-AMWorkflow -FilterSet @{Property = "StartedOn"; Operator = ">"; Value = (Get-Date).AddHours(-1)}











RELATED LINKS

https://github.com/AutomatePS/AutomatePS