# 说明

返回符合查询条件的所有Wiki(分页显示,默认一页30条)

# SDK 方法名

nodeJs:

SDK使用方式 (opens new window)

插件中使用SDK

方法名::

getTapdWikis
1

# url

https://api.tapd.cn/tapd_wikis

# 支持格式

JSON/XML(默认JSON格式)

# HTTP请求方式

GET

# 请求数限制

默认返回 30 条。可通过传 limit 参数设置,最大取 200。也可以传 page 参数翻页

# 请求参数

字段名 必选 类型及范围 说明 特殊规则
id integer id
name string 标题
modifier string 修改人
creator string 创建人
note string 备注
view_count string 浏览量
created datetime 创建时间 支持时间查询
modified datetime 最后修改时间 支持时间查询
workspace_id integer 项目ID
limit integer 设置返回数量限制,默认为30
page integer 返回当前数量限制下第N页的数据,默认为1(第一页)
order string 排序规则,规则:字段名 ASC或者DESC,然后 urlencode 如按创建时间逆序:order=created%20desc
fields string 设置获取的字段,多个字段间以','逗号隔开

# 调用示例及返回结果

# 获取项目下的wiki

# curl 使用 Basic Auth 鉴权调用示例

curl -u 'api_user:api_password' 'https://api.tapd.cn/tapd_wikis?workspace_id=10104801'

# 返回结果

{
    "status": 1,
    "data": [
        {
            "Wiki": {
                "id": "1210104801000043827",
                "name": "test888",
                "workspace_id": "10104801",
                "description": "",
                "markdown_description": "",
                "is_rich": "0",
                "parent_wiki_id": "0",
                "note": "",
                "view_count": "0",
                "created": "2020-08-25 11:24:44",
                "creator": "dev",
                "modified": "2020-08-25 11:24:44",
                "modifier": "dev"
            }
        },
        {
            "Wiki": {
                "id": "1210104801000043825",
                "name": "test888",
                "workspace_id": "10104801",
                "description": "",
                "markdown_description": "",
                "is_rich": "0",
                "parent_wiki_id": "0",
                "note": "",
                "view_count": "1",
                "created": "2020-08-25 11:22:24",
                "creator": "dev",
                "modified": "2020-08-25 11:22:24",
                "modifier": "dev"
            }
        },
        {
            "Wiki": {
                "id": "1210104801000043823",
                "name": "test888",
                "workspace_id": "10104801",
                "description": "",
                "markdown_description": "wfwwf4",
                "is_rich": "0",
                "parent_wiki_id": "0",
                "note": "",
                "view_count": "4",
                "created": "2020-08-25 11:22:20",
                "creator": "dev",
                "modified": "2020-08-25 15:39:05",
                "modifier": "dev"
            }
        }
    ],
    "info": "success"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

# Wiki字段说明

# Wiki重要字段说明

字段 说明
id ID
name 标题
description 富文本
markdown_description Markdown
parent_wiki_id 父wiki ID
author 修改人
creator 创建人
note 备注
view_count 浏览量
created 创建时间
modified 最后修改时间
modifier 最后修改人
workspace_id 项目ID
上次更新: 2024-05-16 14:58:20