- 概述
- 鉴权
- 全局
- 产品管理 Product
- 项目管理 Project
- 项目
- Scrum
- Kanban
- 瀑布
- 工作项
- 发布
- 项目配置中心
- 项目配置
- 工作项配置
- 创建一个工作项标签
- 部分更新一个工作项标签
- 获取全部工作项标签列表
- 删除一个工作项标签
- 创建一个工作项类型
- 部分更新一个工作项类型
- 获取全部工作项类型列表
- 删除一个工作项类型
- 创建一个工作项状态
- 部分更新一个工作项状态
- 获取全部工作项状态列表
- 向状态方案中添加一个工作项状态
- 获取状态方案中的工作项状态列表
- 在状态方案中移除一个工作项状态
- 向状态方案中添加一个工作项状态流转
- 获取状态方案中的工作项状态流转列表
- 在状态方案中移除一个工作项状态流转
- 创建一个工作项属性
- 部分更新一个工作项属性
- - 获取一个工作项属性
- 获取全部工作项属性列表
- 获取工作项属性方案列表
- 向属性方案中添加一个工作项属性
- 获取属性方案中的工作项属性列表
- 在属性方案中移除一个工作项属性
- 测试管理 Testhub
- 知识管理 Wiki
- DevOps 数据集成
获取需求列表
GET
https://open.pingcode.com/v1/ship/ideas
最后修改时间:2024-01-22 09:09:14
责任人:未设置
请求参数
Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token示例:
Authorization: Bearer ********************
Query 参数
product_id
string
产品的id。
state_id
string
需求状态id。
priority_id
string
需求优先级id。
keywords
string
可选
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://open.pingcode.com/v1/ship/ideas?product_id&state_id&priority_id&keywords'
返回响应
🟢200成功
application/json
Body
page_size
integer
必需
page_index
integer
必需
total
integer
必需
values
array [object {23}]
必需
id
string
可选
url
string
可选
product
object
可选
identifier
string
可选
title
string
可选
assignee
object
可选
state
object
可选
priority
object
可选
plan
object
可选
suite
object
可选
plan_at
object
可选
real_at
object
可选
score
integer
可选
progress
number
可选
description
string
可选
properties
object
可选
participants
array [object {5}]
可选
created_at
integer
可选
created_by
object
可选
updated_at
integer
可选
updated_by
object
可选
is_archived
integer
可选
is_deleted
integer
可选
示例
{
"page_size": 30,
"page_index": 0,
"total": 1,
"values": [
{
"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": "https://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.6,
"description": "这是一段描述",
"properties": {
"backlog_from": "5cb7e6e2fda1ce4ca0000001",
"backlog_type": "5cb7e763fda1ce4ca0010002"
},
"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"
}
},
{
"id": "63c8fb32729dee3334d96af7",
"url": "https://rest_api_root/v1/ship/ideas/64b4d70ba368e6594360ea24/participants/63c8fb32729dee3334d96af7",
"type": "user_group",
"user_group": {
"id": "63c8fb32729dee3334d96af7",
"url": "https://rest_api_root/v1/directory/groups/63c8fb32729dee3334d96af7",
"name": "Open Team"
}
}
],
"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": 1689579131,
"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
}
]
}
修改于 2024-01-22 09:09:14