Attributes
Attribute |
type |
values |
default |
mandate |
comment |
report |
Object |
|
|
|
|
metaData |
String |
|
|
|
read only |
queryParams |
String |
|
|
|
In JSON format |
outputParams |
String |
|
|
|
In JSON format |
sortParams |
String |
|
|
|
In JSON format |
status |
ENUM |
RUNNING, |
|
|
read only |
resultCode |
String |
|
|
|
read only |
resultDescription |
String |
|
|
|
read only |
dateStarted |
Date |
|
|
|
read only |
dateCompleted |
Date |
|
|
|
read only |
availableFormats |
ENUM |
PDF, |
|
|
read only |
/reportResult/search
Method:/reportResult/search
Parameters:
{
"match":
{
["id","=", "tid"]
},
"return":["id", "report.name"]
}
Response:
{
"error":0,
"result":
{
total:2,
rows:
[
{"id":1,"report.name":"xxx"},
{"id":2,"report.name":"yyy"}
]
}
}
/reportResult/get
Method:/reportResult/get
Parameters:
{
"match":
{
["id","=", "tid"]
},
"return":["id", "report.name"]
}
Response:
{
"error":0,
"result":
{
"id":1,"report.name":"xxx"
}
}
/reportResult/delete
Method:/reportResult/delete
Parameters:
{
"id":"report result id"
}
Response:
{
"error":0
}
/reportResult/export
Method:/reportResult/export
Parameters:
{
"id":"report result id",
"output":{"format":"PDF"} // optional
}
Response:
{
"error":0
}
/reportResult/cancel
Method:/reportResult/cancel
Parameters:
{
"id":"report result id"
}
Response:
{
"error":0
}
/reportResult/pause
Method:/reportResult/pause
Parameters:
{
"id":"report result id"
}
Response:
{
"error":0
}
/reportResult/resume
Method:/reportResult/resume
Parameters:
{
"id":"report result id"
}
Response:
{
"error":0
}