可以获取项目下任务状态、迭代、执行者等
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetProjectOption |
系统规定参数。取值:GetProjectOption。 |
OrgId | String | 是 | 5ebbc0408123212b59xxxxx |
企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrgId】 |
ProjectId | String | 是 | 60af1829a1dee1003fxxxxx |
项目ID,可以在项目链接中获取,如 https://devops.aliyun.com/project/【ProjectId】/story/section/all |
Query | String | 是 | q |
搜索条件 |
Type | String | 是 | taskflowstatusId |
executorId 执行人,creatorId 创建人,tagId 标签,involveMembers 参与者,sprintId 迭代,taskflowstatusId 任务状态 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ErrorCode | String | “” |
错误码 |
ErrorMsg | String | “” |
错误信息 |
Object | Array of Option |
返回结果 |
|
Kind | String | start |
type 为taskflowstatusId 才有值 |
Name | String | 执行人name |
name,用户名、迭代名、任务状态、tag名称等 |
ScopeName | String | 需求默认工作流 |
type 为taskflowstatusId 才有值,用于说明任务状态的scope例如需求默认工作流 |
Value | String | 60b89885941c8f003fxxxxx |
返回值id,为用户Id,迭代id,tagid 等 |
RequestId | String | ASSDS-ASSASX-XSAXSA-XSAXSAXS |
请求id,每次请求都是唯一值,便于后续排查问题 |
Successful | Boolean | true |
true 接口调用成功,false 接口调用失败 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetProjectOption
&OrgId=5ebbc0408123212b59xxxxx
&ProjectId=60af1829a1dee1003fxxxxx
&Query=q
&Type=taskflowstatusId
&<公共请求参数>
正常返回示例
JSON
格式
{"RequestId":"ASSDS-ASSASX-XSAXSA-XSAXSAXS","ErrorMsg":"“”","Object":[{"ScopeName":"需求默认工作流","Kind":"start","Value":"60b89885941c8f003fxxxxx","Name":"执行人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. | 当前用户不属于该企业 |
访问错误中心查看更多错误码。