部分更新一个需求 - PingCodeRESTAPI

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Path 参数

idea_id

string

必需

示例值:

Body 参数application/json

title

string

可选

需求的标题，最大长度为255。

description

string

需求的描述。

可选

state_id

string

可选

需求状态的id，您可以在获取需求状态列表 API获取。

priority_id

string

可选

需求优先级的id，您可以在获取需求优先级列表 API获取。

assignee_id

string

需求负责人的id。

可选

progress

number

可选

需求的进度，取值范围为：0到1的两位小数。

plan_at

object

可选

需求的计划时间。plan_at是整体更新的，其中包含from、to、granularity三个属性，均为必填。

from

number

必需

需求的计划开始时间。为秒级时间戳。

to

number

必需

需求的计划结束时间。为秒级时间戳。

granularity

string

必需

需求的计划时间周期单位。允许值: year, quarter, month, day

real_at

object

可选

需求的实际时间，参数格式同plan_at。

from

number

必需

to

number

必需

granularity

string

必需

plan_id

string

可选

产品排期的id，您可以在获取产品排期列表 API获取。

suite_id

string

可选

产品模块的id，您可以在获取产品模块列表 API获取。

properties

object

需求的自定义属性。

可选

prop_a

string

可选

需求的自定义属性prop_a。

prop_b

string

可选

需求的自定义属性prop_b。

示例

{
    "title": "示例需求",
    "description": "这是一段描述",
    "state_id": "63e1bf51898a0be5a2d21b2a",
    "priority_id": "5cb9466afda1ce4ca0090005",
    "assignee_id": "a0417f68e846aae315c85d24643678a9",
    "progress": 0.88,
    "plan_at": {
        "from": 1690732800,
        "to": 1691337599,
        "granularity": "day"
    },
    "real_at": {
        "from": 1690732800,
        "to": 1691337599,
        "granularity": "day"
    },
    "plan_id": "63bb744414bd13c9def24ce4",
    "suite_id": "63bb744414bd13c9def24ce4",
    "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/ship/ideas/{idea_id}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "示例需求",
    "description": "这是一段描述",
    "state_id": "63e1bf51898a0be5a2d21b2a",
    "priority_id": "5cb9466afda1ce4ca0090005",
    "assignee_id": "a0417f68e846aae315c85d24643678a9",
    "progress": 0.88,
    "plan_at": {
        "from": 1690732800,
        "to": 1691337599,
        "granularity": "day"
    },
    "real_at": {
        "from": 1690732800,
        "to": 1691337599,
        "granularity": "day"
    },
    "plan_id": "63bb744414bd13c9def24ce4",
    "suite_id": "63bb744414bd13c9def24ce4",
    "properties": {
        "prop_a": "prop_a_value",
        "prop_b": "prop_b_value"
    }
}'

返回响应

🟢200成功

application/json

Body

id

string

必需

url

string

必需

product

object

必需

id

string

必需

url

string

必需

identifier

string

必需

name

string

必需

identifier

string

必需

title

string

必需

assignee

object

必需

id

string

必需

url

string

必需

name

string

必需

display_name

string

必需

avatar

string

必需

state

object

必需

id

string

必需

url

string

必需

name

string

必需

type

string

必需

priority

object

必需

id

string

必需

url

string

必需

name

string

必需

plan

object

必需

id

string

必需

url

string

必需

name

string

必需

suite

object

必需

id

string

必需

url

string

必需

name

string

必需

plan_at

object

必需

from

integer

必需

to

integer

必需

granularity

string

必需

real_at

object

必需

from

integer

必需

to

integer

必需

granularity

string

必需

score

integer

必需

progress

number

必需

description

string

必需

properties

object

必需

backlog_from

string

必需

backlog_type

string

必需

prop_a

string

必需

prop_b

string

必需

participants

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": "64b4d70ba368e6594360ea24",
    "url": "https://rest_api_root/v1/ship/ideas/64b4d70ba368e6594360ea24",
    "product": {
        "id": "6422711c3f12e6c1e46d40e9",
        "url": "http://rest_api_root/v1/ship/products/6422711c3f12e6c1e46d40e9",
        "identifier": "SLC",
        "name": "示例产品"
    },
    "identifier": "SLC-1",
    "title": "示例需求",
    "assignee": {
        "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"
    },
    "state": {
        "id": "63e1bf51898a0be5a2d21b2a",
        "url": "https://rest_api_root/v1/ship/idea_states/63e1bf51898a0be5a2d21b2a",
        "name": "待评审",
        "type": "pending"
    },
    "priority": {
        "id": "5cb9466afda1ce4ca0090005",
        "url": "https://rest_api_root/v1/ship/idea_priorities/5cb9466afda1ce4ca0090005",
        "name": "P0"
    },
    "plan": {
        "id": "63bb744414bd13c9def24ce4",
        "url": "http://rest_api_root/v1/ship/products/6422711c3f12e6c1e46d40e9/plans/63bb744414bd13c9def24ce4",
        "name": "账号管理"
    },
    "suite": {
        "id": "63bb744414bd13c9def24ce4",
        "url": "https://rest_api_root/v1/ship/products/6422711c3f12e6c1e46d40e9/suites/63bb744414bd13c9def24ce4",
        "name": "产品模块"
    },
    "plan_at": {
        "from": 1690732800,
        "to": 1691337599,
        "granularity": "day"
    },
    "real_at": {
        "from": 1690732800,
        "to": 1691337599,
        "granularity": "day"
    },
    "score": 0,
    "progress": 0.88,
    "description": "这是一段描述",
    "properties": {
        "backlog_from": "5cb7e6e2fda1ce4ca0000001",
        "backlog_type": "5cb7e763fda1ce4ca0010002",
        "prop_a": "prop_a_value",
        "prop_b": "prop_b_value"
    },
    "participants": [
        {
            "id": "a0417f68e846aae315c85d24643678a9",
            "url": "https://rest_api_root/v1/ship/ideas/64b4d70ba368e6594360ea24/participants/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": 1689573131,
    "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": 1689578888,
    "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
}