An object that represents a field in a data extension.
Properties
| Name | Data Type | Description |
|---|---|---|
AttributeMaps |
Array of AttributeMap objects | Not used. |
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, which corresponds to the external key assigned to an object. |
DataExtension |
DataExtension object | Specifies the data extension. |
DataType |
String | This has been deprecated. Use ValueType. (PropertyDefinition) The data type of the parameter that is passed to the Data Extract, which can be used to dynamically build a user interface with some basic data validation. (ExtractParameterDescription). |
DefaultValue |
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 suppliedwhen a data extract is executed. Used by PropertyDefinition if the default value for the attribute if not suppliedfor a data profile attribute. |
Description |
String | Describes and provides information regarding the object. |
DisplayOrder |
Int | Specifies the position in which the attribute appears on the Subscriber Profile Center page. |
FieldType |
DataExtensionFieldType object | Designates data type for a data extension field. |
ID |
Int | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. |
IsAccountProperty |
Boolean | Indicates whether the property is specific to the account. |
IsContextSpecific |
Boolean | Not used. |
IsCreatable |
Boolean | Indicates if the PropertyDefinition, ObjectDefinition, or DataExtensionField can be set on a Create call. A value of true indicates it is creatable. |
IsEditable |
Boolean | Indicates if the property is editable by the end-user in the profile center. |
IsFilterable |
Boolean | Indicates if you can filter on this property. Set to true to specify the property in a SimpleFilterPart in a Retrieve call. |
IsNillable |
Boolean | Indicates whether the property can contain a NULL value. |
IsPartnerProperty |
Boolean | Indicates if the property is specific to a partner. |
IsPrimaryKey |
Boolean | Designates whether a data extension field is used as a primary key for that data extension. |
IsQueryable |
Boolean | Indicates whether the property is queryable. |
IsRequired |
Boolean | Indicates whether the property must have a value specified. Create calls must include a supplied value, while Update and Delete calls don't require a value. |
IsRestrictedPicklist |
Boolean | Indicates whetherthe property has a restricted list of valid values. |
IsRetrievable |
Boolean | Indicates if object data is retrievable. |
IsSendTime |
Boolean | Indicates whether the property is a send time attribute. |
IsUpdatable |
Boolean | Indicates whether object is updatable. |
IsViewable |
Boolean | Indicates whether the property is viewable by the end-user in the profile center. |
Label |
String | Name or text that is displayed next to the field. |
Markups |
Array of APIProperty objects | Deprecated. |
MaxLength |
Int | Maximum length of the data. |
MaxValue |
String | Specifies the maximum value to set this property to. |
MinLength |
Int | Specifies the minimum length of the data. |
MinValue |
String | Specifies the minimum value to set this property to. |
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. |
Ordinal |
Int | Indicates position of object within an array. |
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. |
PartnerMap |
String | Deprecated. |
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. |
PicklistItems |
Array of PicklistItem objects | Represents a list of the valid values for the property. |
Precision |
Int | Defines numeric precision for decimal properties. |
PropertyType |
PropertyType object | Indicates the data type of the property. |
References |
Array of APIObject objects | Indicates the object types of the referenced objects. Not used. |
RelationshipName |
String | Indicates the name of the relationship, such as One-to-One, One-to-Many. |
Scale |
Int | Indicates numeric precision for decimal properties. |
Status |
String | Defines status of object. Status of an address. |
StorageType |
DataExtensionFieldStorageType | Indicates special storage properties for the field. Valid values are: Unspecified, Plain, Encrypted, or Obfuscated. |
ValueType |
SoapType object | ValueType indicates the actual data type of the value that is stored in this property. |