Skip to content

Activity

User Activity Auditing - APIs for querying and analyzing user activity logs (resource access, and operational events) with granular filters and audit trail exports


Query the list of activity

GET
/api/v1/activity

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

Activity id

类型integer
格式"int64"
projectId

Project id

类型integer
格式"int64"
targetId

Target id

类型integer
格式"int64"
parentTargetId

Target parent id

类型integer
格式"int64"
targetType

Target type

类型string
有效值
"PROJECT""TAG""MODULE""TASK""TASK_SPRINT""SOFTWARE_VERSION""TASK_ANALYSIS""MEETING""FUNC_PLAN""FUNC_REVIEW""FUNC_CASE""FUNC_CASE_BASELINE""FUNC_CASE_ANALYSIS""SERVICE""API""API_CASE""API_DESIGN""SCENARIO""SCENARIO_MONITOR""SCRIPT""MOCK_SERVICE""VARIABLE""DATASET""MOCK_APIS""EXECUTION""REPORT"
userId

Operation user id

类型integer
格式"int64"
mainTargetId

Main target id

类型integer
格式"int64"
detail

For fulltext search

类型string
optDate
类型string
格式"date-time"
pageNo

Page data size, default 1, maximum 100000

类型integer
格式"int32"
最大值100000
最小值1
pageSize

Page data size, default 10, maximum 2000

类型integer
格式"int32"
最大值2000
最小值1
orderBy

Sort field

类型string
orderSort

Sorting method

类型string
有效值
"ASC""DESC"
filters[0].key

Filter field name

类型string
filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[0].value

Filter value

filters[1].key

Filter field name

类型string
filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[1].value

Filter value

filters[2].key

Filter field name

类型string
filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[2].value

Filter value

infoScope

Query information scope

类型string
有效值
"BASIC""DETAIL"

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Fulltext search the list of activity

GET
/api/v1/activity/search
UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

查询参数

id

Activity id

类型integer
格式"int64"
projectId

Project id

类型integer
格式"int64"
targetId

Target id

类型integer
格式"int64"
parentTargetId

Target parent id

类型integer
格式"int64"
targetType

Target type

类型string
有效值
"PROJECT""TAG""MODULE""TASK""TASK_SPRINT""SOFTWARE_VERSION""TASK_ANALYSIS""MEETING""FUNC_PLAN""FUNC_REVIEW""FUNC_CASE""FUNC_CASE_BASELINE""FUNC_CASE_ANALYSIS""SERVICE""API""API_CASE""API_DESIGN""SCENARIO""SCENARIO_MONITOR""SCRIPT""MOCK_SERVICE""VARIABLE""DATASET""MOCK_APIS""EXECUTION""REPORT"
userId

Operation user id

类型integer
格式"int64"
mainTargetId

Main target id

类型integer
格式"int64"
detail

For fulltext search

类型string
optDate
类型string
格式"date-time"
pageNo

Page data size, default 1, maximum 100000

类型integer
格式"int32"
最大值100000
最小值1
pageSize

Page data size, default 10, maximum 2000

类型integer
格式"int32"
最大值2000
最小值1
orderBy

Sort field

类型string
orderSort

Sorting method

类型string
有效值
"ASC""DESC"
filters[0].key

Filter field name

类型string
filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[0].value

Filter value

filters[1].key

Filter field name

类型string
filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[1].value

Filter value

filters[2].key

Filter field name

类型string
filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
有效值
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[2].value

Filter value

infoScope

Query information scope

类型string
有效值
"BASIC""DETAIL"

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}
授权
变量
cURL
JavaScript
PHP
Python

Released under the GPL-3.0 License.