Gets summary of clients schedule stats based on the date range specified
| Requires authentication? | Yes (HTTP authentication using user name and API key) |
| Response formats | JSON |
api/ClientsSchedule/summary?organisationId=5&startDate=2016-01-01&backupWindowStartTime=09:00&split=true&combineCompleted=true
| Name | Description |
|---|---|
|
organisationId required |
Id of the organisation |
|
nodeGuid optional |
Unique identifier for the predatar agent |
|
nodeGroupId optional |
Id of the node group |
|
startDate optional |
Start date in the format yyyy-MM-dd. If not specified, then the default value will be used, which will be seven days before the current date |
|
endDate optional |
End date in the format yyyy-MM-dd. If not specified, then the default value will be used, which will be the current date |
|
backupWindowStartTime optional |
Backup start time in the format HH:mm. If not specified, then the default value will be used, which will be the 18:00 |
|
split optional |
Can be true or false. If true then stats of individual TSM servers will be retrieved, otherwise results will be combined for all the TSM servers. The default value is false. |
|
combineCompleted optional |
Can be true or false. If true then stats of all completed (RC) will be retrieved, otherwise results will be individual for all completed (RC). The default value is false. |
{
"ClientSchedules": [
{
"Date": "2016-03-09T18:00:00",
"CompletedAbsolute": 0.0,
"Completed0Absolute": 69.0,
"Completed4Absolute": 4.0,
"Completed8Absolute": 1.0,
"CompletedOtherAbsolute": 0.0,
"MissedAbsolute": 1.0,
"FailedAbsolute": 0.0,
"SeveredAbsolute": 0.0,
"RestartedAbsolute": 0.0,
"OtherAbsolute": 0.0,
"NodeGUID": "00000000-0000-0000-0000-000000000000",
"ServerName": null,
"NodeGroupId": 0,
"GroupName": null,
"CompletedPercentage": 0.0,
"Completed0Percentage": 92.0,
"Completed4Percentage": 5.33,
"Completed8Percentage": 1.33,
"CompletedOtherPercentage": 0.0,
"MissedPercentage": 1.33,
"FailedPercentage": 0.0,
"SeveredPercentage": 0.0,
"RestartedPercentage": 0.0,
"OtherPercentage": 0.0
},
{
"Date": "2016-03-08T18:00:00",
"CompletedAbsolute": 0.0,
"Completed0Absolute": 74.0,
"Completed4Absolute": 4.0,
"Completed8Absolute": 0.0,
"CompletedOtherAbsolute": 0.0,
"MissedAbsolute": 1.0,
"FailedAbsolute": 0.0,
"SeveredAbsolute": 0.0,
"RestartedAbsolute": 0.0,
"OtherAbsolute": 0.0,
"NodeGUID": "00000000-0000-0000-0000-000000000000",
"ServerName": null,
"NodeGroupId": 0,
"GroupName": null,
"CompletedPercentage": 0.0,
"Completed0Percentage": 93.67,
"Completed4Percentage": 5.06,
"Completed8Percentage": 0.0,
"CompletedOtherPercentage": 0.0,
"MissedPercentage": 1.27,
"FailedPercentage": 0.0,
"SeveredPercentage": 0.0,
"RestartedPercentage": 0.0,
"OtherPercentage": 0.0
},
{
"Date": "2016-03-07T18:00:00",
"CompletedAbsolute": 0.0,
"Completed0Absolute": 73.0,
"Completed4Absolute": 4.0,
"Completed8Absolute": 1.0,
"CompletedOtherAbsolute": 0.0,
"MissedAbsolute": 1.0,
"FailedAbsolute": 1.0,
"SeveredAbsolute": 0.0,
"RestartedAbsolute": 0.0,
"OtherAbsolute": 0.0,
"NodeGUID": "00000000-0000-0000-0000-000000000000",
"ServerName": null,
"NodeGroupId": 0,
"GroupName": null,
"CompletedPercentage": 0.0,
"Completed0Percentage": 91.25,
"Completed4Percentage": 5.0,
"Completed8Percentage": 1.25,
"CompletedOtherPercentage": 0.0,
"MissedPercentage": 1.25,
"FailedPercentage": 1.25,
"SeveredPercentage": 0.0,
"RestartedPercentage": 0.0,
"OtherPercentage": 0.0
},
{
"Date": "2016-03-07T18:00:00",
"CompletedAbsolute": 0.0,
"Completed0Absolute": 53.0,
"Completed4Absolute": 4.0,
"Completed8Absolute": 2.0,
"CompletedOtherAbsolute": 0.0,
"MissedAbsolute": 1.0,
"FailedAbsolute": 1.0,
"SeveredAbsolute": 0.0,
"RestartedAbsolute": 0.0,
"OtherAbsolute": 0.0,
"NodeGUID": "00000000-0000-0000-0000-000000000000",
"ServerName": null,
"NodeGroupId": 0,
"GroupName": null,
"CompletedPercentage": 0.0,
"Completed0Percentage": 9.25,
"Completed4Percentage": 5.0,
"Completed8Percentage": 1.25,
"CompletedOtherPercentage": 0.0,
"MissedPercentage": 3.25,
"FailedPercentage": 1.25,
"SeveredPercentage": 0.0,
"RestartedPercentage": 0.0,
"OtherPercentage": 0.0
}
]
}