AutomationInstance
The AutomationInstance object defines an automation in Automation Studio for an account.
The only supported operators for the AutomationInstance object are: IN, EQUALS. Complex filter is not supported.
| Name | Data Type | Description |
|---|---|---|
| AutomationID | xsd | Identifies automation associated with this instance. If you already use ProgramID, it is still supported for migrated accounts. |
| AutomationSource | AutomationSource | Identifies source of automation |
| AutomationTasks | AutomationTasks[] | Identifies tasks within automation |
| AutomationType | xsd | Identifies type of automation |
| Client | ClientID | Defines which account owns the automation |
| CompletedTime | xsd | Indicates when automation completed |
| CorrelationID | xsd | Identifies calls involved in a specific asynchronous process |
| CreatedDate | xsd | Read-only date and time of the object's creation |
| CustomerKey | xsd | User-supplied unique identifier for an object within an object type |
| Description | xsd | Describes and provides information regarding the object |
| ID | xsd | Read-only legacy identifier for an object. Not supported on all objects |
| InteractionObjectID | xsd | Returns associated ID for activities within the asynchronous process of the overall conversation or program |
| IsActive | xsd | Specifies whether the object is active |
| Keyword | xsd | Reserved for future use |
| ModifiedDate | Nullable | Indicates the last time object information was modified |
| Name | xsd | Name of the object or property |
| Notifications | AutomationNotification[] | Indicates notifications to use when automation completes |
| ObjectID | xsd | System-controlled, read-only text string identifier for object |
| ObjectState | xsd | Reserved for future use |
| Owner | Owner | Describes account ownership of subscriber in an on-your-behalf account |
| PartnerKey | xsd | Unique identifier provided by partner for an object. This property is accessible only via API. |
| PartnerProperties | APIProperty[] | A collection of metadata supplied by client and stored by system. This property is accessible only via API. |
| Schedule | ScheduleDefinition | Indicates schedule for automation |
| ScheduledTime | xsd | Keeps requests in asynchronous queue until time specified in call |
| StartTime | xsd | Indicates time this instance of an automation started |
| Status | xsd | Indicates status of automation |
| StatusLastUpdate | xsd | Indicates date and time status last updated |
| StatusMessage | xsd | Indicates message associated with status |
| TaskInstances | AutomationTaskInstance[] | Indicates instances of tasks associated with this automation instance |