部分更新一个项目 - PingCodeRESTAPI

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

project_id

string

必需

示例值:

Body 参数application/json

name

string

项目的名称。

可选

identifier

string

可选

项目的标识。在一个企业中这个标识是唯一的。项目的标识由大写英文字母/数字/下划线/连接线组成（不超过15个字符）。

description

string

项目的描述。

可选

start_at

number

项目开始的时间。

可选

end_at

number

项目结束的时间。

可选

assignee_id

string

项目负责人的id。

可选

state

string

可选

项目状态。允许值: normal, warning, delay

properties

object

可选

项目自定义属性的键值对集合。需要注意自定义属性需要包含在项目属性方案中。例如属性方案中包含prop_a和prop_b。

prop_a

object

可选

项目自定义属性prop_a。

prop_b

object

可选

项目自定义属性prop_b。

示例

{
  "name": "Scrum项目",
  "identifier": "SCR",
  "description": "这是一个scrum类型的项目",
  "start_at": 1680278400,
  "end_at": 1682870399,
  "assignee_id": "a0417f68e846aae315c85d24643678a9",
  "state": "normal",
  "properties": {
    "prop_a": "prop_a_value",
    "prop_b": "prop_b_value"
  }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request PATCH 'https://open.pingcode.com/v1/agile/projects/{{project_id}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Scrum项目",
    "identifier": "SCR",
    "description": "这是一个scrum类型的项目",
    "start_at": 1680278400,
    "end_at": 1682870399,
    "assignee_id": "a0417f68e846aae315c85d24643678a9",
    "state": "normal",
    "properties": {
        "prop_a": "prop_a_value",
        "prop_b": "prop_b_value"
    }
}'

返回响应

🟢200成功

application/json

Body

id

string

必需

url

string

必需

identifier

string

必需

name

string

必需

type

string

必需

assignee

object

必需

id

string

必需

url

string

必需

name

string

必需

display_name

string

必需

avatar

string

必需

state

string

必需

start_at

integer

必需

end_at

integer

必需

color

string

必需

description

string

必需

properties

object

必需

prop_a

string

必需

prop_b

string

必需

members

array [object {4}]

必需

id

string

可选

url

string

可选

type

string

可选

user

object

可选

created_at

integer

必需

created_by

object

必需

id

string

必需

url

string

必需

name

string

必需

display_name

string

必需

avatar

string

必需

updated_at

integer

必需

updated_by

object

必需

id

string

必需

url

string

必需

name

string

必需

display_name

string

必需

avatar

string

必需

is_archived

integer

必需

is_deleted

integer

必需

示例

{
  "id": "5eb623f6a70571487ea47000",
  "url": "https://rest_api_root/v1/project/projects/5eb623f6a70571487ea47000",
  "identifier": "SCR",
  "name": "Scrum项目",
  "type": "scrum",
  "assignee": {
    "id": "8168dd057b104c81bceb2e48bdf283d0",
    "url": "http://rest_api_root/v1/directory/users/8168dd057b104c81bceb2e48bdf283d0",
    "name": "john",
    "display_name": "john",
    "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
  },
  "state": "normal",
  "start_at": 1680278400,
  "end_at": 1682870399,
  "color": "#F693E7",
  "description": "这是一个scrum类型的项目",
  "properties": {
    "prop_a": "prop_a_value",
    "prop_b": "prop_b_value"
  },
  "members": [
    {
      "id": "a0417f68e846aae315c85d24643678a9",
      "url": "https://rest_api_root/v1/project/projects/5eb623f6a70571487ea47000/members/a0417f68e846aae315c85d24643678a9",
      "type": "user",
      "user": {
        "id": "a0417f68e846aae315c85d24643678a9",
        "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
        "name": "john",
        "display_name": "John",
        "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
      }
    }
  ],
  "created_at": 1583290300,
  "created_by": {
    "id": "a0417f68e846aae315c85d24643678a9",
    "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
    "name": "john",
    "display_name": "John",
    "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
  },
  "updated_at": 1583293300,
  "updated_by": {
    "id": "a0417f68e846aae315c85d24643678a9",
    "url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
    "name": "john",
    "display_name": "John",
    "avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
  },
  "is_archived": 0,
  "is_deleted": 0
}