Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

Anchor
_Toc341972711
_Toc341972711
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,
PAUSED,
COMPLETED,
FAILED,
CANCELED

 

 

read only

resultCode

String

 

 

 

read only

resultDescription

String

 

 

 

read only

dateStarted

Date

 

 

 

read only

dateCompleted

Date

 

 

 

read only

availableFormats

ENUM

PDF,
HTML,
RTF
...

 

 

read only


Anchor
_Toc341972712
_Toc341972712
/reportResult/search

Wiki Markup
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"\}
\]
\}
\}
\\

Anchor
_Toc341972713
_Toc341972713
/reportResult/get

Wiki Markup
Method:/reportResult/get
Parameters: 
\{
 "match":
\{
 \["id","=", "tid"\]
\},
 "return":\["id", "report.name"\]
\}
\\
Response: 
\{
"error":0,
"result":
\{
 "id":1,"report.name":"xxx"
\}
\}
\\

Anchor
_Toc341972714
_Toc341972714
/reportResult/delete

Method:/reportResult/delete
Parameters:
{
"id":"report result id"
}
Response:
{
"error":0
}

Anchor
_Toc341972715
_Toc341972715
/reportResult/export

Method:/reportResult/export
Parameters:
{
"id":"report result id",
"output":{"format":"PDF"} // optional
}
Response:
{
"error":0
}

Anchor
_Toc341972716
_Toc341972716
/reportResult/cancel

Method:/reportResult/cancel
Parameters:
{
"id":"report result id"
}
Response:
{
"error":0
}

Anchor
_Toc341972717
_Toc341972717
/reportResult/pause

Method:/reportResult/pause
Parameters:
{
"id":"report result id"
}
Response:
{
"error":0
}

Anchor
_Toc341972718
_Toc341972718
/reportResult/resume

Method:/reportResult/resume
Parameters:
{
"id":"report result id"
}
Response:
{
"error":0
}