调用UpdateProjectField更新项目属性与字段_云效(Apsara Devops)-阿里云帮助中心

更新项目自身属性与自定义字段，以及项目状态

接口说明

更新项目自身属性与自定义字段，以及项目状态

调试

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

调试

授权信息

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

请求语法

POST /organization/{organizationId}/project/{identifier}

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业 id	5ebbc0228123212b59xxxxx
identifier	string	是	更新项目的唯一标识，项目 id	deafe5f33xxxxx6a259d8dafd
body	object	否	请求 Body
updateBasicFieldRequestList	array<object>	否	更新基础字段数组
	object	否	更新项目属性对象
propertyKey	string	否	项目基础属性 key 枚举值： scope：scope。 name：name。 description：description。 customCode：customCode。	name
propertyValue	string	否	更新后的值	名称
updateForOpenApiList	array<object>	否	更新项目自定义字段数组
	object	否	更新项目自定义字段对象
fieldIdentifier	string	否	字段唯一标识	c4fd21xxxxxxxx9oj8jk
value	string	否	字段值	字段值
statusIdentifier	string	否	状态唯一标识	fdsaadsfasxxxxdddd

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 id，每次请求都是唯一值，便于后续排查问题	ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorCode	string	错误码	Openapi.RequestError
errorMessage	string	错误信息	errormessage
success	boolean	true/false	True
project	object	项目信息
category	string	空间大类	Project
categoryIdentifier	string	空间大类 id，项目的值都是 Project	Project
creator	string	创建人阿里云 accountId	19xx7043xxxxxxx914
customCode	string	自定义编号，企业下唯一	OJAY
description	string	描述信息	api测试-创建
gmtCreate	long	创建时间的时间戳，单位毫秒	1623916393000
gmtModified	long	修改时间的时间戳，单位毫秒	1684134690000
iconGroup	string	图标组，json 格式字符串	{"small":"https://xxxxxx.png","big":"https://img.yyyyyy.png"}
icon	string	图标	https://xxxxxx.png
iconBig	string	大图标	https://xxxxxx.png
iconSmall	string	小图标	https://img.yyyyyy.png
id	string	项目 id	66893
identifier	string	项目唯一标识符	1e2ea73d24652d5874d001b351
identifierPath	string	空间路径	e8b2xxxxxx2abdxxxxxxxx23
logicalStatus	string	项目状态	NORMAL
modifier	string	修改人阿里云 accountId	19xx7043xxxxxxx914
name	string	项目名称	demo示例项目
organizationIdentifier	string	企业 id	5e70xxxxxxcd000xxxxe96
parentIdentifier	string	父项目 id	null
scope	string	可见范围	public
statusIdentifier	string	状态 id	8a40xxxxxxxxxxxxx64
statusStageIdentifier	string	状态阶段 id，项目状态默认有未开始、进行中、已完成，该字段为状态具体的 id。	8a4058a71159b68254......
subType	string	空间小类	null
typeIdentifier	string	空间小类 id，该字段已废弃	CustomProject
statusName	string	状态名称	进行中
fieldList	array<object>	字段列表
	object	字段对象
identifier	string	字段 id	b787ff504c0b36f8b71d15a4fd
displayName	string	展示名称	进行时
valueType	string	字段类型	user
value	string	字段值	ace3wxxxxxxx7rff3ee

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorCode": "Openapi.RequestError",
  "errorMessage": "errormessage",
  "success": true,
  "project": {
    "category": "Project",
    "categoryIdentifier": "Project",
    "creator": "19xx7043xxxxxxx914",
    "customCode": "OJAY",
    "description": "api测试-创建",
    "gmtCreate": 1623916393000,
    "gmtModified": 1684134690000,
    "iconGroup": "{\"small\":\"https://xxxxxx.png\",\"big\":\"https://img.yyyyyy.png\"}",
    "icon": "https://xxxxxx.png",
    "iconBig": "https://xxxxxx.png",
    "iconSmall": "https://img.yyyyyy.png",
    "id": "66893",
    "identifier": "1e2ea73d24652d5874d001b351",
    "identifierPath": "e8b2xxxxxx2abdxxxxxxxx23",
    "logicalStatus": "NORMAL",
    "modifier": "19xx7043xxxxxxx914",
    "name": "demo示例项目",
    "organizationIdentifier": "5e70xxxxxxcd000xxxxe96",
    "parentIdentifier": "null",
    "scope": "public",
    "statusIdentifier": "8a40xxxxxxxxxxxxx64",
    "statusStageIdentifier": "8a4058a71159b68254......",
    "subType": "null",
    "typeIdentifier": "CustomProject",
    "statusName": "进行中",
    "fieldList": [
      {
        "identifier": "b787ff504c0b36f8b71d15a4fd",
        "displayName": "进行时",
        "valueType": "user",
        "value": "ace3wxxxxxxx7rff3ee"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
403	Operate.NoPermission	NoPermission	没有权限

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

变更历史

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

暂无变更历史