Skip to content

Task

R&D and Testing Task Management - A unified management entry for all tasks related to R&D and testing


Query the detail of task

GET
/api/v1/task/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Replace task

PUT
/api/v1/task/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

请求体

application/json
JSON
{
"moduleId": 0,
"name": "A task",
"softwareVersion": "string",
"taskType": "TASK",
"bugLevel": "MINOR",
"assigneeId": 0,
"confirmorId": 0,
"testerId": 0,
"missingBug": true,
"tagIds": [
0
],
"priority": "MEDIUM",
"deadlineDate": "2023-01-02 12:00:00",
"attachments": [
{
"name": "string",
"url": "string"
}
],
"description": "string",
"evalWorkload": 0,
"actualWorkload": 0,
"parentTaskId": 0,
"refTaskIds": [
0
],
"refCaseIds": [
0
]
}

响应

OK

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

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

Update task

PATCH
/api/v1/task/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

请求体

application/json
JSON
{
"moduleId": 0,
"name": "A Task",
"softwareVersion": "string",
"taskType": "TASK",
"bugLevel": "MINOR",
"assigneeId": 0,
"confirmorId": 0,
"testerId": 0,
"missingBug": true,
"tagIds": [
0
],
"priority": "MEDIUM",
"deadlineDate": "2023-01-02 12:00:00",
"attachments": [
{
"name": "string",
"url": "string"
}
],
"description": "string",
"evalWorkload": 0,
"actualWorkload": 0,
"parentTaskId": 0,
"refTaskIds": [
0
],
"refCaseIds": [
0
]
}

响应

OK

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

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

Replace the type of task

PUT
/api/v1/task/{id}/type

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

查询参数

type*

Task type

类型string
必填

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Replace the tags of task

PUT
/api/v1/task/{id}/tag

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

请求体

application/json
JSON
{
"tagIds": [
0
]
}

响应

OK

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

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

Modify the subtasks of the task

PUT
/api/v1/task/{id}/subtask/set

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

查询参数

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

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Cancel the subtasks of the task

PUT
/api/v1/task/{id}/subtask/cancel

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

查询参数

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

响应

Cancel successfully

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Start task

PUT
/api/v1/task/{id}/start

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Replace the software version of task

PUT
/api/v1/task/{id}/software/version

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

请求体

application/json
JSON
{
"softwareVersion": "string"
}

响应

OK

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

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

Confirm the process result of task

PUT
/api/v1/task/{id}/result/{result}/confirm

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"
result*

Task process result

类型string
必填
有效值
"SUCCESS""FAIL"

查询参数

evalWorkload

Task eval workload

类型number
最大值10000
最小值0
actualWorkload

Task actual workload

类型number
最大值10000
最小值0

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Modify task as processed

PUT
/api/v1/task/{id}/processed

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Replace the priority of task

PUT
/api/v1/task/{id}/priority/{priority}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"
priority*

Task priority

类型string
必填
有效值
"HIGHEST""HIGH""MEDIUM""LOW""LOWEST"

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Replace the name of task

PUT
/api/v1/task/{id}/name

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

查询参数

name*

New task name

类型string
必填

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Replace the bug level of task

PUT
/api/v1/task/{id}/missingBug

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

查询参数

missingBug*

Missing bug flag

类型boolean
必填

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Replace the eval workload of task

PUT
/api/v1/task/{id}/evalWorkload

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

请求体

application/json
JSON
{
"workload": 0
}

响应

OK

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

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

Replace the description of task

PUT
/api/v1/task/{id}/description

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

请求体

application/json
JSON
{
"description": "string"
}

响应

OK

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

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

Replace the deadline of task

PUT
/api/v1/task/{id}/deadline/{deadline}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"
deadline*

Task deadline

类型string
必填
格式"date-time"

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Replace the confirmor of task

PUT
/api/v1/task/{id}/confirmor

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

请求体

application/json
JSON
{
"confirmorId": 0
}

响应

OK

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

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

Complete the task

PUT
/api/v1/task/{id}/complete

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

查询参数

evalWorkload

Task eval workload

类型number
最大值10000
最小值0
actualWorkload

Task actual workload

类型number
最大值10000
最小值0

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Cancel task

PUT
/api/v1/task/{id}/cancel

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Replace the bug level of task

PUT
/api/v1/task/{id}/bugLevel

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

查询参数

bugLevel*

Bug level

类型string
必填

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Replace attachment the task

PUT
/api/v1/task/{id}/attachment

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

请求体

application/json
JSON
{
"attachments": [
{
"name": "string",
"url": "string"
}
]
}

响应

OK

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

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

Associate the tasks of the task

PUT
/api/v1/task/{id}/association/task

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

查询参数

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

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Cancel the association tasks of the task

PUT
/api/v1/task/{id}/association/task/cancel

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

查询参数

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

响应

Cancel successfully

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Associate the cases of the task

PUT
/api/v1/task/{id}/association/case

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

查询参数

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

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Cancel the association cases of the task

PUT
/api/v1/task/{id}/association/case/cancel

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

查询参数

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

响应

Cancel successfully

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Replace the assignees of task

PUT
/api/v1/task/{id}/assignee

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

请求体

application/json
JSON
{
"assigneeId": 0
}

响应

OK

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

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

Replace the actual workload of task

PUT
/api/v1/task/{id}/actualWorkload

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

请求体

application/json
JSON
{
"workload": 0
}

响应

OK

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

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

Query the list of task

GET
/api/v1/task

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

projectId*

Project id

类型integer
必填
格式"int64"
id

Task id

类型integer
格式"int64"
name

Task name

类型string
code

Task code

类型string
softwareVersion

Version of software for the task

类型string
sprintId

Task sprint id

类型integer
格式"int64"
moduleId

Task module id

类型integer
格式"int64"
backlog

Backlog flag. true: Sprint backlog, false: Product backlog

类型boolean
targetId

The scenario or api ID associated with the task

类型integer
格式"int64"
targetParentId

The scenario dir or services ID associated with the task

类型integer
格式"int64"
taskType

Task type

类型string
有效值
"REQUIREMENT""STORY""TASK""BUG""API_TEST""SCENARIO_TEST"
bugLevel

Bug level

类型string
有效值
"CRITICAL""MAJOR""MINOR""TRIVIAL"
testType

Task test type

类型string
有效值
"PERFORMANCE""FUNCTIONAL""STABILITY""CUSTOMIZATION"
assigneeId

Assignee id

类型integer
格式"int64"
confirmorId

Confirmor id

类型integer
格式"int64"
testerId

Tester id

类型integer
格式"int64"
missingBug

Missing bug flag

类型boolean
unplanned
类型boolean
parentTaskId

Task parent id

类型integer
格式"int64"
tagId

Tag id

类型integer
格式"int64"
priority

Task priority

类型string
有效值
"HIGHEST""HIGH""MEDIUM""LOW""LOWEST"
evalWorkload

Task eval workload

类型number
actualWorkload

Task actual workload

类型number
status

Task status

类型string
有效值
"PENDING""IN_PROGRESS""CONFIRMING""COMPLETED""CANCELED"
overdue

Whether the task is overdue

类型boolean
failNum

The number of tasks failures

类型integer
格式"int32"
totalNum

The number of tasks processed

类型integer
格式"int32"
execId

Execution id

类型integer
格式"int64"
execBy

Execution user id

类型integer
格式"int64"
execResult

Task execution result

类型string
有效值
"SUCCESS""FAIL"
startDate

Task start date

类型string
格式"date-time"
deadlineDate

Task deadline

类型string
格式"date-time"
confirmedDate

Task confirmed date

类型string
格式"date-time"
completedDate

Task completed date

类型string
格式"date-time"
processedDate

Task processed date

类型string
格式"date-time"
canceledDate

Task canceled date

类型string
格式"date-time"
execDate

Task execution date

类型string
格式"date-time"
createdBy

Task creator

类型integer
格式"int64"
createdDate

Task creation date

类型string
格式"date-time"
lastModifiedBy

Task last modified user

类型integer
格式"int64"
lastModifiedDate

Task last modified date

类型string
格式"date-time"
admin

Required when app administrators query all projects

类型boolean
hasPermission

Required when the user query has the one permission project

类型string
有效值
"MODIFY_SPRINT""DELETE_SPRINT""ADD_TASK""MODIFY_TASK""DELETE_TASK""EXPORT_TASK""RESTART_TASK""REOPEN_TASK""GRANT"
favouriteBy
类型integer
格式"int64"
followBy
类型integer
格式"int64"
commentBy
类型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

Create task

POST
/api/v1/task

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json
JSON
{
"projectId": 1,
"sprintId": 1,
"moduleId": 0,
"name": "A task",
"softwareVersion": "string",
"taskType": "TASK",
"bugLevel": "MINOR",
"targetId": 0,
"testType": "FUNCTIONAL",
"assigneeId": 0,
"confirmorId": 0,
"testerId": 0,
"missingBug": true,
"tagIds": [
0
],
"priority": "MEDIUM",
"deadlineDate": "2023-01-02 12:00:00",
"attachments": [
{
"name": "string",
"url": "string"
}
],
"description": "string",
"evalWorkload": 0,
"parentTaskId": 0,
"refTaskIds": [
0
],
"refCaseIds": [
0
]
}

响应

OK

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

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

Delete tasks

DELETE
/api/v1/task

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

Task ids

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

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Import the tasks

POST
/api/v1/task/import

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

multipart/form-data
object

Import project id

格式"int64"

Import sprint id, it is required for agile project management

格式"int64"

Strategy for handling duplicate apis. The COVER value overrides the local api, and the IGNORE value ignores the synchronization current api

有效值"COVER""IGNORE"

Import task file, only support excel file

格式"binary"

响应

OK

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

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

Import the task example

POST
/api/v1/task/example/import

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

projectId*

Project id

类型integer
必填
格式"int64"

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Restart task

PATCH
/api/v1/task/{id}/restart

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Reopen task

PATCH
/api/v1/task/{id}/reopen

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Move the task to another sprint

PATCH
/api/v1/task/move

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json
JSON
{
"taskIds": [
0
],
"targetSprintId": 0
}

响应

OK

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

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

Query the not associated tasks list of task

GET
/api/v1/task/{id}/task/notAssociated

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

查询参数

moduleId

Module id

类型integer
格式"int64"
taskType

Task type

类型string
有效值
"REQUIREMENT""STORY""TASK""BUG""API_TEST""SCENARIO_TEST"

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Query the not associated subtask list of task

GET
/api/v1/task/{id}/subtask/notAssociated

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

查询参数

moduleId

Module id

类型integer
格式"int64"

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Query the not associated cases list of task

GET
/api/v1/task/{id}/case/notAssociated

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer
必填
格式"int64"

查询参数

moduleId

Module id

类型integer
格式"int64"

响应

OK

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

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

Fulltext search the list of task

GET
/api/v1/task/search
UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

查询参数

projectId*

Project id

类型integer
必填
格式"int64"
id

Task id

类型integer
格式"int64"
name

Task name

类型string
code

Task code

类型string
softwareVersion

Version of software for the task

类型string
sprintId

Task sprint id

类型integer
格式"int64"
moduleId

Task module id

类型integer
格式"int64"
backlog

Backlog flag. true: Sprint backlog, false: Product backlog

类型boolean
targetId

The scenario or api ID associated with the task

类型integer
格式"int64"
targetParentId

The scenario dir or services ID associated with the task

类型integer
格式"int64"
taskType

Task type

类型string
有效值
"REQUIREMENT""STORY""TASK""BUG""API_TEST""SCENARIO_TEST"
bugLevel

Bug level

类型string
有效值
"CRITICAL""MAJOR""MINOR""TRIVIAL"
testType

Task test type

类型string
有效值
"PERFORMANCE""FUNCTIONAL""STABILITY""CUSTOMIZATION"
assigneeId

Assignee id

类型integer
格式"int64"
confirmorId

Confirmor id

类型integer
格式"int64"
testerId

Tester id

类型integer
格式"int64"
missingBug

Missing bug flag

类型boolean
unplanned
类型boolean
parentTaskId

Task parent id

类型integer
格式"int64"
tagId

Tag id

类型integer
格式"int64"
priority

Task priority

类型string
有效值
"HIGHEST""HIGH""MEDIUM""LOW""LOWEST"
evalWorkload

Task eval workload

类型number
actualWorkload

Task actual workload

类型number
status

Task status

类型string
有效值
"PENDING""IN_PROGRESS""CONFIRMING""COMPLETED""CANCELED"
overdue

Whether the task is overdue

类型boolean
failNum

The number of tasks failures

类型integer
格式"int32"
totalNum

The number of tasks processed

类型integer
格式"int32"
execId

Execution id

类型integer
格式"int64"
execBy

Execution user id

类型integer
格式"int64"
execResult

Task execution result

类型string
有效值
"SUCCESS""FAIL"
startDate

Task start date

类型string
格式"date-time"
deadlineDate

Task deadline

类型string
格式"date-time"
confirmedDate

Task confirmed date

类型string
格式"date-time"
completedDate

Task completed date

类型string
格式"date-time"
processedDate

Task processed date

类型string
格式"date-time"
canceledDate

Task canceled date

类型string
格式"date-time"
execDate

Task execution date

类型string
格式"date-time"
createdBy

Task creator

类型integer
格式"int64"
createdDate

Task creation date

类型string
格式"date-time"
lastModifiedBy

Task last modified user

类型integer
格式"int64"
lastModifiedDate

Task last modified date

类型string
格式"date-time"
admin

Required when app administrators query all projects

类型boolean
hasPermission

Required when the user query has the one permission project

类型string
有效值
"MODIFY_SPRINT""DELETE_SPRINT""ADD_TASK""MODIFY_TASK""DELETE_TASK""EXPORT_TASK""RESTART_TASK""REOPEN_TASK""GRANT"
favouriteBy
类型integer
格式"int64"
followBy
类型integer
格式"int64"
commentBy
类型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

Export the tasks by conditions

GET
/api/v1/task/export

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

projectId*

Project id

类型integer
必填
格式"int64"
id

Task id

类型integer
格式"int64"
name

Task name

类型string
code

Task code

类型string
softwareVersion

Version of software for the task

类型string
sprintId

Task sprint id

类型integer
格式"int64"
moduleId

Task module id

类型integer
格式"int64"
backlog

Backlog flag. true: Sprint backlog, false: Product backlog

类型boolean
targetId

The scenario or api ID associated with the task

类型integer
格式"int64"
targetParentId

The scenario dir or services ID associated with the task

类型integer
格式"int64"
taskType

Task type

类型string
有效值
"REQUIREMENT""STORY""TASK""BUG""API_TEST""SCENARIO_TEST"
bugLevel

Bug level

类型string
有效值
"CRITICAL""MAJOR""MINOR""TRIVIAL"
testType

Task test type

类型string
有效值
"PERFORMANCE""FUNCTIONAL""STABILITY""CUSTOMIZATION"
assigneeId

Assignee id

类型integer
格式"int64"
confirmorId

Confirmor id

类型integer
格式"int64"
testerId

Tester id

类型integer
格式"int64"
missingBug

Missing bug flag

类型boolean
unplanned
类型boolean
parentTaskId

Task parent id

类型integer
格式"int64"
tagId

Tag id

类型integer
格式"int64"
priority

Task priority

类型string
有效值
"HIGHEST""HIGH""MEDIUM""LOW""LOWEST"
evalWorkload

Task eval workload

类型number
actualWorkload

Task actual workload

类型number
status

Task status

类型string
有效值
"PENDING""IN_PROGRESS""CONFIRMING""COMPLETED""CANCELED"
overdue

Whether the task is overdue

类型boolean
failNum

The number of tasks failures

类型integer
格式"int32"
totalNum

The number of tasks processed

类型integer
格式"int32"
execId

Execution id

类型integer
格式"int64"
execBy

Execution user id

类型integer
格式"int64"
execResult

Task execution result

类型string
有效值
"SUCCESS""FAIL"
startDate

Task start date

类型string
格式"date-time"
deadlineDate

Task deadline

类型string
格式"date-time"
confirmedDate

Task confirmed date

类型string
格式"date-time"
completedDate

Task completed date

类型string
格式"date-time"
processedDate

Task processed date

类型string
格式"date-time"
canceledDate

Task canceled date

类型string
格式"date-time"
execDate

Task execution date

类型string
格式"date-time"
createdBy

Task creator

类型integer
格式"int64"
createdDate

Task creation date

类型string
格式"date-time"
lastModifiedBy

Task last modified user

类型integer
格式"int64"
lastModifiedDate

Task last modified date

类型string
格式"date-time"
admin

Required when app administrators query all projects

类型boolean
hasPermission

Required when the user query has the one permission project

类型string
有效值
"MODIFY_SPRINT""DELETE_SPRINT""ADD_TASK""MODIFY_TASK""DELETE_TASK""EXPORT_TASK""RESTART_TASK""REOPEN_TASK""GRANT"
favouriteBy
类型integer
格式"int64"
followBy
类型integer
格式"int64"
commentBy
类型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

*/*

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python