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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "associated_objects",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "PrivacyJobSession - Data API",
  "description": "Represents the status of past, ongoing, and scheduled policy jobs in Privacy Center. This object is available in API version 59.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "CreationDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The date and time the policy job was created."
    },
    "CurrentObject": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The name of the object that the policy job is currently processing."
    },
    "EndTime": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The date and time the policy job finished executing."
    },
    "FailureLog": {
      "type": "textarea",
      "properties": "Nillable",
      "description": "The description of why the policy job failed to execute."
    },
    "JobStartType": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "How the policy job session was started. Possible values are: manual scheduled"
    },
    "JobStatus": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Represents the status of the policy job session. Possible values are: cancelled completed failures inactive running running_next scheduled suspended"
    },
    "Name": {
      "type": "string",
      "properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
      "description": "Represents the job session record. This is a serialized, automatically generated number field."
    },
    "OptionsProcessingFailed": {
      "type": "boolean",
      "properties": "Filter",
      "description": "Indicates that the policy job session failed to process the records with the deletion or masking rules in the policy."
    },
    "OptionsTraversalComplete": {
      "type": "boolean",
      "properties": "Filter",
      "description": "Indicates that the policy job session was completed without errors."
    },
    "OptionsTraversalFailed": {
      "type": "boolean",
      "properties": "Filter",
      "description": "Indicates that the policy job session was completed with errors."
    },
    "OwnerId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "The ID of the owner of the account associated with this customer. This field is a polymorphic relationship field.",
      "relationship_name": "Owner",
      "relationship_type": "Lookup",
      "refers_to": "Group, User"
    },
    "PolicyDescription": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The description of the policy the job session is associated with."
    },
    "PolicyName": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The name of the policy the job session is associated with."
    },
    "PolicyType": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The type of policy the job session is associated with. Possible values are: datamanagement—Data Management. datamask—This policy type is reserved for future use. rtbf— Right to Be Forgotten."
    },
    "PrivacyPolicyDefinitionId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the policy the job session is executing for. This field is a relationship field.",
      "relationship_name": "PrivacyPolicyDefinition",
      "relationship_type": "Lookup",
      "refers_to": "PrivacyPolicyDefinition"
    },
    "PrivacyRtbfRequestId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the Right to Be Forgotten request the policy job is executing for. This field is a relationship field.",
      "relationship_name": "PrivacyRtbfRequest",
      "relationship_type": "Lookup",
      "refers_to": "PrivacyRTBFRequest"
    },
    "ScheduledTime": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The date and time the policy job session is scheduled to run."
    },
    "SerializedPolicy": {
      "type": "textarea",
      "properties": "Nillable",
      "description": "The serial ID of a snapshot of the policy the job session is for. A snapshot of the policy is taken to maintain consistent metadata for the policy the job is for, in case changes are made to the policy while the job is executing."
    },
    "StartTime": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The date and time the policy job session started executing."
    }
  },
  "special_access_rules": "This object is available for users with the Privacy Center license and the Manage Privacy Center Policies user permission.\n\nThis object is available for users with the\n         Privacy Center license and the Manage Privacy Center Policies user permission.",
  "associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **PrivacyJobSessionOwnerSharingRule**: Sharing rules are available for the object.\n- **PrivacyJobSessionShare**: 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=\"PrivacyJobSession\">\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=\"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=\"CreationDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"CurrentObject\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"EndTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"FailureLog\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsPreview\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"JobManagementType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"JobPolicyName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"JobStartType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"JobStatus\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"OptionsAcknowledged\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"OptionsErrorBypassOccurred\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"OptionsPreview\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"OptionsProcessingFailed\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"OptionsTopLevelErrorBypass\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"OptionsTraversalComplete\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"OptionsTraversalFailed\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\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=\"PermissionSet\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PolicyDescription\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PolicyName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PolicyType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PrivacyJobSessionObjects\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"PrivacyPolicyDefinition\" nillable=\"true\" minOccurs=\"0\" type=\"ens:PrivacyPolicyDefinition\"/>\n        <element name=\"PrivacyPolicyDefinitionId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"PrivacyRtbfRequest\" nillable=\"true\" minOccurs=\"0\" type=\"ens:PrivacyRTBFRequest\"/>\n        <element name=\"PrivacyRtbfRequestId\" nillable=\"true\" minO
  "field_reference": {
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CreationDate": {
      "field_label": "Creation Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "CurrentObject": {
      "field_label": "Current Object",
      "type": "string",
      "length": "128"
    },
    "EndTime": {
      "field_label": "End Time",
      "type": "datetime"
    },
    "FailureLog": {
      "field_label": "Failure Log",
      "type": "textarea",
      "length": "131072"
    },
    "Id": {
      "field_label": "Privacy Job Session ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "IsPreview": {
      "field_label": "Preview",
      "type": "boolean"
    },
    "JobManagementType": {
      "field_label": "Job Management Type",
      "type": "picklist",
      "length": "255"
    },
    "JobPolicyName": {
      "field_label": "Job Policy Name",
      "type": "string",
      "length": "255"
    },
    "JobStartType": {
      "field_label": "Job Start Type",
      "type": "picklist",
      "length": "255"
    },
    "JobStatus": {
      "field_label": "Job Status",
      "type": "picklist",
      "length": "255"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "Name": {
      "field_label": "Name",
      "type": "string",
      "length": "255"
    },
    "OptionsAcknowledged": {
      "field_label": "Acknowledged",
      "type": "boolean"
    },
    "OptionsErrorBypassOccurred": {
      "field_label": "ErrorBypassOccurred",
      "type": "boolean"
    },
    "OptionsPreview": {
      "field_label": "Preview",
      "type": "boolean"
    },
    "OptionsProcessingFailed": {
      "field_label": "ProcessingFailed",
      "type": "boolean"
    },
    "OptionsTopLevelErrorBypass": {
      "field_label": "TopLevelErrorBypass",
      "type": "boolean"
    },
    "OptionsTraversalComplete": {
      "field_label": "TraversalComplete",
      "type": "boolean"
    },
    "OptionsTraversalFailed": {
      "field_label": "TraversalFailed",
      "type": "boolean"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "PermissionSet": {
      "field_label": "Permission Set",
      "type": "string",
      "length": "255"
    },
    "PolicyDescription": {
      "field_label": "Policy Description",
      "type": "string",
      "length": "255"
    },
    "PolicyName": {
      "field_label": "Policy Name",
      "type": "string",
      "length": "255"
    },
    "PolicyType": {
      "field_label": "Policy Type",
      "type": "picklist",
      "length": "255"
    },
    "PrivacyPolicyDefinitionId": {
      "field_label": "Privacy Policy Definition ID",
      "type": "reference",
      "length": "18"
    },
    "PrivacyRtbfRequestId": {
      "field_label": "Privacy RTBF Request ID",
      "type": "reference",
      "length": "18"
    },
    "ScheduledTime": {
      "field_label": "Scheduled Time",
      "type": "datetime"
    },
    "SerializedPolicy": {
      "field_label": "Serialized Policy",
      "type": "textarea",
      "length": "131072"
    },
    "StartTime": {
      "field_label": "Start Time",
      "type": "datetime"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}