ListWorkitems
获取工作项列表
服务地址：
华东1（杭州）
输入参数
只看必填
organizationId企业标识
spaceType资源类型
spaceIdentifier项目id
category工作项大类型
nextToken第一页值不需要填写
maxResults每页最大返回数量
conditions过滤条件
extraConditions额外条件
groupCondition
orderBy排序顺序
searchType搜索类型
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

请求语法

GET /organization/{organizationId}/listWorkitems HTTP/1.1

路径参数

字段名称字段详情
organizationIdstring

企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】

示例值:5ebbc0228123212b59xxxxx参考取值来源:
    GetCodeupOrganization
    ListOrganizations

请求参数

字段名称字段详情
spaceTypestring

资源类型

示例值:Project
spaceIdentifierstring

项目 id，同 projectId，项目唯一标识 id

示例值:8fb83debd69a6c7c6626......
categorystring

工作项大类型，需求为 Req，缺陷为 Bug，任务为 Task，风险为 Risk，原始诉求为 Request，主题为 Topic

示例值:Req
nextTokenstring

第一页值不需要填写，后面每一页的值需要从前一次调用结果中获取到此字段，然后获取后面的分页数据

示例值:""
maxResultsstring

每页最大返回数量，0-200，默认值 20

示例值:20
conditionsstring

过滤条件，可以参考页面上的工作项列表中请求 workitem/list 的搜索参数。展开详情

示例值:{"conditionGroups":[]}
extraConditionsstring

额外条件，当该字段不为空时，conditions 也不能为空

示例值:{"conditionGroups":[]}
groupConditionstring

分组条件，可以参考页面上的工作项列表中请求 workitem/list 的搜索参数。展开详情

示例值:{"fieldIdentifier":"tag","className":"tag","format":"multiList","value":["c76e0e4bf64801cfad73......"],"operator":"EQUALS"}
orderBystring

排序顺序，可以参考页面上的工作项列表中请求 workitem/list 的搜索参数。展开详情

示例值:{"fieldIdentifier":"status","format":"list","order":"desc","className":"status"}
searchTypestring

搜索类型，默认是 LIST，还可支持树形 TREE 等类型，具体更多参见页面请求的参数。

示例值:LIST

返回参数

字段名称字段详情
totalCountinteger<int64>

总数

注意 请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。
示例值:10
nextTokenstring

分页 Token，没有下一页则为空

示例值:""
maxResultsinteger<int64>

每页数量

注意 请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。
示例值:20
requestIdstring

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

示例值:ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMsgstring

错误信息

示例值:error
errorCodestring

错误码

示例值:Openapi.RequestError
successboolean

true 或者 false

示例值:true
workitemsarray<object>

工作项信息

变更历史
变更时间变更内容概要操作
2023-11-07
变更返回参数
2022-02-24
新增请求参数conditions