GET api/gbsstored/filespacedetails

Gets occupancy details for a particular TSM node and filespace

Resource Information
Requires authentication? Yes (HTTP authentication using user name and API key)
Response formats JSON
Example URL
  api/gbsstored/filespacedetails?organisationId=5&nodeGuid=7E08BD44-752F-4839-9F2A-840E5CB028A6&entity=SQLAGV_DC:PRP-REQ-01&filespaceName=\AGJOP1-00-ABC-01&filespaceType=FAT32  
Parameters
Name Description
organisationId
required
Id of the organisation
nodeGuid
required
Unique identifier for the predatar agent
entity
required
TSM node name for which the data is to be retrieved.
filespaceName
required
Filespace name for which the data is to be retrieved.
filespaceType
optional
Type of filespace for which the data is to be retrieved.
view
optional
Type of data to be retrieved. The value can be Arch (for archive), Bkup (for backup) or SpMg (for space managed). If not specified, the default value of Bkup will be used.
topRecords
optional
Number of records to be retrieved (e.g., 10, 50, 100, 500, -1(All).)
reportType
optional
Type of report to be retrieved (e.g., reporting, Top10Filespaces, OccupancyByFilesSpace, OccupancyByStgpool, logical.)
Example Result
[
  {
    "ServerName": null,
    "NodeName": null,
    "FilespaceName": "\\AGJOP1-00-ABC-01",
    "FilespaceType": null,
    "DataType": null,
    "GBsStored": 23.0,
    "NumFiles": 493.0,
    "FilespaceSizeGB": 0.0,
    "FilespacePCTUtil": 0.0,
    "FileSpaceUtilisedGB": 0.0,
    "HogFactor": 0.0,
    "BackupStartDate": "1900-01-01T00:00:00",
    "BackupEndDate": "1900-01-01T00:00:00",
    "GBsStoredCopy": 0.0,
    "NumFilesCopy": 0.0,
    "NodeGUID": "00000000-0000-0000-0000-000000000000",
    "StgPoolName": "POOLCONTAINER_01",
    "PoolType": "PRIMARY",
    "FilespaceNameEncoded": "XYZNRlVMT65TDC1MT04tMYE="
  }
]