PropertyDefinitionResponse

data class PropertyDefinitionResponse(val arrayValueSeparator: String? = null, val dataSourcePrecedenceRules: List<DataSourcePrecedenceResponse>, val enumValidValues: List<ProfileEnumValidValuesFormatResponse>? = null, val fieldName: String, val fieldType: String, val isArray: Boolean? = null, val isAvailableInGraph: Boolean? = null, val isEnum: Boolean? = null, val isFlagEnum: Boolean? = null, val isImage: Boolean? = null, val isLocalizedString: Boolean? = null, val isName: Boolean? = null, val isRequired: Boolean? = null, val maxLength: Int? = null, val propertyId: String? = null, val schemaItemPropLink: String? = null)

Property definition.

Constructors

Link copied to clipboard
constructor(arrayValueSeparator: String? = null, dataSourcePrecedenceRules: List<DataSourcePrecedenceResponse>, enumValidValues: List<ProfileEnumValidValuesFormatResponse>? = null, fieldName: String, fieldType: String, isArray: Boolean? = null, isAvailableInGraph: Boolean? = null, isEnum: Boolean? = null, isFlagEnum: Boolean? = null, isImage: Boolean? = null, isLocalizedString: Boolean? = null, isName: Boolean? = null, isRequired: Boolean? = null, maxLength: Int? = null, propertyId: String? = null, schemaItemPropLink: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Array value separator for properties with isArray set.

Link copied to clipboard

This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.

Link copied to clipboard

Describes valid values for an enum property.

Link copied to clipboard

Name of the property.

Link copied to clipboard

Type of the property.

Link copied to clipboard
val isArray: Boolean? = null

Indicates if the property is actually an array of the fieldType above on the data api.

Link copied to clipboard

Whether property is available in graph or not.

Link copied to clipboard
val isEnum: Boolean? = null

Indicates if the property is an enum.

Link copied to clipboard
val isFlagEnum: Boolean? = null

Indicates if the property is an flag enum.

Link copied to clipboard
val isImage: Boolean? = null

Whether the property is an Image.

Link copied to clipboard

Whether the property is a localized string.

Link copied to clipboard
val isName: Boolean? = null

Whether the property is a name or a part of name.

Link copied to clipboard
val isRequired: Boolean? = null

Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.

Link copied to clipboard
val maxLength: Int? = null

Max length of string. Used only if type is string.

Link copied to clipboard
val propertyId: String? = null

The ID associated with the property.

Link copied to clipboard

URL encoded schema.org item prop link for the property.