首页 云效2020 开发参考 API手册(新版) API目录 项目管理(Projex) 工作项 ListWorkItemWorkFlowStatus - 获取工作项工作流状态列表

ListWorkItemWorkFlowStatus - 获取工作项工作流状态列表

更新时间: 2023-08-17 21:03:05

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

调试

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

调试

授权信息

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

请求语法

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

请求参数

名称类型必填描述示例值
organizationIdstring

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

5ebbc0228123212b59xxxxx
spaceTypestring

空间类型

Project
workitemCategoryIdentifierstring

工作项大类型,需求为Req,缺陷为Bug,任务为Task,风险为Risk

Req
workitemTypeIdentifierstring

工作项小类型id,可以从ListProjectWorkitemTypes获取,对应字段为identifier。如果不填,则默认为默认工作流。

例:5e7xxxxb3cd3711dd6xxx2c
spaceIdentifierstring

项目id,同projectId字段,项目唯一标识id

例:5e70xxxxxxcd000xxxxe96

返回参数

名称类型描述示例值
object
requestIdstring

请求id,每次请求都是唯一值

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorCodestring

错误返回码

例:Openapi.RequestError
errorMessagestring

错误返回信息

errormessage
successboolean

接口是否正常返回

true或者false
statusesobject []

工作流状态

identifierstring

工作流状态id

dfexxxxxf4fee18xxxxx36
namestring

工作流状态名称

例:待处理
workflowStageNamestring

阶段信息-名称

例:确认阶段
workflowStageIdentifierstring

阶段信息-阶段的唯一标识

例如:1
sourcestring

状态来源,system:系统默认的,custom:企业、项目或者团队新建的

system
gmtCreatelong

创建时间

1620455467000
creatorstring

状态的创建人

用户阿里云pk,例如19xxxx31947xxxx
descriptionstring

描述

该状态的具体信息
modifierstring

修改人

用户阿里云pk,例如19xxxx31947xxxx
gmtModifiedlong

更新时间

1641870287000
resourceTypestring

状态作用的资源类型,项目: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错误码错误信息描述
400Openapi.RequestErrorrequest errorOpenAPI请求数据错误
403Operate.NoPermissionNoPermission没有权限

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

阿里云首页 云效2020 相关技术圈