Newer Version Available

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

DeviceSyncTransaction

Represents a set of related data items to synchronize 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(), search(), undelete(), update(), upsert()

Fields

Field Details
ActualRecordsCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of data items retrieved from the mobile device and ready to sync.
AppVersion
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. The version of the mobile application with data to sync.
CanCancDpndBeRetired
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether a retry operation is available for a dependent child transaction with a status of Canceled (true) or not (false).
The default value is false.
This field is a calculated field.
Comments
Type
textarea
Properties
Create, Nillable, Update
Description
Additional information about the transaction.
DependentOfflineIdentifiers
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A comma-separated list of IDs that represent dependent transactions from the mobile device. The transactions are processed in the order in which they’re listed.
DeviceIdentifier
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. The ID of the mobile device.
DevicePlatform
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The operating system of the mobile device.
Possible values are:
  • Android
  • MacOS
  • Windows
  • iOS
DeviceType
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The type of mobile device, for example Phone or Tablet.
ExpectedRecordCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The expected number of data items to sync.
IsBulk
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether to sync data items in bulk (true) or not (false). Synchronize data items in bulk only if there are no dependencies between transactions.
The default value is false.
IsDebugMode
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the sync runs in debug mode (true) or not (false).
The default value is false.
IsOwnerPermissionEnforced
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether to respect the user permissions of the transaction record’s owner during the sync (true) or not (false).
The default value is false.
IsRealTime
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the transaction is eligible for real-time batch processing (true) or not (false).
The default value is false.
IsRetry
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the sync is a retry operation (true) or not (false).
The default value is false.
This field is a calculated field.
IsSimulatable
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the simulate operation applies to the transaction (true) or not (false).
The default value is false.
This field is a calculated field.
IsWithSignedItem
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the transaction includes data items with a signature (true) or not (false).
The default value is 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.
LastRunDebug
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID associated with the debug log attachment from the most recent sync.
LastRunLogId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The transaction log from the most recent sync. If no errors occurred, the log is empty.
This field is a relationship field.
Relationship Name
LastRunLog
Relationship Type
Lookup
Refers To
DeviceSyncTransactionLog
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.
MetadataVersion
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. The metadata version for data from the mobile device.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
A system-generated identifier for the device sync transaction.
NumberOfFailedAttempts
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of sync failures for the transaction.
OfflineTimestamp
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
Required. The timestamp when the record from the mobile device occurred.
OfflineUniqueIdentifier
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Required. A unique identifier for 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
Sequence
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Order position of the transaction in relation to other transactions to sync. Use sequence values to process device sync transactions in a specific order.
Status
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. The sync status.
Possible values are:
  • Canceled
  • Failed
  • InProgress
  • Manual
  • New
  • Retry
  • Success
  • Waiting
TotSyncTranRecordCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of data items in the transaction.
This field is a calculated field.
TransactionSource
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The application that stores the data items to sync.
Possible values are:
  • CLM.
UserDeviceData
Type
textarea
Properties
Create, Nillable, Update
Description
User data from the mobile device.

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.

DeviceSyncTransactionFeed
Feed tracking is available for the object.
DeviceSyncTransactionHistory
History is available for tracked fields of the object.