GET Tenants({id})/Offering({offeringId})/OfferingsInSameScope

Get offerings in the same scope of a given offering, and available to the given tenant. That is, offerings with the same isolation mode and the same session machine catalog, and compatible with the same tenant.

Request Information

Parameters

NameDescriptionAdditional information
id

ID of the tenant.

Type:

offeringId

ID of the offering.

Type:

name

See Filtering, Arranging, and Paging.

Type: String

filterBy

See Filtering, Arranging, and Paging. The supported filters are:

  • All: All offerings.
  • NotDeleted: All offerings which are not currently being deleted. (default)
  • NotUsed: All offerings which have no subscriptions.

Type: Filter

filterProp

See Filtering, Arranging, and Paging.

Type: String

arrangeBy

See Filtering, Arranging, and Paging. The supported arrangers are:

  • Name: Arrange by name. (default)
  • SessionMachineCatalog: Arrange by session machine catalog.

Type: String

skip

See Filtering, Arranging, and Paging.

Type: Number

take

See Filtering, Arranging, and Paging.

Type: Number

Response Information

A list of offerings.

Response type

CollectionResultModel<OfferingModel>

Response body formats

application/json, text/json

Sample:
{
  "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)/Offering(2f08f456-7ec8-4edc-866d-25037776ef4f)/OfferingsInSameScope]",
  "Count": 1,
  "TotalMatchingFilter": 1,
  "Items": [
    {
      "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
    }
  ]
}