This operation returns a data set from a report.
To run the GET Data Set REST API, you must copy a dataset ID either from a shared data set or a report. For instructions, see Copying a Dataset ID from a Shared Data Set or Copying a Dataset ID from Reports.
Request
Syntax
Send the request using the data set ID:
GET /CustomReportsEngine/rest/reportsplusengine/datasets/<datasetID>/data
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>Request Parameters
|
Name |
Description |
Required |
Example |
|---|---|---|---|
|
datasetID |
The ID for the data set. |
Yes |
a30bd278-c7d9-470f-9ae9-8b4922743330 |
|
fields |
A comma-separated list of fields from the data set. |
No |
[JobId], [Client], [Agent] |
|
where |
A SQL-like filter option. |
No |
[Agent] = "Windows File System" |
|
orderby |
A SQL-like order that sorts the data, such as ascending alphabetical order. |
No |
[Agent] asc |
|
offset |
The row number where the output data begins. |
No |
20 |
|
limit |
A limit for the number of rows that appear in the output data. |
No |
50 |
|
format |
This parameter returns data in an alternate format, such as key-value pairs. |
No |
object |
Request Headers
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or Web Console that is used in the API request. |
|
Accept |
The format of the response. Valid values are: application/xml or application/json. |
|
Authtoken |
The authentication token that is received after successfully logging on. For information about receiving an authentication token, see Authentication. |
Response
Response Parameters
Response parameters vary by data set.
Examples
Sample Request
This request uses the data set ID.
GET /CustomReportsEngine/rest/reportsplusengine/datasets/a30bd278-c7d9-470f-9ae9-8b4922743330/data
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 3ad7888de90fa83ec27eaa6fe8bcd9cbbfe6397d0b9482538fb88402118829d5ccd87281d9f268c31c65e2371cca00f31f1b76ed812505684bf3968e02f8c4d6e633620ba2f4ac15db5f6472e49e3a9f3a96c73e9995755a49ad413d2693116ff13fbb026bcae8999fab3dcbff75e161bcd090ce2e31ee3200bc6f832a37cc708c25aaf0e7b1fbf372b137de2cc33f57a6bc9b4e10b52fb8e90465930c2f01351fae3fa0fcc93e575b256e9f7cc2882e08392345184a20a61835e842b34943ebceabe587ad106e0144feba3984b6c91159dbddee16f8be6fd3cecc9c68f9d38115c874d5f06b1e555d5a4f1e5e821c3766dd53a81129d2c9095113bbc025d29119975b8f31a702373Sample Response
{ "cacheId": "6e59704a-5b25-4f85-89fa-d5bc751148d9", "offset": 10, "limit": 10, "totalRecordCount": 17, "columns": [ { "name": "sys_rowid", "dataField": "sys_rowid", "type": "Long", "precision": 19, "scale": 0 }, { "name": "DataSource", "dataField": "DataSource", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "JobId", "dataField": "JobId", "type": "Integer", "precision": 10, "scale": 0 }, { "name": "Client", "dataField": "Client", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "ClientId", "dataField": "ClientId", "type": "Integer", "precision": 10, "scale": 0 }, { "name": "Agent", "dataField": "Agent", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "Instance", "dataField": "Instance", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "VMHyperVisorType", "dataField": "VMHyperVisorType", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "BackupSet", "dataField": "BackupSet", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "Subclient", "dataField": "Subclient", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "OperationType", "dataField": "OperationType", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "BackupType", "dataField": "BackupType", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "MediaAgent", "dataField": "MediaAgent", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "BackupWindow", "dataField": "BackupWindow", "type": "Date", "precision": 10, "scale": 0 }, { "name": "StartTime", "dataField": "StartTime", "type": "TimeStamp", "precision": 26, "scale": 6 }, { "name": "EndTime", "dataField": "EndTime", "type": "TimeStamp", "precision": 26, "scale": 6 }, { "name": "Durationmins", "dataField": "Durationmins", "type": "Integer", "precision": 10, "scale": 0 }, { "name": "SizeofApplication", "dataField": "SizeofApplication", "type": "Long", "precision": 19, "scale": 0 }, { "name": "MediaSize", "dataField": "MediaSize", "type": "Long", "precision": 19, "scale": 0 }, { "name": "StoragePolicy", "dataField": "StoragePolicy", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "NetworkSize", "dataField": "NetworkSize", "type": "Long", "precision": 19, "scale": 0 }, { "name": "ProtectedObjects", "dataField": "ProtectedObjects", "type": "Long", "precision": 19, "scale": 0 }, { "name": "FailedObjects", "dataField": "FailedObjects", "type": "Long", "precision": 19, "scale": 0 }, { "name": "FailedFolders", "dataField": "FailedFolders", "type": "Integer", "precision": 10, "scale": 0 }, { "name": "JobStatus", "dataField": "JobStatus", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "DedupSavings", "dataField": "DedupSavings", "type": "Decimal", "precision": 21, "scale": 3 }, { "name": "ClientGroup", "dataField": "ClientGroup", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "FailureReason", "dataField": "FailureReason", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "SyncSourceFilesAndBackupIndex", "dataField": "SyncSourceFilesAndBackupIndex", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "ThroughputGBHour", "dataField": "ThroughputGBHour", "type": "Decimal", "precision": 21, "scale": 3 }, { "name": "VMBackupSize", "dataField": "VMBackupSize", "type": "Long", "precision": 19, "scale": 0 }, { "name": "VMSize", "dataField": "VMSize", "type": "Long", "precision": 19, "scale": 0 }, { "name": "VMGuestSize", "dataField": "VMGuestSize", "type": "Long", "precision": 19, "scale": 0 }, { "name": "Proxy", "dataField": "Proxy", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "VMGuestTools", "dataField": "VMGuestTools", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "VMTransportMode", "dataField": "VMTransportMode", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "VMCBTStatus", "dataField": "VMCBTStatus", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "VMOperatingSystem", "dataField": "VMOperatingSystem", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "VMGUID", "dataField": "VMGUID", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "VMHost", "dataField": "VMHost", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "VMDatastore", "dataField": "VMDatastore", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "VirtualizationClient", "dataField": "VirtualizationClient", "type": "String", "precision": 2147483647, "scale": 0 }, { "name": "VirtualServer", "dataField": "VirtualServer", "type": "String", "precision": 2147483647, "scale": 0 } ], "recordsCount": 7, "records": [ [ 7, "CRV2", 925065, "5days_IndexServer", 81, "Big Data Apps", "N/A", "N/A", "defaultBackupSet", "default", "Backup", "Full", "CRV2", "Sep 6, 2019", "Sep 6, 2019, 01:00:20 PM", "Sep 10, 2019, 12:56:24 PM", 5756, 0, 0, "5days", 0, 0, 0, 0, "Killed", -1, "Index Servers", "Killed by Admin. Reason:[].<br>Source: CRV2, Process: JobManager<br><br>Library [AdminStoragePoolLibrary], MediaAgent [CRV2], Drive Pool [DrivePool(CRV2)2], Media[]: A Partition requires upgrade or is currently being upgraded for this deduplication database. Advice: If the issue persists, please upload log files from CommServe, MediaAgent and Client and contact your vendor's support hotline with the job ID of the failed job.<br>Source: CRV2, Process: JobManager", "No", 0, null, null, null, null, null, null, null, null, null, null, null, null, null, ], [ 4, "CRV2", 925062, "dedup test_IndexServer", 53, "Big Data Apps", "N/A", "N/A", "defaultBackupSet", "default", "Backup", "Full", "crv2-analytics", "Sep 6, 2019", "Sep 6, 2019, 01:00:20 PM", "Sep 10, 2019, 01:07:07 PM", 5767, 0, 0, "dedup test", 0, 0, 0, 0, "Killed", -1, "Index Servers", "Killed by Admin. Reason:[].<br>Source: CRV2, Process: JobManager<br><br>Library [dedup test], MediaAgent [crv2-analytics], Drive Pool [DrivePool(crv2-analytics)3], Media[]: Deduplication Database is currently under maintenance. Advice: Please complete the maintenance operation (DDB Resynchronization, Conversion to Transactional DDB, etc.) to bring the Deduplication Database back online.<br>Source: CRV2, Process: JobManager", "No", 0, null, null, null, null, null, null, null, null, null, null, null, null, null, ], [ 17, "CRV2", 925327, "crv2-analytics", 8, "Windows File System", "N/A", "N/A", "defaultBackupSet", "DDBBackup", "Backup", "Full", "crv2-analytics", "Sep 10, 2019", "Sep 10, 2019, 04:00:15 PM", "Sep 10, 2019, 04:00:19 PM", 0, 0, 0, "dedup test", 0, 0, 0, 0, "Completed with errors", 0, "Media Agents; Infrastructure; Alert Test", "", "No", 0, null, null, null, null, null, null, null, null, null, null, null, null, null, ], [ 16, "CRV2", 925326, "CRV2", 2, "Windows File System", "N/A", "N/A", "defaultBackupSet", "DDBBackup", "Backup", "Full", "CRV2", "Sep 10, 2019", "Sep 10, 2019, 04:00:15 PM", "Sep 10, 2019, 04:00:18 PM", 0, 0, 0, "Device Plan", 0, 0, 0, 0, "Completed with errors", 0, "Media Agents; Infrastructure", "", "No", 0, null, null, null, null, null, null, null, null, null, null, null, null, null, ], [ 8, "CRV2", 925152, "CRV2", 2, "Windows File System", "N/A", "N/A", "aa", "default", "Backup", "Full", "CRV2", "Sep 6, 2019", "Sep 6, 2019, 09:00:16 PM", "Sep 10, 2019, 12:56:24 PM", 5276, 0, 0, "TestPolicy", 0, 0, 0, 0, "Killed", -1, "Media Agents; Infrastructure", "Killed by Admin. Reason:[].<br>Source: CRV2, Process: JobManager<br><br>Library [TestLibrary], MediaAgent [CRV2], Drive Pool [DrivePool(CRV2)1], Media[]: Mount path is offline. Advice: Please check if the mount path is online and accessible. The offline reason shown on mount path properties will indicate why it's unavailable. <br>Source: CRV2, Process: JobManager", "No", 0, null, null, null, null, null, null, null, null, null, null, null, null, null, ], [ 9, "CRV2", 925153, "CRV2", 2, "Windows File System", "N/A", "N/A", "murloc db", "gugu", "Backup", "Full", "CRV2", "Sep 6, 2019", "Sep 6, 2019, 09:00:18 PM", "Sep 10, 2019, 12:56:24 PM", 5276, 0, 0, "5days", 0, 0, 0, 0, "Killed", -1, "Media Agents; Infrastructure", "Killed by Admin. Reason:[].<br>Source: CRV2, Process: JobManager<br><br>Library [AdminStoragePoolLibrary], MediaAgent [CRV2], Drive Pool [DrivePool(CRV2)2], Media[]: A Partition requires upgrade or is currently being upgraded for this deduplication database. Advice: If the issue persists, please upload log files from CommServe, MediaAgent and Client and contact your vendor's support hotline with the job ID of the failed job.<br>Source: CRV2, Process: JobManager", "No", 0, null, null, null, null, null, null, null, null, null, null, null, null, null, ], [ 1, "CRV2", 924928, "CRV2", 2, "Windows File System", "N/A", "N/A", "cvs db", "default", "Backup", "Incremental", "CRV2", "Sep 6, 2019", "Sep 6, 2019, 01:44:31 AM", "Sep 10, 2019, 01:07:05 PM", 6443, 0, 0, "Silver plan", 0, 0, 0, 0, "Killed", -1, "Media Agents; Infrastructure", "Killed by Admin. Reason:[].<br>Source: CRV2, Process: JobManager<br><br>Library [AdminStoragePoolLibrary], MediaAgent [CRV2], Drive Pool [DrivePool(CRV2)2], Media[]: A Partition requires upgrade or is currently being upgraded for this deduplication database. Advice: If the issue persists, please upload log files from CommServe, MediaAgent and Client and contact your vendor's support hotline with the job ID of the failed job.<br>Source: CRV2, Process: JobManager", "No", 0, null, null, null, null, null, null, null, null, null, null, null, null, null, ] ], "failures": {}, "warnings": {}
}