-
Notifications
You must be signed in to change notification settings - Fork 3
get_reports
Alberto Gonzalez edited this page Oct 29, 2015
·
1 revision
Get the list of reports for the defined system.
GET /api/reports/list/?sid={sid}
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>
Optional filters include:
| Filter | Description | Example |
|---|---|---|
| sid={system ID} | Run reports for the specified system only | /api/reports/backup/protection?sid=1 |
| start_date={date} | Return report information starting on specified date | /api/reports/backup/protection?start_date=08/30/2014 |
| end_date={date} | Return report information ending on specified date | /api/reports/backup/protection?end_date=09/20/2014 |
| order | order report data by date newest first (desc), the default or ascending (asc) | |
| format | return data as a table of JSON objects (raw), a csv-file (csv) or a pdf | |
| start_row | return data starting with item start_row (1 by default) | |
| count | return a maximum of count rows of data by default (1000) |
200 success
The reports list API returns a definition of each system report. The user may optionally filter to return only a group of reports, i.e., backup reports or archive reports or replication reports. The data returned is in the following form:
| Index | Value | Type | Returned |
|---|---|---|---|
| name | name of report | string | always |
| title | report title | string | always |
| desc | report description | string | always |
| cols | columns for the report, formatted as data name and data time | array | always |
| extra_cols | optional columns for the report | array | always |
| pdf_url | url of pdf on the system | string | if the format is pdf |
The columns are returned in an array, with the property name being the property returned by the actual report and the value being the data type of the value, e.g., string, long, boolean, etc.
GET /api/reports/list/?sid=1
Host: <server host name>
Accept: application/json
AuthToken: 8a00sjerhterqerjlqkjlk443l4j56869h4f_)(fjdkasHHHHHkdal324
{
"reports": [
{
"backup": [
{
"name": "protection_summary",
"title": "Protection Summary",
"desc": "A summary of protection details and lists of all protected and unprotected instances within the selected date range.",
"cols": [
{
"summary": [
{ "system_name" : "string" },
{ "client_name" : "string" },
{ "app_name" : "string" },
{ "instance_name" : "string" },
{ "database__name" : "string" },
{ "last_backup_date": "string" },
{ "last_replication_date" : "string" },
{ "last_archive_date" : "string" }
],
"backup": [
{ "system_name" : "string" },
{ "client_name" : "string" },
{ "app_name" : "string" },
{ "instance_name" : "string" },
{ "database__name" : "string" },
{ "last_backup_date": "string" },
{ "job_name": "string" },
{ "type": "string" },
{ "count": "long" }
],
"replication": [
{ "system_name" : "string" },
{ "client_name" : "string" },
{ "app_name" : "string" },
{ "instance_name" : "string" },
{ "database__name" : "string" },
{ "last_replication_date": "string" },
{ "job_name": "string" },
{ "type": "string" },
{ "count": "long" }
],
"archive": [
{ "system_name" : "string" },
{ "client_name" : "string" },
{ "app_name" : "string" },
{ "instance_name" : "string" },
{ "database__name" : "string" },
{ "last_archive_date": "string" },
{ "job_name": "string" },
{ "type": "string" },
{ "count": "long" }
],
"unprotected": [
{ "system_name": "string" },
{ "client_name" : "string" },
{ "app_name" : "string" },
{ "instance_name" : "string" },
{ "database__name" : "string" }
]
}
],
"extra_cols": []
},
{
"name": "history",
"title": "Backup History",
"desc": "Backups within the specified date range.",
"cols": [
{ "client_name": "string" },
{ "system_name" : "string" },
{ "app_name" : "string" },
{ "instance_name" : "string" },
{ "database_name" : "string" },
{ "id": "long" },
{ "files" : "long" },
{ "complete": "boolean" },
{ "status": "string" },
{ "replication_status": "string" },
{ "verify_status": "string" },
{ "certify_status": "string" },
{ "encrypted" : "boolean" },
{ "start_date" : "string" },
{ "end_date" : "string" },
{ "elapsed_time" : "string" },
{ "type": "string" },
{ "size" : "long" }
],
"extra_cols": []
},
{
"name": "legal_hold",
"title": "Legal Hold",
"desc": "Backups that are currently on legal hold.",
"cols": [
{ "client_name": "string" },
{ "system_name" : "string" },
{ "app_name" : "string" },
{ "instance_name" : "string" },
{ "database_name" : "string" },
{ "id": "long" },
{ "start_date" : "string" },
{ "hold_end_date" : "string" },
{ "hold_days": "long" },
{ "type": "string" },
{ "size" : "long" }
],
"extra_cols": []
}
]
},
"replication": [
{
"name": "protection_summary",
"title": "Protection Summary",
"desc": "A summary of protection details and lists of all protected and unprotected instances within the
selected date range.",
"cols": [
{
"archive": [
{ "system_name": "string" },
{ "client_name": "string" },
{ "app_name": "string" },
{ "instance_name": "string" },
{ "database__name": "string" },
{ "last_archive_date": "string" },
{ "job_name": "string" },
{ "type": "string" },
{ "count": "long" }
],
"backup": [
{ "system_name": "string" },
{ "client_name": "string" },
{ "app_name": "string" },
{ "instance_name": "string" },
{ "database__name": "string" },
{ "last_backup_date": "string" },
{ "job_name": "string" },
{ "type": "string" },
{ "count": "long" }
],
"replication": [
{ "system_name": "string" },
{ "client_name": "string" },
{ "app_name": "string" },
{ "instance_name": "string" },
{ "database__name": "string" },
{ "last_replication_date": "string" },
{ "job_name": "string" },
{ "type": "string" },
{ "count": "long" }
],
"summary": [
{ "system_name": "string" },
{ "client_name": "string" },
{ "app_name": "string" },
{ "instance_name": "string" },
{ "database__name": "string" },
{ "last_backup_date": "string" },
{ "last_replication_date": "string" },
{ "last_archive_date": "string" }
],
"unprotected": [
{ "system_name": "string" },
{ "client_name": "string" },
{ "app_name": "string" },
{ "instance_name": "string" },
{ "database__name": "string" }
]
}
],
"extra_cols": []
},
{
"name": "history",
"title": "Replication History",
"desc": "Replication within the specified date range.",
"cols": [
{ "client_name": "string" },
{ "system_name": "string" },
{ "app_name": "string" },
{ "instance_name": "string" },
{ "database_name": "string" },
{ "id": "long" },
{ "files": "long" },
{ "complete": "boolean" },
{ "status": "string" },
{ "replication_status": "string" },
{ "verify_status": "string" },
{ "certify_status": "string" },
{ "encrypted": "boolean" },
{ "start_date": "string" },
{ "end_date": "string" },
{ "elapsed_time": "string" },
{ "replication_start_date": "string" },
{ "replication_end_date": "string" },
{ "replication_elapsed_time": "string" },
{ "type": "string" },
{ "size": "long" },
{ "replicated_size": "long" }
],
"extra_cols": []
}
]
}