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

333 lines
17 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",
"associated_objects",
"wsdl_segment",
"field_reference"
],
"title": "Individual - Data API",
"description": "Represents a customers data privacy and protection preferences. Data privacy records based on the Individual object store your customers preferences. Data privacy records are associated with related leads, contacts, person accounts, and users. This object is available in API version 42.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"BirthDate": {
"type": "date",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The customers birthdate."
},
"CanStorePiiElsewhere": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indication that you can store the customers personally identifiable information (PII) outside of their legislation area. For example, you could store an EU citizens PII data in the US."
},
"ChildrenCount": {
"type": "int",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The number of children the customer has."
},
"ConsumerCreditScore": {
"type": "int",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The person's credit score (for example, 740)."
},
"ConsumerCreditScoreProviderName": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The name of the company that provided the credit score."
},
"ConvictionsCount": {
"type": "int",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The number of convictions for the customer."
},
"DeathDate": {
"type": "date",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The customers death date."
},
"FirstName": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The customers first name. Maximum size is 40 characters."
},
"HasOptedOutGeoTracking": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Preference to not track geolocation on mobile devices."
},
"HasOptedOutProcessing": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Preference to not process personal data, which can include collecting, storing, and sharing personal data."
},
"HasOptedOutProfiling": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Preference to not process data for predicting personal attributes, such as interests, behavior, and location."
},
"HasOptedOutSolicit": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Preference to not solicit products and services."
},
"HasOptedOutTracking": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Preference to not track customer web activity and whether the customer opens email sent through Salesforce."
},
"HasPrivacyHold": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates the Privacy Hold status."
},
"IndividualsAge": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Indicates whether the customer is considered to be a minor."
},
"InfluencerRating": {
"type": "int",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "A measure of the person's influence, irrespective of how we do business with them."
},
"IsHomeOwner": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether the customer owns a home."
},
"LastName": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The customers last name. Maximum size is 80 characters.",
"required": true
},
"LastViewedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp for when the current user last viewed this record."
},
"MasterRecordId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "If this object was deleted as the result of a merge, this field contains the ID of the record that was kept. If this object was deleted for any other reason, or hasnt been deleted, the value is null. This is a relationship field.",
"relationship_name": "MasterRecord",
"relationship_type": "Lookup",
"refers_to": "Individual"
},
"MilitaryService": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Indicates whether the customer has served in the military."
},
"Name": {
"type": "string",
"properties": "Filter, Group, Sort",
"description": "Concatenation of FirstName and LastName. Maximum size is 203 characters, including whitespaces."
},
"Occupation": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The customers occupation. Maximum size is 150 characters."
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "The ID of the owner of the account associated with this customer. This is a relationship field.",
"relationship_name": "Owner",
"relationship_type": "Lookup",
"refers_to": "User"
},
"Salutation": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The title for addressing the customer, such as Dr. or Mrs."
},
"SendIndividualData": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Preference to export personal data for delivery to the customer."
},
"ShouldForget": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Preference to delete records and personal data related to this customer."
},
"Website": {
"type": "url",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The URL for the customers website."
}
},
"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- **IndividualChangeEvent (API version 47.0)**: Change events are available for the object.\n- **IndividualHistory**: History is available for tracked fields of the object.\n- **IndividualShare**: Sharing is available for the object.",
"wsdl_segment": "```xml\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=\"Individual\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"ApprovalSubmissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ApprovalWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"AuthorizationFormConsents\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"BirthDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\n <element name=\"CanStorePiiElsewhere\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"ChildrenCount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"CommSubscriptionConsents\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ConsumerCreditScore\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"ConsumerCreditScoreProviderName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"ContactPointAddresses\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ContactPointEmails\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ContactPointPhones\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Contacts\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ConvictionsCount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\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=\"DeathDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\n <element name=\"DuplicateRecordItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"FirstName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"HasOptedOutGeoTracking\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"HasOptedOutProcessing\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"HasOptedOutProfiling\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"HasOptedOutSolicit\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"HasOptedOutTracking\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"Histories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Individuals\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"IndividualsAge\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"InfluencerRating\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsHomeOwner\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\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=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Leads\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"MasterRecord\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Individual\"/>\n <element name=\"MasterRecordId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"MilitaryService\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Occupation\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"PartyConsents\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"PartyRoleCustomers\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"PartyRoleSellers\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Salutation\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SendIndividualData\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ShouldForget\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Website\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n<simpleType name=\"QueryLocator\">\n <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n <sequence>\n <element name=\"done\" type=\"xsd:boolean\"/>\n <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n <element name=\"size\" type=\"xsd:int\"/>\n </sequence>\n</complexType>\n```",
"field_reference": {
"BirthDate": {
"field_label": "Birth Date",
"type": "date"
},
"CanStorePiiElsewhere": {
"field_label": "OK to Store PII Data Elsewhere",
"type": "boolean"
},
"ChildrenCount": {
"field_label": "Number of Children",
"type": "int",
"digits": "9"
},
"ConsumerCreditScore": {
"field_label": "Consumer Credit Score",
"type": "int",
"digits": "9"
},
"ConsumerCreditScoreProviderName": {
"field_label": "Consumer Credit Score Provider Name",
"type": "string",
"length": "255"
},
"ConvictionsCount": {
"field_label": "Conviction Count",
"type": "int",
"digits": "9"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"DeathDate": {
"field_label": "Death Date",
"type": "date"
},
"FirstName": {
"field_label": "First Name",
"type": "string",
"length": "40"
},
"HasOptedOutGeoTracking": {
"field_label": "Block Geolocation Tracking",
"type": "boolean"
},
"HasOptedOutProcessing": {
"field_label": "Don't Process",
"type": "boolean"
},
"HasOptedOutProfiling": {
"field_label": "Don't Profile",
"type": "boolean"
},
"HasOptedOutSolicit": {
"field_label": "Don't Market",
"type": "boolean"
},
"HasOptedOutTracking": {
"field_label": "Don't Track",
"type": "boolean"
},
"Id": {
"field_label": "Individual ID",
"type": "id",
"length": "18"
},
"IndividualsAge": {
"field_label": "Individual's Age",
"type": "picklist",
"length": "255"
},
"InfluencerRating": {
"field_label": "Influencer Rating",
"type": "int",
"digits": "9"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"IsHomeOwner": {
"field_label": "Is Homeowner",
"type": "boolean"
},
"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": "80"
},
"LastViewedDate": {
"field_label": "Last Viewed Date",
"type": "datetime"
},
"MasterRecordId": {
"field_label": "Master Record ID",
"type": "reference",
"length": "18"
},
"MilitaryService": {
"field_label": "Military Service",
"type": "picklist",
"length": "255"
},
"Name": {
"field_label": "Name",
"type": "string",
"length": "121"
},
"Occupation": {
"field_label": "Occupation",
"type": "string",
"length": "150"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"Salutation": {
"field_label": "Salutation",
"type": "picklist",
"length": "40"
},
"SendIndividualData": {
"field_label": "Export Individual's Data",
"type": "boolean"
},
"ShouldForget": {
"field_label": "Forget this Individual",
"type": "boolean"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"Website": {
"field_label": "Website",
"type": "url",
"length": "255"
}
},
"field_reference_columns": [
"field_label",
"type",
"digits",
"length"
]
}