Class GetMappingResponseDataAttributesAttributesItems

Details of a single entity attribute including its mapping configuration and metadata.

Hierarchy

  • GetMappingResponseDataAttributesAttributesItems

Constructors

constructor

Properties

additionalProperties? attribute? description? displayName? groups? isCustom? type?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional attribute

attribute?: string

The attribute identifier as used in the entity data model.

Optional description

description?: string

Human-readable explanation of what the attribute represents.

Optional displayName

displayName?: string

The human-readable label for the attribute shown in the UI.

Optional groups

groups?: string[]

List of group labels used to categorize the attribute.

Optional isCustom

isCustom?: boolean

Whether this attribute is a custom user-defined attribute rather than a built-in one.

Optional type

type?: string

The data type of the attribute (for example, string or number).

Settings

Member Visibility

Theme

Generated using TypeDoc