Last Updated: 1/22/2020 12:11:13 AM
Get scheduled reports for customers
Request
HTTP Request
GET /SMPI/{version}/service/wfbss/api/report
Parameters
Name |
Type |
Description |
Validation |
|---|---|---|---|
|
Required Parameters |
|||
cids |
string |
A list of customer ID separated by comma. |
At least one customer ID must be specified, and no more than 10. |
|
Optional Parameters |
|||
|
name |
string |
Report name |
|
|
rtid |
integer |
Report ID |
|
HTTP Request Example
1. Get scheduled reports
GET /SMPI/{version}/service/wfbss/api/report?cids=74AE704D-CD9E-4F45-A62B-CA3AED65F99F
2. Get scheduled reports having the specified name
GET /SMPI/{version}/service/wfbss/api/report?cids=74AE704D-CD9E-4F45-A62B-CA3AED65F99F&name=weekly report
Do not supply a request body with this method.
Response
Response
If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:
{
"customers":[
{
"id":"74AE704D-CD9E-4F45-A62B-CA3AED65F99F",
"reports":[
{
"setting":{
"enabled":1,
"parameter":{
"time":11100,
"gids":[
2
],
"email":1,
"weekday":1,
"address":[
"report_recipient@trendmicro.com"
]
},
"name":"weekly report"
},
"type":3,
"number":0,
"rtid":1
}
],
"eid":"6FA6C13D-04B9-4FBC-B181-9B8AF75AD801"
}
]
}
Name |
Type |
Description |
Length |
|---|---|---|---|
customers[].eid |
string |
For internal use |
GUID |
customers[].id |
string |
Customer ID |
GUID |
customers[].reports[].number |
integer |
The number of report history |
|
customers[].reports[].rtid |
integer |
Report ID |
|
customers[].reports[].setting.enabled |
integer |
Enable the report |
1 = true; 0 = false |
customers[].reports[].setting.name |
string |
Report name |
|
customers[].reports[].setting.parameter.address[] |
string |
Report recipient |
e.g., report_recipient@trendmicro.com |
customers[].reports[].setting.parameter.email |
integer |
Sent out the report |
1 = true; 0 = false |
customers[].reports[].setting.parameter.gids[] |
integer |
Group ID |
|
customers[].reports[].setting.parameter.monthday |
integer |
For monthly report. The report runs once a month on the specified day the specified time. |
1 to 31 |
customers[].reports[].setting.parameter.weekday |
integer |
For weekly report. The report runs once a week on the specified day the specified time. |
0 = Sunday; 1 = Monday; 2 = Tuesday; 3 = Wednesday; 4 = Thursday; 5 = Friday; 6 = Saturday |
customers[].reports[].setting.parameter.time |
integer |
The time WFBS-SVC should generate the report and the time format is the number of the second of the day. |
0 to 86399. For example, 0 indicates 00:00 AM, 28800 indicates 08:00 AM |
customers[].reports[].type |
integer |
Report schedule |
3 = Weekly; 4 = Monthly |