CollectionResultModel<DeliverySiteModel>

A collection of items.

Properties

Name	Description	Additional information
Href	See Hypermedia.	Type: String
RelatedActions	See Hypermedia.	Type: Array of RelationModel
Count	Number of items in the returned collection. See Object Counts.	Type: Number
TotalMatchingFilter	The total number of items that matched the specified filter. This may be larger than the number of items returned, if the caller specified "take" and/or "skip" parameters. See Object Counts.	Type: Number
Items	The items.	Type: Array of DeliverySiteModel

Sample

application/json

Sample:

{
  "Count": 1,
  "TotalMatchingFilter": 1,
  "Items": [
    {
      "Href": "[api:DeliverySites(0ef3e68d-bb8e-4b69-9c30-ae3fac533996)]",
      "Id": "0ef3e68d-bb8e-4b69-9c30-ae3fac533996",
      "ChangeId": "11",
      "Name": "site1",
      "Description": "my delivery site",
      "Tags": [
        "tag"
      ],
      "CustomProperties": [
        {
          "Name": "myProperty",
          "Value": "myValue"
        }
      ],
      "DeleteState": "NotDeleted",
      "IsShared": false,
      "ProductType": "XenDesktop71",
      "DeliveryControllerArchitecture": "FMA",
      "Tenant": {
        "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
        "Name": "Tenant 1",
        "Id": "91ade655-feb5-47d3-9585-a5827ad50132"
      },
      "AllocationStatus": "Allocated",
      "DataCenter": {
        "Href": "[api:DataCenters(af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a)]",
        "Name": "datacenter1",
        "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
      },
      "HealthSummary": {
        "InfoCount": 1,
        "Messages": [
          {
            "Text": "Attempting to reach desired capacity",
            "IsActive": true,
            "Type": "Allocation"
          }
        ]
      },
      "Domain": {
        "Href": "[api:Domains(241b45cc-261d-47d0-81d7-a0a41c54c760)]",
        "Name": "domain1.local",
        "Id": "241b45cc-261d-47d0-81d7-a0a41c54c760"
      },
      "NetworkName": "Shared Controller Management Network",
      "NumSessionMachines": 10,
      "MaxSessionMachines": 10000,
      "AdministratorUserName": "DOMAIN\\ctxadmin",
      "AdministratorGroup": "DOMAIN\\CitrixAdmins",
      "DeliverySiteUsageType": "Managed",
      "DBServerName": "sqlserver.csp.local",
      "DBName": "site1"
    }
  ]
}