Typescript SDK Type Docs
    Preparing search index...

    Interface SetInheritedAssociatesChange

    This change is initiated by background processes after the Change Parent Unit or Set Unit Type update action is performed (if Associates are inherited).

    interface SetInheritedAssociatesChange {
        addedItems: InheritedAssociate[];
        change: string;
        nextValue: InheritedAssociate[];
        previousValue: InheritedAssociate[];
        removedItems: InheritedAssociate[];
        type: "SetInheritedAssociatesChange";
    }

    Hierarchy (View Summary)

    • IChange
      • SetInheritedAssociatesChange
    Index

    Properties

    addedItems: InheritedAssociate[]

    Elements added to the array.

    change: string

    Change type 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.
    
    nextValue: InheritedAssociate[]

    Value after the change.

    previousValue: InheritedAssociate[]

    Value before the change.

    removedItems: InheritedAssociate[]

    Elements removed from the array.

    type: "SetInheritedAssociatesChange"

    Unique discriminator value to reliably deserialize the data type.