跳到主要内容

Get Doc Meta API

MethodAPI描述
GET/{context}/{docId}/meta?version=xx&action=xx获取docId和version指定的文档元数据，以json形式返回。
参数必须位置说明类型默认值
docId是Path指定文件Id。注意文件Id中不能含有冒号':'string
version否Query文件版本，不填则是最新版本。对于action是edit或者没有指定，version会被忽略。string
action否Queryaction指定文档的打开方式，值可以是edit或者view。如果没有action参数，缺省认为是edit。string

例子： Get http://172.16.52.223/v2/context/123/meta Get http://172.16.52.223/v2/context/123/meta?action=view Get http://172.16.52.223/v2/context/123/meta?action=view&version=asrt0yh3wekdh 返回

{
    "id": "483" //必须有,
    "name": "/study/Nodejs/Demo/mytest.xlsx", //必须包含文件的扩展名，路径名是可选的
    "modified_at": "2020-03-25T02:57:38.000Z"，//必须有，如果没有修改就是创建时间
    "created_by": { //必须有
        "id": "301",  //必须有
        "email": "docstest02@lenovo.com", // 可选的
        "name": "docstest02" // 可选的
    },
    "permissions": {  //必须有
        "write": "true", //必须有，控制文档是否可以被编辑
        "read": "true", //必须有
        "download": false, //可选。
        "print": true, //可选。
        "copy": false //可选，控制内容是否可以复制到系统剪贴版
    },
    "size": 9897, //必须有
    "role": "commenter" //可选项，指明当前用户对当前文档在zoffice编辑器里的角色(仅针对文字文档)。该项值可以是"contributor"，"commenter"，"auditor"。
    "extension": {  //可选，
        "previewWithTrackChange": false, //true表示预览时可以显示修订和批注。false或者不提供该字段表示预览时不显示修订和批注。仅针对文字文档。
        "trackChangeForceOn": false, //true表示编辑时自动打开修订，并且不能关闭。false或者不提供该字段表示编辑时不强制打开修订。仅针对文字文档。
        "showPermMarkForceOn":false, //正常情况下，当文字文档处于保护状态时，可编辑区域会高亮显示。该值是true时，文字文档非保护状态下，可编辑区域也会高亮显示。仅针对文字文档。
        "forceNewVersion":false, //正常情况下，有数据保护的文件，不容许编辑三方系统上传的新版本。用户在在线编辑器中开启数据保护，并且设置了哪些用户可以编辑哪些区域。如果用户又在业务系统上传了新版本。因为这些设置不能完全保存到Office文档中，如果zOffice Server开始编辑新上传的文件，这些在线设置的内容可能会丢失。该值是true时，忽略保护信息，直接编辑三方系统中的新版本。
    },
    "waterMark": { //可选，
        "line1":  "李明 liming@lenovo.com"; // 比如 文件最后更新者信息
        "line2":  "张三 zhangshan@lenovo.com"; // 比如：文件编辑者/预览者信息
        "line3":  ""; //比如：其他自定义文字
        "line4":  "";  //比如：其他自定义文字
        "withDate": true; // 每行文字后，是否带日期
        "fontcolor":  "#FD4147"; //RGB值，
        "transparent": 30; //0 - 100，透明度。值越小，透明效果越明显。
        "rotation": 315; // 旋转角度 0 - 360, 左倾斜=315，右倾斜=45, 水平=0
        "fontsize": "72";
        "font":  "黑体";
        "spacing": 50; //行间距，列间距均为50像素
    } 
    "owner”: { //这项是可选的，如果没有，zOffice编辑器自动用created_by作为owner
         "id": "301",
         "email": "docstest02@lenovo.com",
         "name": "docstest02"
    },
    "modified_by": {  //这项是可选的，如果没有，zOffice编辑器自动用created_by作为modified_by
        "id": "301",
        "email": "docstest02@lenovo.com",
        "name": "docstest02"
    },
    "description": "",  //可选的
    "created_at": "2020-03-25T02:57:38.000Z", //可选的
    "version": "1"  //可选的
}
权限相关

  1. 如果用户没有编辑权限，返回json中permissions.write = false

  2. 如果用户没有预览权限，返回json中permissions.read = false

  3. 用户是否有对外复制内容的能力取决于：permissions.copy， permissions.download,

        如果permissions.copy这个属性没有设置，或者设置为false，需要看permissions.download。如果文档有下载权限，用户可以对外复制内容。如果文档没有下载权限，则用户不能对外复制内容。

        如果permissions.copy这个属性设置成true，用户可以对外复制内容(不管文档是否有下载权限)。

水印信息

水印的信息。水印每组最多显示四行文字，平铺。如果某行设置为空字符串，就不显示那行。如果没有设置水印信息，watermark可以是空。水印的设置可以返回与文件，用户相关的内容，比如：指定版本的文件的最后修改者，当前文件的编辑者/预览者。

modified_at实现时，必须注意

请参考：缓存说明

最后于 更新