DeviceSyncSummary

Represents a summary of the synchronized data from a mobile device. This object is available in API version 65.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Fields

AppVersion

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: Required. The version of the mobile application with data to sync.

BundleIdentifier

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: The ID of the mobile application bundle.

DataDownloadDuration

Type: double
Properties: Filter, Nillable, Sort
Description: The duration of a download process in milliseconds.

This field is a calculated field.

DeviceIdentifier

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: Required. The ID of the mobile device.

DownloadCreatedRecords

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The number of records created based on the downloaded records.

DownloadEnd

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The timestamp when the download ended.

DownloadFreezeTime

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The amount of time during a download process that the sync is paused while the mobile application runs in the background.

DownloadStart

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The timestamp when the download started.

DownloadUpdatedRecords

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The number of records updated based on the downloaded records.

DownloadedRecords

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The number of records downloaded.

ErrorCode

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The error code.

ErrorDetail

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The message to display when synchronization fails.

FileReferenceId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the file downloaded from the mobile device.

This field is a polymorphic relationship field.
Relationship Name: FileReference
Relationship Type: Lookup
Refers To: PresentationFileReference

IosVersion

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: Required. The version of the mobile device’s operating system.

IsDownloadCompleted

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the download completed (true) or not (false).
Default value: false

IsUploadCompleted

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the upload completed (true) or not (false).
Default value: false

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastSuccessfulUploadTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The timestamp of the most recent successful upload during the synchronization process.

LastSyncTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The timestamp of the most recent synchronization process.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.

MetadataDownloadDuration

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The duration of a metadata download process in milliseconds.

MetadataDownloadStart

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The timestamp when the metadata download started.

MetadataUpdated

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The timestamp of the most recent metadata update.

MetadataVersion

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: Required. The version of the metadata.

Name

Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: A system-generated identifier for the device sync summary record.

Network

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The type of network used for the synchronization process.

OfflineCreatedDate

Type: dateTime
Properties: Create, Filter, Sort, Update
Description: Required. The timestamp when the current user created the record from the mobile device.

OfflineLastModifiedDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The timestamp when the current user last modified the record from the mobile device.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The ID of the owner of the record.

This field is a polymorphic relationship field.
Relationship Name: Owner
Refers To: Group, User

S3Bucket

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The Amazon S3 bucket used as a data source.

SignalStrength

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: A measure of the quality of the connection to a mobile device.

SyncErrorMessage

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The message to display when synchronization with an external system fails.

SyncStatus

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: Required. The status of a synchronization process with an external system.
Possible values:
- Error
- New
- Ok
- Pending

SyncSummaryData

Type: textarea
Properties: Create, Nillable, Update
Description: Additional synchronization data in JSON format.

SyncTrigger

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: Required. The action or condition that triggered the synchronization process.
Possible values:
- Days Offline Limit
- Forced
- Idle Background Sync
- Initial
- InitiatedByAIAgent
- Manual
- Metadata In Background
- Pin
- Territory Switch

Type

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The type of synchronization performed.
Possible values:
- clm
- data

UploadDuration

Type: double
Properties: Filter, Nillable, Sort
Description: The duration of an upload process in milliseconds.

This field is a calculated field.

UploadEnd

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The timestamp when the upload ended.

UploadFreezeTime

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The amount of time during an upload process that the sync is paused while the mobile application runs in the background.

UploadRecords

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The number or records uploaded during the synchronization process.

UploadStart

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The number or records uploaded during the synchronization process.

UserLocation

Type: location
Properties: Nillable
Description: The latitude and longitude coordinates of the mobile device during the synchronization process.

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.

DeviceSyncSummaryFeed: Feed tracking is available for the object.
DeviceSyncSummaryHistory: History is available for tracked fields of the object.
DeviceSyncSummaryShare: Sharing is available for the object.