GET DashboardData/Notifications

Get the notifications displayed on the dashboard.

Request Information

Parameters

Name	Description	Additional information
name	See Filtering, Arranging, and Paging.	Type: String
filterBy	See Filtering, Arranging, and Paging. The supported filters are: All: All notifications. (default)	Type: Filter
filterProp	See Filtering, Arranging, and Paging.	Type: String
arrangeBy	See Filtering, Arranging, and Paging. The supported arrangers are: Relevance: Arrange by severity. (default) Name: Arrange by name.	Type: String
skip	See Filtering, Arranging, and Paging.	Type: Number
take	See Filtering, Arranging, and Paging.	Type: Number

Response Information

A list of notifications.

Response type

CollectionResultModel<NotificationModel>

Response body formats

application/json, text/json

Sample:

{
  "Href": "[api:DashboardData/Notifications]",
  "Count": 1,
  "TotalMatchingFilter": 1,
  "Items": [
    {
      "Type": "DataCenterWithRequiredSessionMachineCapacityOnNetworkError",
      "Severity": "Unknown",
      "SessionMachineCatalog": {
        "Href": "[api:SessionMachineCatalogs(628fa898-0c36-4024-8fe4-d7e9a9bfbcfa)]",
        "Name": "catalog 1",
        "Id": "628fa898-0c36-4024-8fe4-d7e9a9bfbcfa"
      },
      "DataCenter": {
        "Href": "[api:DataCenters(af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a)]",
        "Name": "datacenter1",
        "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
      },
      "CapacityRequirementNumItems": 4,
      "CapacityRequirementItemType": "SessionMachines",
      "CapacityRequirementItemTypeFriendlyName": "session machines",
      "Domain": {
        "Href": "[api:Domains(241b45cc-261d-47d0-81d7-a0a41c54c760)]",
        "Name": "domain1.local",
        "Id": "241b45cc-261d-47d0-81d7-a0a41c54c760"
      },
      "Network": "network 1"
    }
  ]
}