DataExtension
The DataExtension object represents a data extension within an account.
To clear data from a DataExtension object using the perform method, you must have the Email | Subscribers | Data Extension | Clear Data permission. Also, your account type must be E2.0 or BU, or you must have the role-based access control business rule. If you don't own the data extension, you can't clear its data.
If your account uses data extension retention policies, you must have the Data Extension | Manage Data Extension Retention permission to create or update a DataExtension object that has data retention properties. The data retention properties are DataRetentionPeriod, DataRetentionPeriodLength, DataRetentionPeriodUnitOfMeasure, RowBasedRetention, ResetRetentionPeriodOnImport, DeleteAtEndOfRetentionPeriod, and RetainUntil.
| Name | Data Type | Description |
|---|---|---|
CategoryID | Int64 | 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. |
DataRetentionPeriod | DateTimeUnitOfMeasure object | Specifies the period during which the application retains the data within a data extension. Valid values are:
|
DataRetentionPeriodLength | Int32 | Specifies the number of time units data is retained for. This property is used with DataRetentionPeriodUnitOfMeasure to specify the full data retention time. |
DataRetentionPeriodUnitOfMeasure | Int32 | Deprecated. Use DataRetentionPeriodLength and DataRetentionPeriod instead. |
DeleteAtEndOfRetentionPeriod | Boolean | Indicates whether data is deleted at the end of the retention period. If the value is true the application deletes the entire data extension. If the value is false, the application deletes the data within the data extension but retains the data extension itself. |
Description | String | Describes and provides information regarding the object. |
Fields | Array of DataExtensionField objects | Specifies fields contained within a data extension. |
ID | Int32 | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. |
IsSendable | Boolean | Indicates whether you can use a data extension as part of an audience for a message send. |
IsTestable | Boolean | Indicates whether a sendable data extension can be used within tests sends for a message. |
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 | 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. |
ResetRetentionPeriodOnImport | Boolean | Indicates whether a data retention period is reset after a successful import of new data. A value of true indicates that the data retention period resets to the beginning upon completion of a successful data import. A value of false indicates that the data retention period continues from the original starting point. |
RetainUntil | String | Indicates the date that ends the retention period for a data extension. Verify that the value passed to this property is correctly formatted based on the Date Format setting of the API user. |
RowBasedRetention | Boolean | Indicates whether the data retention policy removes data by row or deletes all data in an entire data extension. If the value is true, individual rows are removed from the data extension when the retention period expires. If the value is false, the entire data extension is deleted when the retention period expires. |
SendableDataExtensionField | DataExtensionField object | Indicates the field within a sendable data extension to use as an address as part of a send. Possible values are SubscriberID, CustomerKey, or EmailAddress. The application uses this field to establish a data relationship between a value specified by the SendableSubscriberField property and a value within a sendable data extension. |
SendableSubscriberField | Attribute object | Indicates field to use as sending address. The application uses this field to establish a data relationship between a subscriber field and a value specified by the SendableDataExtensionField property. |
Status | String | Defines status of object. |
Template | DataExtensionTemplate object | Indicates the template used to create a data extension. |
The DataExtensionObject object doesn't support LIKE operators in filters for the retrieve method.