Newer Version Available

This content describes an older version of this product. View Latest

PrivacyJobSession

Represents the status of past, ongoing, and scheduled policy jobs in Privacy Center. This object is available in API version 59.0 and later.

This object is Read-only.

Supported Calls

describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Special Access Rules

This object is available for users with the Privacy Center license and the Manage Privacy Center Policies user permission.

Fields

Field Details
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 successfully captured the records targeted by the filters in the policy.
OptionsTraversalFailed
Type
boolean
Properties
Filter
Description
Indicates that the policy job session failed to capture the records targeted by the filters in the policy.
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.

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.

PrivacyJobSessionOwnerSharingRule
Sharing rules are available for the object.
PrivacyJobSessionShare
Sharing is available for the object.