调用ListWorkItemWorkFlowStatus API获取工作项工作流状态-云效-阿里云

获取工作项工作流状态列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /organization/{organizationId}/workitems/workflow/listWorkflowStatus

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】	5ebbc0228123212b59xxxxx
spaceType	string	是	空间类型	Project
workitemCategoryIdentifier	string	是	工作项大类型，需求为 Req，缺陷为 Bug，任务为 Task，风险为 Risk	Req
workitemTypeIdentifier	string	否	工作项小类型 id，可以从 ListProjectWorkitemTypes 获取，对应字段为 identifier。如果不填，则默认为默认工作流。	例：5e7xxxxb3cd3711dd6xxx2c
spaceIdentifier	string	是	项目 id，同 projectId 字段，项目唯一标识 id	例：5e70xxxxxxcd000xxxxe96

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 id，每次请求都是唯一值	ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorCode	string	错误返回码	例：Openapi.RequestError
errorMessage	string	错误返回信息	errormessage
success	boolean	接口是否正常返回	true或者false
statuses	array<object>	工作流状态
	object
identifier	string	工作流状态 id	dfexxxxxf4fee18xxxxx36
name	string	工作流状态名称	例：待处理
workflowStageName	string	阶段信息-名称	例：确认阶段
workflowStageIdentifier	string	阶段信息-阶段的唯一标识	例如：1
source	string	状态来源，system：系统默认的，custom:企业、项目或者团队新建的	system
gmtCreate	long	创建时间	1620455467000
creator	string	状态的创建人	用户阿里云pk，例如19xxxx31947xxxx
description	string	描述	该状态的具体信息
modifier	string	修改人	用户阿里云pk，例如19xxxx31947xxxx
gmtModified	long	更新时间	1641870287000
resourceType	string	状态作用的资源类型，项目：Project，工作项：Workitem	Workitem

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorCode": "例：Openapi.RequestError",
  "errorMessage": "errormessage",
  "success": true,
  "statuses": [
    {
      "identifier": "dfexxxxxf4fee18xxxxx36",
      "name": "例：待处理",
      "workflowStageName": "例：确认阶段",
      "workflowStageIdentifier": "例如：1",
      "source": "system",
      "gmtCreate": 1620455467000,
      "creator": "用户阿里云pk，例如19xxxx31947xxxx",
      "description": "该状态的具体信息",
      "modifier": "用户阿里云pk，例如19xxxx31947xxxx",
      "gmtModified": 1641870287000,
      "resourceType": "Workitem"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	Openapi.RequestError	request error	OpenAPI请求数据错误
403	Operate.NoPermission	NoPermission	没有权限

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史