mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-05 23:41:31 +08:00
39 lines
3.8 KiB
JSON
39 lines
3.8 KiB
JSON
{
|
|
"sections": [
|
|
"title",
|
|
"description",
|
|
"supported_soap_calls",
|
|
"supported_rest_api_http_methods",
|
|
"fields",
|
|
"special_access_rules",
|
|
"wsdl_segment"
|
|
],
|
|
"title": "EnrichedField - Tooling API",
|
|
"description": "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. Available in API version 51.0 and later.",
|
|
"supported_soap_calls": "`delete()`, `describeSObjects()`, `query()`, `retrieve()`",
|
|
"supported_rest_api_http_methods": "`DELETE`, `GET`, `HEAD`, `Query`",
|
|
"fields_columns": [
|
|
"type",
|
|
"properties",
|
|
"description"
|
|
],
|
|
"fields": {
|
|
"ChannelMemberId": {
|
|
"type": "reference",
|
|
"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."
|
|
},
|
|
"Field": {
|
|
"type": "picklist",
|
|
"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."
|
|
},
|
|
"ManageableState": {
|
|
"type": "ManageableState enumerated list",
|
|
"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"
|
|
}
|
|
},
|
|
"special_access_rules": "- This object is part of Change Data Capture Enrichment.\n- 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.\n- To retrieve or query this object, you must have the View Setup and Configuration permission.\n- To delete this object, you must have the Customize Application permission.",
|
|
"wsdl_segment": "```xml\n<xsd:complexType name=\"EnrichedField\">\n <xsd:complexContent>\n <xsd:extension base=\"ens:sObject\">\n <xsd:sequence>\n <xsd:element name=\"ChannelMember\" minOccurs=\"0\" type=\"ens:PlatformEventChannelMember\" nillable=\"true\"/>\n <xsd:element name=\"ChannelMemberId\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"CreatedBy\" minOccurs=\"0\" type=\"ens:User\" nillable=\"true\"/>\n <xsd:element name=\"CreatedById\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"CreatedDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"Field\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"IsDeleted\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedBy\" minOccurs=\"0\" type=\"ens:User\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedById\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"ManageableState\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"SystemModstamp\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n```"
|
|
} |