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
_Toc341972703
_Toc341972703
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,
RUNNING,
SCHEDULED,
COMPLETED

 

 

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

 

 


Anchor
_Toc341972704
_Toc341972704
/report/create

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

Anchor
_Toc341972705
_Toc341972705
/report/search

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

Anchor
_Toc341972706
_Toc341972706
/report/get

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

Anchor
_Toc341972707
_Toc341972707
/report/set

Method:/report/set
Parameters:
{
"id":"report id",
attrs":{"description":"new description"}
}
Response:
{
"error":0
}

Anchor
_Toc341972708
_Toc341972708
/report/delete

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

Anchor
_Toc341972709
_Toc341972709
/report/generate

Method:/report/generate
Parameters:
{
"id":"report id"
}
Response:
{
"error":0
}