OfferingModel
An application or desktop offering.
Properties
Name | Description | Additional information |
---|---|---|
Href | See Hypermedia. |
Type: String |
RelatedActions | See Hypermedia. |
Type: Array of RelationModel |
Id | ID of the offering. |
Type: String |
Name | Name. |
Type: String |
ShortName | See Short Names. |
Type: String |
ChangeId |
Type: String |
|
DisplayName | User-visible name for the application, as it shows up in Receiver. |
Type: String |
Comment | Admin-visible comment attached to the application. |
Type: String |
Description | User-visible description of the application; typically, shown as the tooltip attached to the application icon on the end-user device. |
Type: String |
Tags |
Type: Array of String |
|
CustomProperties |
Type: Array of CustomPropertyModel |
|
DeleteState | See Deleting Objects. |
Type: ObjectDeleteState |
IsolationMode | User session isolation mode. |
Type: IsolationModeState |
Icon | Icon associated with the offering. |
Type: ReferenceModel |
DeliveryControllerArchitecture | Delivery controller architecture used to broker user connections to the session machines where the offering is hosted. |
|
SessionMachineCatalog | Session machine catalog defining the recipe for session machines that will host users for this offering. |
Type: ReferenceModel |
Arguments | Command-line arguments for the offering. Note: for content redirection to work, '%*' must be included in the arguments. |
Type: String |
ClientFolder | Client folder where the icon will appear in Receiver. |
Type: String |
CpuPriorityLevel | CPU priority level which the application will initially launch with. Only valid for application offerings, not desktop offerings. Note: It is highly recommended that you leave this as the default value. |
Type: CpuPriorityLevelState |
EnableState | Enable state of the offering. |
Type: EnableMode |
Executable | The executable to launch when the user accesses the application. Only valid for application offerings, not desktop offerings. |
Type: String |
OfferingType | Offering type. |
Type: OfferingType |
ShortcutAddedToDesktop | If true, a shortcut to launch the offering will be placed on the user's desktop. |
Type: Boolean |
ShortcutAddedToStartMenu | If true, a shortcut to launch the offering will be placed in the user's start menu. |
Type: Boolean |
StartMenuFolder | The folder in the start menu where the shortcut should be placed. Only used if ShortcutAddedToStartMenu is true. |
Type: String |
WaitForPrinterCreation | If true, users will need to wait for printers to be created in their session before they can use the application. |
Type: Boolean |
WorkingDirectory | Working directory for the application. Only used for application offerings, not desktop offerings. |
Type: String |
HealthSummary | Summary of health messages associated with the offering. |
Type: HealthSummaryModel |
IsInLatestVersion | If true, the offering exists in the newest version of the catalog. If false, new subscriptions cannot be made to the offering, and any existing subscriptions may experience user launch failures if they connect to a machine which does not have the offering installed. |
Type: Boolean |
IsInAllVersions | If true, the offering exists in all versions of the catalog for which there are existing session machines. If false, existing subscriptions may experience user launch failures if they connect to a machine which does not have the offering installed. |
Type: Boolean |
NumSubscriptions | Number of subscriptions to the offering. |
Type: Number |
Sample
application/json
{ "Href": "[api:Offerings(2f08f456-7ec8-4edc-866d-25037776ef4f)]", "Id": "2f08f456-7ec8-4edc-866d-25037776ef4f", "Name": "Application", "ShortName": "myapp", "ChangeId": "12", "DisplayName": "Best App", "Comment": "The best app", "Description": "My app", "Tags": [ "tag" ], "CustomProperties": [ { "Name": "myProperty", "Value": "myValue" } ], "DeleteState": "NotDeleted", "IsolationMode": "PrivateDeliveryGroup", "Icon": { "Href": "[api:Icons(00000000-0000-0000-0000-000000000002)]", "RelatedTo": "2f08f456-7ec8-4edc-866d-25037776ef4f", "Id": "00000000-0000-0000-0000-000000000002" }, "DeliveryControllerArchitecture": "FMA", "SessionMachineCatalog": { "Href": "[api:SessionMachineCatalogs(628fa898-0c36-4024-8fe4-d7e9a9bfbcfa)]", "Name": "catalog 1", "Id": "628fa898-0c36-4024-8fe4-d7e9a9bfbcfa" }, "Arguments": "", "ClientFolder": "MyApps", "CpuPriorityLevel": "Normal", "EnableState": "Enabled", "Executable": "C:\\Program Files\\MyApp\\myapp.exe", "OfferingType": "ServerInstalled", "ShortcutAddedToDesktop": true, "ShortcutAddedToStartMenu": true, "StartMenuFolder": "Programs/MyApps", "WorkingDirectory": "C:\\Program Files\\MyApp", "HealthSummary": { "InfoCount": 1, "Messages": [ { "Text": "Attempting to reach desired capacity", "IsActive": true, "Type": "Allocation" } ] }, "IsInLatestVersion": true, "IsInAllVersions": true, "NumSubscriptions": 1 }