PingCodeRESTAPI
PingCode 官网官方接口文档
PingCode 官网官方接口文档
  1. 页面
  • 概述
  • 鉴权
    • 客户端凭据
      • 获取企业令牌
    • 授权码
      • 登录
      • 请求授权(get_transaction_id)
      • 私有部署-请求授权(get_transaction_id)
      • authorized(get_code)
      • 私有部署-authorized(get_code) 
      • 获取用户令牌 (Get token)
      • 刷新用户令牌 (Refresh_access_token)
  • 全局
    • 个人
      • 获取个人基本信息
    • 组织
      • 企业
        • 获取企业信息
      • 企业成员
        • 创建一个企业成员
        • 部分更新一个企业成员
        • 批量更新企业成员属性
        • 获取企业成员列表
        • - 获取一个企业成员
      • 部门
        • 创建一个部门
        • 部分更新一个部门
        • 获取部门列表
        • - 获取一个部门
        • 删除一个部门
      • 团队
        • 创建一个团队
        • 部分更新一个团队
        • 获取团队列表
        • - 获取一个团队
        • 添加一个团队成员
        • 获取团队成员列表
        • - 获取一个团队成员
        • 移除一个团队成员
      • 角色
        • 获取角色列表
        • - 获取一个角色
      • 职位
        • 获取职位列表
        • - 获取一个职位
    • 安全
      • 日志
        • 获取登录日志列表
        • 获取审计日志列表
    • 通用
      • 评论
        • 创建一个评论
        • 获取评论列表
        • - 获取一个评论
        • 删除一个评论
      • 附件
        • 上传一个附件
        • 上传一个代码段
        • 获取附件列表
        • - 获取一个附件
        • 删除一个附件
      • 关注人
        • 添加一个关注人
        • 获取关注人列表
        • - 获取一个关注人
        • 移除一个关注人
      • 关联
        • 创建一个关联
        • 获取关联列表
        • - 获取一个关联
        • 删除一个关联
      • 工时
        • 创建一个工时
        • 部分更新一个工时
        • 获取工时列表
        • - 获取一个工时
        • 删除一个工时
        • 获取工时类型列表
        • - 获取一个工时类型
  • 产品管理 Product
    • 产品
      • 创建一个产品
      • 部分更新一个产品
      • 获取产品列表
      •  -获取一个产品
      • 获取产品中的需求排期列表
      •  - 获取产品中的一个需求排期
      • 获取产品中工单渠道列表
      •  - 获取产品中一个工单渠道
      • 获取产品中工单类型列表
      • - 获取产品中工单一个类型列表
      • 获取产品中的标签列表
      • - 获取产品中的一个标签
    • 客户
      • 创建一个客户
      • 部分更新一个客户
      • 获取客户列表
      • - 获取一个客户
    • 工单
      • 创建一个工单
      • 部分更新一个工单
      • 获取工单列表
      • - 获取一个工单
      • 获取工单类型列表
      • - 获取一个工单类型
      • 获取工单状态列表
      • - 获取一个工单状态
      • 获取工单属性列表
      • - 获取一个工单属性
      • 获取工单渠道列表
      • - 获取工单一个渠道
      • 获取工单优先级列表
      • - 获取工单一个优先级
      • 获取工单解决方案列表
      • - 获取工单一个解决方案
      • 获取工单标签列表
      • - 获取工单一个标签
      • 获取工单流转记录列表
    • 需求
      • 创建一个需求
      •  部分更新一个需求
      • 获取需求列表
      • - 获取一个需求
      • 获取需求状态列表
      • - 获取需求一个状态
      • 获取需求属性列表
      • - 获取需求一个属性
      • 获取需求模块列表
      • - 获取需求一个模块
      • 获取需求排期列表
      • - 获取需求一个排期
      • 获取需求优先级列表
      • - 获取需求一个优先级
    • 产品配置中心
      • 工单配置
        • 获取全部工单类型列表
        • 创建一个工单状态
        • 部分更新一个工单状态
        • 获取全部工单状态列表
        • 获取工单状态方案列表
        • 向状态方案中添加一个工单状态
        • 获取状态方案中的工单状态列表
        • 在状态方案中移除一个工单状态
        • 向状态方案中添加一个工单状态流转
        • 获取状态方案中的工单状态流转列表
        • 在状态方案中移除一个工单状态流转
        • 创建一个工单属性
        • 部分更新一个工单属性
        • 获取全部工单属性列表
        • 获取工单属性方案列表
        • 向工单属性方案中添加一个工单属性
        • 获取工单属性方案中的工单属性列表
        • - 获取一个工单类型
        • - 获取一个工单状态
        • - 获取一个工单属性
        • 在工单属性方案中移除一个工单属性
      • 需求配置
        • 获取全部需求状态列表
        • - 获取一个需求状态
        • 获取全部需求属性列表
        • - 获取一个需求属性
    • 需求属性
      • 获取一个需求属性
      • 获取需求属性列表
    • 工单优先级
      • 获取一个工单优先级
      • 获取工单优先级列表
    • 需求优先级
      • 获取一个续期优先级
      • 获取需求优先级列表
    • 工单解决方案
      • 获取一个工单解决方案
      • 获取工单解决方案列表
    • 产品成员
      • 获取一个产品成员
    • 产品标签
      • 获取一个产品标签
      • 获取产品标签列表
    • 产品排期
      • 获取一个产品排期
      • 获取产品排期列表
    • 产品模块
      • 获取一个产品模块
      • 获取产品模块列表
    • 工单关注人
      • 获取一个工单关注人
    • 需求关注人
      • 获取一个需求关注人
  • 项目管理 Project
    • 项目
      • 创建一个项目
      • 部分更新一个项目
      • 获取项目列表
      • 获取项目状态列表
      • - 获取一个项目
      • 向项目中添加一个成员
      • 部分更新一个项目内的成员
      • 获取项目中的成员列表
      • - 获取一个项目成员
      • 在项目中移除一个成员
      • 向项目中添加一个项目属性
      • 获取项目中的项目属性列表
      •  - 获取项目中一个项目属性
      • 在项目中移除一个项目属性
      • 获取一个项目的进度
    • Scrum
      • 创建一个迭代
      • 批量创建迭代
      • 部分更新一个迭代
      • 获取迭代列表
      • - 获取一个迭代
      • 创建一个迭代分组
      • 部分更新一个迭代分组
      • 获取迭代分组列表
      • - 获取一个迭代分组
      • 删除一个迭代分组
      • 创建一个迭代类别
      • 部分更新一个迭代类别
      • 获取迭代类别列表
      • - 获取一个迭代类别
      • 删除一个迭代类别
    • Kanban
      • 创建一个看板
      • 部分更新一个看板栏
      • 获取看板列表
      • - 获取一个看板
      • 删除一个看板
      • 创建一个看板栏
      • 部分更新一个看板栏
      • 获取看板栏列表
      • - 获取一个看板栏
      • 删除一个看板栏
      • 创建一个泳道
      • 部分更新一个泳道
      • 获取泳道列表
      • - 获取一个泳道
      • 删除一个泳道
    • 瀑布
      • 向瀑布项目中增加一个工作项类型
      • 获取瀑布项目中的工作项类型列表
      • - 获取瀑布项目中的一个工作项类型
      • 在瀑布项目中移除一个工作项类型
      • 获取工作项流转记录列表
    • 工作项
      • 创建一个工作项
      • 部分更新一个工作项
      • 批量部分更新一个工作项属性
      • 获取工作项列表
      • - 获取一个工作项
      • 删除一个工作项
      • 获取工作项类型列表
      • - 获取一个工作项类型
      • 获取工作项状态列表
      • - 获取一个工作项状态
      • 获取工作项属性列表
      • - 获取一个工作项属性
      • 获取工作项优先级列表
      • - 获取一个工作项优先级
      • 获取工作项标签列表
      • - 获取工作项一个标签
      • 向工作项中添加一个标签
      • 在工作项移除一个标签
      • 关联一个工作项
      • 获取关联的工作项列表
      • 取消关联一个工作项
      • 创建一个工作项交付目标
      • 部分更新一个工作项交付目标
      • 获取工作项交付目标列表
      • - 获取工作项一个交付目标
      • 删除一个工作项交付目标
      • 获取工作项流转记录列表
    • 发布
      • 创建一个发布
      • 批量创建发布
      • 部分更新一个发布
      • 获取发布列表
      • - 获取一个发布
      • 创建一个发布阶段
      • 部分更新一个发布阶段
      • 获取发布阶段列表
      • - 获取一个发布阶段
      • 删除一个发布阶段
      • 创建一个发布分组
      • 部分更新一个发布分组
      • 获取发布分组列表
      • - 获取一个发布分组
      • 删除一个发布分组
      • 创建一个发布类别
      • 部分更新一个发布类别
      • 获取发布类别列表
      • - 获取一个发布类别
      • 删除一个发布类别
    • 项目配置中心
      • 项目配置
        • 创建一个项目属性
        • 部分更新一个项目属性
        • 获取项目属性列表
        • - 获取一个项目属性
      • 工作项配置
        • 创建一个工作项标签
        • 部分更新一个工作项标签
        • 获取全部工作项标签列表
        • 删除一个工作项标签
        • 创建一个工作项类型
        • 部分更新一个工作项类型
        • 获取全部工作项类型列表
        • 删除一个工作项类型
        • 创建一个工作项状态
        • 部分更新一个工作项状态
        • 获取全部工作项状态列表
        • 向状态方案中添加一个工作项状态
        • 获取状态方案中的工作项状态列表
        • 在状态方案中移除一个工作项状态
        • 向状态方案中添加一个工作项状态流转
        • 获取状态方案中的工作项状态流转列表
        • 在状态方案中移除一个工作项状态流转
        • 创建一个工作项属性
        • 部分更新一个工作项属性
        • - 获取一个工作项属性
        • 获取全部工作项属性列表
        • 获取工作项属性方案列表
        • 向属性方案中添加一个工作项属性
        • 获取属性方案中的工作项属性列表
        • 在属性方案中移除一个工作项属性
  • 测试管理 Testhub
    • 测试库
      • 创建一个测试库
      • 部分更新一个测试库
      • 获取测试库列表
      • - 获取一个测试库
      • 向测试库中添加一个成员
      • 获取测试库中的成员列表
      • - 在测试库中获取一个成员
      • 在测试库中移除一个成员
      • 向测试库中添加一个用例模块
      • 部分更新一个测试库中用例模块
      • 获取测试库中的用例模块列表
    • 用例
      • 创建一个测试用例
      • 批量创建测试用例
      • 部分更新一个测试用例
      • 获取测试用例列表
      • - 获取一个测试用例
      • 删除一个测试用例
      • 获取用例模块列表
      • - 获取一个用例模块
      • 获取用例属性列表
      • 获取用例的执行历史列表
      • 批量创建测试用例关联工作项
      • 批量删除测试用例关联工作项
    • 计划
      • 创建一个计划
      • 部分更新一个计划
      • 获取计划列表
      • 获取计划类型列表
      • 创建一个执行用例
      • 批量创建执行用例
      • 全量更新一个执行用例
      • 部分更新一个执行用例
      • 批量部分更新执行用例
      • 批量操作执行用例
      • 获取执行用例列表
      • 获取执行用例的结果记录
    • 配置中心
      • 用例配置
        • 获取全部用例属性列表
        • 获取用例类型列表
        • 获取用例属性方案列表
        • 获取用例属性方案列表
  • 知识管理 Wiki
    • 页面关注人
    • 空间
      • 创建一个空间
      • 部分更新一个空间
      • 获取空间列表
      • - 获取一个空间
      • 删除一个空间
    • 页面
      • 创建一个页面
        POST
      • 部分更新一个页面
        PATCH
      • 更新一个文档正文
        PUT
      • 获取一个文档正文
        GET
      • 获取一个页面的版本列表
        GET
      • 恢复一个页面到指定版本
        POST
      • 获取页面列表
        GET
      • 删除一个页面
        DELETE
    • 页面关注人(全局)
      • 获取一个页面关注人
      • 添加一个页面关注人
    • 页面附件(全局)
      • 获取一个页面附件列表
      • 添加一个页面附件
  • DevOps 数据集成
    • 代码
      • 托管平台
        • 创建一个托管平台
        • 全量更新一个托管平台
        • 部分更新一个托管平台
        • 获取一个托管平台
        • 获取托管平台列表
      • 托管平台用户
        • 创建一个托管平台用户
        • 全量更新一个托管平台用户
        • 部分更新一个托管平台用户
        • 获取托管平台用户列表
        • - 获取一个托管平台用户
      • 代码仓库
        • 创建一个代码仓库
        • 全量更新一个代码仓库
        • 部分更新一个代码仓库
        • 获取代码仓库列表
        • - 获取一个代码仓库
      • 代码分支
        • 创建一个代码分支
        • 设置默认代码分支
        • 获取代码分支列表
        • - 获取一个代码分支
        • 删除一个代码分支
      • 提交
        • 创建一个提交
        • 获取提交列表
        • - 获取一个提交
      • 提交引用
        • 创建一个提交引用
        • 获取提交引用列表
        • - 获取一个提交引用
      • 拉取请求
        • 创建一个拉取请求
        • 全量更新一个拉取请求
        • 部分更新一个拉取请求
        • 获取一个拉取请求
        • 获取拉取请求列表
      • 代码评审
        • 创建一个代码评审
        • 全量更新一个代码评审
        • 部分更新一个代码评审
        • 获取一个代码评审
        • 获取代码评审列表
    • 构建
      • 构建记录
        • 创建一条构建记录
        • 全量更新一条构建记录
        • 部分更新一条构建记录
        • 获取一条构建记录
        • 获取构建记录列表
        • 删除一条构建记录
    • 交付
      • 环境
        • 创建一个环境
        • 全量更新一个环境
        • 部分更新一个环境
        • 获取一个环境
        • 获取环境列表
        • 删除一个环境
      • 部署
        • 创建一个部署
        • 全量更新一个部署
        • 部分更新一个部署
        • 获取一个部署
        • 获取部署了列表
        • 删除一个部署
  1. 页面

获取页面列表

GET
https://open.pingcode.com/v1/wiki/pages
最后修改时间:2024-01-22 09:21:05
责任人:未设置

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Query 参数
space_id
string 
必需
示例值:
{{wiki_space_id}}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://open.pingcode.com/v1/wiki/pages?space_id={{wiki_space_id}}'

返回响应

🟢200成功
application/json
Body
page_index
integer 
必需
page_size
integer 
必需
total
integer 
必需
values
array [object {17}] 
必需
id
string 
必需
url
string 
必需
name
string 
必需
icon
string 
必需
space
object 
必需
parent
null 
必需
type
string 
必需
readings
integer 
必需
participants
array [object {4}] 
必需
published_at
integer 
必需
published_by
object 
必需
created_at
integer 
必需
created_by
object 
必需
updated_at
integer 
必需
updated_by
object 
必需
is_archived
integer 
必需
is_deleted
integer 
必需
示例
{
    "page_index": 0,
    "page_size": 0,
    "total": 0,
    "values": [
        {
            "id": "string",
            "url": "string",
            "name": "string",
            "icon": "string",
            "space": {
                "id": "string",
                "url": "string",
                "name": "string",
                "identifier": "string"
            },
            "parent": null,
            "type": "string",
            "readings": 0,
            "participants": [
                {
                    "id": "string",
                    "url": "string",
                    "type": "string",
                    "user": {
                        "id": "string",
                        "url": "string",
                        "name": "string",
                        "display_name": "string",
                        "avatar": "string"
                    }
                }
            ],
            "published_at": 0,
            "published_by": {
                "id": "string",
                "url": "string",
                "name": "string",
                "display_name": "string",
                "avatar": "string"
            },
            "created_at": 0,
            "created_by": {
                "id": "string",
                "url": "string",
                "name": "string",
                "display_name": "string",
                "avatar": "string"
            },
            "updated_at": 0,
            "updated_by": {
                "id": "string",
                "url": "string",
                "name": "string",
                "display_name": "string",
                "avatar": "string"
            },
            "is_archived": 0,
            "is_deleted": 0
        }
    ]
}
上一页
恢复一个页面到指定版本
下一页
删除一个页面
Built with