afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/ContactCleanInfo.json

497 lines
24 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"usage",
"associated_objects",
"wsdl_segment",
"field_reference"
],
"title": "ContactCleanInfo - Data API",
"description": "Stores the metadata Data.com Clean uses to determine a contact records clean status. Helps you automate the cleaning or related processing of contact records. ContactCleanInfo includes a number of bit vector fields. This object is removed in API version 67.0",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"Address": {
"type": "address",
"properties": "Filter, Nillable",
"description": "The compound form of the address. Read-only. See Address Compound Fields for details on compound address fields."
},
"City": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Details for the billing address of the contact."
},
"CleanedByJob": {
"type": "boolean",
"properties": "Filter",
"description": "Indicates whether the contact record was cleaned by a Data.com Clean job (true) or not (false)."
},
"CleanedByUser": {
"type": "boolean",
"properties": "Filter",
"description": "Indicates whether the contact record was cleaned by a Salesforce user (true) or not (false)."
},
"ContactId": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "The unique, system-generated ID assigned when the contact record was created."
},
"ContactStatusDataDotCom": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Sort",
"description": "The status of the contact per Data.com. Values are: Contact is Active per Data.com, Phone is Wrong per Data.com , Email is Wrong per Data.com, Phone and Email are Wrong per Data.com, Contact Not at Company per Data.com, Contact is Inactive per Data.com, Company this contact belongs to is out of business per Data.com, Company this contact belongs to never existed per Data.com or Email address is invalid per Data.com."
},
"Country": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Details for the billing address of the contact."
},
"DataDotComID": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID Data.com maintains for the contact."
},
"Email": {
"type": "email",
"properties": "Filter, Group, Nillable, Sort",
"description": "The email address for the contact."
},
"FirstName": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The contacts first name."
},
"IsDifferentCity": {
"type": "boolean",
"properties": "Filter",
"description": "Indicates whether the contacts City field value is different from the corresponding value on its matched Data.com record (true) or not (false)."
},
"IsDifferentCountry": {
"type": "boolean",
"properties": "Filter",
"description": "Indicates whether the contacts Country field value is different from the corresponding value on its matched Data.com record (true) or not (false)."
},
"IsDifferentCountryCode": {
"type": "boolean",
"properties": "Filter",
"description": "Indicates whether the contacts Country Code field value is different from the corresponding value on its matched Data.com record (true) or not (false)."
},
"IsDifferentEmail": {
"type": "boolean",
"properties": "Filter",
"description": "Indicates whether the contacts Email field value is different from the corresponding value on its matched Data.com record (true) or not (false)."
},
"IsDifferentFirstName": {
"type": "boolean",
"properties": "Filter",
"description": "Indicates whether the contacts First Name field value is different from the corresponding value on its matched Data.com record (true) or not (false)."
},
"IsDifferentLastName": {
"type": "boolean",
"properties": "Filter",
"description": "Indicates whether the contacts Last Name field value is different from the corresponding value on its matched Data.com record (true) or not (false)."
},
"IsDifferentPhone": {
"type": "boolean",
"properties": "Filter",
"description": "Indicates whether the contacts Phone field value is different from the corresponding value on its matched Data.com record (true) or not (false)."
},
"IsDifferentPostalCode": {
"type": "boolean",
"properties": "Filter",
"description": "Indicates whether the contacts Postal Code field value is different from the corresponding value on its matched Data.com record (true) or not (false)."
},
"IsDifferentState": {
"type": "boolean",
"properties": "Filter",
"description": "Indicates whether the contacts State field value is different from the corresponding value on its matched Data.com record (true) or not (false)."
},
"IsDifferentStateCode": {
"type": "boolean",
"properties": "Filter",
"description": "Indicates whether the contacts State Code field value is different from the corresponding value on its matched Data.com record (true) or not (false)."
},
"IsDifferentStreet": {
"type": "boolean",
"properties": "Filter",
"description": "Indicates whether the contacts Street field value is different from the corresponding value on its matched Data.com record (true) or not (false)."
},
"IsDifferentTitle": {
"type": "boolean",
"properties": "Filter",
"description": "Indicates whether the contacts Title field value is different from the corresponding value on its matched Data.com record (true) or not (false)."
},
"IsFlaggedWrongAddress": {
"type": "boolean",
"properties": "Filter, Update",
"description": "Indicates whether the contacts Address field value is flagged as wrong to Data.com (true) or not (false)."
},
"IsFlaggedWrongEmail": {
"type": "boolean",
"properties": "Filter, Update",
"description": "Indicates whether the contacts Email field value is flagged as wrong to Data.com (true) or not (false)."
},
"IsFlaggedWrongName": {
"type": "boolean",
"properties": "Filter, Update",
"description": "Indicates whether the contacts Name field value is flagged as wrong to Data.com (true) or not (false)."
},
"IsFlaggedWrongPhone": {
"type": "boolean",
"properties": "Filter, Update",
"description": "Indicates whether the contacts Phone field value is flagged as wrong to Data.com (true) or not (false)."
},
"IsFlaggedWrongTitle": {
"type": "boolean",
"properties": "Filter, Update",
"description": "Indicates whether the contacts Title field value is flagged as wrong to Data.com (true) or not (false)."
},
"IsInactive": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Indicates whether the contact has been reported to Data.com as Inactive (true) or not (false)."
},
"IsReviewedAddress": {
"type": "boolean",
"properties": "Filter, Update",
"description": "Indicates whether the contacts Address field value is in a Reviewed state (true) or not (false)."
},
"IsReviewedEmail": {
"type": "boolean",
"properties": "Filter, Update",
"description": "Indicates whether the contacts Email field value is in a Reviewed state (true) or not (false)."
},
"IsReviewedName": {
"type": "boolean",
"properties": "Filter, Update",
"description": "Indicates whether the contacts Name field value is in a Reviewed state (true) or not (false)."
},
"IsReviewedPhone": {
"type": "boolean",
"properties": "Filter, Update",
"description": "Indicates whether the contacts Phone field value is in a Reviewed state (true) or not (false)."
},
"IsReviewedTitle": {
"type": "boolean",
"properties": "Filter, Update",
"description": "Indicates whether the contacts Title field value is in a Reviewed state (true) or not (false)."
},
"LastMatchedDate": {
"type": "dateTime",
"properties": "Filter, Sort",
"description": "The date the contact record was last matched and linked to a Data.com record."
},
"LastName": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The contacts last name."
},
"LastStatusChangedById": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of who or what last changed the records Clean Status field value: a Salesforce user or a Clean job."
},
"LastStatusChangedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The date on which the records Clean Status field value was last changed."
},
"Latitude": {
"type": "double",
"properties": "Filter, Nillable, Sort",
"description": "Used with Longitude to specify the precise geolocation of a billing address. Data not currently provided."
},
"Longitude": {
"type": "double",
"properties": "Filter, Nillable, Sort",
"description": "Used with Latitude to specify the precise geolocation of a billing address. Data not currently provided."
},
"Name": {
"type": "string",
"properties": "Filter, Group, Sort, Update",
"description": "Field label is Contact Clean Info Name. The name of the contact. Maximum size is 255 characters."
},
"Phone": {
"type": "phone",
"properties": "Filter, Group, Nillable, Sort",
"description": "The phone number for the contact."
},
"PostalCode": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Details for the billing address of the contact."
},
"State": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Details for the billing address of the contact."
},
"Street": {
"type": "textarea",
"properties": "Filter, Group, Nillable, Sort",
"description": "Details for the billing address of the contact."
},
"Title": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The contacts title."
}
},
"usage": "Developers can create triggers that read the Contact Clean Info fields to help automate the cleaning or related processing of contact records. Create a customized set of Title field values. Use triggers to map values from fields on imported or cleaned records onto a standard set of values.\n\nDevelopers can create triggers that read the Contact Clean Info fields to help automate the cleaning or related processing of contact records.\n\nCreate a customized set of Title field values. Use triggers to map values from fields on imported or cleaned records onto a standard set of values.",
"associated_objects": "This object has the following associated objects. If the API version isnt specified, theyre available in the same API versions as this object. Otherwise, theyre available in the specified API version and later.\n\n- **ContactCleanInfoChangeEvent (API version 62.0)**: Change events are available for the object.",
"wsdl_segment": "```xml\n<complexType name=\"ContactCleanInfo\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"Address\" nillable=\"true\" minOccurs=\"0\" type=\"tns:address\"/>\n <element name=\"City\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"CleanedByJob\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"CleanedByUser\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"Contact\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Contact\"/>\n <element name=\"ContactId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"ContactStatusDataDotCom\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Country\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"DataDotComId\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Email\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"FirstName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"GeocodeAccuracy\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsDifferentCity\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsDifferentCountry\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsDifferentCountryCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsDifferentEmail\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsDifferentFirstName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsDifferentLastName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsDifferentPhone\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsDifferentPostalCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsDifferentState\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsDifferentStateCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsDifferentStreet\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsDifferentTitle\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsFlaggedWrongAddress\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsFlaggedWrongEmail\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsFlaggedWrongName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsFlaggedWrongPhone\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsFlaggedWrongTitle\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsInactive\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsReviewedAddress\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsReviewedEmail\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsReviewedName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsReviewedPhone\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsReviewedTitle\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"LastMatchedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"LastStatusChangedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"LastStatusChangedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"LastStatusChangedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Latitude\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"Longitude\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Phone\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"PostalCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"State\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Street\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Title\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n <restriction base=\"xsd:string\">\n <length value=\"18\"/>\n <pattern value=\"[a-zA-Z0-9]{18}\"/>\n </restriction>\n</simpleType>\n<complexType name=\"address\">\n <complexContent>\n <extension base=\"tns:location\">\n <sequence>\n <element name=\"city\" type=\"xsd:string\" nillable=\"true\"/>\n <element name=\"country\" type=\"xsd:string\" nillable=\"true\"/>\n <element name=\"countryCode\" type=\"xsd:string\" nillable=\"true\"/>\n <element name=\"geocodeAccuracy\" type=\"xsd:string\" nillable=\"true\"/>\n <element name=\"postalCode\" type=\"xsd:string\" nillable=\"true\"/>\n <element name=\"state\" type=\"xsd:string\" nillable=\"true\"/>\n <element name=\"stateCode\" type=\"xsd:string\" nillable=\"true\"/>\n <element name=\"street\" type=\"xsd:string\" nillable=\"true\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n<complexType name=\"location\">\n <sequence>\n <element name=\"latitude\" type=\"xsd:double\" nillable=\"true\"/>\n <element name=\"longitude\" type=\"xsd:double\" nillable=\"true\"/>\n </sequence>\n</complexType>\n```",
"field_reference": {
"Address": {
"field_label": "Address",
"type": "address"
},
"City": {
"field_label": "City",
"type": "string",
"length": "40"
},
"CleanedByJob": {
"field_label": "Cleaned by Job",
"type": "boolean"
},
"CleanedByUser": {
"field_label": "Cleaned by User",
"type": "boolean"
},
"ContactId": {
"field_label": "Contact ID",
"type": "reference",
"length": "18"
},
"ContactStatusDataDotCom": {
"field_label": "Contact Status per Data.com",
"type": "picklist",
"length": "255"
},
"Country": {
"field_label": "Country",
"type": "string",
"length": "80"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"CurrencyIsoCode": {
"field_label": "Currency ISO Code",
"type": "picklist",
"length": "3"
},
"DataDotComId": {
"field_label": "Data.com ID",
"type": "string",
"length": "20"
},
"Email": {
"field_label": "Email",
"type": "email",
"length": "80"
},
"FirstName": {
"field_label": "First Name",
"type": "string",
"length": "255"
},
"GeocodeAccuracy": {
"field_label": "Geocode Accuracy",
"type": "picklist",
"length": "40"
},
"Id": {
"field_label": "Contact Clean Info ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"IsDifferentCity": {
"field_label": "City is Different",
"type": "boolean"
},
"IsDifferentCountry": {
"field_label": "Country is Different",
"type": "boolean"
},
"IsDifferentCountryCode": {
"field_label": "Country Code is Different",
"type": "boolean"
},
"IsDifferentEmail": {
"field_label": "Email is Different",
"type": "boolean"
},
"IsDifferentFirstName": {
"field_label": "First Name is Different",
"type": "boolean"
},
"IsDifferentLastName": {
"field_label": "Last Name is Different",
"type": "boolean"
},
"IsDifferentPhone": {
"field_label": "Phone is Different",
"type": "boolean"
},
"IsDifferentPostalCode": {
"field_label": "ZIP is Different",
"type": "boolean"
},
"IsDifferentState": {
"field_label": "State is Different",
"type": "boolean"
},
"IsDifferentStateCode": {
"field_label": "State Code is Different",
"type": "boolean"
},
"IsDifferentStreet": {
"field_label": "Street is Different",
"type": "boolean"
},
"IsDifferentTitle": {
"field_label": "Title is Different",
"type": "boolean"
},
"IsFlaggedWrongAddress": {
"field_label": "Address is Flagged Wrong",
"type": "boolean"
},
"IsFlaggedWrongEmail": {
"field_label": "Email is Flagged Wrong",
"type": "boolean"
},
"IsFlaggedWrongName": {
"field_label": "Name is Flagged Wrong",
"type": "boolean"
},
"IsFlaggedWrongPhone": {
"field_label": "Phone is Flagged Wrong",
"type": "boolean"
},
"IsFlaggedWrongTitle": {
"field_label": "Title is Flagged Wrong",
"type": "boolean"
},
"IsInactive": {
"field_label": "Contact Status in Salesforce",
"type": "boolean"
},
"IsReviewedAddress": {
"field_label": "Address is Reviewed",
"type": "boolean"
},
"IsReviewedEmail": {
"field_label": "Email is Reviewed",
"type": "boolean"
},
"IsReviewedName": {
"field_label": "Name is Reviewed",
"type": "boolean"
},
"IsReviewedPhone": {
"field_label": "Phone is Reviewed",
"type": "boolean"
},
"IsReviewedTitle": {
"field_label": "Title is Reviewed",
"type": "boolean"
},
"LastMatchedDate": {
"field_label": "Last Matched Date",
"type": "datetime"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"LastName": {
"field_label": "Last Name",
"type": "string",
"length": "255"
},
"LastStatusChangedById": {
"field_label": "User ID",
"type": "reference",
"length": "18"
},
"LastStatusChangedDate": {
"field_label": "Last Status Changed Date",
"type": "datetime"
},
"Latitude": {
"field_label": "Latitude",
"type": "double",
"precision": "18",
"scale": "15"
},
"Longitude": {
"field_label": "Longitude",
"type": "double",
"precision": "18",
"scale": "15"
},
"Name": {
"field_label": "Contact Clean Info Name",
"type": "string",
"length": "255"
},
"Phone": {
"field_label": "Phone",
"type": "phone",
"length": "40"
},
"PostalCode": {
"field_label": "Zip",
"type": "string",
"length": "20"
},
"State": {
"field_label": "State",
"type": "string",
"length": "80"
},
"Street": {
"field_label": "Street",
"type": "textarea",
"length": "255"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"Title": {
"field_label": "Title",
"type": "string",
"length": "128"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"precision",
"scale"
]
}