获取模板列表

GET 
/wiki/templates

History

Version	Changes
v6.12.0	Added in: v6.12.0

获取模板列表。

Request

Query Parameters

teamID stringrequired

团队ID

requestUserID string

用户 ID，此参数仅在作为 Oauth 机器人调用时才能传递。它用于以指定用户的身份执行操作

contextType stringrequired

Possible values: [space, team, system]

上下文类型。

contextID stringrequired

上下文 ID。

start integerrequired

本次请求的起始位置

limit integerrequired

本次请求要返回的数量，最大值 200

Responses

200

成功

application/json

Schema

Schema

data

object

templates

object[]

Array [

id string

模板 ID

title string

模板标题

contextType string

上下文类型

contextID string

上下文 ID

refType string

引用

refID string

引用 ID

subRefType string

子引用类型

createdTime integer

模板创建时间

updatedTime integer

模板更新时间

]

total integer

总数

start integer

起始位置

count integer

本次返回数量

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

errorData object

本次请求错误元数据

Example (from schema)

{
  "data": {
    "templates": [
      {
        "id": "string",
        "title": "string",
        "contextType": "string",
        "contextID": "string",
        "refType": "string",
        "refID": "string",
        "subRefType": "string",
        "createdTime": 0,
        "updatedTime": 0
      }
    ],
    "total": 0,
    "start": 0,
    "count": 0
  },
  "result": "string",
  "errorCode": "string",
  "errorMsg": "string",
  "errorData": {}
}

401

如果身份验证凭据不正确或丢失，则返回

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Unauthorized",
  "errorMsg": "Access token is invalid"
}

403

如果scope检验不通过，则返回

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Forbidden",
  "errorMsg": "Scope is invalid"
}

404

如果未找到资源对象，则返回

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "NotFound",
  "errorMsg": "Not Found"
}

500

内部服务器错误

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Internal Server Error",
  "errorMsg": "Internal Server Error"
}

Loading...