Interface ChangeLabelChange

Change triggered by the following update actions:

- [Change AttributeDefinition Label](ctp:api:type:ProductTypeChangeLabelAction) on Product Types.
- [Change FieldDefinition Label](ctp:api:type:TypeChangeLabelAction) on Types.
interface ChangeLabelChange {
    attributeName: string;
    change: string;
    fieldName: string;
    nextValue: LocalizedString;
    previousValue: LocalizedString;
    type: "ChangeLabelChange";
}

Hierarchy (View Summary)

Properties

attributeName change fieldName nextValue previousValue type

Properties

ReadonlyattributeName

attributeName: string

Name of the updated AttributeDefinition; only present on changes to Product Types.

Readonlychange

change: string

Type of change on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the setDescription change can occur with a localized and non-localized representation.

[Records](ctp:history:type:Record) can be filtered by this value using the `changes` query parameter.

ReadonlyfieldName

fieldName: string

Name of the updated FieldDefinition; only present on changes to Types).

ReadonlynextValue

nextValue: LocalizedString

Value after the change.

ReadonlypreviousValue

previousValue: LocalizedString

Value before the change.

Readonlytype

type: "ChangeLabelChange"

Unique discriminator value to reliably deserialize the data type.

Settings

Member Visibility

On This Page

Properties