ApplicationVersion Object

Contains information about a version of an app.

For example, this object is returned by the GET /api/apps/versions/{AppVersionID} method.

This object is used by the following operations:

The properties included in the ApplicationVersion object are listed below.

Property Type Description
RuntimeID string Although this field is labeled RuntimeID it is actually the AppVersionID; the unique ID for the specific app version.
AppID string The unique ID for a specific app.
Name string The display name of the app version; for example, 1.0. Required when adding or modifying an app version. When adding an app version, Name is the minimum input required. AppID is also required information, but is part of the URL so is not required in the request object.
Description string

Text description of the app.

Optional.
WebsiteAddress string The website for the app, if defined. The character limit for the WebsiteAddress field is 2048 characters.
Visibility string The visibility setting for this resource. For a list of valid values, see Visibility Settings.

Required when adding an app version.
InitialEnvironment string

The initial environment for the app (normally Sandbox).

Required when adding or modifying an app version.
CurrentEnvironment string The current environment for the app (Sandbox or Production).
Tag string[ ] One or more user-defined tags for the app version.
HasKeyInfo boolean Indicates whether or not the app has a security key certificate loaded (true or false).
Created dateTime The date/time stamp when the resource was first created. Used only in response messages.
Updated dateTime The date/time stamp when the resource was last updated. Used only in response messages.
State string The current state of the app. For valid values, see App State Values.
SecurityMechanisms string[ ] One or more security mechanisms being used by the app version. For more information, see App Security Mechanisms.
RatingSummary RatingSummary An aggregated, averaged summary of individual user ratings for the resource, including the current ratings count for each possible value (1, 2, 3, 4, or 5). Used only in response messages.
Identity string When adding an app version, you can specify a custom identity name for the app version (Runtime Identity). If no custom value is specified, in response messages this property defaults to the reverse of the AppVersionID, with a dash. For example, if the AppVersionID is 6CYql2jSyfK9vaGZrvNkb7Am.acmepaymentscorp, the value for the Identity property will be acmepaymentscorp-6CYql2jSyfK9vaGZrvNkb7Am.
SharedSecret string

The Shared Secret value for the app, if applicable.

Note: If the app has a user-defined App Identity that includes a domain, the platform does not collect, regenerate, return, or display the Shared Secret value. In this scenario, the user manages it in the external identity domain, which must be a valid domain set up in the platform. The platform takes the Shared Secret value that the user provides and validates it with the external identity domain.

For this to occur, the platform's App Settings must allow user-defined identity (this includes ID and Shared Secret), and the user identity must be set to a value of {LoginDomain}\{LoginDomain-UserName}, where {login-domain} is the platform's ID for a valid login domain set up on the platform, LoginDomain-UserName is a valid account on that login domain, and they are separated by a backslash. The platform validates the LoginDomain ID and does nothing with the Shared Secret value except validate it at runtime when it's provided by the user.
EncryptedSharedSecret string The encrypted Shared Secret value for the app, if applicable.
AppVersionSettings AppVersionSettings Contains information about the settings for an app version.
TargetResources TargetResources Contains information about one or more resources associated with the current resource. Used only in response messages.
classifiers classifiers

Applicable with Lifecycle Repository integration only. Contains a property name and an array of one or more values for the property. For an example, see POST /api/users/completeSignup.

The user interface shows custom properties as a single concept, but on the API, app, or user they exist as classifiers and artifacts. The artifacts have URLs ("by-ref" artifacts). Classifiers and artifacts are only applicable if the Repository Extension is enabled and custom properties configured.
artifacts artifacts

Applicable with Lifecycle Repository integration only. Contains entries with an artifact name and value. The value is always a URL. For an example, see POST /api/users/completeSignup.

The user interface shows custom properties as a single concept, but on the API, app, or user they exist as classifiers and artifacts. The artifacts have URLs ("by-ref" artifacts). Classifiers and artifacts are only applicable if the Repository Extension is enabled and custom properties configured.