获取文档详情 - ShowDocumentDetail
功能介绍
获取文档详情
URI
GET /v1/app/documents/{document_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| document_id | 是 | String | 参数解释： 文档ID。 约束限制： 不涉及。 取值范围： [1-64]个字符。 默认取值： 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| with_content | 否 | Boolean | 参数解释： 是否返回文档内容。 约束限制： 不涉及。 取值范围： boolean。 默认取值： true。 |
| with_plaintext | 否 | Boolean | 参数解释： 是否返回文档文本内容。 约束限制： 不涉及。 取值范围： boolean。 默认取值： false。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 参数解释： 认证凭证。 约束限制： 格式：Bearer {access_token}。 取值范围： [1-1024]个字符。 默认取值： 不涉及。 |
| X-Cloud-Doc-AppId | 是 | String | 参数解释： APP ID。 约束限制： 不涉及。 取值范围： [1-128]个字符。 默认取值： 不涉及。 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| title | String | 参数解释： 文档标题。 取值范围： [1-255]个字符。 |
| content | String | 参数解释： 文档内容。 取值范围： 不涉及。 |
| plaintext | String | 参数解释： 文档纯文本内容。 取值范围： 不涉及。 |
| type | Integer | 参数解释： 文档类型。 取值范围： 1：目录。 2：Page文档。 3：Board文档。 4：Mind文档。 5：Draw文档。 6：Table文档。 7：Slide文档。 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
查询文档id为d3XXXX1-0fb8-4926-8fXXXXX67511的信息和内容。
GET https://{Endpoint}/v1/app/documents/d3XXXX1-0fb8-4926-8fXXXXX67511?with_content=true 响应示例
状态码：200
{
"title" : "接口设计规范",
"content" : "文档内容Json数据",
"plaintext" : "接口设计规范 本文档描述接口设计相关规范...",
"type" : 1
} 状态码：400
{
"error_code" : "KPGE.00001000",
"error_msg" : "Parameter error."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 400 | 错误响应。 |
错误码
请参见错误码。
