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

The following API methods use this data model.

Read-Only Fields

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

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.

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

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.

lastSuccessfulSync

SyncRequestModel, nullable, read-only

Data about the last successful sync associated with this enrollment

Required Fields

isActive

boolean

Determines whether the app enrollment is in use

syncScheduleIsActive

boolean

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

Optional Fields

cronSettings

string, nullable, 0-50 characters

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

connectorInfo

ConnectorInfoModel, nullable

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

Included Collections

These fields are available when using Retrieve or Query API calls if you specify the associated Include parameter.

customFieldDefinitions

CustomFieldDefinitionModel[], nullable, read-only

A collection of custom fields linked to this record. To retrieve this collection, specify
CustomFieldDefinitions in the include parameter when retrieving data.

To create a custom field, use the Create Custom Field
endpoint with the TableKey to AppEnrollment and the ObjectKey set to the AppEnrollmentId for this record. For
more information on extensibility, see linking extensible metadata to objects.

customFieldValues

CustomFieldValueModel[], nullable, read-only

A collection of custom fields linked to this record. To retrieve this collection, specify
CustomFieldValues in the include parameter when retrieving data.

To create a custom field, use the Create Custom Field
endpoint with the TableKey to AppEnrollment and the ObjectKey set to the AppEnrollmentId for this record. For
more information on extensibility, see linking extensible metadata to objects.

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.


Did this page help you?