Automation
The Automation object defines an automation in Automation Studio for an account. To update, delete, or perform an Automation where your account has the Programs_30 feature and AutomationSourceType is not Playbooks, you need the corresponding Automation Studio | Automation permissions.
The only supported operators for the Automation object are: IN, EQUALS. Complex filter is not supported.
| Name | Data Type | Description |
|---|---|---|
| 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. |
| 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. |
| 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. |
| ProgramID | xsd | System-controlled, read-only text string identifier for object. |
| Schedule | ScheduleDefinition | Indicates schedule for automation. |
| ScheduledTime | xsd | Keeps requests in asynchronous queue until time specified in call. |
| Status | xsd | Indicates status of automation. |
The schedule property is non-retrievable, so ScheduledTime and CreatedDate always show as "0001-01-01T00:00:00.000".
The Status property can contain these values:
| Code | Status Type | Message |
|---|---|---|
| -1 | Error | Program errored out. |
| 0 | BuildingError | Program errored out during building. |
| 1 | Building | Program building with activities, schedules, and other elements. |
| 2 | Ready | Program ready to start. |
| 3 | Running | Program running. |
| 4 | Paused | Program paused from running state. |
| 5 | Stopped | Program stopped. |
| 6 | Scheduled | Program scheduled. |
| 7 | Awaiting Trigger | Program waiting for a trigger. |
| 8 | InactiveTrigger | Program trigger inactive. |