---
schema_version: "1"
id: 1151ae3e617b695391db4fa54d471649bf79bf860e5d7a72e8ef7d87f82ee1dd
title: PrivacyObjectSession
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_privacyobjectsession.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_privacyobjectsession.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 6f916994f315eb89151f2604176ead8ec0db3258f6466da2521986d20df86b7f
description: Represents the status of each object being processed in past, ongoing, and scheduled policy jobs in Privacy Center. This object is available in API version 59.0 and later.
---
# PrivacyObjectSession

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

See the status of each object as a policy executes. For example, if a Data Management policy includes an Account object and a Contact object, then a PrivacyObjectSession record is created for each object.

Each object in a policy has five potential queues to enter. The first queue captures and stores records targeted by the policy filters. If the first queue run fails to capture every record, then the object goes through three retry attempts to capture the remaining records. The fifth queue stores the record IDs of any records that weren’t captured in any of the four attempts.

This object is Read-only.

## Supported Calls

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 |
| --- | --- |
| CurrentEntity | 
Type

string

Properties

Filter, Group, Nillable, Sort

Description

The name of the object in the policy.



 |
| 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.



 |
| ObjectFailureLog | 

Type

textarea

Properties

Nillable

Description

This field is reserved for later use.



 |
| ObjectStatus | 

Type

picklist

Properties

Filter, Group, Nillable, Restricted picklist, Sort

Description

The policy execution status for the object.

Possible values are:

- processing\_completed
- processing\_failed
- processing\_ongoing
- processing\_pending
- traversal\_completed
- traversal\_failed
- traversal\_ongoing





 |
| OwnerId | 

Type

reference

Properties

Filter, Group, Sort

Description

The ID of the owner of the account associated with the customer that the policy was executed for.

This field is a polymorphic relationship field.

Relationship Name

Owner

Relationship Type

Lookup

Refers To

Group, User



 |
| PolicyNode | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

The ID of the object in the serialized policy. This field associates the object session in the policy execution with the coordinating object in the Privacy Center policy.



 |
| Position | 

Type

int

Properties

Filter, Group, Nillable, Sort

Description

Represents a record’s position in the batch queue for the object being processed.



 |
| PrivacyJobSessionObjectId | 

Type

reference

Properties

Filter, Group, Sort

Description

The ID of the policy job session.

This field is a relationship field.

Relationship Name

PrivacyJobSessionObject

Relationship Type

Lookup

Refers To

PrivacyJobSession



 |
| ProcessType | 

Type

picklist

Properties

Filter, Group, Nillable, Restricted picklist, Sort

Description

The type of action being executed on the object in the policy.

Possible values are:

- delete
- mask
- retry\_delete
- retry\_mask





 |
| ProcessedFailures | 

Type

int

Properties

Filter, Group, Nillable, Sort

Description

The number of records the policy execution failed to process.



 |
| ProcessedSuccesses | 

Type

int

Properties

Filter, Group, Nillable, Sort

Description

The number of records the policy execution successfully processed.



 |
| ProcessedTotal | 

Type

int

Properties

Filter, Group, Nillable, Sort

Description

The total number of records processed in the policy job.



 |
| Processor | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

The name of the deletion, masking, or traversal processor executing the policy job.



 |
| Queue | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

This field is reserved for later use.



 |
| QueueLength | 

Type

int

Properties

Filter, Group, Nillable, Sort

Description

The total number of records in the queue to be processed by the policy job.



 |
| RecordsAffected | 

Type

int

Properties

Filter, Group, Nillable, Sort

Description

The number of records processed by the policy job.



 |
| Retry | 

Type

int

Properties

Filter, Group, Nillable, Sort

Description

The queue number of the retry session after a failed policy execution attempt. Each attempt to retry the policy execution is put into a retry queue.



 |
| TraversalEndTime | 

Type

dateTime

Properties

Filter, Nillable, Sort

Description

The end time of the record-capturing phase for the object session.



 |
| TraversalStartTime | 

Type

dateTime

Properties

Filter, Nillable, Sort

Description

The start time of the record-capturing phase for the object session.



 |
| UniqueConstraint | 

Type

string

Properties

Filter, Group, idLookup, Nillable, Sort

Description

For internal use only.



 |

## 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.

[PrivacyObjectSessionOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.")

Sharing rules are available for the object.

[PrivacyObjectSessionShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.")

Sharing is available for the object.