Get-AMExecutionEvent

NAME Get-AMExecutionEvent



SYNOPSIS

Gets AutoMate Enterprise execution events.





SYNTAX

Get-AMExecutionEvent [-StartDate <DateTime>] [-EndDate <DateTime>] [-FilterSet <Hashtable[]>] [-FilterSetMode

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



Get-AMExecutionEvent [[-InputObject] <Object>] [-StartDate <DateTime>] [-EndDate <DateTime>] [-FilterSet

<Hashtable[]>] [-FilterSetMode <String>] [-SortProperty <String[]>] [-SortDescending] [-Connection <Object>]

[<CommonParameters>]





DESCRIPTION

Get-AMExecutionEvent gets execution events for workflows and tasks.





PARAMETERS

-InputObject <Object>

The object(s) to retrieve execution events for.



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-StartDate <DateTime>

The first date of events to retrieve (Default: 1 hour ago).



Required? false

Position? named

Default value (Get-Date).AddHours(-1)

Accept pipeline input? false

Accept wildcard characters? false



-EndDate <DateTime>

The last date of events to retrieve (Default: now).



Required? false

Position? named

Default value (Get-Date)

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



-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 @("StartDateTime","EndDateTime")

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

Execution events for the following objects can be retrieved by this function:

Workflow

Task

Condition

Process

TaskAgent

ProcessAgent





OUTPUTS

ExecutionEvent





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



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



Get-AMWorkflow "My Workflow" | Get-AMExecutionEvent









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



PS C:\\># Get events using filter sets



Get-AMExecutionEvent -Connection AMprd -FilterSet @{Property = 'ResultText'; Operator = 'contains'; Value =

'Agent01'}











RELATED LINKS

https://github.com/AutomatePS/AutomatePS