创建目录或文档 - CreateDocument
功能介绍
创建目录或文档。
URI
POST /v1/app/documents
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 参数解释: 认证凭证。 约束限制: 格式:Bearer {access_token}。 取值范围: [1-1024]个字符。 默认取值: 不涉及。 |
| X-Cloud-Doc-AppId | 是 | String | 参数解释: APP ID。 约束限制: 不涉及。 取值范围: [1-128]个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| organization_id | 是 | String | 参数解释: 所属空间ID。 约束限制: 不涉及。 取值范围: [1-64]个字符。 默认取值: 不涉及。 |
| parent_document_id | 否 | String | 参数解释: 父级文档ID。 约束限制: 不涉及。 取值范围: [1-64]个字符。 默认取值: 不涉及。 |
| template_id | 否 | String | 参数解释: 模板ID,如果指定模板ID,创建的文档内容为该模板内容。 约束限制: 不涉及。 取值范围: [1-64]个字符。 默认取值: 不涉及。 |
| wiki_id | 是 | String | 参数解释: 文档库ID。 约束限制: 不涉及。 取值范围: [1-64]个字符。 默认取值: 不涉及。 |
| title | 否 | String | 参数解释: 文档标题。 约束限制: 不涉及。 取值范围: [1-255]个字符。 默认取值: 不涉及。 |
| type | 否 | Integer | 参数解释: 文档类型。 约束限制: 不涉及。 取值范围: 1:目录。 2:Page文档。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 文档ID。 取值范围: [1-64]个字符。 |
| organization_id | String | 参数解释: 所属空间ID。 取值范围: [1-64]个字符。 |
| wiki_id | String | 参数解释: 所属文档库ID。 取值范围: [1-64]个字符。 |
| title | String | 参数解释: 标题。 取值范围: [1-255]个字符。 |
| create_time | String | 参数解释: 创建时间。 取值范围: 不涉及。 |
| type | Integer | 参数解释: 文档类型。 取值范围: 1:目录,2:Page文档。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
POST https://{Endpoint}/v1/app/documents
{
"organization_id" : "org_abc123def456",
"wiki_id" : "wiki_xyz789",
"parent_document_id" : "doc_parent_001",
"title" : "产品技术方案",
"template_id" : "tpl_abc123def456",
"type" : 2
} 响应示例
状态码:200
{
"id" : "doc_1a2b3c4d",
"organization_id" : "org_abc123def456",
"wiki_id" : "wiki_xyz789",
"title" : "产品技术方案",
"create_time" : "2026-09-18 10:00:00",
"type" : 2
} 状态码:400
{
"error_code" : "KPGE.00001000",
"error_msg" : "Parameter error."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 400 | 错误响应。 |
错误码
请参见错误码。