Skip to content

结构化内容插入[文件执行指令]

适用版本>=v7.0.2512.20251225

接口说明:结构化内容插入[文件执行指令]

请求说明

请求地址配置域名+/openapi+/v7/appfiles/drives/{drive_id}/files/{file_id}/exec_script
请求方法POST
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求应用身份管理文档(应用授权) kso.appfiles.exec_script.readwrite

请求头(Header)

Header参数类型是否必填说明
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

路径参数(Path)

名称类型是否必填说明
drive_idstring驱动盘id
file_idstring文件id

查询参数(Query)

名称类型是否必填说明
_w_third_user_idstring操作者id

请求体(Body)

字段名类型必填说明
scriptstring指令脚本
passwordstring文档密码,不为空时,会参与转换PDF的过程,加密方式:先进行AES/ECB/PKCS5Padding加密,再进行base64加密
overwriteboolean指令为修改文档时,若为true则覆盖原文件生成新版本,为false则保存到新文件,默认为true

请求体示例

json
{
  "script": "string",
  "password": "admin@123",
  "overwrite": true
}

响应体(Response)

名称类型说明
dataobject返回的数据对象
∟ file_infoobject文件信息对象
∟∟ idstring文件 ID
∟∟ namestring文件名称
∟∟ typestring文件类型 Enum: "folder" "file"
∟∟ parent_idstring父目录 ID(应用文档固定为 "0"
∟∟ sizeinteger文件大小(字节)
∟∟ versioninteger文件版本号
∟∟ drive_idstring驱动盘 ID
∟∟ ctimeinteger创建时间(Unix 时间戳)
∟∟ mtimeinteger修改时间(Unix 时间戳)
∟∟ sharedboolean是否分享(应用文档为 false
∟∟ link_idstring链接 ID(应用文档为空字符串)
∟∟ link_urlstring链接 URL(应用文档为空字符串)
∟∟ created_byobject创建者信息
∟∟∟ idstring身份 ID
∟∟∟ typestringEnum: "sp"
∟∟ modified_byobject修改者信息
∟∟∟ idstring身份 ID
∟∟∟ typestringEnum: "sp"
∟ exec_resultstring脚本执行结果输出
codeint错误码
msgstring状态信息
detailstring详细信息

响应体示例

json
{
    "data": {
        "file_info": {
            "id": "350750123212800",
            "drive_id": "349087249465344",
            "parent_id": "0",
            "created_by": {
                "id": "userID",
                "type": "sp"
            },
            "modified_by": {
                "id": "userID",
                "type": "sp"
            },
            "size": 20480,
            "version": 3,
            "type": "file",
            "name": "脚本处理结果文档.docx",
            "ctime": 1764931200,
            "mtime": 1764931200,
            "shared": false,
            "link_url": "",
            "link_id": ""
        },
        "exec_result": "Script executed successfully."
    },
    "code": 0,
    "msg": "ok",
    "detail": ""
}