GET api/tsmforve/sessionssummary

Gets summary of TSM for VE sessions stats based on the date range specified

Resource Information
Requires authentication? Yes (HTTP authentication using user name and API key)
Response formats JSON
Example URL
  api/tsmforve/sessionssummary?organisationId=5&selectedDate=2016-01-01 00:00&view=Archive  
Parameters
Name Description
organisationId
required
Id of the organisation
nodeGuid
optional
Unique identifier for the predatar agent. If not specified, then the data for all the TSM servers will be retrieved.
nodeGroupId
optional
Id of the node group
selectedDate
optional
Selected date in the format yyyy-MM-dd HH:mm. If not specified, then the default value will be used, which will be the current date
view
optional
Type of data to be retrieved. The value can be Backup or Archive. If not specified, the default value of Backup will be used.
isIncludeNodesWithFailedOnly
optional
Can be true or false. If true then stats of nodes having failure status will be retrieved. The default value is false.
Example Result
[
  {
    "NodeGUID": "7E08BD44-752F-4839-9F2A-840E5CB028A6",
    "Entity": "TSM_01_DC",
    "ServerName": "TSM-ABC-01",
    "BackupMapRows": [
      {
        "StartTime": "2016-02-14T00:00:00",
        "TotalRows": 0,
        "FullTotalCount": 0,
        "FullSuccessCount": 0,
        "FullNonSuccessCount": 0,
        "IncTotalCount": 0,
        "IncSuccessCount": 0,
        "IncNonSuccessCount": 0,
        "IncrementalActivity": null,
        "FullActivity": null
      },
      {
        "StartTime": "2016-02-15T00:00:00",
        "TotalRows": 0,
        "FullTotalCount": 0,
        "FullSuccessCount": 0,
        "FullNonSuccessCount": 0,
        "IncTotalCount": 0,
        "IncSuccessCount": 0,
        "IncNonSuccessCount": 0,
        "IncrementalActivity": null,
        "FullActivity": null
      }
    ]
  },
  {
    "NodeGUID": "7E08BD44-752F-4839-9F2A-840E5CB028A6",
    "Entity": "PRP01_DC:AD-AWS-01",
    "ServerName": "TSM-ABC-01",
    "BackupMapRows": [
      {
        "StartTime": "2016-02-14T00:00:00",
        "TotalRows": 1,
        "FullTotalCount": 0,
        "FullSuccessCount": 0,
        "FullNonSuccessCount": 0,
        "IncTotalCount": 1,
        "IncSuccessCount": 1,
        "IncNonSuccessCount": 0,
        "IncrementalActivity": {
          "ActivityType": "INCREMENTAL",
          "DataMoverAgent": "PRHOST-ABC-01_LOG",
          "DataMoverAgentCount": 1
        },
        "FullActivity": null
      },
      {
        "StartTime": "2016-02-15T00:00:00",
        "TotalRows": 1,
        "FullTotalCount": 0,
        "FullSuccessCount": 0,
        "FullNonSuccessCount": 0,
        "IncTotalCount": 1,
        "IncSuccessCount": 1,
        "IncNonSuccessCount": 0,
        "IncrementalActivity": {
          "ActivityType": "INCREMENTAL",
          "DataMoverAgent": "PRHOST-ABC-01_LOG",
          "DataMoverAgentCount": 1
        },
        "FullActivity": null
       }
    ]
  }
]