ApplicationModel

An Application represents a feature available to customers within the Lockstep Platform. You can create
Applications by working with your Lockstep business development manager and publish them on the platform
so that customers can browse and find your Application on the Lockstep Platform Marketplace. When a
customer adds an Application to their account, they obtain an AppEnrollment which represents that customer's
instance of this Application. The customer-specific AppEnrollment contains a customer's configuration data
for the Application, which is not customer-specific.

See Applications and Enrollments for more information.
--swaggerCategory:Platform

Methods

Fields

appId

uuid, read-only

A unique code identifying this application

name

string, nullable

The name of this application

description

string, nullable

Brief summary of this application shown as a subtitle

appType

string, 0-50 characters

Tag for what type of app this is

ownerId

uuid

The ID of the owner

projectUrl

uri, nullable

The URL to visit for more information about this application

iconUrl

uri, nullable

The URL for the icon for this application

priceTerms

string, nullable

The description of the price for this application

createdUserId

uuid, nullable, read-only

The ID of the user who created this application

modifiedUserId

uuid, nullable, read-only

The ID of the user who last modified this application

created

date-time, nullable, read-only

The date this application was created

modified

date-time, nullable, read-only

The date this application was last modified

isActive

boolean

Flag indicating if the application is active.

wikiURL

uri, nullable, 0-99 characters

URL to the Wiki for the Application

groupKey

uuid

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.

notes

NoteModel[], nullable, read-only

All notes attached to this app.
To retrieve this collection, specify Notes in the "Include" parameter for your query.

attachments

AttachmentModel[], nullable, read-only

All attachments attached to this app.
To retrieve this collection, specify Attachments in the "Include" parameter for your query.

customFieldDefinitions

CustomFieldDefinitionModel[], nullable, read-only

All definitions attached to the application.
To retrieve this collection, specify CustomFieldValues in the "Include" parameter for your query.

customFieldValues

CustomFieldValueModel[], nullable, read-only

All values attached to the application.
To retrieve this collection, specify CustomFieldValues in the "Include" parameter for your query.


Did this page help you?