(Click the banner to go to the related Docs.Code.ExactTarget.com page.)
Definition
Represents a data extension within an account.
Properties
This object has following properties.
| Name | Data Type | Description |
|---|
| CategoryID | xsd:long | Specifies the identifier of the folder. |
| Client | ClientID | Specifies the account ownership and context of an object. |
| CorrelationID | xsd:string | Identifies correlation of objects across several requests. |
| CreatedDate | xsd:dateTime | Read-only date and time of the object's creation. |
| CustomerKey | xsd:string | User-supplied unique identifier for an object within an object type (corresponds to the external key assigned to an object in the user interface). |
| DataRetentionPeriod | DateTimeUnitOfMeasure | Specifies the period during which the application retains the data within a data extension. |
| DataRetentionPeriodLength | xsd:int | Specifies the number of time units for which data will be retained (used with DataRetentionPeriodUnitOfMeasure to specify the full data retention time). |
| DataRetentionPeriodUnitOfMeasure | xsd:int | Specifies the units of time for which data will be retained. Deprecated. |
| DeleteAtEndOfRetentionPeriod | xsd:boolean | Indicates whether data should be deleted at the end of the retention period. |
| Description | xsd:string | Describes and provides information regarding the object. |
| Fields | DataExtensionField[] | Specifies fields contained within a data extension. |
| ID | xsd:int | Read-only legacy identifier for an object. Not supported on all objects. Some objects use the ObjectID property as the ExactTarget unique ID. |
| IsSendable | xsd:boolean | Indicates whether you can use a data extension as part of an audience for a message send. |
| IsTestable | xsd:boolean | Indicates whether a sendable data extension can be used within tests sends for a message. |
| ModifiedDate | Nullable`1 | Indicates the last time object information was modified. |
| Name | xsd:string | Name of the object or property. |
| ObjectID | xsd:string | System-controlled, read-only text string identifier for object. |
| ObjectState | xsd:string | Reserved for future use. |
| Owner | Owner | Describes account ownership of subscriber in an on-your-behalf account. |
| PartnerKey | xsd:string | Unique identifier provided by partner for an object, accessible only via API. |
| PartnerProperties | APIProperty[] | A collection of metadata supplied by client and stored by system - only accessible via API. |
| ResetRetentionPeriodOnImport | xsd:boolean | Indicates whether a data retention period should be 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 the data retention period continues from the original starting point. |
| RetainUntil | xsd:string | Indicates the date that ends the retention period for a data extension. Make sure that the value passed to this property is correctly formatted based on the Date Format setting of the API user. Failure to do so may result in an error. |
| RowBasedRetention | xsd:boolean | Indicates whether the data retention policy removes data by row or by entire data extension. A value of true indicates all records within a data extension are removed at the same time. A value of false indicates that the application can remove individual rows within a data extension. |
| SendableDataExtensionField | DataExtensionField | Indicates the field within a sendable data extension to use as an address as part of a send. Possible values include 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 | 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 SendableDataExtentionField property. |
| Status | xsd:string | Defines status of object. Status of an address. |
| Template | DataExtensionTemplate | Indicates template used to create a data extension. |
Description
Valid values for the DataRetentionPeriod property include:
If the value of the DeleteAtEndOfRetentionPeriod property is false, the application deletes the entire data extension. If the value is true, the application deletes the data within the data extension but retains the data extension itself.
Use the RowBasedRetention property to determine whether the deletion affects all data within a data extension or removes the data on a per-row bases.
('WSDL_Use_Cases')
Methods
This object has the following methods.
| Name | Description |
|---|
| Create | Creates an individual object or a batch of objects. |
| Delete | Deletes an individual object or a batch of objects. |
| Retrieve | Retrieves an individual object or a batch of objects. |
| Update | Updates an individual object or a batch of objects. |
This page was last updated by Ryan Williams on Fri, 06 Jan 2012 22:02:10 GMT.
If you require assistance with the ExactTarget application, please contact Global Support. If you wish to send Ryan direct feedback, fill out the form below:
You are not logged in. Log in 
