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

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/task/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Replace task

PUT

/api/v1/task/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer

必填

format"int64"

请求体

application/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

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/task/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

cURL

JavaScript

PHP

Python

---

Update task

PATCH

/api/v1/task/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Task id

类型integer

必填

format"int64"

请求体

application/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

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/task/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

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

必填

format"int64"

查询参数

type*

Task type

类型string

必填

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

type*

示例

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

必填

format"int64"

请求体

application/json

{

"tagIds": [

0

]

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

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

必填

format"int64"

查询参数

subTaskIds*

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

subTaskIds*

示例

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

必填

format"int64"

查询参数

subTaskIds*

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

Cancel successfully

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

subTaskIds*

示例

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

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

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

必填

format"int64"

请求体

application/json

{

"softwareVersion": "string"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

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

必填

format"int64"

result*

Task process result

类型string

必填

枚举

"SUCCESS""FAIL"

查询参数

evalWorkload

Task eval workload

类型number

maximum10000

minimum0

actualWorkload

Task actual workload

类型number

maximum10000

minimum0

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

result*

evalWorkload

actualWorkload

示例

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

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

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

必填

format"int64"

priority*

Task priority

类型string

必填

枚举

"HIGHEST""HIGH""MEDIUM""LOW""LOWEST"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

priority*

示例

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

必填

format"int64"

查询参数

name*

New task name

类型string

必填

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

name*

示例

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

必填

format"int64"

查询参数

missingBug*

Missing bug flag

类型boolean

必填

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

missingBug*

示例

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

必填

format"int64"

请求体

application/json

{

"workload": 0

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

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

必填

format"int64"

请求体

application/json

{

"description": "string"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

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

必填

format"int64"

deadline*

Task deadline

类型string

必填

format"date-time"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

deadline*

示例

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

必填

format"int64"

请求体

application/json

{

"confirmorId": 0

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

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

必填

format"int64"

查询参数

evalWorkload

Task eval workload

类型number

maximum10000

minimum0

actualWorkload

Task actual workload

类型number

maximum10000

minimum0

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

evalWorkload

actualWorkload

示例

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

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

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

必填

format"int64"

查询参数

bugLevel*

Bug level

类型string

必填

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

bugLevel*

示例

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

必填

format"int64"

请求体

application/json

{

"attachments": [

{

"name": "string",

"url": "string"

}

]

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

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

必填

format"int64"

查询参数

assocTaskIds*

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

assocTaskIds*

示例

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

必填

format"int64"

查询参数

assocTaskIds*

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

Cancel successfully

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

assocTaskIds*

示例

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

必填

format"int64"

查询参数

assocCaseIds*

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

assocCaseIds*

示例

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

必填

format"int64"

查询参数

assocCaseIds*

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

Cancel successfully

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

assocCaseIds*

示例

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

必填

format"int64"

请求体

application/json

{

"assigneeId": 0

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

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

必填

format"int64"

请求体

application/json

{

"workload": 0

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

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

试验场

授权

UserHttpBearer

变量

键

值

id*

主体

示例

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

必填

format"int64"

id

Task id

类型integer

format"int64"

name

Task name

类型string

code

Task code

类型string

softwareVersion

Version of software for the task

类型string

sprintId

Task sprint id

类型integer

format"int64"

moduleId

Task module id

类型integer

format"int64"

backlog

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

类型boolean

targetId

The scenario or api ID associated with the task

类型integer

format"int64"

targetParentId

The scenario dir or services ID associated with the task

类型integer

format"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

format"int64"

confirmorId

Confirmor id

类型integer

format"int64"

testerId

Tester id

类型integer

format"int64"

missingBug

Missing bug flag

类型boolean

unplanned

类型boolean

parentTaskId

Task parent id

类型integer

format"int64"

tagId

Tag id

类型integer

format"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

format"int32"

totalNum

The number of tasks processed

类型integer

format"int32"

execId

Execution id

类型integer

format"int64"

execBy

Execution user id

类型integer

format"int64"

execResult

Task execution result

类型string

枚举

"SUCCESS""FAIL"

startDate

Task start date

类型string

format"date-time"

deadlineDate

Task deadline

类型string

format"date-time"

confirmedDate

Task confirmed date

类型string

format"date-time"

completedDate

Task completed date

类型string

format"date-time"

processedDate

Task processed date

类型string

format"date-time"

canceledDate

Task canceled date

类型string

format"date-time"

execDate

Task execution date

类型string

format"date-time"

createdBy

Task creator

类型integer

format"int64"

createdDate

Task creation date

类型string

format"date-time"

lastModifiedBy

Task last modified user

类型integer

format"int64"

lastModifiedDate

Task last modified date

类型string

format"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

format"int64"

followBy

类型integer

format"int64"

commentBy

类型integer

format"int64"

pageNo

Page data size, default 1, maximum 100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

Page data size, default 10, maximum 2000

类型integer

format"int32"

maximum2000

minimum1

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

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/task

试验场

授权

UserHttpBearer

变量

键

值

projectId*

id

name

code

softwareVersion

sprintId

moduleId

backlog

targetId

targetParentId

taskType

bugLevel

testType

assigneeId

confirmorId

testerId

missingBug

unplanned

parentTaskId

tagId

priority

evalWorkload

actualWorkload

status

overdue

failNum

totalNum

execId

execBy

execResult

startDate

deadlineDate

confirmedDate

completedDate

processedDate

canceledDate

execDate

createdBy

createdDate

lastModifiedBy

lastModifiedDate

admin

hasPermission

favouriteBy

followBy

commentBy

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

Create task

POST

/api/v1/task

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/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

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/task

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Delete tasks

DELETE

/api/v1/task

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

Task ids

类型array

必填

maxItems200

minItems0

uniqueItemstrue

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/task

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

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

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/task/import

试验场

授权

UserHttpBearer

主体

projectId*

sprintId

strategyWhenDuplicated*

file*

示例

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

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/task/example/import

试验场

授权

UserHttpBearer

变量

键

值

projectId*

示例

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

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

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

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

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

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

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

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

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

{

"taskIds": [

0

],

"targetSprintId": 0

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/task/move

试验场

授权

UserHttpBearer

主体

示例

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

必填

format"int64"

查询参数

moduleId

Module id

类型integer

format"int64"

taskType

Task type

类型string

枚举

"REQUIREMENT""STORY""TASK""BUG""API_TEST""SCENARIO_TEST"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

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

试验场

授权

UserHttpBearer

变量

键

值

id*

moduleId

taskType

示例

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

必填

format"int64"

查询参数

moduleId

Module id

类型integer

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

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

试验场

授权

UserHttpBearer

变量

键

值

id*

moduleId

示例

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

必填

format"int64"

查询参数

moduleId

Module id

类型integer

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

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

试验场

授权

UserHttpBearer

变量

键

值

id*

moduleId

示例

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

必填

format"int64"

id

Task id

类型integer

format"int64"

name

Task name

类型string

code

Task code

类型string

softwareVersion

Version of software for the task

类型string

sprintId

Task sprint id

类型integer

format"int64"

moduleId

Task module id

类型integer

format"int64"

backlog

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

类型boolean

targetId

The scenario or api ID associated with the task

类型integer

format"int64"

targetParentId

The scenario dir or services ID associated with the task

类型integer

format"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

format"int64"

confirmorId

Confirmor id

类型integer

format"int64"

testerId

Tester id

类型integer

format"int64"

missingBug

Missing bug flag

类型boolean

unplanned

类型boolean

parentTaskId

Task parent id

类型integer

format"int64"

tagId

Tag id

类型integer

format"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

format"int32"

totalNum

The number of tasks processed

类型integer

format"int32"

execId

Execution id

类型integer

format"int64"

execBy

Execution user id

类型integer

format"int64"

execResult

Task execution result

类型string

枚举

"SUCCESS""FAIL"

startDate

Task start date

类型string

format"date-time"

deadlineDate

Task deadline

类型string

format"date-time"

confirmedDate

Task confirmed date

类型string

format"date-time"

completedDate

Task completed date

类型string

format"date-time"

processedDate

Task processed date

类型string

format"date-time"

canceledDate

Task canceled date

类型string

format"date-time"

execDate

Task execution date

类型string

format"date-time"

createdBy

Task creator

类型integer

format"int64"

createdDate

Task creation date

类型string

format"date-time"

lastModifiedBy

Task last modified user

类型integer

format"int64"

lastModifiedDate

Task last modified date

类型string

format"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

format"int64"

followBy

类型integer

format"int64"

commentBy

类型integer

format"int64"

pageNo

Page data size, default 1, maximum 100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

Page data size, default 10, maximum 2000

类型integer

format"int32"

maximum2000

minimum1

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

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/task/search

试验场

授权

UserHttpBearer

变量

键

值

projectId*

id

name

code

softwareVersion

sprintId

moduleId

backlog

targetId

targetParentId

taskType

bugLevel

testType

assigneeId

confirmorId

testerId

missingBug

unplanned

parentTaskId

tagId

priority

evalWorkload

actualWorkload

status

overdue

failNum

totalNum

execId

execBy

execResult

startDate

deadlineDate

confirmedDate

completedDate

processedDate

canceledDate

execDate

createdBy

createdDate

lastModifiedBy

lastModifiedDate

admin

hasPermission

favouriteBy

followBy

commentBy

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

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

必填

format"int64"

id

Task id

类型integer

format"int64"

name

Task name

类型string

code

Task code

类型string

softwareVersion

Version of software for the task

类型string

sprintId

Task sprint id

类型integer

format"int64"

moduleId

Task module id

类型integer

format"int64"

backlog

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

类型boolean

targetId

The scenario or api ID associated with the task

类型integer

format"int64"

targetParentId

The scenario dir or services ID associated with the task

类型integer

format"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

format"int64"

confirmorId

Confirmor id

类型integer

format"int64"

testerId

Tester id

类型integer

format"int64"

missingBug

Missing bug flag

类型boolean

unplanned

类型boolean

parentTaskId

Task parent id

类型integer

format"int64"

tagId

Tag id

类型integer

format"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

format"int32"

totalNum

The number of tasks processed

类型integer

format"int32"

execId

Execution id

类型integer

format"int64"

execBy

Execution user id

类型integer

format"int64"

execResult

Task execution result

类型string

枚举

"SUCCESS""FAIL"

startDate

Task start date

类型string

format"date-time"

deadlineDate

Task deadline

类型string

format"date-time"

confirmedDate

Task confirmed date

类型string

format"date-time"

completedDate

Task completed date

类型string

format"date-time"

processedDate

Task processed date

类型string

format"date-time"

canceledDate

Task canceled date

类型string

format"date-time"

execDate

Task execution date

类型string

format"date-time"

createdBy

Task creator

类型integer

format"int64"

createdDate

Task creation date

类型string

format"date-time"

lastModifiedBy

Task last modified user

类型integer

format"int64"

lastModifiedDate

Task last modified date

类型string

format"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

format"int64"

followBy

类型integer

format"int64"

commentBy

类型integer

format"int64"

pageNo

Page data size, default 1, maximum 100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

Page data size, default 10, maximum 2000

类型integer

format"int32"

maximum2000

minimum1

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

Content-Type

*/*

GET

/api/v1/task/export

试验场

授权

UserHttpBearer

变量

键

值

projectId*

id

name

code

softwareVersion

sprintId

moduleId

backlog

targetId

targetParentId

taskType

bugLevel

testType

assigneeId

confirmorId

testerId

missingBug

unplanned

parentTaskId

tagId

priority

evalWorkload

actualWorkload

status

overdue

failNum

totalNum

execId

execBy

execResult

startDate

deadlineDate

confirmedDate

completedDate

processedDate

canceledDate

execDate

createdBy

createdDate

lastModifiedBy

lastModifiedDate

admin

hasPermission

favouriteBy

followBy

commentBy

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---