(Click the banner to go to the related Docs.Code.ExactTarget.com page.)
Definition
Represents a field within a data extension.
Properties
This object has following properties.
| Name | Data Type | Description |
|---|
| AttributeMaps | AttributeMap[] | Reserved for future use. |
| 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). |
| DataExtension | DataExtension | Specifies the data extension. |
| DataType | xsd:string | This has been deprecated. Please use ValueType. (PropertyDefinition) The data type of the parameter that will be passed to the Data Extract (can be used to dynamically build a user interface with some basic data validation). (ExtractParameterDescription) |
| DefaultValue | xsd:string | The default value for a data extension field if no value is supplied (Include Now() as the default value if you wish to have a field default to today's date). Used by ExtractParameterDescription as the default value for the parameter if not supplied when a data extract is executed. Used by PropertyDefinition if the default value for the attribute if not supplied for a data profile attribute. |
| Description | xsd:string | Describes and provides information regarding the object. |
| DisplayOrder | xsd:int | Specifies the position in which the attribute will appear on the Subscriber Profile Center page. |
| FieldType | DataExtensionFieldType | Designates data type for a data extension field. |
| 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. |
| IsAccountProperty | xsd:boolean | Indicates whether the property is specific to the account. Reserved for future use. |
| IsContextSpecific | xsd:boolean | Reserved for future use. |
| IsCreatable | xsd:boolean | Indicates if the property can be set on a Create call. A value of true indicates it can be created. (PropertyDefinition) Indicates whether object can be created. A value of true indicates it can be created. (ObjectDefinition) Indicates whether the field can be created. A value of true indicates it can be created. (DataExtensionField) |
| IsEditable | xsd:boolean | Indicates if the property can be edited by the end-user in the profile center |
| IsFilterable | xsd:boolean | Indicates if you can filter on this property. A value of true indicates the property can be specified in a SimpleFilterPart in a Retrieve call. Reserved for future use. |
| IsNillable | xsd:boolean | Indicates whether the property can contain a NULL value. Reserved for future use. |
| IsPartnerProperty | xsd:boolean | Indicates if the property is specific to a partner. Reserved for future use. |
| IsPrimaryKey | xsd:boolean | Designates whether a data extension field is used as a primary key for that data extension. |
| IsQueryable | xsd:boolean | Indicates whether the property can be queried. Reserved for future use. |
| IsRequired | xsd:boolean | Indicates whether the property must have a value specified. Create calls must include a supplied value, while Update and Delete calls do not require a value. |
| IsRestrictedPicklist | xsd:boolean | Indicates whether the property has a restricted list of valid values. |
| IsRetrievable | xsd:boolean | Indicates if object data can be retrieved. |
| IsSendTime | xsd:boolean | Indicates whether the property is a send time attribute. |
| IsUpdatable | xsd:boolean | Indicates whether object can be updated. |
| IsViewable | xsd:boolean | Indicates whether the property is viewable by the end-user in the profile center. |
| Label | xsd:string | Name or text that is displayed next to the field. |
| Markups | APIProperty[] | Deprecated. |
| MaxLength | xsd:int | Maximum length of the data. |
| MaxValue | xsd:string | Indicates the maximum value that this property can be set to. |
| MinLength | xsd:int | Specifies the minimum length of the data. |
| MinValue | xsd:string | Specifies the minimum value that this property can be set to. |
| 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. |
| Ordinal | xsd:int | Indicates position of object within an array |
| 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. |
| PartnerMap | xsd:string | Deprecated. |
| PartnerProperties | APIProperty[] | A collection of metadata supplied by client and stored by system - only accessible via API. |
| PicklistItems | PicklistItem[] | Represents a list of the valid values for the property. |
| Precision | xsd:int | Defines numeric precision for decimal properties. |
| PropertyType | PropertyType | - Indicates the ExactTarget data type of the property.
|
| References | APIObject[] | Indicates the object types of the referenced objects. Reserved for future use. |
| RelationshipName | xsd:string | Indicates the name of the relationship (e.g. One-to-One, One-to-Many). Reserved for future use. |
| Scale | xsd:int | Indicates numeric precision for decimal properties. |
| Status | xsd:string | Defines status of object. Status of an address. |
| ValueType | SoapType | ValueType indicates the actual data type of the value that will be stored in this property. Reserved for future use. |
Description
You can perform a Retrieve call on this object and request DataExtension.CustomerKey. You cannot update properties on this object, and it does not support the Delete method.
Methods
This object has the following methods.
| Name | Description |
|---|
| Retrieve | Retrieves an individual object or a batch of objects. |
This page was last updated by Ryan Williams on Fri, 06 Jan 2012 22:01:02 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 
