Skip to content

Analysis

Analysis Management - Provides a centralized entry point for analyzing and querying data related to development tasks and testing activities, enabling teams to gain insights and make informed decisions.


Query the list of analysis

GET
/api/v1/analysis

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

Analysis id

类型integer
格式"int64"
projectId*

Project id

类型integer
必填
格式"int64"
resource

Analysis resource type

类型string
有效值
"TASK""CASE"
template

Analysis template

类型string
name

Analysis name

类型string
object

Analysis object type

类型string
planId

Analysis sprint or plan id, required when the object type is a plan

类型integer
格式"int64"
orgType

Analysis organization type, required when the object type is an organization

类型string
有效值
"USER""DEPT""GROUP"
orgId

Analysis organization id, required when the object type is an organization

类型integer
格式"int64"
datasource

Analysis data source

类型string
有效值
"REAL_TIME_DATA""SNAPSHOT_DATA"
createdBy
类型integer
格式"int64"
createdDate
类型string
格式"date-time"
lastModifiedBy
类型integer
格式"int64"
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

Replace analysis

PUT
/api/v1/analysis

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json
JSON
{
"id": 0,
"projectId": 0,
"resource": "string",
"template": "string",
"name": "string",
"description": "string",
"object": "string",
"planId": 0,
"orgType": "string",
"orgId": 0,
"containsUserAnalysis": true,
"containsDataDetail": true,
"timeRange": "string",
"startTime": "string",
"endTime": "string",
"datasource": "string",
"filterCriteria": "string"
}

响应

OK

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

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

Create analysis

POST
/api/v1/analysis

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json
JSON
{
"projectId": 0,
"resource": "string",
"template": "string",
"name": "string",
"description": "string",
"object": "string",
"planId": 0,
"orgType": "string",
"orgId": 0,
"containsUserAnalysis": true,
"containsDataDetail": true,
"timeRange": "string",
"startTime": "string",
"endTime": "string",
"datasource": "string",
"filterCriteria": "string"
}

响应

OK

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

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

Delete analysis

DELETE
/api/v1/analysis

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

Analysis ids

类型array
必填
最大项数200
最小项数0
唯一项true

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Update analysis

PATCH
/api/v1/analysis

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json
JSON
{
"id": 0,
"name": "string",
"description": "string",
"object": "string",
"planId": 0,
"orgType": "string",
"orgId": 0,
"containsUserAnalysis": true,
"containsDataDetail": true,
"timeRange": "string",
"startTime": "string",
"endTime": "string",
"datasource": "string",
"filterCriteria": "string"
}

响应

OK

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

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

Refresh the latest analysis snapshot data

POST
/api/v1/analysis/{id}/refresh

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Analysis id

类型integer
必填
格式"int64"

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Query the detail of analysis

GET
/api/v1/analysis/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Analysis id

类型integer
必填
格式"int64"

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Export the overview data of analysis

GET
/api/v1/analysis/{id}/overview/export

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Analysis id

类型integer
必填
格式"int64"

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Fulltext search the list of analysis

GET
/api/v1/analysis/search
UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

查询参数

id

Analysis id

类型integer
格式"int64"
projectId*

Project id

类型integer
必填
格式"int64"
resource

Analysis resource type

类型string
有效值
"TASK""CASE"
template

Analysis template

类型string
name

Analysis name

类型string
object

Analysis object type

类型string
planId

Analysis sprint or plan id, required when the object type is a plan

类型integer
格式"int64"
orgType

Analysis organization type, required when the object type is an organization

类型string
有效值
"USER""DEPT""GROUP"
orgId

Analysis organization id, required when the object type is an organization

类型integer
格式"int64"
datasource

Analysis data source

类型string
有效值
"REAL_TIME_DATA""SNAPSHOT_DATA"
createdBy
类型integer
格式"int64"
createdDate
类型string
格式"date-time"
lastModifiedBy
类型integer
格式"int64"
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.