mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-07 00:02:34 +08:00
160 lines
8.8 KiB
JSON
160 lines
8.8 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"special_access_rules",
|
||
"associated_objects",
|
||
"wsdl_segment",
|
||
"field_reference"
|
||
],
|
||
"title": "DataUsePurpose - Data API",
|
||
"description": "Represents the reason for contacting a prospect or customer, such as for billing, marketing, or surveys. This object is available in API version 45.0 and later.",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description",
|
||
"relationship_name",
|
||
"relationship_type",
|
||
"refers_to"
|
||
],
|
||
"fields": {
|
||
"CanDataSubjectOptOut": {
|
||
"type": "boolean",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
|
||
"description": "Indicates whether the customer can decline contact for the described purpose.",
|
||
"required": true
|
||
},
|
||
"Description": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "Indicates the purpose for contacting a customer."
|
||
},
|
||
"LastReferencedDate": {
|
||
"type": "dateTime",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The timestamp for when the current user last viewed a record related to this record."
|
||
},
|
||
"LastViewedDate": {
|
||
"type": "dateTime",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed."
|
||
},
|
||
"LegalBasisId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "Identifies the legal basis record associated with the data use purpose. This is a relationship field.",
|
||
"relationship_name": "LegalBasis",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "DataUseLegalBasis"
|
||
},
|
||
"Name": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, idLookup, Sort, Update",
|
||
"description": "Identifies the reason for contacting a customer. For example, billing or marketing.",
|
||
"required": true
|
||
},
|
||
"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 polymorphic relationship field.",
|
||
"relationship_name": "Owner",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "Group, User"
|
||
},
|
||
"PurposeId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "The ID of an object containing data specific to the data use purpose. This is a polymorphic relationship field.",
|
||
"relationship_name": "Purpose",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "Asset, CareProgram, CareRegisteredDevice, or Product2"
|
||
}
|
||
},
|
||
"special_access_rules": "This object is available if Data Protection and Privacy is enabled.",
|
||
"associated_objects": "This object has the following associated objects. Unless noted, they’re available in the same API version as this object.\n\n- **DataUsePurposeChangeEvent (API version 62.0)**: Change events are available for the object.\n- **DataUsePurposeHistory**: History is available for tracked fields of the object.\n- **DataUsePurposeOwnerSharingRule**: Sharing rules are available for the object.\n- **DataUsePurposeShare**: Sharing is available for the object.",
|
||
"wsdl_segment": "```xml\n<complexType name=\"DataUsePurpose\">\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=\"AuthorizationFormDataUses\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"CanDataSubjectOptOut\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"CommSubscriptions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\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=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Histories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"IsDeleted\" 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=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LegalBasis\" nillable=\"true\" minOccurs=\"0\" type=\"ens:DataUseLegalBasis\"/>\n <element name=\"LegalBasisId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\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=\"ProcessInstances\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ProcessSteps\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\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<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": {
|
||
"CanDataSubjectOptOut": {
|
||
"field_label": "Can Data Subject Opt Out",
|
||
"type": "boolean"
|
||
},
|
||
"CreatedById": {
|
||
"field_label": "Created By ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"CreatedDate": {
|
||
"field_label": "Created Date",
|
||
"type": "datetime"
|
||
},
|
||
"Description": {
|
||
"field_label": "Description",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"Id": {
|
||
"field_label": "Data Use Purpose ID",
|
||
"type": "id",
|
||
"length": "18"
|
||
},
|
||
"IsActive": {
|
||
"field_label": "Is Active",
|
||
"type": "boolean"
|
||
},
|
||
"IsDeleted": {
|
||
"field_label": "Deleted",
|
||
"type": "boolean"
|
||
},
|
||
"IsReadOnly": {
|
||
"field_label": "Is Read Only",
|
||
"type": "boolean"
|
||
},
|
||
"LastModifiedById": {
|
||
"field_label": "Last Modified By ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"LastModifiedDate": {
|
||
"field_label": "Last Modified Date",
|
||
"type": "datetime"
|
||
},
|
||
"LastReferencedDate": {
|
||
"field_label": "Last Referenced Date",
|
||
"type": "datetime"
|
||
},
|
||
"LastViewedDate": {
|
||
"field_label": "Last Viewed Date",
|
||
"type": "datetime"
|
||
},
|
||
"LegalBasisId": {
|
||
"field_label": "Legal Basis ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"Name": {
|
||
"field_label": "Name",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"OwnerId": {
|
||
"field_label": "Owner ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"PurposeId": {
|
||
"field_label": "Purpose ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"SystemModstamp": {
|
||
"field_label": "System Modstamp",
|
||
"type": "datetime"
|
||
}
|
||
},
|
||
"field_reference_columns": [
|
||
"field_label",
|
||
"type",
|
||
"length"
|
||
]
|
||
} |