EnrichedField

Represents a field selected for Change Data Capture Enrichment for a channel and channel member. A non-empty enriched field is added to an update or delete change event even when not changed.

Introduced in API version 51.0.

create(), delete(), describeSObjects(), query(), retrieve()

DELETE, GET, HEAD, POST, Query

• • This object is part of Change Data Capture Enrichment.
  • Use the EnrichedField object to query, retrieve, or delete enriched fields. Add an enriched field as part of PlatformEventChannelMember. For more information about Change Data Capture Enrichment and adding enriched fields, see Enrich Change Events with Extra Fields When Subscribed with CometD and Example: Add Event Enrichment Fields with Tooling API in the Change Data Capture Developer Guide.
  • To retrieve or query this object, you must have the View Setup and Configuration permission.
  • To delete this object, you must have the Customize Application permission.

• Type: reference

• Required: No

• Properties: Create, Filter, Group, Sort

• Description: The ID of the PlatformEventChannelMember that this field is part of. For example, if a field is added to the AccountChangeEvent, which is part of PlatformEventChannelMember, ChannelMemberId is the ID of the PlatformEventChannelMember record.

• Relationship name: ChannelMember

• Relationship type: relationship

• Type: picklist

• Required: No

• Properties: Create, Filter, Group, Restricted picklist, Sort

• Description: The name of the field to enrich change events with. For a list of supported field types, see Enrich Change Events with Extra Fields When Subscribed with CometD in the Change Data Capture Developer Guide.

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates the manageable state of the specified component that is contained in a package:

• beta

• deleted

• deprecated

• deprecatedEditable

• installed

• installedEditable

• released

• unmanaged

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

To find out which channel members and fields you configured, query the EnrichedField object. For example, this query returns the channel member ID and the selected enriched field on that channel.

1SELECT ChannelMemberId,Field FROM EnrichedField ORDER BY ChannelMemberId

In these query results, the rows returned are ordered by the channel member ID. The first two rows contain two enriched fields on the same channel: the Industry field and a custom field, whose value is an ID. The last row is for a different channel member and contains the Phone enriched field.