Attributes
Attribute |
type |
values |
default |
mandate |
comment |
Name |
String |
|
|
True |
|
description |
string |
|
|
False |
|
template |
Object |
|
|
|
immutable |
metaData |
String |
|
|
|
read only |
queryParams |
String |
|
|
|
In JSON format |
outputParams |
String |
|
|
|
In JSON format |
sortParams |
String |
|
|
|
In JSON format |
status |
ENUM |
PENDING, |
|
|
read only |
dateCreated |
date |
|
|
|
read only |
dateUpdated |
date |
|
|
|
read only |
lastExecuted |
date |
|
|
|
read only |
failedTimes |
integer |
|
|
|
read only |
succeededTimes |
integer |
|
|
|
read only |
schedualEnabled |
Boolean |
|
False |
|
|
schedule |
String |
|
|
|
Cron express |
repeatCount |
integer |
|
0 |
|
|
/report/create
Method:/report/create
Request:
{
"attrs":
{
"template.id":"Report template ID"
// or "template.name":"Report template name"
"name":"test report",
"queryParams":
'[ // please be aware this is a string
["loginName", "=", "john.smith"],"and",
["domain","=","ACME"], "and",
[
["logDate", ">","2011-03-08T00:00:00"], "or"
["logDate", "<","2011-01-08T00:00:00"]
],"or",
[
[],"and",
[]
]
]',
"outputParams":
'{ // please be aware this is a string
"id":true,
"loginName":true,
"idWidth":60,
"loginName":60
}',
"sortParams":
'{
"loginName":"loginName"
}'
}
}
Response: {"error":124}
Response: {"error":0}
/report/search
Method:/report/search
Parameters:
{
"match":
{
["id","=", "tid"]
},
"return":["id", "name"],
}
Response:
{
"error":0,
"result":
{
total:2,
rows:
[
{"id":1,"name":"xxx"},
{"id":2,"name":"yyy"}
]
}
}
/report/get
Method:/report/get
Parameters:
{
"match":
{
["id","=", "tid"]
},
"return":["id", "name"],
}
Response:
{
"error":0,
"result":
{
"id":1,"name":"xxx"
}
}
/report/set
Method:/report/set
Parameters:
{
"id":"report id",
attrs":{"description":"new description"}
}
Response:
{
"error":0
}
/report/delete
Method:/report/delete
Parameters:
{
"id":"report id"
}
Response:
{
"error":0
}
/report/generate
Method:/report/generate
Parameters:
{
"id":"report id"
}
Response:
{
"error":0
}