AppEnrollmentModel

An AppEnrollment represents an app that has been enrolled to the current account. When you sign up for an
app using the Lockstep Platform, you obtain an enrollment record for that app. Example types of apps include
connectors and feature enhancement apps. The App Enrollment object contains information about this app, its
configuration, and settings.

See Applications and Enrollments for more information.

Methods

Fields

appEnrollmentId

uuid, read-only

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

appId

uuid, read-only

The ID number of the Application that this enrollment represents. You can fetch information
about this Application object by specifying App in the "Include" parameter for your request.

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.

isActive

boolean

Determines whether the app enrollment is in use

created

date-time, read-only

Created date

createdUserId

uuid, read-only

Created user ID

modified

date-time, read-only

Last modified date

modifiedUserId

uuid, read-only

Last user ID to modify

cronSettings

string, nullable, 0-50 characters

Stores schedule information for the application enrollment
see https://en.wikipedia.org/wiki/Cron

syncScheduleIsActive

boolean

Flag indicating if the Sync process should be ran on the specified schedule

app

ApplicationModel, nullable, read-only

The Application to which this AppEnrollment belongs. Contains general name, description,
logo, and other metadata about this application.

To retrieve this object, specify App in the "Include" parameter for your query.

customFieldDefinitions

CustomFieldDefinitionModel[], nullable, read-only

All definitions attached to this app.

To retrieve this collection, specify CustomFieldValues in the "Include" parameter for your query.

customFieldValues

CustomFieldValueModel[], nullable, read-only

All values attached to this app.

To retrieve this collection, specify CustomFieldValues in the "Include" parameter for your query.

lastSync

SyncRequestModel, nullable, read-only

Data about the last sync attached to this app enrollment

To retrieve this collection, specify LastSync in the "Include" parameter for your query.

lastSuccessfulSync

SyncRequestModel, nullable, read-only

Data about the last successful sync associated with this enrollment

connectorInfo

ConnectorInfoModel, nullable

Optional data necessary to create an app enrollment for a supported connector.
Only enter relevant fields for the given connector.

Deprecated Fields

Deprecated fields are maintained for backwards compatibility with previous versions of the Lockstep API. Deprecated fields may be removed in a future release of the API.

erpInfo

ErpInfoDataModel, nullable

Use ConnectorInfo instead.


Did this page help you?