SyncRequestModel

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 Success or Failed.

You can fetch a list of detailed results for the Sync API by calling Retrieve or Query with an include
parameter of details. These detailed results contain line-by-line errors that were detected during
processing of this sync.

Methods

The following API methods use this data model.

Read-Only Fields

These fields are assigned by the API server and cannot be changed.

syncRequestId

uuid, read-only

The unique ID of this record, automatically assigned by Lockstep when this record is
added to the Lockstep platform.

groupKey

uuid, read-only

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.

statusCode

string, nullable, read-only, 0-20 characters

The status of processing for this SyncRequest. When a SyncRequest is created, it is flagged as Ready.
When it is picked up for execution, its status moves to In Progress. When it is complete, its status
will move to Success or Failed. If another API call cancels the SyncRequest, its status will move
to Cancelled.

  • Ready
  • In Progress
  • Cancelled
  • Failed
  • Success

processResultMessage

string, nullable, read-only, 0-200 characters

Message containing information about the sync request results

appEnrollmentId

uuid, nullable, read-only

The AppEnrollmentId of the AppEnrollment object that executed this sync request

created

date-time, read-only

The date this sync request was created

modified

date-time, read-only

The date this sync request was last modified

modifiedUserId

uuid, read-only

The ID number of the user who most recently modified this sync request.

details

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 Cancelled, Success, or Failed.

To retrieve this collection, add the keyword details to the include parameter on your Retrieve or
Query requests.


Did this page help you?