获取 Wiki 列表详情

文章内容

1. 接口描述
2. 输入参数
3. 输出参数
4. WikiList
5. 示例

接口描述

获取 Wiki 列表详情

输入参数

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeWikiList
AccessToken	是	String	公共参数，AccessToken
ProjectName	是	String	项目名称

输出参数

参数名称	类型	描述
Data	WikiList	wiki 的具体信息
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId

WikiList

wiki 列表的具体信息

名称	类型	描述
Id	Integer	wikiId
Title	String	标题
Iid	Integer	Iid
ParentIid	Integer	父级 IiD
Order	Double	所处顺序位置
IsShared	Boolean	是否分享
IsTreeShared	Boolean	是否父级分享
VisibleRange	String	可见范围
CanMaintain	Boolean	是否为维护者
CanRead	Boolean	是否可以阅读
Editor	User	修改者
Creator	User	创建者
Children	WikiList	创建者

示例

输入示例

{
  "Action":"DescribeWikiList",
  "Authorization":"8c044154bd5c7cadb5720944c733b018d0984b3",
  "ProjectName":"demo-project"
}

输出示例

{
    "Response": {
        "RequestId": "1",
        "data": [{
            "id": 359411,
            "iid": 24,
            "title": null,
            "parentIid": 0,
            "visibleRange": "HIDDEN",
            "canMaintain": false,
            "canRead": false,
            "isShared": false,
            "isTreeShared": true,
            "children": [{
                "id": 359413,
                "iid": 25,
                "title": "产品文档",
                "parentIid": 24,
                "visibleRange": "READ_ONLY",
                "canMaintain": true,
                "canRead": false,
                "isShared": false,
                "isTreeShared": false,
                "creator": {
                    "id": 38981,
                    "status": 1,
                    "globalKey": "wangjiajun",
                    "avatar": "https://dn-coding-net-production-static.codehub.cn/d466b293-5637-48e7-b485-e979d125d7a6.jpg?imageMogr2/auto-orient/format/jpeg/crop/!639x639a0a0",
                    "name": "王佳骏",
                    "email": "wangjiajun@coding.net"
                },
                "editor": {
                    "id": 39018,
                    "status": 1,
                    "globalKey": "caiyuezhang",
                    "avatar": "https://dn-coding-net-production-static.codehub.cn/86e98800-d835-41d8-8142-b7fca0550bf7.jpg?imageMogr2/auto-orient/format/jpeg/crop/!410x410a0a0",
                    "name": "蔡悦彰",
                    "email": "caiyuezhang@coding.net"
                },
                "createdAt": 1578036875000,
                "updatedAt": 1586787643000,
                "children": [{
                    "id": 359414,
                    "iid": 26,
                    "title": "Wiki 产品",
                    "parentIid": 25,
                    "visibleRange": "INHERIT",
                    "canMaintain": true,
                    "canRead": false,
                    "isShared": false,
                    "isTreeShared": false,
                    "creator": {
                        "id": 38981,
                        "status": 1,
                        "globalKey": "wangjiajun",
                        "avatar": "https://dn-coding-net-production-static.codehub.cn/d466b293-5637-48e7-b485-e979d125d7a6.jpg?imageMogr2/auto-orient/format/jpeg/crop/!639x639a0a0",
                        "name": "王佳骏",
                        "email": "wangjiajun@coding.net"
                    },
                    "editor": {
                        "id": 39018,
                        "status": 1,
                        "globalKey": "caiyuezhang",
                        "avatar": "https://dn-coding-net-production-static.codehub.cn/86e98800-d835-41d8-8142-b7fca0550bf7.jpg?imageMogr2/auto-orient/format/jpeg/crop/!410x410a0a0",
                        "name": "蔡悦彰",
                        "email": "caiyuezhang@coding.net"
                    },
                    "createdAt": 1578036875000,
                    "updatedAt": 1586787643000,
                    "children": [],
                    "order": 1.0
                }],
                "order": 1.0
            }],
            "order": 1.0
        }]
    }

}

最近更新

感谢反馈有用

感谢反馈没用