Represents a Sync action that loads data from a connector into the Lockstep Platform. Users can
request Sync actions manually using Lockstep Inbox, or via the Create Sync API.
Each Sync action is tied to an AppEnrollment.
When the Sync action is complete, the field
StatusCode will be set to either
You can fetch a list of detailed results for the Sync API by calling Retrieve or Query with an
details. These detailed results contain line-by-line errors that were detected during
processing of this sync.
The following API methods use this data model.
These fields are assigned by the API server and cannot be changed.
The unique ID of this record, automatically assigned by Lockstep when this record is
added to the Lockstep platform.
The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
account will share the same GroupKey value. GroupKey values cannot be changed once created.
For more information, see Accounts and GroupKeys.
string, nullable, read-only, 0-20 characters
The status of processing for this SyncRequest. When a SyncRequest is created, it is flagged as
While it is in queue waiting to be picked up, its status moves to
When it is picked up for execution, its status moves to
In Progress. When it is complete, its status
will move to
Failed. If another API call cancels the SyncRequest, its status will move
- In Progress
string, nullable, read-only
The name of the OperationType for this SyncRequest
Possible operation types for a SyncRequest
string, nullable, read-only, 0-200 characters
Message containing information about the sync request results
The number of times this Sync Request has failed
A boolean indicating whether a sync from an ERP system should process all the data from the ERP
as opposed to just the delta of changes since the previous sync run
uuid, nullable, read-only
The AppEnrollmentId of the AppEnrollment object that executed this sync request
The date this sync request was created
The date this sync request was last modified
The ID number of the user who most recently modified this sync request.
object, nullable, read-only
The detailed list of results and errors that occurred during the processing of this SyncRequest. This
information is available only after the SyncRequest has completed. You will only be able to fetch this
field if the SyncRequest's
StatusCode field is set to
To retrieve this collection, add the keyword
details to the
include parameter on your Retrieve or
Inbound sync payload
Updated 3 months ago