开发工具

创建协同文档副本

POST

/sdk/v2/collab-files/{fileId}/copy

创建指定协同文档的副本。

提示

path 中的 shimo-files 改为 collab-files，原 shimo-files 仍可用

首次调用时，会创建一个”创建副本“的任务，重复请求该接口时，会返回任务状态，具体如下：

HTTP 状态码

状态码	说明
204	创建成功
200	重复请求时，文件拷贝正在执行，响应数据 `{"code":70019}`
400	重复请求时，目标文件关联数据存在但无法找到创建副本任务信息，响应数据 `{"code":70016}`
400	重复请求时，目标文件关联数据存在，创建副本执行失败，响应数据 `{"code":70017}`
500	重复请求时，创建副本时获取源文件内容遇到错误，响应数据 `{"code":70015}`
500	重复请求时，获取创建副本任务时遇到错误，响应数据 `{"code":70018}`
500	重复请求时，未知的创建副本任务状态, 响应数据 `{"code":70020}`

请求参数

Path 参数

fileId

string

必需

旧文件的 id，即被复制的文件的 id

示例值:

fileid1001

Header 参数

X-Shimo-Signature

string

必需

示例值:

X-Shimo-Token

string

必需

示例值:

Body 参数application/json

fileId

string

必需

新文件 ID，接入方的文件唯一 ID，字符串长度不超过 64

示例

{
  "fileId": "83478944-8d4c-4936-baff-20ab180eb712"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://office.shimoapi.com/sdk/v2/collab-files/fileid1001/copy' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fileId": "83478944-8d4c-4936-baff-20ab180eb712"
}'

返回响应

🟢204创建成功

text/plain

Body

object {0}

🟢200正在执行

🟠400无法找到创建副本任务信息

🟠400创建副本执行失败

🔴500获取源文件内容遇到错误

🔴500获取创建副本任务时遇到错误

🔴500未知的创建副本任务状态

创建协同文档

删除协同文档