可以筛选任务、需求、缺陷

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetTaskListFilter

系统规定参数。取值:GetTaskListFilter。

ObjectType String TASK

任务类型(TASK/BUG/STORY 对应任务/缺陷/需求)

Order String DESC

排序顺序(ASC / DESC)

OrderCondition String startDate

排序条件( startDate 按开始时间最晚 priority 按照优先级 created 按照创建时间 created 按照创建时间 updated 按照更新时间 updated 按照更新时间 dueDate 按截止时间)

OrgId String 5ebbc0408123212b59xxxxx

企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如

https://devops.aliyun.com/organization/【OrgId】

ProjectId String 5ebbc0408123212b59xxxxx

项目ID,可以在项目链接中获取,如

https://devops.aliyun.com/project/【ProjectId】/story/section/all

ScenarioFieldConfigId String 5ebbc0408123212b59xxxxx

任务类型Id,通过API ListDevopsScenarioFieldConfig 获取

Name String 任务名称

任务名称

ExecutorId String 5ebbc0408123212b59xxxxx

执行者

TagId String 5ebbc0408123212b59xxxxx

项目ID,可以在项目链接中获取,如

https://devops.aliyun.com/project/【ProjectId】/story/section/all

DueDateStart String 希望查询的开始时间(2020-11-24T16:00:00.000Z)

希望查询的开始时间(2020-11-24T16:00:00.000Z)

DueDateEnd String 希望查询的开始时间(2020-11-24T16:00:00.000Z)

希望查询的结束时间

CreatorId String 5ebbc0408123212b59xxxxx

创建人

InvolveMembers String 5ebbc0408123212b59xxxxx

参与人

IsDone Boolean false

是否已经完成

Priority String 0

优先级(-10 较低 / 0 普通 / 1 紧急 / 2 非常紧急 ),多个以逗号","分隔

PageSize Integer 11

每页个数

PageToken String sssssssssssssssssssssss

分页token

TaskFlowStatusId String 5ebbc0408123212b59xxxxx

任务状态,多个以逗号","分隔

SprintId String 5ebbc0408123212b59xxxxx

迭代id

Extra String {}

其他

返回数据

名称 类型 示例值 描述
ErrorCode String “”

错误码

ErrorMsg String “”

错误信息

Object Struct

任务

NextPageToken String xxxxxxxx

分页token

Result Array of Task

任务

Accomplished String ""

""

AncestorIds List []

AttachmentsCount Integer 0

0

Badges Struct

提示

AttachmentsCount Integer 0

0

CommentsCount Integer 0

0

LikesCount Integer 0

0

ObjectlinksCount Integer 0

0

CommentsCount Integer 1

评论数

Content String 任务名称

任务名称

Created String 2020-11-30T03:34:10.539Z

创建时间

Creator Struct

创建者

AvatarUrl String http://aliyun.com

创建者头像

Id String 60b89885941c8f003fxxxxx

创建者Id

Name String 创建者名称

创建者名称

CreatorId String 60b89885941c8f003fxxxxx

创建者

Customfields Array of Customfield

自定义字段

CustomfieldId String 60b89885941c8f003fxxxxx

自定义字段id

Type String comongroup

自定义属性类型

commongroup: 缺陷分类

dropDown:单选选项

multipleChoice:多选选项

number:数字

date:日期

text:文本

cascading:层级

lookup:成员、版本

Value Array of Value

自定义字段值

Id String 60b89885941c8f003fxxxxx

自定义字段id

Title String 自定义字段

自定义字段内容

Values String ""

自定义字段值

Divisions List []

DueDate String 2020-11-30T03:34:10.539Z

截止时间

Executor Struct

执行者

AvatarUrl String http://www.baidu.com

执行者头像

Id String 60b89885941c8f003fxxxxx

执行者id

Name String 执行者

执行者名称

ExecutorId String 60b89885941c8f003fxxxxx

执行者id

Id String 60b89885941c8f003fxxxxx

任务id

InvolveMembers List ['60b89885941c8f003fxxxxx']

参与者

IsArchived Boolean false

是否归档

IsDone Boolean false

是否完成

IsFavorite Boolean false

是否

IsTopInProject Boolean false

是否顶级

Labels List 60b89885941c8f003fxxxxx

标签

LikesCount Integer 1

喜爱数

Note String 备注

备注

ObjectType String task

任务类型

ObjectlinksCount Integer 1

关联任务数

OrganizationId String 60b89885941c8f003fxxxxx

企业id

Parent String ""

父任务id

Pos Integer 1

位置

Priority Integer 1

优先级:

0:普通(默认值)

1:紧急

2:非常紧急

Progress Integer 0

0

ProjectId String 60b89885941c8f003fxxxxx

项目id

Rating Integer 0

0

Recurrence String “”

“”

Reminder Struct

提醒

CreatorId String 60b89885941c8f003fxxxxx

创建人

Date String nul

时间

Members List 60b89885941c8f003fxxxxx

成员

Rules List []

规则

Type String unset

unset

ScenariofFeldConfigId String 60b89885941c8f003fxxxxx

任务类型id

ShareStatus Integer 1

1

Source String {}

source

SourceDate String 2020-11-30T03:34:10.539Z

source date

SourceId String 60b89885941c8f003fxxxxx

source id

Sprint String {}

迭代

SprintId String 60b89885941c8f003fxxxxx

迭代id

Stage Struct

阶段

Id String 60b89885941c8f003fxxxxx

阶段id

Name String 阶段名称

阶段名称

StageId String 60b89885941c8f003fxxxxx

阶段id

StartDate String 2020-11-30T03:34:10.539Z

开始时间

StoryPoint String 0

故事点

SubtaskCount Struct

子任务数

Done Integer 1

完成的任务数

Total Integer 1

总任务数

TagIds List 60b89885941c8f003fxxxxx

标签id

TaskFlowStatus Struct

任务流程

Id String 60b89885941c8f003fxxxxx

任务流程状态id

Kind String start

类型

Name String 已完成

流程状态

Pos Integer 1

状态位置

TaskFlowId String 60b89885941c8f003fxxxxx

任务流程id

TaskFlowStatusId String 60b89885941c8f003fxxxxx

任务流程状态id

TaskId String 60b89885941c8f003fxxxxx

任务Id

TaskListId String 60b89885941c8f003fxxxxx

任务列表Id

TaskUniqueId String ass-35

任务Id

UniqueId Integer 35

任务id

UntilDate String 2020-11-30T03:34:10.539Z

2020-11-30T03:34:10.539Z

Updated String 2020-11-30T03:34:10.539Z

最后更新时间

Visible String members

可见性

involves:任务参与者可见

members:项目成员可见(默认值)

WorkTime Struct

工作时间

TotalTime Integer 0

总时间

Unit String minute

单位

UsedTime Integer 0

已用时间

TotalSize Integer 20

任务总数

RequestId String ASSDS-ASSASX-XSAXSA-XSAXSAXS

请求id,每次请求都是唯一值,便于后续排查问题

Successful String true

true 接口调用成功,false 接口调用失败

示例

请求示例

http(s)://[Endpoint]/?Action=GetTaskListFilter
&ObjectType=TASK
&Order=DESC
&OrderCondition=startDate
&OrgId=5ebbc0408123212b59xxxxx
&ProjectId=5ebbc0408123212b59xxxxx
&ScenarioFieldConfigId=5ebbc0408123212b59xxxxx
&<公共请求参数>

正常返回示例

JSON格式

{"RequestId":"ASSDS-ASSASX-XSAXSA-XSAXSAXS","ErrorMsg":"“”","Object":{"NextPageToken":"xxxxxxxx","TotalSize":"20","Result":[{"UntilDate":"2020-11-30T03:34:10.539Z","Recurrence":"“”","SourceDate":"2020-11-30T03:34:10.539Z","TaskId":"60b89885941c8f003fxxxxx","Accomplished":"\"\"","Parent":"\"\"","TaskUniqueId":"ass-35","Rating":"0","SourceId":"60b89885941c8f003fxxxxx","StageId":"60b89885941c8f003fxxxxx","TaskListId":"60b89885941c8f003fxxxxx","SprintId":"60b89885941c8f003fxxxxx","OrganizationId":"60b89885941c8f003fxxxxx","Source":"{}","TaskFlowStatusId":"60b89885941c8f003fxxxxx","Created":"2020-11-30T03:34:10.539Z","StartDate":"2020-11-30T03:34:10.539Z","ObjectType":"task","ExecutorId":"60b89885941c8f003fxxxxx","Visible":"members","DueDate":"2020-11-30T03:34:10.539Z","LikesCount":"1","UniqueId":"35","Progress":"0","Updated":"2020-11-30T03:34:10.539Z","ScenariofFeldConfigId":"60b89885941c8f003fxxxxx","Priority":"1","CreatorId":"60b89885941c8f003fxxxxx","ProjectId":"60b89885941c8f003fxxxxx","ShareStatus":"1","IsDone":"false","StoryPoint":"0","IsFavorite":"false","AttachmentsCount":"0","IsArchived":"false","IsTopInProject":"false","Pos":"1","Content":"任务名称","CommentsCount":"1","Note":"备注","Sprint":"{}","Id":"60b89885941c8f003fxxxxx","ObjectlinksCount":"1","Customfields":[{"CustomfieldId":"60b89885941c8f003fxxxxx","Type":"comongroup","Values":"\"\"","Value":[{"Title":"自定义字段","Id":"60b89885941c8f003fxxxxx"}]}],"AncestorIds":"[]","Labels":"60b89885941c8f003fxxxxx","TagIds":"60b89885941c8f003fxxxxx","InvolveMembers":"['60b89885941c8f003fxxxxx']","Divisions":"[]","WorkTime":{"UsedTime":"0","TotalTime":"0","Unit":"minute"},"Badges":{"LikesCount":"0","CommentsCount":"0","ObjectlinksCount":"0","AttachmentsCount":"0"},"SubtaskCount":{"Done":"1","Total":"1"},"Reminder":{"Type":"unset","CreatorId":"60b89885941c8f003fxxxxx","Date":"nul","Members":"60b89885941c8f003fxxxxx","Rules":"[]"},"Creator":{"AvatarUrl":"http://aliyun.com","Id":"60b89885941c8f003fxxxxx","Name":"创建者名称"},"Stage":{"Id":"60b89885941c8f003fxxxxx","Name":"阶段名称"},"Executor":{"AvatarUrl":"http://www.baidu.com","Id":"60b89885941c8f003fxxxxx","Name":"执行者"},"TaskFlowStatus":{"Pos":"1","Kind":"start","Id":"60b89885941c8f003fxxxxx","TaskFlowId":"60b89885941c8f003fxxxxx","Name":"已完成"}}]},"ErrorCode":"“”","Successful":"true"}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidOrganization.NotFound The specified organization doe not exist. 企业信息有误,未找到该企业
404 InvalidUser.NotFound The specified user does not exist. 用户数据有误,未找到该用户
400 InvalidUser.UserNotInCurrentOrganization The user does not belong to the specified organization. 当前用户不属于该企业

访问错误中心查看更多错误码。