ListWorkitems_云效2020_API文档-阿里云OpenAPI开发者门户

流控信息

当前云产品API请求速率暂未透出。

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作
暂无数据

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>	工作项信息

没有我想要的错误码, 点击反馈

HTTP 状态码	错误码	错误信息	操作

400	Openapi.RequestError	request error	诊断
403	Operate.NoPermission	NoPermission	诊断

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