Attributes

Attribute

type

values

default

mandate

comment

auditId

Long

 

 

 

 

category

string

SYSTEM
ADMINISTRATION
AUTHENTICATION

 

true

 

type

string

ERROR,
WARNING,
INFO,
FAILURE,
SUCCESS

 

true

 

eventCode

string

 

 

true

 

errorCode

string

 

 

true

 

agentIp

string

 

 

 

 

agentId

long

 

 

 

These attributes are real columns in log table

agentName

string

 

 

 

 

userId

long

 

 

 

 

loginName

string

 

 

 

 

domainName

string

 

 

 

 

domainId

Long

 

 

 

 

unitName

String

 

 

 

 

unitId

Long

 

 

 

 

clientIp

string

 

 

 

 

serverName

string

 

 

 

 

description

string

 

 

 

 

logDate

date

 

 

 

 

children

coll

 

 

 

 

fields

coll

 

 

 

 

user

object

 

 

 

These attributes are lazy Associations

agent

object

 

 

 

 

domain

 

 

 

 

 

unit

 

 

 

 

 

/log/search

Examples:
Method:/log/search
Parameters:
{
"match":
[
["category", "=", "Authentication"]
}
"return":["*"]
}
Response:
{
"error":0,
"result":
{
"total":100,
"rows":
[
{
"category":"Authentication",
"type":"Failure",
"eventCode":"VERIFY_CREDENTIAL",
"errorCode":"E_OTP_OUT_SYNC"

},

]
}
}

/log/getEventLogFilter

Examples:
Method:/log/getEventLogFilter
Parameters:
{
}
Response:
{
"error":0,
"result":
{
total:10,
rows:
[
"LOGON",
"CREATE_DOMAIN",
...
]
}
}
}

/log/setEventLogFilter

Examples:
Method:/log/setEventLogFilter
Parameters:
{
"eventCodes":
[
"LOGON",
"LOGOUT"
}
}
Response:
{
"error":0,
}

/log/ listAllEventCodes

Examples:
Method:/log/listAllEventCodes
Parameters:
{
}
Response:
{
"error":0,
"result":
{
total:10,
rows:
[
{"value":"LOGON","description":"Logon"},
{"value":"CREATE_DOMAIN", "description":"Create domain"}
...
]
}
}

/log/export

Examples:
Method:/log/export
Parameters:
{
from:'2011-03-15T00:00:00',
to:'2011-03-16T00:00:00',
format:'CSV', // CSV | XML
purge:true // true | false
}

  • No labels