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
<!--complex table-->| Name | Data Type | Description |
|---|---|---|
CategoryID |
Int | Specifies the identifier of the folder. |
Client |
ClientID object | Specifies the account ownership and context of an object. |
CorrelationID |
String | Identifies correlation of objects across several requests. |
CreatedDate |
DateTime | The date and time when the object was created. |
CustomerKey |
String | User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object. |
DataExtensionTarget |
InteractionBaseObject object | Indicates 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. |
Description |
String | Describes and provides information regarding the object. |
FileSpec |
String | Defines the file-naming pattern associated with an activity (valid substitutions include%%YEAR%%, %%MONTH%%, and %%DAY%%). |
FileType |
String | Specifies column delimiter of a file. Valid values include:<ul><li>CSV</li><li>TAB</li><li>Other</li></ul> |
ID |
Int | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. |
InteractionObjectID |
String | Returns associated ID for activities within the asynchronous process of the overall conversation or program. |
Keyword |
String | Not used. |
ModifiedDate |
DateTime | The date and time when the object was last modified. |
Name |
String | Name of the object or property. |
ObjectID |
String | System-controlled, read-only text string identifier for object. |
ObjectState |
String | Not used. |
Owner |
Owner object | Describes account ownership of subscriber in an on-your-behalf account. |
PartnerKey |
String | Unique identifier provided by partner for an object. This property is accessible only via API. |
PartnerProperties |
Array of APIProperty objects | A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API. |
QueryText |
String | Specifies text associated with a query definition. |
Status |
String | Defines status of object. Status of an address. |
TargetType |
String | Indicates target type for a query definition. |
TargetUpdateType |
String | Indicates the target update type for a query definition. |