[]
        
(Showing Draft Content)

AuditLog

AuditLog

[POST] /admin/api/testconnection

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

AuditLogInfo

Responses

[200] Success

[POST] /admin/api/createdatabase

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

AuditLogInfo

Responses

[200] Success

[POST] /admin/api/createtable

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

AuditLogInfo

Responses

[200] Success

[GET] /admin/api/auditlog/builtindocumentstatus

if the built-in audit log documents already exist

Responses

[200] Success

[POST] /admin/api/auditlog/addbuiltindocument

Add built-in audit log documents

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

AuditLogInfo

Responses

[200] Success

[PUT] /admin/api/auditlog/updatebuiltindocument

Update built-in audit log documents

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

AuditLogInfo

Responses

[200] Success

[DELETE] /admin/api/auditlog/deletebuiltindocument

Delete built-in audit log documents

Responses

[200] Success

[POST] /admin/api/auditlog/enable

Enable audit log.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

EnableAuditLogModel

Responses

[200] Success

[GET] /admin/api/auditlogs/pagination

Parameters

Name In Type
Info_DocumentType query string
Info_ActionType query string
utcTicksStart query integer
utcTicksEnd query integer
UserName query string
Info_DocumentName query string
pageNumber query integer
pageSize query integer
order query string
fields query string

Responses

[200] Success

[GET] /admin/api/auditlogs/pivot

Parameters

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

Responses

[200] Success

[POST] /api/auditlog/AddServiceLog

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

ServiceInfo

Responses

[200] Success

[POST] /api/auditlog/AddRequestLog

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

RequestInfo

Responses

[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"
dmHostNullable string Dm Host "localhost"
dmPortNullable string Dm Port "5236"
dmUserNameNullable string Dm UserName "username"
dmPasswordNullable string Dm Password "password"

Ƭ EnableAuditLogModel

Name Type
dbTypeNullable string
dbConnectionStringNullable string
dataRetentionPeriod int32
addBuiltInDocuments Boolean

Ƭ ServiceInfo

Name Type
typeNullable string
contentNullable string
isSuccess Boolean
descriptionNullable string

Ƭ RequestInfo

Name Type
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