TaskSprint

Task Sprint Management - Provides a dedicated entry point for managing the iterations of tasks, enabling teams to track progress and make adjustments throughout the development cycle

---

Query the list of task sprint

GET

/api/v1/task/sprint

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

类型integer

格式"int64"

projectId*

Project id

类型integer

必填

格式"int64"

name

类型string

status

类型string

有效值

"PENDING""IN_PROGRESS""COMPLETED""BLOCKED"

startDate

类型string

格式"date-time"

deadlineDate

类型string

格式"date-time"

ownerId

类型integer

格式"int64"

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

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/task/sprint

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

name

status

startDate

deadlineDate

ownerId

createdBy

createdDate

lastModifiedBy

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

---

Replace task sprint

PUT

/api/v1/task/sprint

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 0,

"projectId": 0,

"auth": true,

"name": "Example sprint",

"startDate": "2023-06-10 00:00:00",

"deadlineDate": "2023-06-20 00:00:00",

"ownerId": 0,

"taskPrefix": "EXAMPLE_",

"evalWorkloadMethod": "STORY_POINT",

"attachments": [

{

"name": "string",

"url": "string"

}

],

"acceptanceCriteria": "string",

"otherInformation": "string"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/task/sprint

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Add task sprint

POST

/api/v1/task/sprint

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"projectId": 0,

"name": "Example sprint",

"auth": true,

"startDate": "2023-06-10 00:00:00",

"deadlineDate": "2023-06-20 00:00:00",

"ownerId": 0,

"taskPrefix": "EXAMPLE_",

"evalWorkloadMethod": "STORY_POINT",

"attachments": [

{

"name": "string",

"url": "string"

}

],

"acceptanceCriteria": "string",

"otherInformation": "string"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/task/sprint

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Update task sprint

PATCH

/api/v1/task/sprint

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"id": 0,

"name": "Example sprint",

"startDate": "2023-06-10 00:00:00",

"deadlineDate": "2023-06-20 00:00:00",

"ownerId": 1,

"evalWorkloadMethod": "STORY_POINT",

"attachments": [

{

"name": "string",

"url": "string"

}

],

"acceptanceCriteria": "string",

"otherInformation": "string"

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/task/sprint

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Move task sprint to another project

PATCH

/api/v1/task/sprint/{id}/{targetProjectId}/move

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Sprint id

类型integer

必填

格式"int64"

targetProjectId*

Target project id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/task/sprint/{id}/{targetProjectId}/move

试验场

授权

UserHttpBearer

变量

键

值

id*

targetProjectId*

示例

cURL

JavaScript

PHP

Python

---

Start task sprint

PATCH

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

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Sprint id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

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

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

End task sprint

PATCH

/api/v1/task/sprint/{id}/end

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Sprint id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/task/sprint/{id}/end

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Clone task sprint

PATCH

/api/v1/task/sprint/{id}/clone

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Sprint id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/task/sprint/{id}/clone

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Block task sprint

PATCH

/api/v1/task/sprint/{id}/block

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Sprint id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/task/sprint/{id}/block

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Restart the task of sprint

PATCH

/api/v1/task/sprint/task/restart

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

类型array

必填

最大项数200

最小项数0

唯一项true

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/task/sprint/task/restart

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

Reopen the task of sprint

PATCH

/api/v1/task/sprint/task/reopen

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

类型array

必填

最大项数200

最小项数0

唯一项true

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/task/sprint/task/reopen

试验场

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

Query the detail of task sprint

GET

/api/v1/task/sprint/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Sprint id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/task/sprint/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Delete task sprint

DELETE

/api/v1/task/sprint/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Sprint id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/task/sprint/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Fulltext search the list of task sprint

GET

/api/v1/task/sprint/search

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

类型integer

格式"int64"

projectId*

Project id

类型integer

必填

格式"int64"

name

类型string

status

类型string

有效值

"PENDING""IN_PROGRESS""COMPLETED""BLOCKED"

startDate

类型string

格式"date-time"

deadlineDate

类型string

格式"date-time"

ownerId

类型integer

格式"int64"

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

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/task/sprint/search

试验场

授权

UserHttpBearer

变量

键

值

id

projectId*

name

status

startDate

deadlineDate

ownerId

createdBy

createdDate

lastModifiedBy

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

---