Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Available in version v7+
A filter type that determines which automation is returned by a query.
Filters applied against properties with string data types are not case-sensitive.
Name | Type | Description | Constraints |
|---|---|---|---|
name | The name of the automation. The name is defined by the system user when the automation is created. The name identifies the automation in the system. The name does not have to be unique in the system. | optional | |
automationType | An enumerated type that indicates whether the automation is time-based or event-based. A list of possible values is available in the description for the AutomationType type. | required | |
jobType | An enumerated type that indicates which job is executed by the automation. A list of possible values is available in the description for the AutomationJobType type. | optional | |
eventType | An enumerated type that indicates which event initiates execution of the job. A list of possible values is available in the description for the EventType type. Use only for automations with the EVENT_BASED automationType property. | optional | |
ownerName | The name of the system user who created the automation. Provided in the format LastName, FirstName. | optional | |
nextExecutionDateFrom | The start date for a time frame in which queries for automation are scheduled for the next execution after the specified time. Specify the Datetime format. | optional | |
nextExecutionDateTo | The end date for a time frame in which queries for automation are scheduled for the next execution before the specified time. Specify using Datetime format. Must be later than nextExecutionDateFrom when both dates are specified. | optional | |
endDateFrom | The start date for a time frame in which queries for the automations are scheduled to finish after the specified time. Specify using Datetime format. | optional | |
endDateTo | The end date for a time frame in which queries for automation are scheduled to finish before the specified time. Specify using Datetime format. Must be later than endDateFrom when both dates are specified. | optional | |
hasErrors | True if the number of errors encountered during execution is greater than zero, otherwise false. An error does not mean that the execution failed. | required | |
status | An enumerated type that indicates the current status of the automation. A list of possible values is available in the description for the AutomationStatus type. | optional | |
archived | True if the automation is currently archived, otherwise false. | required |