ListAttribute
Defines a list attribute.
| Name | Data Type | Description |
|---|---|---|
BaseAttribute | ListAttribute object | Specifies the base attribute of a list attribute in the person model. |
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. |
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. |
FieldLength | Int | Defines number of characters available within a field for a list attribute. |
FieldType | ListAttributeFieldType | 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. |
Inheritable | Boolean | Indicates whether a list attribute can be inherited. A value of true indicates an inheritable list attribute. |
IsHidden | Boolean | Specifies whether a list attribute is hidden. A value of true indicates that the list attribute is hidden. |
IsNullable | Boolean | Specifies whether a list attribute can contain a null value. A value of true indicates a list attributes can contain a null value. |
IsReadOnly | Boolean | Indicates whether a list attribute is read-only. A value of true indicates that the list attribute is read-only. |
List | List object | List associated with an object. |
MaxValue | String | Indicates the maximum value that this property can be set to. |
MinValue | String | Specifies the minimum value that this property can be set to. |
ModifiedDate | DateTime | The date and time when the object was last modified. |
MustOverride | Boolean | Indicates whether a list attribute must override all other values. A value of true indicates that this list attribute overrides other list attributes. |
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. |
Overridable | Boolean | Indicates a list attribute can be overridden. A value of true indicates that a list attribute can be overridden. |
OverrideType | OverrideType object | Indicates how a list attribute can be overridden. Valid values include:
|
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. |
RestrictedValues | Array of ListAttributeRestrictedValue objects | Specifies a collection for restricted values. |
Scale | Int | Indicates numeric precision for decimal properties. |