ApplicationModel
Less than to read
An Application represents a feature available to customers within the Sage Network. You can create Applications by working with your Sage Network business development manager and publish them on the platform so that customers can browse and find your Application on the Sage Network 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
The following API methods use this data model.
- Retrieve Application
- Update Application
- Create Applications
- Query Applications
Read-Only Fields
These fields are assigned by the API server and cannot be changed.
appId
uuid, read-only
A unique code identifying this application
createdUserId
uuid, read-only
The ID of the user who created this application
modifiedUserId
uuid, read-only
The ID of the user who last modified this application
created
date-time, read-only
The date this application was created
modified
date-time, read-only
The date this application was last modified
groupKey
uuid, read-only
The GroupKey uniquely identifies a single Sage Network 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.
b2CClientId
uuid, nullable, read-only
The B2C Client ID of the application
Required Fields
name
string, 1-100 characters
The name of this application
appType
string, max 50 characters
Tag for what type of app this is
ownerId
The ID of the owner
isActive
Flag indicating if the application is active.
Optional Fields
description
string, nullable, max 500 characters
Brief summary of this application shown as a subtitle
projectUrl
string, nullable, max 200 characters
The URL to visit for more information about this application
iconUrl
string, nullable, max 200 characters
The URL for the icon for this application
Included Collections
These fields are available when using Retrieve or Query API calls if you specify the associated Include parameter.
notes
NoteModel[], nullable, read-only
A collection of notes linked to this record. To retrieve this collection, specify Notes in the
include parameter when retrieving data.
To create a note, use the Create Note
endpoint with the TableKey to Application and the ObjectKey set to the ApplicationId for this record. For
more information on extensibility, see linking extensible metadata to objects.
attachments
AttachmentModel[], nullable, read-only
A collection of attachments linked to this record. To retrieve this collection, specify Attachments in
the include parameter when retrieving data.
To create an attachment, use the Upload Attachment
endpoint with the TableKey to Application and the ObjectKey set to the ApplicationId for this record. For
more information on extensibility, see linking extensible metadata to objects.
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 Application and the ObjectKey set to the ApplicationId 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 Application and the ObjectKey set to the ApplicationId for this record. For
more information on extensibility, see linking extensible metadata to objects.