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

85 lines
4.1 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",
"special_access_rules",
"associated_objects"
],
"title": "DsarPolicyLog - Data API",
"description": "Represents the history of Data Subject Access Request (DSAR) policy execution requests. This log records the status and results of executed DSAR policies for a customer. This object is available in API version 50.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"CompletionDateTime": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The date and time when the data subject access request was completed. Available in API version 51.0 and later."
},
"DataSubjectId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "The 1518 character ID of the data subject making the request. Available in API version 51.0 and later."
},
"DeletedDateTime": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The date and time when the file generated for the data subjects request is deleted. Available in API version 51.0 and later."
},
"DeveloperName": {
"type": "string",
"properties": "Filter, Group, Sort",
"description": "Developer name of the policy. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
},
"DownloadedDateTime": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The most recent date and time when the data subject downloaded the file generated at their request. Available in API version 51.0 and later."
},
"DsarError": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Represents an error in generating the file for the data subject access request. Available in API version 51.0 and later."
},
"DsarPolicyId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the DSAR policy."
},
"FileURL": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The result of the DSAR policy execution. The URL links to a downloadable file that contains the customer data."
},
"Language": {
"type": "picklist",
"properties": "Filter, Group, Restricted picklist, Sort",
"description": "The language of the MasterLabel. Possible values are: da—Danish de—German en_US—English es—Spanish es_MX—Spanish (Mexico) fi—Finnish fr—French it—Italian ja—Japanese ko—Korean nl_NL—Dutch no—Norwegian pt_BR—Portuguese (Brazil) ru—Russian sv—Swedish th—Thai zh_CN—Chinese (Simplified) zh_TW—Chinese (Traditional)"
},
"MasterLabel": {
"type": "string",
"properties": "Filter, Group, Sort",
"description": "Label of the policy."
},
"RequestDateTime": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The date and time when a data subject requested access to their data in the org. Available in API version 51.0 and later."
},
"RequestStatus": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "The status of the policy execution. Possible values are: Complete Deleted Downloaded Expired Failed In Progress"
},
"RequestUserId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the org employee or admin making the request on behalf of the data subject. Available in API version 51.0 and later."
}
},
"special_access_rules": "This object is for Privacy Center customers with the ReadAllData or PrivacyDataAccess permissions.",
"associated_objects": "This object has the following associated objects. Unless noted, theyre available in the same API version as the object.\n\n- **DsarPolicy**: Sharing is available for the object."
}