PUT Offerings({id})

Update an offering.

Request Information

Parameters

Name	Description	Additional information
id	ID of the offering to update.	Type: String
changeId	See Optimistic Concurrency.	Type: String

Request body type

UpdateOfferingModel

Request body formats

application/json, text/json

Sample:

{
  "Name": "Application",
  "DisplayName": "Best App",
  "Comment": "The best app",
  "Description": "My app",
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ],
  "Arguments": "",
  "ClientFolder": "MyApps",
  "CpuPriorityLevel": "Normal",
  "EnableState": "Enabled",
  "ShortcutAddedToDesktop": true,
  "ShortcutAddedToStartMenu": true,
  "StartMenuFolder": "Programs/MyApps",
  "WaitForPrinterCreation": false,
  "WorkingDirectory": "C:\\Program Files\\MyApp",
  "ConfiguredFileTypes": [
    {
      "ExtensionName": ".txt",
      "ContentType": "application/text",
      "Name": "App.1",
      "Description": "Text file",
      "HandlerOpen": "C:\\Program Files\\myapp\\app.exe -file %1",
      "HandlerOpenExecutableName": "app.exe",
      "HandlerOpenArguments": "-file %1",
      "HandlerEdit": "C:\\Program Files\\myapp\\app.exe -file %1",
      "HandlerEditExecutableName": "app.exe",
      "HandlerEditArguments": "-file %1"
    }
  ]
}

Response Information

Updated offering.

Response type

OfferingModel

Response body formats

application/json, text/json

Sample:

{
  "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",
  "WaitForPrinterCreation": false,
  "WorkingDirectory": "C:\\Program Files\\MyApp",
  "HealthSummary": {
    "ActiveCount": 0,
    "ErrorCount": 0,
    "WarningCount": 0,
    "InfoCount": 1,
    "Messages": [
      {
        "Text": "Attempting to reach desired capacity",
        "IsError": false,
        "IsWarning": false,
        "IsInfo": false,
        "IsActive": true,
        "Type": "Allocation"
      }
    ]
  },
  "IsInLatestVersion": true,
  "IsInAllVersions": true,
  "NumSubscriptions": 1
}