文档

ListWorkItemAllFields - 获取工作项字段列表

更新时间:

获取工作项字段列表。

调试

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

授权信息

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

请求语法

GET /organization/{organizationId}/workitems/fields/listAll

请求参数

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

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

5ebbc0228123212b59xxxxx
spaceTypestring

资源类型

Project
spaceIdentifierstring

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

e8bxxxxxxxxxxxxxxxx23
workitemTypeIdentifierstring

工作项类型 id,工作项类型的列表和 ID 可以从 ListProjectWorkitemTypes 中获取

dfexxxxxf4fee18xxxxx36

返回参数

名称类型描述示例值
object
requestIdstring

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

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMsgstring

错误信息

error
errorCodestring

错误码

Openapi.RequestError
successboolean

true 或者 false

true
fieldsarray<object>

字段信息

object
creatorstring

创建人阿里云 accountId

19xx7043xxxxxxx914
descriptionstring

描述信息

字段的具体信息
gmtCreatelong

创建时间的时间戳,单位毫秒

1623916393000
gmtModifiedlong

修改时间的时间戳,单位毫秒

1623916393000
typestring

区分不同的类型,如系统字段:NativeField,用户自定义字段:CustomField

NativeField
identifierstring

字段唯一标识符

e8bxxxxxxxxxxxxxxxx23
modifierstring

修改人阿里云 accountId

19xx7043xxxxxxx914
namestring

字段名称

负责人
formatstring

字段格式

list
classNamestring

字段类型

例:date
resourceTypestring

区分不同的适用对象

例:Workitem
defaultValuestring

默认值

123
isRequiredboolean

是否必填

false
isSystemRequiredboolean

是否是系统必须字段,比如:负责人、状态等。

false
linkWithServicestring

联动的服务,比如迭代,迭代服务开启/关闭,这个字段加进/剔除出对应的模板; 字段模板里,这类字段不能手动添加或删除

null
isShowWhenCreateboolean

创建时是否展示

false
optionsarray<object>

待选值

object
identifierstring

待选值的唯一标识

重复的缺陷
fieldIdentifierstring

字段唯一标识

e8bxxxxxxxxxxxxxxxx23
valuestring

待选值中文名称

重复的缺陷
valueEnstring

待选值英文名称

null
displayValuestring

根据语言环境获取当前展示的值

重复的缺陷
positionlong

待选值顺序

1
levellong

展示级别,数字范围 1~9,数字越大,颜色越浅。

1

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorMsg": "error",
  "errorCode": "Openapi.RequestError",
  "success": true,
  "fields": [
    {
      "creator": "19xx7043xxxxxxx914",
      "description": "字段的具体信息",
      "gmtCreate": 1623916393000,
      "gmtModified": 1623916393000,
      "type": "NativeField",
      "identifier": "e8bxxxxxxxxxxxxxxxx23",
      "modifier": "19xx7043xxxxxxx914",
      "name": "负责人",
      "format": "list",
      "className": "例:date",
      "resourceType": "例:Workitem",
      "defaultValue": "123",
      "isRequired": false,
      "isSystemRequired": false,
      "linkWithService": "null",
      "isShowWhenCreate": false,
      "options": [
        {
          "identifier": "重复的缺陷",
          "fieldIdentifier": "e8bxxxxxxxxxxxxxxxx23",
          "value": "重复的缺陷",
          "valueEn": "null",
          "displayValue": "重复的缺陷",
          "position": 1,
          "level": 1
        }
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Openapi.RequestErrorrequest errorOpenAPI请求数据错误
403Operate.NoPermissionNoPermission没有权限

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

变更历史

变更时间变更内容概要操作
暂无变更历史