AuditLog

[POST] /admin/api/testconnection

Request Schema

AuditLogInfo

Response

Status Code: 200

Success

[POST] /admin/api/createdatabase

Request Schema

AuditLogInfo

Response

Status Code: 200

Success

[POST] /admin/api/createtable

Request Schema

AuditLogInfo

Response

Status Code: 200

Success

[GET] /admin/api/auditlog/builtindocumentstatus

if the built-in audit log documents already exist

Response

Status Code: 200

Success

[POST] /admin/api/auditlog/addbuiltindocument

Add built-in audit log documents

Request Schema

AuditLogInfo

Response

Status Code: 200

Success

[PUT] /admin/api/auditlog/updatebuiltindocument

Update built-in audit log documents

Request Schema

AuditLogInfo

Response

Status Code: 200

Success

[DELETE] /admin/api/auditlog/deletebuiltindocument

Delete built-in audit log documents

Response

Status Code: 200

Success

[POST] /admin/api/auditlog/enable

Enable audit log.

Request Schema

EnableAuditLogModel

Response

Status Code: 200

Success

[GET] /admin/api/auditlogs/pagination

Parameters

Name	Type	Located In
Info_DocumentType	string	query
Info_ActionType	string	query
utcTicksStart	int64	query
utcTicksEnd	int64	query
UserName	string	query
Info_DocumentName	string	query
pageNumber	int32	query
pageSize	int32	query
order	string	query
fields	string	query

Response

Status Code: 200

Success

[GET] /admin/api/auditlogs/pivot

Parameters

Name	Type	Located In
Info_DocumentType	string	query
Info_ActionType	string	query
utcTicksStart	int64	query
utcTicksEnd	int64	query
UserName	string	query
Info_DocumentName	string	query
chartTemplate	string	query

Response

Status Code: 200

Success

[POST] /api/auditlog/AddServiceLog

Request Schema

ServiceInfo

Response

Status Code: 200

Success

[POST] /api/auditlog/AddRequestLog

Request Schema

RequestInfo

Response

Status Code: 200

Success

Models

Ƭ AuditLogInfo

Audit log information.

Name	Type	Description	Example
providerNullable	string	Database provider.	"MySQL"
openAdvancedOption	Boolean	Whether the advanced option is opened or not.	true
connectionStringNullable	string	The database connection string.	"Server=localhost;Port=3306;Uid=root;Pwd=root;"
sqlServerServerNameNullable	string	SQLServer instance name.	"localhost"
sqlServerPortNullable	string	SQLServer listening port.	"1433"
sqlServerDatabaseNameNullable	string	SQLServer database name.	"audit-logs"
sqlServerAuthenticationMethodNullable	string	SQLServer authentication mode.	"integration"
sqlServerUserNameNullable	string	SQLServer user name.	"username"
sqlServerPasswordNullable	string	SQLServer password.	"password"
mySqlServerNameNullable	string	MySql instance name.	"localhost"
mySqlPortNullable	string	MySql listening port.	"3306"
mySqlDatabaseNameNullable	string	MySql database name.	"audit-logs"
mySqlUserNameNullable	string	MySql user name.	"username"
mySqlPasswordNullable	string	MySql password.	"password"
oracleServerNameNullable	string	Oracle instance name.	"localhost"
oraclePortNullable	string	Oracle listening port.	"1521"
oracleServiceNameNullable	string	Oracle service name.	"oracle.service.name"
oracleUserNameNullable	string	Oracle user name.	"username"
oraclePasswordNullable	string	Oracle password.	"password"
postgresHostNullable	string	PostgreSQL instance name.	"localhost"
postgresPortNullable	string	PostgreSQL listening port.	"5432"
postgresDatabaseNameNullable	string	PostgreSQL database name.	"audit-logs"
postgresUserNameNullable	string	PostgreSQL user name.	"username"
postgresPasswordNullable	string	PostgreSQL password.	"password"

Ƭ EnableAuditLogModel

Name	Type	Description	Example
dbTypeNullable	string
dbConnectionStringNullable	string
dataRetentionPeriod	int32
addBuiltInDocuments	Boolean

Ƭ ServiceInfo

Name	Type	Description	Example
typeNullable	string
contentNullable	string
isSuccess	Boolean
descriptionNullable	string

Ƭ RequestInfo

Name	Type	Description	Example
parametersNullable	string
serverIPNullable	string
clientIPNullable	string
linkNullable	string
semanticModelVersionNullable	string
semanticModelNameNullable	string
datasetQueryNullable	string
documentVersionNullable	string
documentNameNullable	string
documentIdNullable	string
requestSourceNullable	string
requestDeviceNullable	string
actionTypeNullable	string
requestIDNullable	string
documentTypeNullable	string
resultURLNullable	string
descriptionNullable	string
totalRunTimeNullable	int64
totalRowsFoundNullable	int64