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

调试

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

请求参数

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

系统规定参数。取值:GetTaskListFilter

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 任务名称

任务名称

OrderCondition String startDate

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

Order String DESC

排序顺序(ASC / DESC)

ExecutorId String 5ebbc0408123212b59xxxxx

执行者UserId

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,查询第一页数据时填空,接口会返回值NextPageToken标示下一页的值

ObjectType String TASK

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

TaskFlowStatusId String 5ebbc0408123212b59xxxxx

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

SprintId String 5ebbc0408123212b59xxxxx

迭代id

Extra String {}

其他扩展参数,暂时为空

返回数据

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

错误信息

RequestId String ASSDS-ASSASX-XSAXSA-XSAXSAXS

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

Successful String true

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

ErrorCode String ""

错误码

Object Object

任务

NextPageToken String xxxxxxxx

下一页的分页token

TotalSize Integer 20

任务总数

Result Array of Task

任务

IsFavorite Boolean false

是否已收藏

ExecutorId String 60b89885941c8f003fxxxxx

执行者id

ProjectId String 60b89885941c8f003fxxxxx

项目id

Priority Integer 1

优先级:

0:普通(默认值)

1:紧急

2:非常紧急

IsTopInProject Boolean false

是否顶级

ScenariofFeldConfigId String 60b89885941c8f003fxxxxx

任务类型id

ShareStatus Integer 1

分享状态,0表示未分享,1表示已分享

Accomplished String ""

无效参数已废弃

TaskListId String 60b89885941c8f003fxxxxx

任务id

Note String 备注

任务的备注信息

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

最后更新时间

UniqueId Integer 35

任务id

IsArchived Boolean false

是否归档

Content String 任务名称

任务名称

Rating Integer 0

无效参数已废弃

CommentsCount Integer 1

被评论的数量

TaskFlowStatusId String 60b89885941c8f003fxxxxx

任务流程状态id

Recurrence String “”

无效参数已废弃

ObjectType String task

任务类型

Progress Integer 0

进度0~100

UntilDate String ""

无效参数已废弃

StoryPoint String 0

故事点

ObjectlinksCount Integer 1

关联任务数

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

开始时间

Sprint String ""

迭代

CreatorId String 60b89885941c8f003fxxxxx

创建者id

Source String ""

无效参数已废弃

SourceId String ""

无效参数已废弃

SourceDate String ""

无效参数已废弃

OrganizationId String 60b89885941c8f003fxxxxx

企业id

LikesCount Integer 1

喜爱数

StageId String 60b89885941c8f003fxxxxx

阶段id

Visible String members

可见性

involves:任务参与者可见

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

IsDone Boolean false

是否完成

Parent String ""

父任务id

SprintId String 60b89885941c8f003fxxxxx

迭代id

AttachmentsCount Integer 1

附件的数量

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

截止时间

TaskUniqueId String ass-35

任务短号id

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

创建时间

TaskId String 60b89885941c8f003fxxxxx

任务id

Id String 60b89885941c8f003fxxxxx

任务id

Customfields Array of Customfield

自定义字段

Type String comongroup

自定义属性类型

commongroup: 缺陷分类

dropDown:单选选项

multipleChoice:多选选项

number:数字

date:日期

text:文本

cascading:层级

lookup:成员、版本

CustomfieldId String 60b89885941c8f003fxxxxx

自定义字段id

Values String ""

自定义字段值

Value Array of Value

自定义字段值

Id String 60b89885941c8f003fxxxxx

自定义字段id

Title String 自定义字段

自定义字段内容

InvolveMembers Array of String ['60b89885941c8f003fxxxxx']

参与者

TagIds Array of String 60b89885941c8f003fxxxxx

标签id

Labels Array of String 60b89885941c8f003fxxxxx

标签

Divisions Array of String 60b89885941c8f003fxxxxx

部门

AncestorIds Array of String xxx

无效参数已废弃

WorkTime Object

工作时间

UsedTime Integer 8

已用时间

TotalTime Integer 10

总时间

Unit String minute

单位 取值:minute, hour

Badges Object

提示

LikesCount Integer 0

喜欢的人数

ObjectlinksCount Integer 0

关联的任务数量

AttachmentsCount Integer 0

附件数量

CommentsCount Integer 0

评论数量

SubtaskCount Object

子任务数量

Done Integer 1

已完成的数量

Total Integer 10

总共的数量

Reminder Object

无效参数已废弃

Type String ""

无效参数已废弃

Date String ""

无效参数已废弃

CreatorId String 60b89885941c8f003fxxxxx

无效参数已废弃

Members Array of String ""

无效参数已废弃

Rules Array of String “”

无效参数已废弃

Creator Object

创建者信息

Name String test

创建者名称

AvatarUrl String http://aliyun.com

创建者头像

Id String 60b89885941c8f003fxxxxx

创建者Id

Stage Object

阶段

Name String 阶段名称

阶段名称

Id String 60b89885941c8f003fxxxxx

阶段id

Executor Object

执行者信息

Name String test

执行者名称

AvatarUrl String http://www.baidu.com

执行者头像

Id String 60b89885941c8f003fxxxxx

执行者id

TaskFlowStatus Object

任务流程

TaskFlowId String 60b89885941c8f003fxxxxx

任务流程id

Name String 已完成

流程状态

Pos Integer 1

状态位置

Kind String start

无效参数已废弃

Id String 60b89885941c8f003fxxxxx

任务流程状态id

示例

请求示例

http(s)://[Endpoint]/?Action=GetTaskListFilter
&OrgId=5ebbc0408123212b59xxxxx
&ProjectId=5ebbc0408123212b59xxxxx
&ScenarioFieldConfigId=5ebbc0408123212b59xxxxx
&Name=任务名称
&OrderCondition=startDate
&Order=DESC
&ExecutorId=5ebbc0408123212b59xxxxx
&TagId=5ebbc0408123212b59xxxxx
&DueDateStart=希望查询的开始时间(2020-11-24T16:00:00.000Z)
&DueDateEnd=希望查询的开始时间(2020-11-24T16:00:00.000Z)
&CreatorId=5ebbc0408123212b59xxxxx
&InvolveMembers=5ebbc0408123212b59xxxxx
&IsDone=false
&Priority=0
&PageSize=11
&PageToken=sssssssssssssssssssssss
&ObjectType=TASK
&TaskFlowStatusId=5ebbc0408123212b59xxxxx
&SprintId=5ebbc0408123212b59xxxxx
&Extra={}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

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