QueryDefinition

The QueryDefinition object represents a SQL query activity accessed and performed by the SOAP API.

  • To update a QueryDefinition where the CategoryID is greater than 0, you need the Email | Interactions | Activities | Query | Move permission.
  • To start a QueryDefinition using the perform method, you need the Email | Interactions | Activities | Query | Move permission.

Properties

NameData TypeDescription
CategoryIDxsdSpecifies the identifier of the folder.
ClientClientIDSpecifies the account ownership and context of an object.
CorrelationIDxsdIdentifies correlation of objects across several requests.
CreatedDatexsdRead-only date and time of the object's creation.
CustomerKeyxsdUser-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object in Marketing Cloud.
DataExtensionTargetInteractionBaseObjectIndicates data extension to use as a template when auto-generating a new data extension. To ensure that the query activity targets the correct data extension, specify a unique external key for each data extension. For Enterprise 2.0 accounts, the external key must be unique among business unit and enterprise shared data extensions.
DescriptionxsdDescribes and provides information regarding the object.
FileSpecxsdDefines the file-naming pattern associated with an activity (valid substitutions include%%YEAR%%, %%MONTH%%, and %%DAY%%).
FileTypexsdSpecifies column delimiter of a file. Valid values include:
  • CSV
  • TAB
  • Other
IDxsdRead-only identifier for an object. Some objects use the ObjectID property as the Marketing Cloud unique ID.
InteractionObjectIDxsdReturns associated ID for activities within the asynchronous process of the overall conversation or program.
KeywordxsdReserved for future use.
ModifiedDateNullable`1Indicates the last time object information was modified.
NamexsdName of the object or property.
ObjectIDxsdSystem-controlled, read-only text string identifier for object.
ObjectStatexsdReserved for future use.
OwnerOwnerDescribes account ownership of subscriber in an on-your-behalf account.
PartnerKeyxsdUnique identifier provided by partner for an object. This property is accessible only via API.
PartnerPropertiesAPIProperty[]A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.
QueryTextxsdSpecifies text associated with a query definition.
StatusxsdDefines status of object. Status of an address.
TargetTypexsdIndicates target type for a query definition.
TargetUpdateTypexsdIndicates the target update type for a query definition.