title: myApps.5.0trunk v1.0.0
language_tabs:

shell: Shell
http: HTTP
javascript: JavaScript
ruby: Ruby
python: Python
php: PHP
java: Java
go: Go
toc_footers: []
includes: []
search: true
code_clipboard: true
highlight_theme: darkula
headingLevel: 2
generator: “@tarslib/widdershins v4.0.17”

myApps.5.0trunk

v1.0.0

Base URLs:

知识文档/网盘（Disks）

GET 获取部门网盘集合

GET /kms/disks/departments

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "11e7-a198-c5a5aeea-a900-73852bc58bcf",
      "name": "铁塔院管理员",
      "nameLetter": "ttygly",
      "loginno": "ttyadmin",
      "email": "",
      "telephone": "",
      "avatar": "",
      "favoriteContacts": "",
      "superior": null,
      "roles": [
        {
          "id": "0001",
          "name": "员工",
          "levels": 0
        },
        {
          "id": "0010",
          "name": "部门知识管理员",
          "levels": 10
        },
        {
          "id": "0020",
          "name": "专委会知识管理员",
          "levels": 20
        }
      ],
      "domainid": "11e7-a197-b8af019e-a900-73852bc58bcf",
      "defaultDepartment": "11e7-a198-36b48314-a900-73852bc58bcf",
      "calendarType": "11e7-a197-b8cdad30-a900-73852bc58bcf",
      "status": 1,
      "level": 0
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	Disk对象

POST 创建部门网盘

POST /kms/disks/departments

Body 请求参数

[
  " id1",
  "id2",
  "id3"
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
deptIds	query	string	否	部门Id数组
body	body	object	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	number	true	none	Disk对象

DELETE 删除部门网盘

DELETE /kms/disks/{diskId}

Body 请求参数

{}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	网盘id
body	body	object	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	Disk对象

PUT 更新部门网盘

PUT /kms/disks/{diskId}

Body 请求参数

{
  "id": "45e196e4-cdc7-4911-b1a0-0eab8cff2aac",
  "name": "江苏省邮电规划设计院",
  "type": 1,
  "ownerId": "11e7-7045-1c91a1dc-85f9-cbfc8973e987",
  "orderNo": 98
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	网盘id
body	body	object	否	none
» id	body	string	是	网盘ID
» name	body	string	是	网盘名称
» type	body	integer	是	网盘类型
» ownerId	body	string	是	网盘所有者
» orderNo	body	integer	是	排序号

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "4f00e65e-94a0-4c2a-b50f-c64d7f6bdc3e",
    "name": "测试数据",
    "type": 1,
    "ownerId": "11e7-7045-2da34ac9-85f9-cbfc8973e987",
    "orderNo": 25
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	Disk对象
»» id	string	true	none	none
»» name	string	true	none	none
»» type	integer	true	none	none
»» ownerId	string	true	none	none
»» orderNo	integer	true	none	none

GET 获取指定网盘下的管理员

GET /kms/disks/{diskId}/superadmins

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 创建新网盘

POST /kms/new/disk

Body 请求参数

{
  "id": "1"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

DELETE 删除新网盘集合

DELETE /kms/new/disk

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

PUT 更新新网盘

PUT /kms/new/disk

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取新网盘集合

GET /kms/new/disk

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取网盘结构树

GET /kms/disksTree

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

知识文档/目录（Folders）

PATCH 目录的置顶

PATCH /kms/disks/{diskId}/folders/{folderId}/top

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	网盘id
folderId	path	string	是	置顶目录id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "bea126f8-7637-452b-babb-b50ff9fe6e80",
    "name": "新建目录22",
    "creatorId": "b27f525b-f44f-4519-8bf1-2087382d4f56",
    "creator": "邢专员（行政专员）",
    "createDate": 1502158542785,
    "lastModifyDate": 1502158542785,
    "diskId": "45e196e4-cdc7-4911-b1a0-0eab8cff2aac",
    "folderId": "5d09741b-1ef3-42e7-80b8-e971fcfba738",
    "folder": true,
    "size": 0,
    "path": "\\\\45e196e4-cdc7-4911-b1a0-0eab8cff2aac\\\\5d09741b-1ef3-42e7-80b8-e971fcfba738",
    "orderNo": 0,
    "type": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	Folder对象
»» id	string	true	none	none
»» name	string	true	none	none
»» creatorId	null	true	none	none
»» creator	null	true	none	none
»» createDate	string	true	none	none
»» lastModifyDate	string	true	none	none
»» diskId	string	true	none	none
»» folderId	string	true	none	none
»» folder	boolean	true	none	none
»» size	integer	true	none	none
»» path	string	true	none	none
»» orderNo	integer	true	none	none
»» type	integer	true	none	none

DELETE 取消目录置顶

DELETE /kms/disks/{diskId}/folders/{folderId}/top

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	none
folderId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

PATCH 目录重命名

PATCH /kms/disks/{diskId}/folders/{folderId}/rename

Body 请求参数

{
  "name": "name"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	网盘id
folderId	path	string	是	目录id
body	body	object	否	none
» name	body	string	是	重命名的名称

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "bea126f8-7637-452b-babb-b50ff9fe6e80",
    "name": "新建目录22",
    "creatorId": "b27f525b-f44f-4519-8bf1-2087382d4f56",
    "creator": "邢专员（行政专员）",
    "createDate": 1502158542785,
    "lastModifyDate": 1502158542785,
    "diskId": "45e196e4-cdc7-4911-b1a0-0eab8cff2aac",
    "folderId": "5d09741b-1ef3-42e7-80b8-e971fcfba738",
    "folder": true,
    "size": 0,
    "path": "\\\\45e196e4-cdc7-4911-b1a0-0eab8cff2aac\\\\5d09741b-1ef3-42e7-80b8-e971fcfba738",
    "orderNo": 0,
    "type": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	Folder对象
»» id	string	true	none	none
»» name	string	true	none	none
»» creatorId	null	true	none	none
»» creator	null	true	none	none
»» createDate	string	true	none	none
»» lastModifyDate	string	true	none	none
»» diskId	string	true	none	none
»» folderId	string	true	none	none
»» folder	boolean	true	none	none
»» size	integer	true	none	none
»» path	string	true	none	none
»» orderNo	integer	true	none	none
»» type	integer	true	none	none

POST 目录的创建

POST /kms/disks/{diskId}/folders

Body 请求参数

{
  "name": "value",
  "diskId": "value",
  "folderId": "value"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	网盘id
body	body	object	否	none
» name	body	string	是	目录名称
» diskId	body	string	是	目录所在的网盘id
» folderId	body	string	是	目录的上级目录ID，根目录的ID为网盘ID

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "bea126f8-7637-452b-babb-b50ff9fe6e80",
    "name": "新建目录22",
    "creatorId": "b27f525b-f44f-4519-8bf1-2087382d4f56",
    "creator": "邢专员（行政专员）",
    "createDate": 1502158542785,
    "lastModifyDate": 1502158542785,
    "diskId": "45e196e4-cdc7-4911-b1a0-0eab8cff2aac",
    "folderId": "5d09741b-1ef3-42e7-80b8-e971fcfba738",
    "folder": true,
    "size": 0,
    "path": "\\\\45e196e4-cdc7-4911-b1a0-0eab8cff2aac\\\\5d09741b-1ef3-42e7-80b8-e971fcfba738",
    "orderNo": 0,
    "type": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	Folder对象
»» id	string	true	none	none
»» name	string	true	none	none
»» creatorId	string	true	none	none
»» creator	string	true	none	none
»» diskId	string	true	none	none
»» folderId	string	true	none	none
»» folder	boolean	true	none	none
»» size	integer	true	none	none
»» path	string	true	none	none
»» orderNo	integer	true	none	none
»» type	integer	true	none	none

PATCH 目录移动

PATCH /kms/disks/{diskId}/folders/{folderId}/moveto/folderId/{destFolderId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	网盘id
folderId	path	string	是	目录id
destFolderId	path	string	是	目标目录id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回操作是否成功，true或者false

GET 单个目录下载（已废弃）

GET /kms/download/{fileId}

Body 请求参数

{
  "name": "下载目录",
  "diskId": "__oP0irhWXGA2oZRusW1d",
  "folderId": "__oP0irhWXGA2oZRusW1d"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
fileId	path	string	是	none
folderIds	query	string	是	目录id集合
fileIds	query	string	是	传空
body	body	object	否	none
» name	body	string	是	none
» diskId	body	string	是	none
» folderId	body	string	是	none

返回示例

200 Response

{
  "errcode": "string",
  "errmsg": "string",
  "data": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	string	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	返回操作是否成功，true/false

DELETE 目录删除

DELETE /kms/disks/{diskId}/folders/{folderId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	网盘id
folderId	path	string	是	删除目录id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回操作是否成功，true/false

GET 根据folderId得到路劲

GET /kms/disks/folders/{folderId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
folderId	path	string	是	目录id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "权限设置/铁塔院可下载/铁塔院可预览"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	false	none	none

GET 目录结构树

GET /kms/disks/{diskId}/foldersTree

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

DELETE 取消目录置顶

DELETE /kms/disks/{diskId}/folders/{folderId%20}/top

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	网盘id
folderId	path	string	是	置顶目录id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "bea126f8-7637-452b-babb-b50ff9fe6e80",
    "name": "新建目录22",
    "creatorId": "b27f525b-f44f-4519-8bf1-2087382d4f56",
    "creator": "邢专员（行政专员）",
    "createDate": 1502158542785,
    "lastModifyDate": 1502158542785,
    "diskId": "45e196e4-cdc7-4911-b1a0-0eab8cff2aac",
    "folderId": "5d09741b-1ef3-42e7-80b8-e971fcfba738",
    "folder": true,
    "size": 0,
    "path": "\\\\45e196e4-cdc7-4911-b1a0-0eab8cff2aac\\\\5d09741b-1ef3-42e7-80b8-e971fcfba738",
    "orderNo": 0,
    "type": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码·
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	Folder对象
»» id	string	true	none	none
»» name	string	true	none	none
»» creatorId	null	true	none	none
»» creator	null	true	none	none
»» createDate	string	true	none	none
»» lastModifyDate	string	true	none	none
»» diskId	string	true	none	none
»» folderId	null	true	none	none
»» folder	boolean	true	none	none
»» size	integer	true	none	none
»» path	null	true	none	none
»» orderNo	integer	true	none	none
»» type	integer	true	none	none

GET 根据folderId得到路劲文件夹集合

GET /kms/disks/folders/{folderId}/path/list

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
folderId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取父级目录

GET /kms/disks/folders/{folderId}/parent

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
folderId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 创建归档目录,判断是否有没有在创建目录

POST /kms/archive/folder

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	query	string	否	none
body	body	object	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

知识文档/文件（Files）

GET 据网盘id得到该网盘下的预览和下载的数次

GET /kms/disks/{diskId}/files/viewsAndDownloads

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

OPTIONS 创建空文档

OPTIONS /kms/disks/{diskId}/folders/{folderId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	none
folderId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 目录下的文件列表(路劲不包含diskId和folderId)

GET /kms/disks/folders/files

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
ownerId	query	string	否	网盘的id或者目录的id
fileName	query	string	否	文件名
orderMode	query	string	否	升序(ASC)/降序(DESC)
linesPerPage	query	string	是	每页显示条数
orderByfield	query	string	否	属性名(NAME CREATOR LAST_MODIFY_DATE)
pageNo	query	string	是	当前页

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 13,
    "linesPerPage": 2,
    "pageNo": 1,
    "datas": [
      {
        "id": "4b5cba76-ab97-4f51-ae56-0ad7a45ade2c",
        "name": "default.pdf",
        "creatorId": "11e7-a198-3969df1c-a900-73852bc58bcf",
        "creator": "企业知识管理员",
        "createDate": "2017-09-26",
        "lastModifyDate": "2017-09-26",
        "diskId": "11e7-a198-3969df1c-a900-73852bc58bcf",
        "folderId": "db5cc5de-26f1-42f4-a77a-baddf00729b0",
        "folder": false,
        "size": 0,
        "path": "11e7-a198-3969df1c-a900-73852bc58bcf/db5cc5de-26f1-42f4-a77a-baddf00729b0",
        "type": "pdf",
        "url": "11e7-a198-3969df1c-a900-73852bc58bcf/201709/4b5cba76-ab97-4f51-ae56-0ad7a45ade2c.pdf",
        "originType": 1,
        "originId": null,
        "views": 2,
        "lastViewDate": "2017-10-27",
        "downloads": 0,
        "lastDownloadDate": null,
        "shares": 0,
        "lastShareDate": null,
        "collects": 0,
        "lastCollectDate": null,
        "good": 0,
        "bad": 0
      },
      {
        "id": "cf0a1cc3-dde6-4b63-b75b-5e0ead601295",
        "name": "md的bug.html",
        "creatorId": "11e7-a198-3969df1c-a900-73852bc58bcf",
        "creator": "企业知识管理员",
        "createDate": "2017-09-26",
        "lastModifyDate": "2017-09-26",
        "diskId": "11e7-a198-3969df1c-a900-73852bc58bcf",
        "folderId": "db5cc5de-26f1-42f4-a77a-baddf00729b0",
        "folder": false,
        "size": 0,
        "path": "11e7-a198-3969df1c-a900-73852bc58bcf/db5cc5de-26f1-42f4-a77a-baddf00729b0",
        "type": "html",
        "url": "11e7-a198-3969df1c-a900-73852bc58bcf/201709/cf0a1cc3-dde6-4b63-b75b-5e0ead601295.html",
        "originType": 1,
        "originId": null,
        "views": 1,
        "lastViewDate": "2017-11-09",
        "downloads": 0,
        "lastDownloadDate": null,
        "shares": 0,
        "lastShareDate": null,
        "collects": 0,
        "lastCollectDate": null,
        "good": 0,
        "bad": 0
      }
    ],
    "pageCount": 7
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的对象数据
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	true	none	none
»»» name	string	true	none	none
»»» creatorId	string	true	none	none
»»» creator	string	true	none	none
»»» createDate	string	true	none	none
»»» lastModifyDate	string	true	none	none
»»» diskId	string	true	none	none
»»» folderId	string	true	none	none
»»» folder	boolean	true	none	none
»»» size	integer	true	none	none
»»» path	string	true	none	none
»»» type	string	true	none	none
»»» url	string	true	none	none
»»» originType	integer	true	none	none
»»» originId	null	true	none	none
»»» views	integer	true	none	none
»»» lastViewDate	string	true	none	none
»»» downloads	integer	true	none	none
»»» lastDownloadDate	null	true	none	none
»»» shares	integer	true	none	none
»»» lastShareDate	null	true	none	none
»»» collects	integer	true	none	none
»»» lastCollectDate	null	true	none	none
»»» good	integer	true	none	none
»»» bad	integer	true	none	none
»» pageCount	integer	true	none	none

GET 文件预览

GET /kms/disks/{diskId}/files/{fileId}/preview

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	none
fileId	path	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "url": "\\45e196e4-cdc7-4911-b1a0-0eab8cff2aac\\201708\\45e196e4-cdc7-4911-b1a0-0eab8cff2aac.pdf",
    "operations": [
      1,
      2
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

GET 目录下的文件列表

GET /kms/disks/{diskId}/folders/{folders}/files

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	网盘id
folders	path	string	是	目录id
fileName	query	string	是	文件名
orderMode	query	string	是	升序(ASC)/降序(DESC)
linesPerPage	query	string	是	每页显示条数
orderByfield	query	string	是	属性名(NAME CREATOR LAST_MODIFY_DATE)
pageNo	query	string	是	当前页

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 8,
    "linesPerPage": 2,
    "pageNo": 1,
    "datas": [
      {
        "id": "687aa9c6-df3c-42c5-9be9-929fed7cae5c",
        "name": "新建目录",
        "creatorId": null,
        "creator": null,
        "createDate": null,
        "lastModifyDate": null,
        "diskId": "45e196e4-cdc7-4911-b1a0-0eab8cff2aac",
        "folderId": "5d09741b-1ef3-42e7-80b8-e971fcfba738",
        "folder": true,
        "size": 0,
        "path": null,
        "orderNo": 0,
        "type": 0
      },
      {
        "id": "616979ef-c4b5-47c3-959a-70b13622e3ab",
        "name": "aa",
        "creatorId": "b27f525b-f44f-4519-8bf1-2087382d4f56",
        "creator": "邢专员（行政专员）",
        "createDate": "2017-08-08",
        "lastModifyDate": "2017-08-08",
        "diskId": "45e196e4-cdc7-4911-b1a0-0eab8cff2aac",
        "folderId": "5d09741b-1ef3-42e7-80b8-e971fcfba738",
        "folder": true,
        "size": 0,
        "path": "\\\\45e196e4-cdc7-4911-b1a0-0eab8cff2aac\\\\cfe92a5b-8fa3-45fd-896b-5ed27365bfe6\\\\5d09741b-1ef3-42e7-80b8-e971fcfba738",
        "orderNo": 0,
        "type": 0
      }
    ],
    "pageCount": 4
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的对象数据
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	true	none	none
»»» name	string	true	none	none
»»» creatorId	string¦null	true	none	none
»»» creator	string¦null	true	none	none
»»» createDate	string¦null	true	none	none
»»» lastModifyDate	string¦null	true	none	none
»»» diskId	string	true	none	none
»»» folderId	string	true	none	none
»»» folder	boolean	true	none	none
»»» size	integer	true	none	none
»»» path	string¦null	true	none	none
»»» orderNo	integer	true	none	none
»»» type	integer	true	none	none
»» pageCount	integer	true	none	none

GET 文件收藏

GET /kms/disks/{diskId}/files/{fileId}/collect

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	none
fileId	path	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回操作是否成功，true/false

GET 手机端预览(包含是有没有开启预览水印配置)

GET /kms/mobile/disks/{diskId}/files/{fileId}/preview

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	网盘id
fileId	path	string	是	文件id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "{\"pdfFileUrl\":\"4a2a7704-0cdd-425d-8c51-75f4af062ca2/202007/PDF/d319492a-3252-4bb7-b647-af301406f64e.pdf\",\"message\":null,\"readable\":true,\"fileEntity\":{\"id\":\"d319492a-3252-4bb7-b647-af301406f64e\",\"name\":\"105成都高新区关于加快国际科技金融创新中心建设的若干政策.docx\",\"creatorId\":\"zPsp2hk7CEwtqeMCwtj\",\"creator\":\"管理员\",\"createDate\":1594051200000,\"lastModifyDate\":1594090105000,\"diskId\":\"4a2a7704-0cdd-425d-8c51-75f4af062ca2\",\"folderId\":\"440681f5-641d-482d-973c-0b86e00cf552\",\"folder\":false,\"size\":17526,\"path\":\"4a2a7704-0cdd-425d-8c51-75f4af062ca2/440681f5-641d-482d-973c-0b86e00cf552\",\"type\":\"docx\",\"url\":\"4a2a7704-0cdd-425d-8c51-75f4af062ca2/202007/d319492a-3252-4bb7-b647-af301406f64e.docx\",\"originType\":1,\"originId\":null,\"categorys\":null,\"categorysJson\":[],\"views\":6,\"lastViewDate\":1594093971173,\"downloads\":0,\"lastDownloadDate\":null,\"shares\":0,\"lastShareDate\":null,\"collects\":0,\"lastCollectDate\":null,\"lastEditDate\":null,\"good\":0,\"bad\":0}}"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	PDF文件路径

PATCH 文件分享(已废弃）

PATCH /kms/disks/{diskId}/files/{fileId}/share

Body 请求参数

[
  "stageId1",
  "stageId2"
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	网盘id
fileId	path	string	是	文件id
body	body	object	否	none
» stageIds	body	string	是	数组：{ stageId1，stageId2}

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回操作是否成功，true/false

DELETE 文件删除

DELETE /kms/disks/{diskId%20}/files/{fileId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	网盘id
fileId	path	string	是	文件id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回操作是否成功，true/false

PATCH 文件重命名

PATCH /kms/disks/{diskId}/files/{fileId}/rename

Body 请求参数

{
  "name": "name1"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	网盘id
fileId	path	string	是	文件id
folderId	query	string	否	目录id
body	body	object	否	none
» name	body	string	是	文件名称

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "d46b2ed9-ec75-40c6-9bdf-d35e7aa309dc",
    "name": "abc",
    "creatorId": "b27f525b-f44f-4519-8bf1-2087382d4f56",
    "creator": "邢专员（行政专员）",
    "createDate": "2017-08-01",
    "lastModifyDate": "2017-08-08",
    "diskId": "45e196e4-cdc7-4911-b1a0-0eab8cff2aac",
    "folderId": "5d09741b-1ef3-42e7-80b8-e971fcfba738",
    "folder": false,
    "size": 12,
    "path": "\\\\45e196e4-cdc7-4911-b1a0-0eab8cff2aac\\\\cfe92a5b-8fa3-45fd-896b-5ed27365bfe6\\\\5d09741b-1ef3-42e7-80b8-e971fcfba738",
    "type": "txt",
    "url": "\\\\45e196e4-cdc7-4911-b1a0-0eab8cff2aac",
    "originType": 1,
    "originId": null,
    "views": 0,
    "lastViewDate": null,
    "downloads": 0,
    "lastDownloadDate": null,
    "shares": 0,
    "lastShareDate": null,
    "collects": 0,
    "lastCollectDate": null,
    "good": 0,
    "bad": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	返回File对象
»» id	string	true	none	none
»» name	string	true	none	none
»» creatorId	null	true	none	none
»» creator	null	true	none	none
»» createDate	null	true	none	none
»» lastModifyDate	null	true	none	none
»» diskId	string	true	none	none
»» folderId	string	true	none	none
»» folder	boolean	true	none	none
»» size	integer	true	none	none
»» path	string	true	none	none
»» type	null	true	none	none
»» url	null	true	none	none
»» originType	integer	true	none	none
»» originId	null	true	none	none
»» views	integer	true	none	none
»» lastViewDate	null	true	none	none
»» downloads	integer	true	none	none
»» lastDownloadDate	null	true	none	none
»» shares	integer	true	none	none
»» lastShareDate	null	true	none	none
»» collects	integer	true	none	none
»» lastCollectDate	null	true	none	none
»» good	integer	true	none	none
»» bad	integer	true	none	none

PATCH 文件移动

PATCH /kms/disks/{diskId}/files/{fileId}/moveto/folderId/{destfolderId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	网盘id
fileId	path	string	是	文件id
destfolderId	path	string	是	目标目录id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回操作是否成功，true/false

GET 文件下载（已废弃）

GET /kms/download/{filed}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
filed	path	string	是	none

返回示例

200 Response

{
  "errcode": "string",
  "errmsg": "string",
  "data": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	string	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	返回的视图对象

GET 文件分享至阶段目录结构树

GET /kms/teams/stagesTree

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 文件收藏至文件夹

GET /kms/disks/{diskId}/files/{fileId}/collect/folder/{folderId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	none
fileId	path	string	是	none
folderId	path	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回操作是否成功，true/false

GET 产看贡献者的上传文件数量

GET /kms/contributor/fileCount

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
topCount	query	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	none

GET 获取用户的文件上传数量

GET /kms/files/userUploadFileCount

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
originType	query	string	否	文件来源类型

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "count"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	number	true	none	返回值

GET 查询文件

GET /kms/files/data

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
fileName	query	string	否	文件名称
userIds	query	string	否	用户id集合
beginTime	query	string	否	创建时间(毫秒值)
endTime	query	string	否	结束时间(毫秒值)
linesPerPage	query	string	否	每页条数
pageNo	query	string	否	页数
orderByfield	query	string	否	none
orderMode	query	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 6,
    "linesPerPage": 2,
    "pageNo": 1,
    "datas": [
      {
        "id": "8bdf7853-4056-48cd-901d-2d53dc7b8561",
        "name": "授权sql.txt",
        "creatorId": "11e9-97b7-64c3bedb-bb3a-9339eb852df7",
        "creator": "admin1",
        "createDate": "2019-07-11",
        "lastModifyDate": "2019-07-11",
        "diskId": "dfdf77eb-2a18-4250-99aa-12686be663a7",
        "folderId": "95068913-915f-4ca2-a1bb-6a7741d6b761",
        "folder": false,
        "size": 1262,
        "path": "null/dfdf77eb-2a18-4250-99aa-12686be663a7/4161ea88-ed6c-490b-a261-130cd8793f4f/95068913-915f-4ca2-a1bb-6a7741d6b761",
        "permission": null,
        "type": "txt",
        "url": "dfdf77eb-2a18-4250-99aa-12686be663a7/201907/8bdf7853-4056-48cd-901d-2d53dc7b8561.txt",
        "originType": 1,
        "originId": null,
        "views": 0,
        "lastViewDate": null,
        "downloads": 0,
        "lastDownloadDate": null,
        "shares": 0,
        "lastShareDate": null,
        "collects": 0,
        "lastCollectDate": null,
        "good": 0,
        "bad": 0
      },
      {
        "id": "4b08a9a4-be99-4705-aca4-66f377ba25ea",
        "name": "werty.doc",
        "creatorId": "11e9-97b7-64c3bedb-bb3a-9339eb852df7",
        "creator": "admin1",
        "createDate": "2019-07-10",
        "lastModifyDate": "2019-07-10",
        "diskId": "dfdf77eb-2a18-4250-99aa-12686be663a7",
        "folderId": "756e06ff-bce6-4f5a-8d3f-ae38f4198719",
        "folder": false,
        "size": 10240,
        "path": "null/dfdf77eb-2a18-4250-99aa-12686be663a7/4161ea88-ed6c-490b-a261-130cd8793f4f/756e06ff-bce6-4f5a-8d3f-ae38f4198719",
        "permission": null,
        "type": "doc",
        "url": "dfdf77eb-2a18-4250-99aa-12686be663a7/201907/4b08a9a4-be99-4705-aca4-66f377ba25ea.doc",
        "originType": 1,
        "originId": null,
        "views": 0,
        "lastViewDate": null,
        "downloads": 0,
        "lastDownloadDate": null,
        "shares": 0,
        "lastShareDate": null,
        "collects": 0,
        "lastCollectDate": null,
        "good": 0,
        "bad": 0
      }
    ],
    "from": null,
    "pageCount": 3
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回操作是否成功，true/false
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	true	none	none
»»» name	string	true	none	none
»»» creatorId	string	true	none	none
»»» creator	string	true	none	none
»»» createDate	string	true	none	none
»»» lastModifyDate	string	true	none	none
»»» diskId	string	true	none	none
»»» folderId	string	true	none	none
»»» folder	boolean	true	none	none
»»» size	integer	true	none	none
»»» path	string	true	none	none
»»» permission	null	true	none	none
»»» type	string	true	none	none
»»» url	string	true	none	none
»»» originType	integer	true	none	none
»»» originId	null	true	none	none
»»» views	integer	true	none	none
»»» lastViewDate	null	true	none	none
»»» downloads	integer	true	none	none
»»» lastDownloadDate	null	true	none	none
»»» shares	integer	true	none	none
»»» lastShareDate	null	true	none	none
»»» collects	integer	true	none	none
»»» lastCollectDate	null	true	none	none
»»» good	integer	true	none	none
»»» bad	integer	true	none	none
»» from	null	false	none	none
»» pageCount	integer	true	none	none

GET 获取所有用户的文件上传数量

GET /kms/files/getAllUserUploadFileCount

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
linesPerPage	query	string	是	行数
pageNo	query	string	是	页码

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 2,
    "linesPerPage": 10,
    "pageNo": 1,
    "datas": [
      {
        "count": 3,
        "name": "sam01",
        "avatar": null
      },
      {
        "count": 1,
        "name": "胡坚锐",
        "avatar": null
      }
    ],
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回数据
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» count	integer	true	none	none
»»» name	string	true	none	none
»»» avatar	null	true	none	none
»» pageCount	integer	true	none	none

PATCH FileObjs批量移动

PATCH /kms/disks/{diskId}/fileObjs/moveto/folders/{folderId}

Body 请求参数

[
  {
    "fileObjectId": "e9457e4c-c21e-444b-84cb-158475a211c2",
    "isFolder": true
  }
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	网盘id
folderId	path	string	是	移动到目录id
body	body	array[object]	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回操作是否成功，true/false

DELETE FileObjs批量删除

DELETE /kms/disks/{diskId}/fileObjs

Body 请求参数

[
  {
    "fileObjectId": "fileId",
    "isFolder": true
  }
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	网盘id
body	body	array[object]	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回操作是否成功，true/false

GET 多个FileObj下载(已废弃）

GET /kms/downloads

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
folderIds	query	string	是	目录id,可同时有多个相同参数
fileIds	query	string	否	文件id，可同时有多个相同参数

返回示例

200 Response

{
  "errcode": "string",
  "errmsg": "string",
  "data": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	string	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	返回的表单对象

GET 判断文件是否加密

GET /kms/file/isencrypt

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
fileUrl	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 目录下的文件列表(此接口用户移动端专属(个人km))

GET /kms/disks/{diskId}/folders/{folderId}/phone/files

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	none
folderId	path	string	是	none
orderByfield	query	string	否	none
orderMode	query	string	否	none
pageNo	query	string	否	none
linesPerPage	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 文件内部分享

POST /kms/disks/{diskId}/files/{fileId}/insideshare

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	none
fileId	path	string	是	none
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 别人分享给自己的文件列表

GET /kms/disks/{diskId}/sharefiles

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
diskId	path	string	是	none
orderByfield	query	string	否	none
orderMode	query	string	否	none
pageNo	query	string	否	none
linesPerPage	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 文件外部分享(文件名称+文件地址)

POST /kms/files/{fileId}/outsideshare

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
fileId	path	string	是	none
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取知识地图关联文档

GET /kms//files/{fileId}/knowledgemap

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
fileId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 外部链接访问接口(链接两小时过期)

GET /kms/files/{fileId}/outsidepreview

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
fileId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 文件预览是否具备权限

GET /kms/previewAble/files/{fileId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
fileId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 文件编辑是否具备权限

GET /kms/editAble/files/{fileId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
fileId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 单个文件下载前，判断是否具备权限

GET /kms/downloadAble

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
folderIds	query	string	否	none
fileIds	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 根据文件所属id和文件名查找文件包体

GET /kms/disks/files

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
ownerId	query	string	否	none
fileName	query	string	否	none
pageNo	query	string	否	none
linesPerPage	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

PUT 给文件贴标签

PUT /kms/files/categorys

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
fileIds	query	string	否	none
categorys	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 根据文件id获取标签

GET /kms/files/{id}/categorys

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
id	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取该文件的标签集合

GET /kms/files/{fileId}/auto/categorys

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
fileId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 创建归档文件

POST /kms/archive/file

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
id	query	string	否	none
diskId	query	string	否	none
fileName	query	string	否	none
longSize	query	string	否	none
folderId	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 根据文件id取预览页面

GET /kms/disks/files/{fileId}/preview

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
fileId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 知识地图重建索引(文件名重建索引)

GET /kms/fileName/rebuildIndex

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 根据文件id获取所在文件夹名称

GET /kms//files/{id}/folder/name

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
id	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 上传文件夹

POST /kms/folder/upload

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
folderId	query	string	否	none
diskId	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

知识文档/搜索模块

GET 文件搜索列表

GET /kms/search/files

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
keyWord	query	string	否	关键词
selectTitle	query	string	否	标题是否搜索-true/false
selectContent	query	string	否	内容是否搜索-true/false
creator	query	string	否	创建人
beginTime	query	string	否	时间范围-开始时间-毫秒值
endTime	query	string	否	时间范围-结束时间-毫秒值
fileTypes	query	string	否	文件类型-doc/docx/ppt/pptx/xls/xlsx
categoryIds	query	string	否	标签id集合
scope	query	string	否	区域
pageNo	query	string	否	页数
linesPerPage	query	string	否	每页显示数量

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 1,
    "linesPerPage": 10,
    "pageNo": 1,
    "datas": [
      {
        "id": "a5133813-54f9-45ac-bed0-3bb6c96d137f",
        "name": "2018.1.19信息参阅第18期人行道<span style='color:red;'>建设</span>与治理专刊 (1).doc",
        "creatorId": "zPsp2hk7CEwtqeMCwtj",
        "creator": "管理员",
        "createDate": "2020-06-08",
        "lastModifyDate": "2020-06-08",
        "diskId": "0dd1e1c1-b5dd-41f4-8e3e-c0479448faf9",
        "folderId": "a56f8f78-52b4-44ef-af2e-fe4136974500",
        "folder": false,
        "size": 98586,
        "path": "0dd1e1c1-b5dd-41f4-8e3e-c0479448faf9/a56f8f78-52b4-44ef-af2e-fe4136974500",
        "type": "doc",
        "url": "0dd1e1c1-b5dd-41f4-8e3e-c0479448faf9/202006/a5133813-54f9-45ac-bed0-3bb6c96d137f.doc",
        "originType": 1,
        "originId": null,
        "categorys": null,
        "categorysJson": [
          {
            "isAuto": true,
            "categoryName": "2",
            "categoryId": "4e8278fe-df5d-4542-b044-5f9673fd5d4a",
            "fileId": "a5133813-54f9-45ac-bed0-3bb6c96d137f"
          },
          {
            "isAuto": false,
            "categoryName": "素质",
            "categoryId": "61b0c95e-9660-4b6b-9d87-d217c132562b",
            "fileId": "a5133813-54f9-45ac-bed0-3bb6c96d137f"
          },
          {
            "isAuto": false,
            "categoryName": "天河区",
            "categoryId": "52ec8721-c5a5-475f-b3dc-208a228765c8",
            "fileId": "a5133813-54f9-45ac-bed0-3bb6c96d137f"
          },
          {
            "isAuto": false,
            "categoryName": "审核意见",
            "categoryId": "90fedf5e-fb65-4b9b-ab63-ecab39c7e61a",
            "fileId": "a5133813-54f9-45ac-bed0-3bb6c96d137f"
          },
          {
            "isAuto": false,
            "categoryName": "广州市",
            "categoryId": "d0afdbdc-ea28-4dd1-b3e8-54a14e2e0071",
            "fileId": "a5133813-54f9-45ac-bed0-3bb6c96d137f"
          }
        ],
        "views": 0,
        "lastViewDate": null,
        "downloads": 0,
        "lastDownloadDate": null,
        "shares": 0,
        "lastShareDate": null,
        "collects": 0,
        "lastCollectDate": null,
        "lastEditDate": null,
        "good": 0,
        "bad": 0,
        "fileType": "doc",
        "content": "<abc style='color:red;'>建设</abc>",
        "resourceType": "1",
        "pageCount": "17",
        "folderName": "bb"
      }
    ],
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的对象数据
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» name	string	false	none	none
»»» creatorId	string	false	none	none
»»» creator	string	false	none	none
»»» createDate	string	false	none	none
»»» lastModifyDate	string	false	none	none
»»» diskId	string	false	none	none
»»» folderId	string	false	none	none
»»» folder	boolean	false	none	none
»»» size	integer	false	none	none
»»» path	string	false	none	none
»»» type	string	false	none	none
»»» url	string	false	none	none
»»» originType	integer	false	none	none
»»» originId	null	false	none	none
»»» categorys	null	false	none	none
»»» categorysJson	[object]	false	none	none
»»»» isAuto	boolean	true	none	none
»»»» categoryName	string	true	none	none
»»»» categoryId	string	true	none	none
»»»» fileId	string	true	none	none
»»» views	integer	false	none	none
»»» lastViewDate	null	false	none	none
»»» downloads	integer	false	none	none
»»» lastDownloadDate	null	false	none	none
»»» shares	integer	false	none	none
»»» lastShareDate	null	false	none	none
»»» collects	integer	false	none	none
»»» lastCollectDate	null	false	none	none
»»» lastEditDate	null	false	none	none
»»» good	integer	false	none	none
»»» bad	integer	false	none	none
»»» fileType	string	false	none	none
»»» content	string	false	none	none
»»» resourceType	string	false	none	none
»»» pageCount	string	false	none	none
»»» folderName	string	false	none	none
»» pageCount	integer	true	none	none

GET 最新浏览文件列表

GET /kms/search/files/lastest_view

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
pageNo	query	string	否	当前页
linesPerPage	query	string	否	每页条数
linesPerPage	query	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 33,
    "linesPerPage": 5,
    "pageNo": 1,
    "datas": [
      {
        "id": "4d8ee020-7f2d-4490-9adf-a654a6e45d7e",
        "name": "江苏省邮电规划设计院知识管理系统需求文档V4.0.docx",
        "creatorId": "11e6-5fac-d126bfe2-a02a-b789a6ff0217",
        "creator": "康妮",
        "createDate": "2017-08-09",
        "lastModifyDate": null,
        "diskId": "45e196e4-cdc7-4911-b1a0-0eab8cff2aac",
        "folderId": "cfe92a5b-8fa3-45fd-896b-5ed27365bfe6",
        "folder": false,
        "size": 7514142,
        "path": "\\\\45e196e4-cdc7-4911-b1a0-0eab8cff2aac/cfe92a5b-8fa3-45fd-896b-5ed27365bfe6",
        "type": "docx",
        "url": "45e196e4-cdc7-4911-b1a0-0eab8cff2aac/201708/4d8ee020-7f2d-4490-9adf-a654a6e45d7e.docx",
        "originType": 0,
        "originId": null,
        "views": 0,
        "lastViewDate": null,
        "downloads": 0,
        "lastDownloadDate": null,
        "shares": 0,
        "lastShareDate": null,
        "collects": 0,
        "lastCollectDate": null,
        "good": 0,
        "bad": 0
      }
    ],
    "pageCount": 7
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

GET 最新搜素文件列表

GET /kms/search/files/lastest_search

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
pageNo	query	string	否	none
linesPerPage	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 最新分享文件列表

GET /kms/search/files/lastest_share

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
pageNo	query	string	是	当前页
linesPerPage	query	string	是	每页条数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 33,
    "linesPerPage": 5,
    "pageNo": 1,
    "datas": [
      {
        "id": "4d8ee020-7f2d-4490-9adf-a654a6e45d7e",
        "name": "江苏省邮电规划设计院知识管理系统需求文档V4.0.docx",
        "creatorId": "11e6-5fac-d126bfe2-a02a-b789a6ff0217",
        "creator": "康妮",
        "createDate": "2017-08-09",
        "lastModifyDate": null,
        "diskId": "45e196e4-cdc7-4911-b1a0-0eab8cff2aac",
        "folderId": "cfe92a5b-8fa3-45fd-896b-5ed27365bfe6",
        "folder": false,
        "size": 7514142,
        "path": "\\\\45e196e4-cdc7-4911-b1a0-0eab8cff2aac/cfe92a5b-8fa3-45fd-896b-5ed27365bfe6",
        "type": "docx",
        "url": "45e196e4-cdc7-4911-b1a0-0eab8cff2aac/201708/4d8ee020-7f2d-4490-9adf-a654a6e45d7e.docx",
        "originType": 0,
        "originId": null,
        "views": 0,
        "lastViewDate": null,
        "downloads": 0,
        "lastDownloadDate": null,
        "shares": 0,
        "lastShareDate": null,
        "collects": 0,
        "lastCollectDate": null,
        "good": 0,
        "bad": 0
      }
    ],
    "pageCount": 7
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的表单对象
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» name	string	false	none	none
»»» creatorId	string	false	none	none
»»» creator	string	false	none	none
»»» createDate	string	false	none	none
»»» lastModifyDate	null	false	none	none
»»» diskId	string	false	none	none
»»» folderId	string	false	none	none
»»» folder	boolean	false	none	none
»»» size	integer	false	none	none
»»» path	string	false	none	none
»»» type	string	false	none	none
»»» url	string	false	none	none
»»» originType	integer	false	none	none
»»» originId	null	false	none	none
»»» views	integer	false	none	none
»»» lastViewDate	null	false	none	none
»»» downloads	integer	false	none	none
»»» lastDownloadDate	null	false	none	none
»»» shares	integer	false	none	none
»»» lastShareDate	null	false	none	none
»»» collects	integer	false	none	none
»»» lastCollectDate	null	false	none	none
»»» good	integer	false	none	none
»»» bad	integer	false	none	none
»» pageCount	integer	true	none	none

GET 根据资源获取授权列表

GET /kms/resources/{resourceId}/authorizations

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
resourceId	path	string	是	none
pageNo	query	string	否	none
linesPerPage	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 创建授权信息

POST /kms/resources/{resourceId}/authorizations

Body 请求参数

{
  "description": "技术研发部_一级目录1_1.txt",
  "scope": 1,
  "targetId": [
    "11e7-7045-31a4aecf-85f9-cbfc8973e987"
  ],
  "targetName": "Oliver",
  "startDate": 1502953873385,
  "endDate": 1502953873385,
  "resourceId": "d46b2ed9-ec75-40c6-9bdf-d35e7aa309dc",
  "resourceType": 1,
  "operations": [
    "1",
    "2"
  ]
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
resourceId	path	string	是	资源ID
body	body	object	否	none
» description	body	string	是	资源名称
» scope	body	integer	是	授权范围
» targetId	body	[string]	是	用户ID数组
» targetName	body	string	是	数组对应的用户名，仅用于前台回显
» startDate	body	integer	是	起始时间
» endDate	body	integer	是	结束时间
» resourceId	body	string	是	资源ID
» resourceType	body	integer	是	资源类型
» operations	body	[string]	是	授权权限

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "15c87e9e-9123-4191-add8-fa7a4c070dc0",
    "description": "技术研发部_一级目录1_1.txt",
    "scope": 1,
    "targetId": [
      "11e7-7045-31a4aecf-85f9-cbfc8973e987"
    ],
    "targetName": "Oliver",
    "startDate": 1502882808693,
    "endDate": 1502882808693,
    "creatorId": "11e7-80be-f5cbdfaa-8e11-e7a531ef9423",
    "creator": "Annie",
    "createDate": 1502882808693,
    "resourceId": "d46b2ed9-ec75-40c6-9bdf-d35e7aa309dc",
    "resourceType": 1,
    "operations": [
      "1",
      "2"
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		none
» errmsg	string	true	none		none

DELETE 删除授权信息

DELETE /kms/authorizations

Body 请求参数

[
  "e13b99c3-5706-4708-836e-7be6d9c9a871"
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	array[string]	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述说明
» data	boolean	true	none	返回操作是否成功，true/false

POST 更新授权信息

POST /kms/resources/{resourceId}/authorizations/{authorizationId}

Body 请求参数

{
  "id": "15c87e9e-9123-4191-add8-fa7a4c070dc0",
  "description": "技术研发部_一级目录1_1.txt",
  "scope": 1,
  "targetId": [
    "11e7-7045-31a4aecf-85f9-cbfc8973e987"
  ],
  "targetName": "Oliver",
  "startDate": 1502882808693,
  "endDate": 1502882808693,
  "creatorId": "11e7-80be-f5cbdfaa-8e11-e7a531ef9423",
  "creator": "Annie",
  "createDate": 1502882808693,
  "resourceId": "d46b2ed9-ec75-40c6-9bdf-d35e7aa309dc",
  "resourceType": 1,
  "operations": [
    "1",
    "2"
  ]
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
resourceId	path	string	是	资源ID
authorizationId	path	string	是	none
body	body	object	否	none
» id	body	string	是	none
» description	body	string	是	none
» scope	body	integer	是	none
» targetId	body	[string]	是	none
» targetName	body	string	是	none
» startDate	body	integer	是	none
» endDate	body	integer	是	none
» creatorId	body	string	是	none
» creator	body	string	是	none
» createDate	body	integer	是	none
» resourceId	body	string	是	none
» resourceType	body	integer	是	none
» operations	body	[string]	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "15c87e9e-9123-4191-add8-fa7a4c070dc0",
    "description": "技术研发部_一级目录1_1.txt",
    "scope": 1,
    "targetId": [
      "11e7-7045-31a4aecf-85f9-cbfc8973e987"
    ],
    "targetName": "Oliver",
    "startDate": 1502882808693,
    "endDate": 1502882808693,
    "creatorId": "11e7-80be-f5cbdfaa-8e11-e7a531ef9423",
    "creator": "Annie",
    "createDate": 1502882808693,
    "resourceId": "d46b2ed9-ec75-40c6-9bdf-d35e7aa309dc",
    "resourceType": 1,
    "operations": [
      "1",
      "2"
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	none
» errmsg	string	true	none	none
» data	object	true	none	none
»» id	string	true	none	none
»» description	null	true	none	none
»» scope	integer	true	none	none
»» targetId	[string]	true	none	none
»» targetName	string	true	none	none
»» startDate	string	true	none	none
»» endDate	string	true	none	none
»» creatorId	string	true	none	none
»» creator	string	true	none	none
»» createDate	string	true	none	none
»» resourceId	string	true	none	none
»» resourceType	integer	true	none	none
»» operations	[string]	true	none	none

GET 用户最近上传文件列表

GET /kms/search/files/myLastest_upload

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
pageNo	query	string	否	none
linesPerPage	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 最新上传文件列表

GET /kms/search/files/lastest_upload

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
pageNo	query	string	否	none
linesPerPage	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 用户最近编辑的word文档列表

GET /kms/search/files/myRecent_edit

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
pageNo	query	string	否	none
linesPerPage	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 最热浏览次数文件列表

GET /kms/search/files/hot_view

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
pageNo	query	string	否	none
linesPerPage	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 用户最近预览文档列表

GET /kms/search/files/myRecent_preview

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
pageNo	query	string	否	none
linesPerPage	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 用户最近搜素文件列表

GET /kms/search/files/myLastest_search

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
pageNo	query	string	否	none
linesPerPage	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

知识文档/团队（Teams）

POST 创建团队

POST /kms/teams

Body 请求参数

{
  "name": "teamName",
  "description": "description",
  "serialNumber": "20170823002",
  "deptPermission": [
    "download",
    "preview"
  ],
  "compPermission": [
    "download",
    "preview"
  ],
  "members": [
    {
      "name": "userName",
      "type": 1,
      "userId": "userId"
    },
    {
      "name": "userName",
      "type": 0,
      "userId": "userId"
    }
  ]
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» name	body	string	是	none
» description	body	string	是	none
» serialNumber	body	string	是	none
» deptPermission	body	[string]	是	none
» compPermission	body	[string]	是	none
» members	body	[object]	是	none
»» name	body	string	是	none
»» type	body	integer	是	none
»» userId	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "1c43e748-2edb-4b8e-84bd-b46adaac8263",
    "name": "c++222",
    "serialNumber": "20170821001",
    "description": "desc",
    "creatorId": "11e7-7045-31a4aecf-85f9-cbfc8973e987",
    "creator": "Oliver",
    "createDate": 1503298639088,
    "members": [
      {
        "id": "c6f7f43d-dabb-40f5-a5ad-cf7f38545fad",
        "name": "用户名1",
        "type": 0,
        "teamId": "1c43e748-2edb-4b8e-84bd-b46adaac8263",
        "userId": "用户id1"
      },
      {
        "id": "4a8faedd-7664-4f36-b2d5-2c1d44e4a4d7",
        "name": "用户名2",
        "type": 1,
        "teamId": "1c43e748-2edb-4b8e-84bd-b46adaac8263",
        "userId": "用户id2"
      }
    ],
    "stages": [],
    "deptPermission": [
      "download",
      "preview"
    ],
    "compPermission": [
      "download",
      "preview"
    ],
    "diskId": "3a5d55bf-6d5e-45f0-8fee-1f5bba8e0b3a"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» id	string	true	none	none
»» name	string	true	none	none
»» serialNumber	string	true	none	none
»» description	string	true	none	none
»» creatorId	string	true	none	none
»» creator	string	true	none	none
»» members	[object]	true	none	none
»»» id	string	true	none	none
»»» name	string	true	none	none
»»» type	integer	true	none	none
»»» teamId	string	true	none	none
»»» userId	string	true	none	none
»» stages	[string]	true	none	none
»» deptPermission	[string]	true	none	none
»» compPermission	[string]	true	none	none
»» diskId	string	true	none	none

DELETE 删除团队

DELETE /kms/teams

Body 请求参数

[
  "teamId1",
  "teamId2"
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	array[string]	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

没有权限

{
  "errcode": 401,
  "errmsg": "没有删除[XXX团队名称]的权限"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline
401	Unauthorized	没有权限	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回的视图对象

状态码 401

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

GET 团队集合

GET /kms/teams

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
isMyTeams	query	string	否	none
linesPerPage	query	string	否	none
pageNo	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

PUT 更新团队

PUT /kms/teams/{teamId}

Body 请求参数

{
  "teamId": "teamId",
  "name": "teamName",
  "description": "description",
  "serialNumber": "20170823002",
  "deptPermission": [
    "download",
    "preview"
  ],
  "compPermission": [
    "download",
    "preview"
  ],
  "members": [
    {
      "name": "userName",
      "type": 0,
      "teamId": "teamId",
      "userId": "userId"
    },
    {
      "name": "userName",
      "type": 1,
      "teamId": "teamId",
      "userId": "userId"
    }
  ]
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
teamId	path	string	是	团队id
body	body	object	否	none
» teamId	body	string	是	none
» name	body	string	是	none
» description	body	string	是	none
» serialNumber	body	string	是	none
» deptPermission	body	[string]	是	none
» compPermission	body	[string]	是	none
» members	body	[object]	是	none
»» name	body	string	是	none
»» type	body	integer	是	none
»» teamId	body	string	是	none
»» userId	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "57d9e050-d68f-462e-af32-117ed16ee963",
    "name": "团队名称2",
    "serialNumber": "20170809001",
    "description": "第2次修改",
    "creatorId": "b27f525b-f44f-4519-8bf1-2087382d4f56",
    "creator": "邢专员（行政专员）",
    "createDate": 1502236800000,
    "members": [
      {
        "id": "6e5cf85f-a3ad-4db5-ad2b-88ddbcf36b0f",
        "name": "邢专员（行政专员）",
        "type": 1,
        "teamId": "57d9e050-d68f-462e-af32-117ed16ee963",
        "userId": "b27f525b-f44f-4519-8bf1-2087382d4f56"
      }
    ],
    "stages": [
      {
        "id": "c67c5eb2-89c4-4643-818c-0831f5d82edf",
        "name": "基础数据初始阶段",
        "teamId": "57d9e050-d68f-462e-af32-117ed16ee963",
        "folderId": "1eb0dc00-4154-4dd5-8a2b-855af65a160c",
        "comments": "[]",
        "orderNo": 0,
        "commentList": [
          {
            "id": "b29a648f-0374-4604-b224-6826d2f74736",
            "content": "基础数据评论1",
            "creatorId": "b27f525b-f44f-4519-8bf1-2087382d4f56",
            "creator": "邢专员（行政专员）",
            "createDate": 1502249111318
          }
        ]
      },
      {
        "id": "efc48775-d05a-426e-9f00-048fe27d4964",
        "name": "基础数据中级阶段",
        "teamId": "57d9e050-d68f-462e-af32-117ed16ee963",
        "folderId": "3511315c-a049-4dee-b065-d52cd9b1acb4",
        "comments": null,
        "orderNo": 0,
        "commentList": []
      }
    ],
    "deptPermission": [
      "download",
      "preview"
    ],
    "compPermission": null,
    "diskId": "9679acdd-81b7-4091-adee-f2754d91e6b9"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» id	string	true	none	none
»» name	string	true	none	none
»» serialNumber	string	true	none	none
»» description	string	true	none	none
»» creatorId	string	true	none	none
»» creator	string	true	none	none
»» members	[object]	true	none	none
»»» id	string	false	none	none
»»» name	string	false	none	none
»»» type	integer	false	none	none
»»» teamId	string	false	none	none
»»» userId	string	false	none	none
»» stages	[object]	true	none	none
»»» id	string	true	none	none
»»» name	string	true	none	none
»»» teamId	string	true	none	none
»»» folderId	string	true	none	none
»»» comments	string¦null	true	none	none
»»» orderNo	integer	true	none	none
»»» commentList	[object]	true	none	none
»»»» id	string	false	none	none
»»»» content	string	false	none	none
»»»» creatorId	string	false	none	none
»»»» creator	string	false	none	none
»»»» createDate	integer	false	none	none
»» deptPermission	[string]	true	none	none
»» diskId	string	true	none	none

GET 获取指定团队

GET /kms/teams/{teamId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
teamId	path	string	是	团队id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "1c43e748-2edb-4b8e-84bd-b46adaac8263",
    "name": "c++222",
    "serialNumber": "20170821001",
    "description": "desc",
    "creatorId": "11e7-7045-31a4aecf-85f9-cbfc8973e987",
    "creator": "Oliver",
    "createDate": 1503298639088,
    "members": [
      {
        "id": "c6f7f43d-dabb-40f5-a5ad-cf7f38545fad",
        "name": "用户名1",
        "type": 0,
        "teamId": "1c43e748-2edb-4b8e-84bd-b46adaac8263",
        "userId": "用户id1"
      },
      {
        "id": "4a8faedd-7664-4f36-b2d5-2c1d44e4a4d7",
        "name": "用户名2",
        "type": 1,
        "teamId": "1c43e748-2edb-4b8e-84bd-b46adaac8263",
        "userId": "用户id2"
      }
    ],
    "stages": [],
    "deptPermission": [
      "download",
      "preview"
    ],
    "compPermission": [
      "download",
      "preview"
    ],
    "diskId": "3a5d55bf-6d5e-45f0-8fee-1f5bba8e0b3a"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» id	string	true	none	none
»» name	string	true	none	none
»» serialNumber	string	true	none	none
»» description	string	true	none	none
»» creatorId	string	true	none	none
»» creator	string	true	none	none
»» members	[object]	true	none	none
»»» id	string	true	none	none
»»» name	string	true	none	none
»»» type	integer	true	none	none
»»» teamId	string	true	none	none
»»» userId	string	true	none	none
»» stages	[string]	true	none	none
»» deptPermission	[string]	true	none	none
»» compPermission	[string]	true	none	none
»» diskId	string	true	none	none

GET 获取团队编号

GET /kms/teams/serialNumber

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "20170823002"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	返回的视图对象

GET 查询团队

GET /kms/teams/

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
isMyTeams	query	string	是	True/false,是否点了我参与的团队，为空时””
serialNumber	query	string	否	查询时，用户是否有填编号,为空时””
creator	query	string	否	查询时，用户是否有填创建者，为空时””
departmentId	query	string	否	查询时，用户是否有填部门(部门id), 为空时””
teamName	query	string	否	查询时，用户是否有填团队名称, 为空时””
beginTime	query	string	否	查询时，用户是否有时间范围, 为空时””
endTime	query	string	否	查询时，用户是否有时间范围, 为空时””
linesPerPage	query	string	是	每页显示的条数
pageNo	query	string	是	第几页

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 1,
    "linesPerPage": 15,
    "pageNo": 1,
    "datas": [
      {
        "id": "416c5d1c-35f1-4a07-aedf-7fc3f6239f57",
        "name": "技术支持组",
        "serialNumber": "20200615001",
        "description": "技术支持组",
        "creatorId": "qxtJKvUApXkqDWUHWt2",
        "creator": "陈小聪",
        "createDate": "2020-06-15",
        "members": [
          {
            "id": "2fe4e6eb-b5fd-4a95-bb7c-41e83771ea47",
            "name": "陈小聪",
            "type": 1,
            "teamId": "416c5d1c-35f1-4a07-aedf-7fc3f6239f57",
            "userId": "qxtJKvUApXkqDWUHWt2"
          }
        ],
        "stages": [],
        "deptPermission": [
          "preview",
          "download"
        ],
        "compPermission": [
          "preview"
        ],
        "diskId": "416c5d1c-35f1-4a07-aedf-7fc3f6239f57",
        "subscription": false
      }
    ],
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

GET 团队下的成员集合

GET /kms/teams/{teamId}/members

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
teamId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 申请加入团队（已废弃）

POST /kms/teams/{teamId}/member

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
teamId	path	string	是	团队id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "514606c3-d10d-44ac-b9af-80229422433d",
    "name": "user3",
    "type": 0,
    "teamId": "746122f8-3bd9-4b9d-852d-f0bb12b40e82",
    "userId": "11e9-a221-c98ca9ad-a6b6-d110b71dd060"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» id	string	true	none	none
»» name	string	true	none	none
»» type	integer	true	none	none
»» teamId	string	true	none	none
»» userId	string	true	none	none

GET 根据团队id获取团队管理员用户（已废弃）

GET /kms/teams/applications/approvers

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
teamId	query	string	否	团队id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "11e9-97b7-64c3bedb-bb3a-9339eb852df7",
      "name": "admin1",
      "nameLetter": "admin1",
      "loginno": "admin1",
      "email": "",
      "telephone": "",
      "avatar": "",
      "favoriteContacts": "",
      "superior": null,
      "roles": [
        {
          "id": "0100",
          "name": "企业知识管理员",
          "levels": 100
        },
        {
          "id": "0020",
          "name": "专委会知识管理员",
          "levels": 20
        },
        {
          "id": "0010",
          "name": "部门知识管理员",
          "levels": 10
        },
        {
          "id": "0001",
          "name": "员工",
          "levels": 0
        }
      ],
      "domainid": "11e9-97b6-a4b1ac2a-bb3a-9339eb852df7",
      "defaultDepartment": "11e9-97b7-4caa76d1-bb3a-9339eb852df7",
      "calendarType": "11e9-97b6-a4c1d8d4-bb3a-9339eb852df7",
      "status": 1,
      "level": 0
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	读返回码的文本描述内容
» data	[object]	true	none	返回的视图对象
»» id	string	false	none	none
»» name	string	false	none	none
»» nameLetter	string	false	none	none
»» loginno	string	false	none	none
»» email	string	false	none	none
»» telephone	string	false	none	none
»» avatar	string	false	none	none
»» favoriteContacts	string	false	none	none
»» superior	null	false	none	none
»» roles	[object]	false	none	none
»»» id	string	true	none	none
»»» name	string	true	none	none
»»» levels	integer	true	none	none
»» domainid	string	false	none	none
»» defaultDepartment	string	false	none	none
»» calendarType	string	false	none	none
»» status	integer	false	none	none
»» level	integer	false	none	none

GET 获取km的团队和专委会是否点击打开

GET /kms/realmAndTeam

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 以list的集合得到我的团队（我创建的，我参加的）

GET /kms/myTeams

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

PUT 更新团队名称

PUT /kms/teams/{teamId}/name

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
teamId	path	string	是	none
teamName	query	string	否	none
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

知识文档/阶段（Stages）

GET 得到阶段集合

GET /kms/teams/{teamId}/stages

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
teamId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 创建阶段

POST /kms/stages

Body 请求参数

{
  "name": "stageName",
  "teamId": "teamId",
  "orderNo": 2
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» name	body	string	是	none
» teamId	body	string	是	团队id
» orderNo	body	integer	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "af902b84-eb87-42b8-9921-dbf590bd6227",
    "name": "阶段一",
    "teamId": "57d9e050-d68f-462e-af32-117ed16ee963",
    "folderId": "a935893b-48e1-4a13-823a-5909db47b4d6",
    "comments": null,
    "orderNo": 0,
    "commentList": []
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» id	string	true	none	none
»» name	string	true	none	none
»» teamId	string	true	none	none
»» folderId	string	true	none	none
»» comments	null	true	none	none
»» orderNo	integer	true	none	none
»» commentList	[string]	true	none	none

PUT 编辑阶段的名称

PUT /kms/stages

Body 请求参数

{
  "id": "阶段id",
  "name": "阶段名称"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» id	body	string	是	阶段id
» name	body	string	是	阶段名称

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "2559cea4-01b2-45ea-a852-0770745cd450",
    "name": "我要更改名称8.25",
    "teamId": "e4fb76a6-6bf7-4ad4-9f46-869312ccc9d2",
    "folderId": "33d34551-35ed-4de3-bb8f-45f2863460ed",
    "comments": "[]",
    "orderNo": 0,
    "commentList": []
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» id	string	true	none	none
»» name	string	true	none	none
»» teamId	string	true	none	none
»» folderId	string	true	none	none
»» comments	null	true	none	none
»» orderNo	integer	true	none	none
»» commentList	[string]	true	none	none

DELETE 删除阶段

DELETE /kms/stages

Body 请求参数

[
  "stageId1",
  "stageId2"
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

没有权限

{
  "errcode": 401,
  "errmsg": "没有删除[基础数据初始阶段]的阶段权限"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline
401	Unauthorized	没有权限	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回的视图对象

状态码 401

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		返回码的文本描述内容

GET 得到一个阶段

GET /kms/stages/{stageId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
stageId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 创建阶段评论

GET /kms/stages/{stageId}/comments

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
stageId	path	string	是	阶段id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	返回码的文本描述内容1
» data	boolean	false	none	返回的视图对象

DELETE 删除阶段评论

DELETE /kms/stages/{stageId}/comments/{commentId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
stageId	path	string	是	阶段id
commentId	path	string	是	评论id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

没有权限

{
  "errcode": 401,
  "errmsg": "你没有删除评论的权限"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline
401	Unauthorized	没有权限	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回的视图对象

状态码 401

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		返回码的文本描述内容

知识文档/部门（Department）

GET 企业域下部门集合

GET /kms/departments

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "11e7-7045-1c91a1dc-85f9-cbfc8973e987",
      "name": "江苏省邮电规划设计院",
      "parentId": null,
      "children": [
        {
          "id": "11e7-7045-2da34ac9-85f9-cbfc8973e231",
          "name": "技术研发部",
          "parentId": "11e7-7045-1c91a1dc-85f9-cbfc8973e987",
          "children": [],
          "leaf": true
        },
        {
          "id": "11e7-7045-2da34ac9-85f9-cbfc8973e987",
          "name": "测试数据",
          "parentId": "11e7-7045-1c91a1dc-85f9-cbfc8973e987",
          "children": [],
          "leaf": true
        }
      ],
      "leaf": false
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

知识文档/用户（Users）

GET 获取当前登录用户

GET /kms/users/myprofile

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "11e7-7045-31a4aecf-85f9-cbfc8973e987",
    "name": "Oliver",
    "nameLetter": "Oliver",
    "loginno": "oliver",
    "email": "",
    "telephone": "",
    "avatar": null,
    "favoriteContacts": "",
    "superior": "",
    "roles": [],
    "domainid": "11e7-7045-1c856cdb-85f9-cbfc8973e987",
    "defaultDepartment": "11e7-7045-2da34ac9-85f9-cbfc8973e987",
    "calendarType": "11e7-7045-1c9a7b7d-85f9-cbfc8973e987",
    "status": 1,
    "level": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

GET 获取用户

GET /kms/users/{id}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
id	path	string	是	用户id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "11e7-7045-31a4aecf-85f9-cbfc8973e987",
    "name": "Oliver",
    "nameLetter": "Oliver",
    "loginno": "oliver",
    "email": "",
    "telephone": "",
    "avatar": "",
    "favoriteContacts": "",
    "superior": null,
    "roles": [],
    "domainid": "11e7-7045-1c856cdb-85f9-cbfc8973e987",
    "defaultDepartment": "11e7-7045-2da34ac9-85f9-cbfc8973e987",
    "calendarType": "11e7-7045-1c9a7b7d-85f9-cbfc8973e987",
    "status": 1,
    "level": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» id	string	true	none	none
»» name	string	true	none	none
»» nameLetter	string	true	none	none
»» loginno	string	true	none	none
»» email	string	true	none	none
»» telephone	string	true	none	none
»» avatar	null	true	none	none
»» favoriteContacts	null	true	none	none
»» superior	null	true	none	none
»» domainid	string	true	none	none
»» defaultDepartment	string	true	none	none
»» calendarType	string	true	none	none
»» status	integer	true	none	none
»» level	integer	true	none	none

GET 用户选择框：获取指定部门下的用户

GET /kms/users/selectbox/departments/{departmentId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
departmentId	path	string	是	指定部门
pageNo	query	string	是	第几页
linesPerPage	query	string	是	每页显示的条数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "linesPerPage": 10,
    "pageCount": 1,
    "datas": [
      {
        "id": "11e7-a198-3969df1c-a900-73852bc58bcf",
        "name": "企业知识管理员",
        "type": 1,
        "mobile": "",
        "mobile2": "",
        "email": "",
        "avatar": "",
        "dept": "江苏省南京规划设计院",
        "deptId": null,
        "loginNo": "superadmin",
        "domainId": "11e7-a197-b8af019e-a900-73852bc58bcf"
      }
    ],
    "pageNo": 1,
    "rowCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

GET 用户选择框：异步获取部门

GET /kms/users/selectbox/departments

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
parentDeptId	query	string	否	指定部门,若该字段为空，则获取根部门s
linesPerPage	query	string	是	每页显示的条数
pageNo	query	string	是	第几页

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "11e7-a197-b8c71d7f-a900-73852bc58bcf",
      "name": "江苏省南京规划设计院",
      "type": 2,
      "code": "00",
      "level": 0,
      "children": []
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码文本描述内容
» data	[object]	true	none	none
»» id	string	false	none	none
»» name	string	false	none	none
»» type	integer	false	none	none
»» code	string	false	none	none
»» level	integer	false	none	none
»» children	[string]	false	none	none

POST 为用户赋角色

POST /kms/users/userroleset

Body 请求参数

{
  "userIds": [
    "userId1",
    "userId2"
  ],
  "roleIds": [
    "roleId1",
    "roleId2"
  ]
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» userIds	body	[string]	是	none
» roleIds	body	[string]	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回的视图对象

GET 用户分页的列表

GET /kms/users/roles/realmAdmin

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
name	query	string	否	当为空时，把全部的专委会管理员的用户列出来
linesPerPage	query	string	是	每页显示的条数
pageNo	query	string	是	第几页

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 1,
    "linesPerPage": 10,
    "pageNo": 1,
    "datas": [
      {
        "id": "11e7-a1fd-13d2f69b-8d43-3528ba91253b",
        "name": "oliver2",
        "nameLetter": "oliver2",
        "loginno": "oliver2",
        "email": "we@qq.com",
        "telephone": "",
        "avatar": "",
        "favoriteContacts": "",
        "superior": null,
        "roles": [
          {
            "id": "0010",
            "name": "部门知识管理员",
            "levels": 10
          },
          {
            "id": "0020",
            "name": "专委会知识管理员",
            "levels": 20
          }
        ],
        "domainid": "11e7-9b79-61d7f3d6-8848-c9fe21dcc7c4",
        "defaultDepartment": "11e7-a1fb-3e7ecd59-8d43-3528ba91253b",
        "calendarType": "11e7-9b79-61e22d08-8848-c9fe21dcc7c4",
        "status": 1,
        "level": 0
      }
    ],
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

GET 获取以通讯录为树形结构的用户集合

GET /kms/users/selectbox/contacts

Body 请求参数

{}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "linesPerPage": 10,
    "pageCount": 1,
    "datas": [
      {
        "id": "11e7-80be-f5cbdfaa-8e11-e7a531ef9423",
        "name": "康妮",
        "type": 1,
        "mobile": "",
        "mobile2": "",
        "email": "",
        "avatar": "",
        "dept": "测试数据",
        "deptId": "11e7-7045-2da34ac9-85f9-cbfc8973e987",
        "loginNo": "annie",
        "domainId": "11e7-7045-1c856cdb-85f9-cbfc8973e987"
      },
      {
        "id": "11e7-7045-31a4aecf-85f9-cbfc8973e987",
        "name": "Oliver",
        "type": 1,
        "mobile": "",
        "mobile2": "",
        "email": "",
        "avatar": "",
        "dept": "测试数据",
        "deptId": "11e7-7045-2da34ac9-85f9-cbfc8973e987",
        "loginNo": "oliver",
        "domainId": "11e7-7045-1c856cdb-85f9-cbfc8973e987"
      },
      {
        "id": "11e7-80bf-450a6f38-8e11-e7a531ef9423",
        "name": "企业文档管理员",
        "type": 1,
        "mobile": "",
        "mobile2": "",
        "email": "",
        "avatar": "",
        "dept": "江苏省邮电规划设计院",
        "deptId": "11e7-7045-1c91a1dc-85f9-cbfc8973e987",
        "loginNo": "superadmin",
        "domainId": "11e7-7045-1c856cdb-85f9-cbfc8973e987"
      },
      {
        "id": "11e7-80bf-0a5dfcbc-8e11-e7a531ef9423",
        "name": "seven",
        "type": 1,
        "mobile": "",
        "mobile2": "",
        "email": "",
        "avatar": "",
        "dept": "测试数据",
        "deptId": "11e7-7045-2da34ac9-85f9-cbfc8973e987",
        "loginNo": "seven",
        "domainId": "11e7-7045-1c856cdb-85f9-cbfc8973e987"
      }
    ],
    "pageNo": 1,
    "rowCount": 4
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

GET 用户选择框：根据关键词查询用户

GET /kms/users/selectbox/search

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
keyword	query	string	是	查询关键词
pageNo	query	string	是	每页显示的条数
linesPerPage	query	string	是	第几页

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "linesPerPage": 10,
    "pageCount": 1,
    "datas": [
      {
        "id": "11e7-a198-3969df1c-a900-73852bc58bcf",
        "name": "企业知识管理员",
        "type": 1,
        "mobile": "",
        "mobile2": "",
        "email": "",
        "avatar": "",
        "dept": "江苏省南京规划设计院",
        "deptId": null,
        "loginNo": "superadmin",
        "domainId": "11e7-a197-b8af019e-a900-73852bc58bcf"
      }
    ],
    "pageNo": 1,
    "rowCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

GET 根据部门的id查找用户(没部门id默认为全部用户)

GET /kms//users

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
departmentId	query	string	否	none
nameOrAccount	query	string	否	none
linesPerPage	query	string	否	none
pageNo	query	string	否	none
roleId	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取部门下的用户集合

GET /kms/departments/{departmentId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
departmentId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

知识文档/订阅内容（Subscription）

DELETE 删除订阅内容

DELETE /kms/subscriptions

Body 请求参数

[
  "订阅id1",
  "订阅id2"
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	array[string]	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回的视图对象

POST 创建订阅内容

POST /kms/subscriptions

Body 请求参数

{
  "contentId": "资源id",
  "contentType": 1,
  "contentName": "团队1名称"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» contentId	body	string	是	资源id
» contentType	body	integer	是	资源类型
» contentName	body	string	是	资源名称

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "fcf44115-b4ac-46db-9e4b-aa1e1e8663c3",
    "userId": "b27f525b-f44f-4519-8bf1-2087382d4f56",
    "contentId": "e4fb76a6-6bf7-4ad4-9f46-869312ccc9d2",
    "contentType": 1,
    "contentName": "基础数据团队2",
    "createDate": 1503892004249
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» id	string	true	none	none
»» userId	string	true	none	none
»» contentId	string	true	none	none
»» contentType	integer	true	none	none
»» contentName	string	true	none	none

GET 查找订阅内容

GET /kms/subscriptions

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userId	query	string	是	用户id
linesPerPage	query	string	是	每页的数量
pageNo	query	string	是	现在的页数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 1,
    "linesPerPage": 3,
    "pageNo": 1,
    "datas": [
      {
        "id": "cb137308-66a8-43dd-9792-13341bec4e4e",
        "userId": "cb137308-66a8-1233-9792-13341bec4e4e",
        "contentId": "d46b2ed9-ec75-40c6-9bdf-d35e7aa309dc",
        "contentType": 2,
        "contentName": "团队1",
        "createDate": "2017-08-25"
      }
    ],
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» userId	string	false	none	none
»»» contentId	string	false	none	none
»»» contentType	integer	false	none	none
»»» contentName	string	false	none	none
»»» createDate	string	false	none	none
»» pageCount	integer	true	none	none

知识文档/订阅动态（SubscriptionNotice）

DELETE 删除订阅动态(单个/多个)

DELETE /kms/subscriptions/notices

Body 请求参数

[
  "订阅动态id1",
  "订阅动态id2"
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回的视图对象

GET 查询订阅动态

GET /kms/subscriptions/notices

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userId	query	string	是	用户id
linesPerPage	query	string	是	每页的数量
pageNo	query	string	是	现在的页数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 1,
    "linesPerPage": 5,
    "pageNo": 1,
    "datas": [
      {
        "id": "56b160f3-9b51-42ff-bf38-33d7e3fae13a",
        "userId": "cb137308-66a8-1233-9792-13341bec4e4e",
        "resourceId": "65849b39-9040-41c7-94ff-e657f74d65d0",
        "resourceName": "文件1",
        "resourceType": 1,
        "contentOwnerId": "46a1e6a4-a0f5-46a1-8d7d-559f27d2ab3f",
        "contentName": "团队名称1",
        "createDate": "2017-08-28",
        "read": false
      }
    ],
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» userId	string	false	none	none
»»» resourceId	string	false	none	none
»»» resourceName	string	false	none	none
»»» resourceType	integer	false	none	none
»»» contentOwnerId	string	false	none	none
»»» contentName	string	false	none	none
»»» createDate	string	false	none	none
»»» read	boolean	false	none	none
»» pageCount	integer	true	none	none

知识文档/申请权限（PermissionApplicationForm）

GET 根据文件的id查找审批人的信息

GET /kms/applications/approvers

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
pageNo	query	string	否	none
linesPerPage	query	string	否	none
resourceId	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 批量处理申请单

POST /kms/applications

请求包体：
同意时：
{
“ids”: [
“3f07bc70-c698-4eb0-a38b-b8b7be8d49f4”,
“b0e46a8c-cc48-4d74-9444-c491608516d3”],
“status”: 1
}

不同意时：
{
“ids”:
[
“3f07bc70-c698-4eb0-a38b-b8b7be8d49f4”,
“b0e46a8c-cc48-4d74-9444-c491608516d3”],
“rejectReason”: “拒绝理由”,
“status”: 2
}

Body 请求参数

{
  "resourceId": "488e1f8e-a613-4e65-a2f5-1880f19061ab"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» resourceId	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "3f07bc70-c698-4eb0-a38b-b8b7be8d49f4",
      "userId": "11e9-9f01-3257a890-b28b-1f246e24670c",
      "userName": "user2",
      "resourceId": "9f2b192a-91ce-4c0a-9d99-683ec94e5db7",
      "resourceName": "abc",
      "resourceType": 2,
      "fileObjectType": 1,
      "resourceOwnerId": "60446461-bfd8-4193-8b07-a3269a26aaca",
      "download": false,
      "preview": false,
      "approvers": "admin1",
      "approverIds": "11e9-97b7-64c3bedb-bb3a-9339eb852df7",
      "reason": "dd",
      "rejectReason": null,
      "createDate": "2019-07-09",
      "status": 1,
      "permission": "read"
    },
    {
      "id": "b0e46a8c-cc48-4d74-9444-c491608516d3",
      "userId": "11e9-9f01-3257a890-b28b-1f246e24670c",
      "userName": "user2",
      "resourceId": "de132478-a876-41df-b2aa-7a0c264e8791",
      "resourceName": "ABCDEF",
      "resourceType": 0,
      "fileObjectType": 1,
      "resourceOwnerId": "11e9-97b7-4caa76d1-bb3a-9339eb852df7",
      "download": true,
      "preview": false,
      "approvers": "admin1",
      "approverIds": "11e9-97b7-64c3bedb-bb3a-9339eb852df7",
      "reason": "FFFFFFFFFFFF",
      "rejectReason": null,
      "createDate": "2019-07-09",
      "status": 1,
      "permission": null
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	none

GET 查询我的申请

GET /kms/users/{userId}/applications

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userId	path	string	是	当前用户id
linesPerPage	query	string	否	none
pageNo	query	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 1,
    "linesPerPage": 3,
    "pageNo": 1,
    "datas": [
      {
        "id": "61eef68b-3122-40ee-b529-03f6553d8986",
        "userId": "11e7-a5b2-78a52539-94b8-0b402482f12a",
        "userName": "CommonUser",
        "resourceId": "9269612b-0f41-45b6-8679-3b69dacd27e5",
        "resourceName": "审批人测试.txt",
        "resourceType": 1,
        "fileObjectType": 0,
        "resourceOwnerId": "508b54f5-555e-447f-b4d5-29a8a0cbc6fe",
        "download": true,
        "preview": true,
        "approvers": "oliver2",
        "approverIds": "11e7-a1fd-13d2f69b-8d43-3528ba91253b",
        "reason": "审批人设置",
        "rejectReason": null,
        "createDate": "2017-10-29",
        "status": 1
      }
    ],
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» userId	string	false	none	none
»»» userName	string	false	none	none
»»» resourceId	string	false	none	none
»»» resourceName	string	false	none	none
»»» resourceType	integer	false	none	none
»»» fileObjectType	integer	false	none	none
»»» resourceOwnerId	string	false	none	none
»»» download	boolean	false	none	none
»»» preview	boolean	false	none	none
»»» approvers	string	false	none	none
»»» approverIds	string	false	none	none
»»» reason	string	false	none	none
»»» rejectReason	null	false	none	none
»»» createDate	string	false	none	none
»»» status	integer	false	none	none
»» pageCount	integer	true	none	none

GET 查看我的待办

GET /kms/users/{userId}/pending/applications

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userId	path	string	是	当前用户id
linesPerPage	query	string	否	none
pageNo	query	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 1,
    "linesPerPage": 3,
    "pageNo": 1,
    "datas": [
      {
        "id": "afd3cbf7-1f43-4716-9eff-faffa1f1e7dc",
        "userId": "11e7-a5b2-78a52539-94b8-0b402482f12a",
        "userName": "CommonUser",
        "resourceId": "146f7859-860d-4243-a2de-20da74b87746",
        "resourceName": "成龙个",
        "resourceType": 0,
        "fileObjectType": 1,
        "resourceOwnerId": "11e7-a1fb-3e7ecd59-8d43-3528ba91253b",
        "download": true,
        "preview": false,
        "approvers": "oliver2",
        "approverIds": "[11e7-a1fd-13d2f69b-8d43-3528ba91253b]",
        "reason": "ffffff",
        "rejectReason": null,
        "createDate": "2017-10-29",
        "status": 0
      }
    ],
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» userId	string	false	none	none
»»» userName	string	false	none	none
»»» resourceId	string	false	none	none
»»» resourceName	string	false	none	none
»»» resourceType	integer	false	none	none
»»» fileObjectType	integer	false	none	none
»»» resourceOwnerId	string	false	none	none
»»» download	boolean	false	none	none
»»» preview	boolean	false	none	none
»»» approvers	string	false	none	none
»»» approverIds	string	false	none	none
»»» reason	string	false	none	none
»»» rejectReason	null	false	none	none
»»» createDate	string	false	none	none
»»» status	integer	false	none	none
»» pageCount	integer	true	none	none

GET 查看我的已办

GET /kms/users/{userId}/disposing/applications

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userId	path	string	是	当前用户id
linesPerPage	query	string	否	none
pageNo	query	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 1,
    "linesPerPage": 3,
    "pageNo": 1,
    "datas": [
      {
        "id": "c326419c-282e-4d84-9d8f-65c858924818",
        "userId": "11e7-a5b2-78a52539-94b8-0b402482f12a",
        "userName": "CommonUser",
        "resourceId": "3b6604ef-2b8e-486f-b869-a809e1c882aa",
        "resourceName": "测试",
        "resourceType": 0,
        "fileObjectType": 1,
        "resourceOwnerId": "11e7-a1fb-3e7ecd59-8d43-3528ba91253b",
        "download": true,
        "preview": false,
        "approvers": "oliver2",
        "approverIds": "11e7-a1fd-13d2f69b-8d43-3528ba91253b",
        "reason": "testDownloadFolder",
        "rejectReason": null,
        "createDate": "2017-10-29",
        "status": 1
      }
    ],
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» userId	string	false	none	none
»»» userName	string	false	none	none
»»» resourceId	string	false	none	none
»»» resourceName	string	false	none	none
»»» resourceType	integer	false	none	none
»»» fileObjectType	integer	false	none	none
»»» resourceOwnerId	string	false	none	none
»»» download	boolean	false	none	none
»»» preview	boolean	false	none	none
»»» approvers	string	false	none	none
»»» approverIds	string	false	none	none
»»» reason	string	false	none	none
»»» rejectReason	null	false	none	none
»»» createDate	string	false	none	none
»»» status	integer	false	none	none
»» pageCount	integer	true	none	none

GET 查询我的审批后确认(团队/部门/kass)

GET /kms/users/{userId}/confirmation/applications

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userId	path	string	是	当前用户id
linesPerPage	query	string	否	每页条数
pageNo	query	string	否	页数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 3,
    "linesPerPage": 3,
    "pageNo": 1,
    "datas": [
      {
        "id": "2bdd733a-4e73-4e25-b320-9edb712ccd43",
        "userId": "11e9-9f01-3257a890-b28b-1f246e24670c",
        "userName": "user2",
        "resourceId": "9d89f355-145f-40e4-aebb-eb4e4ddf76bc",
        "resourceName": "ghi",
        "resourceType": 0,
        "fileObjectType": 1,
        "resourceOwnerId": "11e9-97b7-4caa76d1-bb3a-9339eb852df7",
        "download": true,
        "preview": false,
        "approvers": "admin1",
        "approverIds": "11e9-97b7-64c3bedb-bb3a-9339eb852df7",
        "reason": "i want to download",
        "rejectReason": null,
        "createDate": "2019-07-11",
        "status": 1,
        "permission": null,
        "isRead": "unread"
      },
      {
        "id": "aad8f0d1-d803-4e92-8600-d22a7aba7747",
        "userId": "11e9-9f01-3257a890-b28b-1f246e24670c",
        "userName": "user2",
        "resourceId": "3d41e8ef-c7cc-4fcf-b8d2-2efd00391c9e",
        "resourceName": "jkl",
        "resourceType": 0,
        "fileObjectType": 1,
        "resourceOwnerId": "11e9-97b7-4caa76d1-bb3a-9339eb852df7",
        "download": true,
        "preview": false,
        "approvers": "admin1",
        "approverIds": "11e9-97b7-64c3bedb-bb3a-9339eb852df7",
        "reason": "i",
        "rejectReason": "ddd",
        "createDate": "2019-07-11",
        "status": 2,
        "permission": null,
        "isRead": "unread"
      },
      {
        "id": "cadbba79-5067-452e-8a89-d61ad5d20937",
        "userId": "11e9-9f01-3257a890-b28b-1f246e24670c",
        "userName": "user2",
        "resourceId": "de132478-a876-41df-b2aa-7a0c264e8791",
        "resourceName": "ABCDEF",
        "resourceType": 0,
        "fileObjectType": 1,
        "resourceOwnerId": "11e9-97b7-4caa76d1-bb3a-9339eb852df7",
        "download": true,
        "preview": false,
        "approvers": "admin1",
        "approverIds": "11e9-97b7-64c3bedb-bb3a-9339eb852df7",
        "reason": "download",
        "rejectReason": null,
        "createDate": "2019-07-10",
        "status": 1,
        "permission": null,
        "isRead": "unread"
      }
    ],
    "from": null,
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码·
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	true	none	none
»»» userId	string	true	none	none
»»» userName	string	true	none	none
»»» resourceId	string	true	none	none
»»» resourceName	string	true	none	none
»»» resourceType	integer	true	none	none
»»» fileObjectType	integer	true	none	none
»»» resourceOwnerId	string	true	none	none
»»» download	boolean	true	none	none
»»» preview	boolean	true	none	none
»»» reason	string	true	none	none
»»» rejectReason	string¦null	true	none	none
»»» createDate	string	true	none	none
»»» status	integer	true	none	none
»»» permission	null	false	none	none
»»» isRead	string	false	none	none
»» from	null	false	none	none
»» pageCount	integer	true	none	none

PUT 更新申请单为已读

PUT /kms/applications/{applicationId}/reading

Body 请求参数

{
  "id": "3df2a4b9-8911-484f-be32-eb74c402f188"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	申请单id
body	body	object	否	none
» id	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "d4fc4e7a-b5a3-46b8-b255-f60ae639592b",
    "userId": "11e9-9f01-3257a890-b28b-1f246e24670c",
    "userName": "user2",
    "resourceId": "dfdf77eb-2a18-4250-99aa-12686be663a7",
    "resourceName": "团队2",
    "resourceType": 3,
    "fileObjectType": 1,
    "resourceOwnerId": "dfdf77eb-2a18-4250-99aa-12686be663a7",
    "download": false,
    "preview": false,
    "approvers": "user3",
    "approverIds": "11e9-a221-c98ca9ad-a6b6-d110b71dd060",
    "reason": "我要申请加入团队",
    "rejectReason": "我拒绝",
    "createDate": "2019-07-11",
    "status": 2,
    "permission": null,
    "isRead": "read"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» id	string	true	none	none
»» userId	string	true	none	none
»» userName	string	true	none	none
»» resourceId	string	true	none	none
»» resourceName	string	true	none	none
»» resourceType	integer	true	none	none
»» fileObjectType	integer	true	none	none
»» resourceOwnerId	string	true	none	none
»» download	boolean	true	none	none
»» preview	boolean	true	none	none
»» approvers	string	true	none	none
»» approverIds	string	true	none	none
»» reason	string	true	none	none
»» rejectReason	null	true	none	none
»» createDate	string	true	none	none
»» status	integer	true	none	none
»» permission	null	false	none	none
»» isRead	string	false	none	none

PUT 批量更新申请单为已读

PUT /kms/applications/reading

Body 请求参数

[
  "d8d82fa3-aa93-4bc0-a6db-a5c1406baeac",
  "fcc2d2d8-a2ef-4e4d-bd8f-219eec030be9"
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	array[string]	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "d8d82fa3-aa93-4bc0-a6db-a5c1406baeac",
      "userId": "11e9-9f01-3257a890-b28b-1f246e24670c",
      "userName": "user2",
      "resourceId": "caf5a8fc-3dac-477d-a400-986cf584842c",
      "resourceName": "新1",
      "resourceType": 2,
      "fileObjectType": 1,
      "resourceOwnerId": "60446461-bfd8-4193-8b07-a3269a26aaca",
      "download": false,
      "preview": false,
      "approvers": "admin1",
      "approverIds": "11e9-97b7-64c3bedb-bb3a-9339eb852df7",
      "reason": "XXXX",
      "rejectReason": null,
      "createDate": "2019-07-12",
      "status": 0,
      "permission": "upload",
      "isRead": "read"
    },
    {
      "id": "fcc2d2d8-a2ef-4e4d-bd8f-219eec030be9",
      "userId": "11e9-9f01-3257a890-b28b-1f246e24670c",
      "userName": "user2",
      "resourceId": "caf5a8fc-3dac-477d-a400-986cf584842c",
      "resourceName": "新1",
      "resourceType": 2,
      "fileObjectType": 1,
      "resourceOwnerId": "60446461-bfd8-4193-8b07-a3269a26aaca",
      "download": false,
      "preview": false,
      "approvers": "admin1",
      "approverIds": "11e9-97b7-64c3bedb-bb3a-9339eb852df7",
      "reason": "XXCC",
      "rejectReason": null,
      "createDate": "2019-07-12",
      "status": 0,
      "permission": "manage",
      "isRead": "read"
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	none

GET 查询我的待办(团队申请)

GET /kms/users/{userId}/team/pending/applications

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userId	path	string	是	当前用户id
linesPerPage	query	string	否	none
pageNo	query	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 1,
    "linesPerPage": 3,
    "pageNo": 1,
    "datas": [
      {
        "id": "d4fc4e7a-b5a3-46b8-b255-f60ae639592b",
        "userId": "11e9-9f01-3257a890-b28b-1f246e24670c",
        "userName": "user2",
        "resourceId": "dfdf77eb-2a18-4250-99aa-12686be663a7",
        "resourceName": "团队2",
        "resourceType": 3,
        "fileObjectType": 1,
        "resourceOwnerId": "dfdf77eb-2a18-4250-99aa-12686be663a7",
        "download": false,
        "preview": false,
        "approvers": "admin1",
        "approverIds": "11e9-97b7-64c3bedb-bb3a-9339eb852df7",
        "reason": "我要申请加入团队",
        "rejectReason": null,
        "createDate": "2019-07-11",
        "status": 0,
        "permission": null,
        "isRead": null
      }
    ],
    "from": null,
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» userId	string	false	none	none
»»» userName	string	false	none	none
»»» resourceId	string	false	none	none
»»» resourceName	string	false	none	none
»»» resourceType	integer	false	none	none
»»» fileObjectType	integer	false	none	none
»»» resourceOwnerId	string	false	none	none
»»» download	boolean	false	none	none
»»» preview	boolean	false	none	none
»»» approvers	string	false	none	none
»»» approverIds	string	false	none	none
»»» reason	string	false	none	none
»»» rejectReason	null	false	none	none
»»» createDate	string	false	none	none
»»» status	integer	false	none	none
»»» permission	null	false	none	none
»»» isRead	null	false	none	none
»» from	null	false	none	none
»» pageCount	integer	true	none	none

GET 查询我的审批后确认(团队申请)（已废弃）

GET /kms/users/{userId}/team/confirmation/applications

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userId	path	string	是	当前用户id
linesPerPage	query	string	否	每页条数
pageNo	query	string	否	页数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 1,
    "linesPerPage": 3,
    "pageNo": 1,
    "datas": [
      {
        "id": "d4fc4e7a-b5a3-46b8-b255-f60ae639592b",
        "userId": "11e9-9f01-3257a890-b28b-1f246e24670c",
        "userName": "user2",
        "resourceId": "dfdf77eb-2a18-4250-99aa-12686be663a7",
        "resourceName": "团队2",
        "resourceType": 3,
        "fileObjectType": 1,
        "resourceOwnerId": "dfdf77eb-2a18-4250-99aa-12686be663a7",
        "download": false,
        "preview": false,
        "approvers": "user3",
        "approverIds": "11e9-a221-c98ca9ad-a6b6-d110b71dd060",
        "reason": "我要申请加入团队",
        "rejectReason": "我拒绝",
        "createDate": "2019-07-11",
        "status": 2,
        "permission": null,
        "isRead": "unread"
      }
    ],
    "from": null,
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» userId	string	false	none	none
»»» userName	string	false	none	none
»»» resourceId	string	false	none	none
»»» resourceName	string	false	none	none
»»» resourceType	integer	false	none	none
»»» fileObjectType	integer	false	none	none
»»» resourceOwnerId	string	false	none	none
»»» download	boolean	false	none	none
»»» preview	boolean	false	none	none
»»» approvers	string	false	none	none
»»» approverIds	string	false	none	none
»»» reason	string	false	none	none
»»» rejectReason	string	false	none	none
»»» createDate	string	false	none	none
»»» status	integer	false	none	none
»»» permission	null	false	none	none
»»» isRead	string	false	none	none
»» from	null	true	none	none
»» pageCount	integer	true	none	none

GET 查询我的已办(团队申请)

GET /kms/users/{userId}/team/disposing/applications

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userId	path	string	是	当前用户id
linesPerPage	query	string	否	none
pageNo	query	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 1,
    "linesPerPage": 3,
    "pageNo": 1,
    "datas": [
      {
        "id": "d4fc4e7a-b5a3-46b8-b255-f60ae639592b",
        "userId": "11e9-9f01-3257a890-b28b-1f246e24670c",
        "userName": "user2",
        "resourceId": "dfdf77eb-2a18-4250-99aa-12686be663a7",
        "resourceName": "团队2",
        "resourceType": 3,
        "fileObjectType": 1,
        "resourceOwnerId": "dfdf77eb-2a18-4250-99aa-12686be663a7",
        "download": false,
        "preview": false,
        "approvers": "admin1",
        "approverIds": "11e9-97b7-64c3bedb-bb3a-9339eb852df7",
        "reason": "我要申请加入团队",
        "rejectReason": null,
        "createDate": "2019-07-11",
        "status": 0,
        "permission": null,
        "isRead": null
      }
    ],
    "from": null,
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» userId	string	false	none	none
»»» userName	string	false	none	none
»»» resourceId	string	false	none	none
»»» resourceName	string	false	none	none
»»» resourceType	integer	false	none	none
»»» fileObjectType	integer	false	none	none
»»» resourceOwnerId	string	false	none	none
»»» download	boolean	false	none	none
»»» preview	boolean	false	none	none
»»» reason	string	false	none	none
»»» rejectReason	null	false	none	none
»»» createDate	string	false	none	none
»»» status	integer	false	none	none
»»» permission	null	false	none	none
»»» isRead	null	false	none	none
»» from	null	false	none	none
»» pageCount	integer	true	none	none

PUT 处理申请单时提交的

PUT /kms/applications/{applicationId}

请求包体：
同意时：
{
“id”: “申请单id”,
“status”: 1
}

不同意时：
{
“id”: “申请单id”,
“rejectReason”: “拒绝理由”,
“status”: 2
}

编辑时(当为kass申请单时，resource_type=2,可进行编辑，添加窗口)：
{
“id”: “55a5ff0b-abb2-4828-8927-0b670a2145c9”,
“description”: “abcdefg”,
“permission”: “uploadAndRead”,
“status”: 1,
“startDate”: 1569243727000,
“endDate”: 1569675727000
}

Body 请求参数

{
  "id": "db745744-52ee-4154-98fa-5192cf06059d"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	申请单id
body	body	object	否	none
» id	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "61eef68b-3122-40ee-b529-03f6553d8986",
    "userId": "11e7-a5b2-78a52539-94b8-0b402482f12a",
    "userName": "CommonUser",
    "resourceId": "9269612b-0f41-45b6-8679-3b69dacd27e5",
    "resourceName": "审批人测试.txt",
    "resourceType": 1,
    "fileObjectType": 0,
    "resourceOwnerId": "508b54f5-555e-447f-b4d5-29a8a0cbc6fe",
    "download": true,
    "preview": true,
    "approvers": "oliver2",
    "approverIds": "11e7-a1fd-13d2f69b-8d43-3528ba91253b",
    "reason": "审批人设置",
    "rejectReason": null,
    "createDate": "2017-10-29",
    "status": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» id	string	true	none	none
»» userId	string	true	none	none
»» userName	string	true	none	none
»» resourceId	string	true	none	none
»» resourceName	string	true	none	none
»» resourceType	integer	true	none	none
»» fileObjectType	integer	true	none	none
»» resourceOwnerId	string	true	none	none
»» download	boolean	true	none	none
»» preview	boolean	true	none	none
»» approvers	string	true	none	none
»» approverIds	string	true	none	none
»» reason	string	true	none	none
»» rejectReason	null	true	none	none
»» createDate	string	true	none	none
»» status	integer	true	none	none

知识文档/专委会（KnowledgeRealm）

POST 创建专委会

POST /kms/realms

Body 请求参数

{
  "name": "专委会1",
  "orderNo": 98
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» name	body	string	是	none
» orderNo	body	integer	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "97bda559-81b7-4e20-8b16-00a5bb0568eb",
    "name": "专委会1",
    "orderNo": 98,
    "domainId": "11e7-a197-b8af019e-a900-73852bc58bcf"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» id	string	true	none	none
»» name	string	true	none	none
»» orderNo	integer	true	none	none
»» domainId	string	true	none	none

DELETE 删除专委会

DELETE /kms/realms

Body 请求参数

"[\"专委会id\",\"专委会id2\",…]\r\n"

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	boolean	true	none	返回的视图对象

PUT 编辑专委会

PUT /kms/realms

Body 请求参数

{
  "id": "fbded617-88e8-4ded-9f5f-fb6c958f35c9",
  "name": "专委会1",
  "orderNo": 98
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» id	body	string	是	none
» name	body	string	是	none
» orderNo	body	integer	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "97bda559-81b7-4e20-8b16-00a5bb0568eb",
    "name": "专委会11",
    "orderNo": 44,
    "domainId": "11e7-a197-b8af019e-a900-73852bc58bcf"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» id	string	true	none	none
»» name	string	true	none	none
»» orderNo	integer	true	none	none
»» domainId	string	true	none	none

GET 显示专委会的列表(分页)

GET /kms/realms/

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
linesPerPage	query	string	否	每页显示的条数
pageNo	query	string	否	第几页

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 1,
    "linesPerPage": 5,
    "pageNo": 1,
    "datas": [
      {
        "id": "97bda559-81b7-4e20-8b16-00a5bb0568eb",
        "name": "专委会1",
        "orderNo": 98,
        "domainId": "11e7-a197-b8af019e-a900-73852bc58bcf"
      }
    ],
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» name	string	false	none	none
»»» orderNo	integer	false	none	none
»»» domainId	string	false	none	none
»» pageCount	integer	true	none	none

GET 显示专委会的集合

GET /kms/realms/list

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "97bda559-81b7-4e20-8b16-00a5bb0568eb",
      "name": "专委会1",
      "orderNo": 98,
      "domainId": "11e7-a197-b8af019e-a900-73852bc58bcf"
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	true	none	返回的视图对象
»» id	string	false	none	none
»» name	string	false	none	none
»» orderNo	integer	false	none	none
»» domainId	string	false	none	none

GET 判断该专委会是否订阅

GET /kms/realms/{realmId}/isSubscription

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
realmId	path	string	是	专委会id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "isSubscription": true
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» isSubscription	boolean	true	none	none

知识文档/知识地图

GET 创建知识地图的编号

GET /kms/maps/serialNumber

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": "20170823002"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	string	true	none	返回的视图对象

GET 根据id获取知识地图集合

GET /kms/realms/{realmId}/maps

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
realmId	path	string	是	none
title	query	string	否	none
pageNo	query	string	否	none
linesPerPage	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

PUT 提交知识地图

PUT /kms/maps/submitting

Body 请求参数

{
  "id": "知识地图id",
  "title": "标题1",
  "serialNumber": "33",
  "knowledgeReamlId": "专委会id",
  "approverHistorys": [
    {
      "approverId": "用户id",
      "approver": "用户名"
    },
    {
      "approverId": "用户id",
      "approver": "用户名"
    }
  ],
  "content": "内容1"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» id	body	string	是	none
» title	body	string	是	none
» serialNumber	body	string	是	none
» knowledgeReamlId	body	string	是	none
» approverHistorys	body	[object]	是	none
»» approverId	body	string	是	none
»» approver	body	string	是	none
» content	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "4f501417-deb3-4fe6-a359-2e35260e08c6",
    "title": "标题1",
    "serialNumber": "33",
    "content": "内容1",
    "creatorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
    "creator": "uuii",
    "createDate": "2017-10-09",
    "lastModifyDate": "2017-10-09",
    "knowledgeReamlId": "a7a1f3d1-09a8-4ea6-884d-fc35f567e6e1",
    "status": "initiate",
    "flowHistorys": [
      {
        "id": "a9243b6b-31ba-47b4-81ea-e90cdc242576",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c6",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507544073089
      }
    ],
    "approvers": "",
    "approverIds": "",
    "mode": null,
    "approverHistorys": [],
    "lastOperation": "select realmAdmin"
  }
}

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "4f501417-deb3-4fe6-a359-2e35260e08c7",
    "title": "标题1",
    "serialNumber": "33",
    "content": "内容1",
    "creatorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
    "creator": "uuii",
    "createDate": "2017-10-09",
    "lastModifyDate": 1507545004875,
    "knowledgeReamlId": "a7a1f3d1-09a8-4ea6-884d-fc35f567e6e1",
    "status": "standard",
    "flowHistorys": [
      {
        "id": "a9243b6b-31ba-47b4-81ea-e90cdc242576",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c6",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507544073089
      },
      {
        "id": "b8844af3-72e8-493e-89ee-9dcef51aa153",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c7",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507545004875
      }
    ],
    "approvers": "oliver,oliver2",
    "approverIds": "11e7-9b79-885eede2-8848-c9fe21dcc7c4,11e7-a1fd-13d2f69b-8d43-3528ba91253b",
    "mode": null,
    "approverHistorys": [
      {
        "approverId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "approver": "oliver",
        "status": "initiate"
      },
      {
        "approverId": "11e7-a1fd-13d2f69b-8d43-3528ba91253b",
        "approver": "oliver2",
        "status": "initiate"
      }
    ],
    "lastOperation": "submit"
  }
}

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "4f501417-deb3-4fe6-a359-2e35260e08c7",
    "title": "标题1",
    "serialNumber": "33",
    "content": "内容1",
    "creatorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
    "creator": "uuii",
    "createDate": "2017-10-09",
    "lastModifyDate": "2017-10-09",
    "knowledgeReamlId": "a7a1f3d1-09a8-4ea6-884d-fc35f567e6e1",
    "status": "standard",
    "flowHistorys": [
      {
        "id": "a9243b6b-31ba-47b4-81ea-e90cdc242576",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c6",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507544073089
      },
      {
        "id": "b8844af3-72e8-493e-89ee-9dcef51aa153",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c7",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507545004875
      }
    ],
    "approvers": "oliver,oliver2",
    "approverIds": "11e7-9b79-885eede2-8848-c9fe21dcc7c4,11e7-a1fd-13d2f69b-8d43-3528ba91253b",
    "mode": null,
    "approverHistorys": [
      {
        "approverId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "approver": "oliver",
        "status": "initiate"
      },
      {
        "approverId": "11e7-a1fd-13d2f69b-8d43-3528ba91253b",
        "approver": "oliver2",
        "status": "initiate"
      }
    ],
    "lastOperation": "select user"
  }
}

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "4f501417-deb3-4fe6-a359-2e35260e08c8",
    "title": "标题1",
    "serialNumber": "33",
    "content": "内容1",
    "creatorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
    "creator": "uuii",
    "createDate": "2017-10-09",
    "lastModifyDate": 1507545666107,
    "knowledgeReamlId": "a7a1f3d1-09a8-4ea6-884d-fc35f567e6e1",
    "status": "edit",
    "flowHistorys": [
      {
        "id": "a9243b6b-31ba-47b4-81ea-e90cdc242576",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c6",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507544073089
      },
      {
        "id": "b8844af3-72e8-493e-89ee-9dcef51aa153",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c7",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507545004875
      },
      {
        "id": "a4e2f4be-b1f9-410e-b8ad-c424d3cbd93f",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c8",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "standard",
        "actionType": 1,
        "remark": null,
        "createDate": 1507545666107
      }
    ],
    "approvers": "CommonUser",
    "approverIds": "11e7-a5b2-78a52539-94b8-0b402482f12a",
    "mode": null,
    "approverHistorys": [
      {
        "approverId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "approver": "oliver",
        "status": "initiate"
      },
      {
        "approverId": "11e7-a1fd-13d2f69b-8d43-3528ba91253b",
        "approver": "oliver2",
        "status": "initiate"
      },
      {
        "approverId": "11e7-a5b2-78a52539-94b8-0b402482f12a",
        "approver": "CommonUser",
        "status": "standard"
      }
    ],
    "lastOperation": "submit"
  }
}

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "4f501417-deb3-4fe6-a359-2e35260e08c9",
    "title": "标题1",
    "serialNumber": "33",
    "content": "内容1",
    "creatorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
    "creator": "uuii",
    "createDate": "2017-10-09",
    "lastModifyDate": 1507621018478,
    "knowledgeReamlId": "a7a1f3d1-09a8-4ea6-884d-fc35f567e6e1",
    "status": "review",
    "flowHistorys": [
      {
        "id": "a9243b6b-31ba-47b4-81ea-e90cdc242576",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c6",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507544073089
      },
      {
        "id": "b8844af3-72e8-493e-89ee-9dcef51aa153",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c7",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507545004875
      },
      {
        "id": "56907b1f-86f3-43d1-9efa-b9bd41a668c0",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c8",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "standard",
        "actionType": 1,
        "remark": null,
        "createDate": 1507545718264
      },
      {
        "id": "a2e024ae-25ab-4b73-bdd7-81612a82deca",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c9",
        "auditor": "CommonUser",
        "auditorId": "11e7-a5b2-78a52539-94b8-0b402482f12a",
        "status": "edit",
        "actionType": 1,
        "remark": null,
        "createDate": 1507621018478
      }
    ],
    "approvers": "uuii",
    "approverIds": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
    "mode": null,
    "approverHistorys": [
      {
        "approverId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "approver": "oliver",
        "status": "initiate"
      },
      {
        "approverId": "11e7-a1fd-13d2f69b-8d43-3528ba91253b",
        "approver": "oliver2",
        "status": "initiate"
      },
      {
        "approverId": "11e7-a5b2-78a52539-94b8-0b402482f12a",
        "approver": "CommonUser",
        "status": "standard"
      }
    ],
    "lastOperation": "submit"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» id	string	true	none	none
»» title	string	true	none	none
»» serialNumber	string	true	none	none
»» content	string	true	none	none
»» creatorId	string	true	none	none
»» creator	string	true	none	none
»» createDate	string	true	none	none
»» lastModifyDate	string	true	none	none
»» knowledgeReamlId	string	true	none	none
»» status	string	true	none	none
»» flowHistorys	string	true	none	none
»» approvers	string	true	none	none
»» approverIds	string	true	none	none
»» mode	null	true	none	none
»» approverHistorys	string	true	none	none
»» lastOperation	string	true	none	none

PUT 保存知识地图

PUT /kms/maps

Body 请求参数

{
  "id": "知识地图id",
  "content": "内容1",
  "serialNumber": "编号1",
  "title": "标题1",
  "knowledgeReamlId": "a7a1f3d1-09a8-4ea6-884d-fc35f567e6e1"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» id	body	string	是	none
» content	body	string	是	none
» serialNumber	body	string	是	none
» title	body	string	是	none
» knowledgeReamlId	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "4f501417-deb3-4fe6-a359-2e35260e08c6",
    "title": "标题1",
    "serialNumber": "33",
    "content": "内容1",
    "creatorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
    "creator": "uuii",
    "createDate": 1507544072155,
    "lastModifyDate": 1507544073090,
    "knowledgeReamlId": "a7a1f3d1-09a8-4ea6-884d-fc35f567e6e1",
    "status": "initiate",
    "flowHistorys": [
      {
        "id": "a9243b6b-31ba-47b4-81ea-e90cdc242576",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c6",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507544073089
      }
    ],
    "approvers": null,
    "approverIds": null,
    "mode": null,
    "approverHistorys": [],
    "lastOperation": "submit"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» id	string	true	none	none
»» title	string	true	none	none
»» serialNumber	string	true	none	none
»» content	string	true	none	none
»» creatorId	string	true	none	none
»» creator	string	true	none	none
»» createDate	string	true	none	none
»» lastModifyDate	string	true	none	none
»» knowledgeReamlId	string	true	none	none
»» status	string	true	none	none
»» flowHistorys	[object]	true	none	none
»»» id	string	false	none	none
»»» knowledgeMapId	string	false	none	none
»»» auditor	string	false	none	none
»»» auditorId	string	false	none	none
»»» status	string	false	none	none
»»» actionType	integer	false	none	none
»»» remark	null	false	none	none
»»» createDate	integer	false	none	none
»» approvers	string	true	none	none
»» approverIds	string	true	none	none
»» mode	null	true	none	none
»» approverHistorys	[string]	true	none	none
»» lastOperation	string	true	none	none

DELETE 删除知识地图

DELETE /kms/maps

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

PUT 回退

PUT /kms/maps/{mapId}/rollback

Body 请求参数

{
  "flowHistorys": [
    {
      "remark": "无权访问"
    }
  ]
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
mapId	path	string	是	知识地图id
body	body	object	否	none
» flowHistorys	body	[object]	是	none
»» remark	body	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "4f501417-deb3-4fe6-a359-2e35260e08c12",
    "title": "标题1",
    "serialNumber": "33",
    "content": "",
    "creatorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
    "creator": "uuii",
    "createDate": "2017-10-09",
    "lastModifyDate": 1507683997505,
    "knowledgeReamlId": "a7a1f3d1-09a8-4ea6-884d-fc35f567e6e1",
    "status": "initiate",
    "flowHistorys": [
      {
        "id": "a9243b6b-31ba-47b4-81ea-e90cdc242576",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c6",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507544073089
      },
      {
        "id": "b8844af3-72e8-493e-89ee-9dcef51aa153",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c7",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507545004875
      },
      {
        "id": "56907b1f-86f3-43d1-9efa-b9bd41a668c0",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c8",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "standard",
        "actionType": 1,
        "remark": null,
        "createDate": 1507545718264
      },
      {
        "id": "a2e024ae-25ab-4b73-bdd7-81612a82deca",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c9",
        "auditor": "CommonUser",
        "auditorId": "11e7-a5b2-78a52539-94b8-0b402482f12a",
        "status": "edit",
        "actionType": 1,
        "remark": null,
        "createDate": 1507621018478
      },
      {
        "id": "ca988d9e-3680-495c-9570-973f4ff3efa5",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c11",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "review",
        "actionType": 1,
        "remark": null,
        "createDate": 1507633682743
      },
      {
        "id": "bdda8e73-0e22-4d5f-8b38-09b58b42649e",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c12",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "pass",
        "actionType": 1,
        "remark": null,
        "createDate": 1507640751275
      },
      {
        "id": "05d14532-6cab-47fd-8c15-5b3781de45a2",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c12",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "release",
        "actionType": -1,
        "remark": null,
        "createDate": 1507683997505
      }
    ],
    "approvers": "",
    "approverIds": "",
    "mode": null,
    "approverHistorys": [
      {
        "approverId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "approver": "oliver",
        "status": "initiate"
      },
      {
        "approverId": "11e7-a1fd-13d2f69b-8d43-3528ba91253b",
        "approver": "oliver2",
        "status": "initiate"
      },
      {
        "approverId": "11e7-a5b2-78a52539-94b8-0b402482f12a",
        "approver": "CommonUser",
        "status": "standard"
      }
    ],
    "lastOperation": "rollback"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	false	none	返回的视图对象
»» id	string	true	none	none
»» title	string	true	none	none
»» serialNumber	string	true	none	none
»» content	string	true	none	none
»» creatorId	string	true	none	none
»» creator	string	true	none	none
»» createDate	string	true	none	none
»» lastModifyDate	string	true	none	none
»» knowledgeReamlId	string	true	none	none
»» status	string	true	none	none
»» flowHistorys	[object]	true	none	none
»»» id	string	true	none	none
»»» knowledgeMapId	string	true	none	none
»»» auditor	string	true	none	none
»»» auditorId	string	true	none	none
»»» status	string	true	none	none
»»» actionType	integer	true	none	none
»»» remark	string	true	none	none
»»» createDate	string	true	none	none
»» approvers	string	true	none	none
»» approverIds	string	true	none	none
»» mode	null	true	none	none
»» approverHistorys	[object]	true	none	none
»»» approverId	string	true	none	none
»»» approver	string	true	none	none
»»» status	string	true	none	none
»» lastOperation	string	true	none	none

GET 根据知识地图id查找知识地图

GET /kms/maps/{mapId}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
mapId	path	string	是	知识地图id

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "4f501417-deb3-4fe6-a359-2e35260e08c12",
    "title": "标题1",
    "serialNumber": "33",
    "content": "内容1",
    "creatorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
    "creator": "uuii",
    "createDate": "2017-10-09",
    "lastModifyDate": "2017-10-10",
    "knowledgeReamlId": "a7a1f3d1-09a8-4ea6-884d-fc35f567e6e1",
    "status": "release",
    "flowHistorys": [
      {
        "id": "a9243b6b-31ba-47b4-81ea-e90cdc242576",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c6",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507544073089
      },
      {
        "id": "b8844af3-72e8-493e-89ee-9dcef51aa153",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c7",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507545004875
      },
      {
        "id": "56907b1f-86f3-43d1-9efa-b9bd41a668c0",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c8",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "standard",
        "actionType": 1,
        "remark": null,
        "createDate": 1507545718264
      },
      {
        "id": "a2e024ae-25ab-4b73-bdd7-81612a82deca",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c9",
        "auditor": "CommonUser",
        "auditorId": "11e7-a5b2-78a52539-94b8-0b402482f12a",
        "status": "edit",
        "actionType": 1,
        "remark": null,
        "createDate": 1507621018478
      },
      {
        "id": "ca988d9e-3680-495c-9570-973f4ff3efa5",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c11",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "review",
        "actionType": 1,
        "remark": null,
        "createDate": 1507633682743
      },
      {
        "id": "bdda8e73-0e22-4d5f-8b38-09b58b42649e",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c12",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "pass",
        "actionType": 1,
        "remark": null,
        "createDate": 1507640751275
      }
    ],
    "approvers": "uuii",
    "approverIds": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
    "mode": "read",
    "approverHistorys": [
      {
        "approverId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "approver": "oliver",
        "status": "initiate"
      },
      {
        "approverId": "11e7-a1fd-13d2f69b-8d43-3528ba91253b",
        "approver": "oliver2",
        "status": "initiate"
      },
      {
        "approverId": "11e7-a5b2-78a52539-94b8-0b402482f12a",
        "approver": "CommonUser",
        "status": "standard"
      }
    ],
    "lastOperation": "submit"
  }
}

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "4f501417-deb3-4fe6-a359-2e35260e08c6",
    "title": "标题1",
    "serialNumber": "33",
    "content": "内容1",
    "creatorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
    "creator": "uuii",
    "createDate": "2017-10-09",
    "lastModifyDate": "2017-10-09",
    "knowledgeReamlId": "a7a1f3d1-09a8-4ea6-884d-fc35f567e6e1",
    "status": "initiate",
    "flowHistorys": [
      {
        "id": "a9243b6b-31ba-47b4-81ea-e90cdc242576",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c6",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507544073089
      }
    ],
    "approvers": "",
    "approverIds": "",
    "mode": "edit",
    "approverHistorys": [],
    "lastOperation": "submit"
  }
}

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "4f501417-deb3-4fe6-a359-2e35260e08c7",
    "title": "标题1",
    "serialNumber": "33",
    "content": "内容1",
    "creatorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
    "creator": "uuii",
    "createDate": "2017-10-09",
    "lastModifyDate": "2017-10-09",
    "knowledgeReamlId": "a7a1f3d1-09a8-4ea6-884d-fc35f567e6e1",
    "status": "standard",
    "flowHistorys": [
      {
        "id": "a9243b6b-31ba-47b4-81ea-e90cdc242576",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c6",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507544073089
      },
      {
        "id": "b8844af3-72e8-493e-89ee-9dcef51aa153",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c7",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507545004875
      }
    ],
    "approvers": "oliver,oliver2",
    "approverIds": "11e7-9b79-885eede2-8848-c9fe21dcc7c4,11e7-a1fd-13d2f69b-8d43-3528ba91253b",
    "mode": "edit",
    "approverHistorys": [
      {
        "approverId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "approver": "oliver",
        "status": "initiate"
      },
      {
        "approverId": "11e7-a1fd-13d2f69b-8d43-3528ba91253b",
        "approver": "oliver2",
        "status": "initiate"
      }
    ],
    "lastOperation": "submit"
  }
}

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "4f501417-deb3-4fe6-a359-2e35260e08c8",
    "title": "标题1",
    "serialNumber": "33",
    "content": "内容1",
    "creatorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
    "creator": "uuii",
    "createDate": "2017-10-09",
    "lastModifyDate": "2017-10-09",
    "knowledgeReamlId": "a7a1f3d1-09a8-4ea6-884d-fc35f567e6e1",
    "status": "edit",
    "flowHistorys": [
      {
        "id": "a9243b6b-31ba-47b4-81ea-e90cdc242576",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c6",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507544073089
      },
      {
        "id": "b8844af3-72e8-493e-89ee-9dcef51aa153",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c7",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "initiate",
        "actionType": 1,
        "remark": null,
        "createDate": 1507545004875
      },
      {
        "id": "56907b1f-86f3-43d1-9efa-b9bd41a668c0",
        "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c8",
        "auditor": "uuii",
        "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "status": "standard",
        "actionType": 1,
        "remark": null,
        "createDate": 1507545718264
      }
    ],
    "approvers": "CommonUser",
    "approverIds": "11e7-a5b2-78a52539-94b8-0b402482f12a",
    "mode": "edit",
    "approverHistorys": [
      {
        "approverId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "approver": "oliver",
        "status": "initiate"
      },
      {
        "approverId": "11e7-a1fd-13d2f69b-8d43-3528ba91253b",
        "approver": "oliver2",
        "status": "initiate"
      },
      {
        "approverId": "11e7-a5b2-78a52539-94b8-0b402482f12a",
        "approver": "CommonUser",
        "status": "standard"
      }
    ],
    "lastOperation": "submit"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述说明
» data	object	true	none	返回的视图对象
»» id	string	true	none	none
»» title	string	true	none	none
»» serialNumber	string	true	none	none
»» content	string	true	none	none
»» creatorId	string	true	none	none
»» creator	string	true	none	none
»» createDate	string	true	none	none
»» lastModifyDate	string	true	none	none
»» knowledgeReamlId	string	true	none	none
»» status	string	true	none	none
»» flowHistorys	string	true	none	none
»» approvers	string	true	none	none
»» approverIds	string	true	none	none
»» mode	string	true	none	none
»» approverHistorys	string	true	none	none
»» lastOperation	string	true	none	none

PUT 维持知识地图

PUT /kms/maps/{mapId}/maintenance

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
mapId	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 查询我的待办(超级管理员审核，专委会管理员审定，有两个角色的有审核和审定)

GET /kms/maps/{userId}/pending

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userId	path	string	是	用户id
pageNo	query	string	否	现在的页数
linesPerPage	query	string	否	每页的显示的条数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 1,
    "linesPerPage": 5,
    "pageNo": 1,
    "datas": [
      {
        "id": "4f501417-deb3-4fe6-a359-2e35260e08c9",
        "title": "标题1",
        "serialNumber": "33",
        "content": "内容1",
        "creatorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "creator": "uuii",
        "createDate": "2017-10-09",
        "lastModifyDate": "2017-10-10",
        "knowledgeReamlId": "a7a1f3d1-09a8-4ea6-884d-fc35f567e6e1",
        "status": "review",
        "flowHistorys": [
          {
            "id": "a9243b6b-31ba-47b4-81ea-e90cdc242576",
            "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c6",
            "auditor": "uuii",
            "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
            "status": "initiate",
            "actionType": 1,
            "remark": null,
            "createDate": 1507544073089
          },
          {
            "id": "b8844af3-72e8-493e-89ee-9dcef51aa153",
            "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c7",
            "auditor": "uuii",
            "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
            "status": "initiate",
            "actionType": 1,
            "remark": null,
            "createDate": 1507545004875
          },
          {
            "id": "56907b1f-86f3-43d1-9efa-b9bd41a668c0",
            "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c8",
            "auditor": "uuii",
            "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
            "status": "standard",
            "actionType": 1,
            "remark": null,
            "createDate": 1507545718264
          },
          {
            "id": "a2e024ae-25ab-4b73-bdd7-81612a82deca",
            "knowledgeMapId": "4f501417-deb3-4fe6-a359-2e35260e08c9",
            "auditor": "CommonUser",
            "auditorId": "11e7-a5b2-78a52539-94b8-0b402482f12a",
            "status": "edit",
            "actionType": 1,
            "remark": null,
            "createDate": 1507621018478
          }
        ],
        "approvers": "uuii",
        "approverIds": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "mode": null,
        "approverHistorys": [
          {
            "approverId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
            "approver": "oliver",
            "status": "initiate"
          },
          {
            "approverId": "11e7-a1fd-13d2f69b-8d43-3528ba91253b",
            "approver": "oliver2",
            "status": "initiate"
          },
          {
            "approverId": "11e7-a5b2-78a52539-94b8-0b402482f12a",
            "approver": "CommonUser",
            "status": "standard"
          }
        ],
        "lastOperation": "submit"
      }
    ],
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» title	string	false	none	none
»»» serialNumber	string	false	none	none
»»» content	string	false	none	none
»»» creatorId	string	false	none	none
»»» creator	string	false	none	none
»»» createDate	string	false	none	none
»»» lastModifyDate	string	false	none	none
»»» knowledgeReamlId	string	false	none	none
»»» status	string	false	none	none
»»» approvers	string	false	none	none
»»» approverIds	string	false	none	none
»»» mode	null	false	none	none
»»» approverHistorys	[object]	false	none	none
»»»» approverId	string	true	none	none
»»»» approver	string	true	none	none
»»»» status	string	true	none	none
»»» lastOperation	string	false	none	none
»» pageCount	integer	true	none	none

GET 查询我的已办()

GET /kms/maps/{userId}/disposing

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userId	path	string	是	用户id
pageNo	query	string	否	现在的页数
linesPerPage	query	string	否	每页的显示的条数

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 2,
    "linesPerPage": 1,
    "pageNo": 1,
    "datas": [
      {
        "id": "9e0c7332-e91f-4bbb-95a6-8bc7e18c47d9",
        "title": "11知识",
        "serialNumber": "20171017003",
        "content": "<p>知识地图1909809809090kklklklkloopopop</p>",
        "creatorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "creator": "uuii",
        "createDate": "2017-10-17",
        "lastModifyDate": "2017-10-17",
        "knowledgeReamlId": "a7a1f3d1-09a8-4ea6-884d-fc35f567e6e1",
        "status": "release",
        "flowHistorys": [
          {
            "id": "e287d6c8-3562-4b7f-bf64-6c6c50d2b8d1",
            "knowledgeMapId": "9e0c7332-e91f-4bbb-95a6-8bc7e18c47d9",
            "auditor": "uuii",
            "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
            "status": "initiate",
            "actionType": 1,
            "remark": null,
            "createDate": 1508205704897
          },
          {
            "id": "5a260b10-5d2d-427b-be05-3a40d947b2b9",
            "knowledgeMapId": "9e0c7332-e91f-4bbb-95a6-8bc7e18c47d9",
            "auditor": "oliver2",
            "auditorId": "11e7-a1fd-13d2f69b-8d43-3528ba91253b",
            "status": "standard",
            "actionType": 1,
            "remark": null,
            "createDate": 1508205770627
          },
          {
            "id": "7dc00a3f-7d31-4b2c-b577-212b0366f09e",
            "knowledgeMapId": "9e0c7332-e91f-4bbb-95a6-8bc7e18c47d9",
            "auditor": "uuii",
            "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
            "status": "edit",
            "actionType": 1,
            "remark": null,
            "createDate": 1508205825470
          },
          {
            "id": "c252d4dd-7233-46e4-8ebe-b3e367b69002",
            "knowledgeMapId": "9e0c7332-e91f-4bbb-95a6-8bc7e18c47d9",
            "auditor": "uuii",
            "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
            "status": "review",
            "actionType": 1,
            "remark": null,
            "createDate": 1508205838200
          },
          {
            "id": "3eee855c-b472-48c1-9519-53e66cd397d8",
            "knowledgeMapId": "9e0c7332-e91f-4bbb-95a6-8bc7e18c47d9",
            "auditor": "oliver2",
            "auditorId": "11e7-a1fd-13d2f69b-8d43-3528ba91253b",
            "status": "pass",
            "actionType": 1,
            "remark": null,
            "createDate": 1508205864402
          },
          {
            "id": "b9fd0d2d-04ad-4c91-aba5-b63e289a6fe0",
            "knowledgeMapId": "9e0c7332-e91f-4bbb-95a6-8bc7e18c47d9",
            "auditor": "uuii",
            "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
            "status": "release",
            "actionType": 0,
            "remark": null,
            "createDate": 1508205971477
          },
          {
            "id": "e6a63215-264c-4c5e-ac40-5abffe9f96fb",
            "knowledgeMapId": "9e0c7332-e91f-4bbb-95a6-8bc7e18c47d9",
            "auditor": "uuii",
            "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
            "status": "initiate",
            "actionType": 1,
            "remark": null,
            "createDate": 1508206024807
          },
          {
            "id": "246d4686-66cf-404b-9656-183f61357f35",
            "knowledgeMapId": "9e0c7332-e91f-4bbb-95a6-8bc7e18c47d9",
            "auditor": "uuii",
            "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
            "status": "standard",
            "actionType": 1,
            "remark": null,
            "createDate": 1508206127363
          },
          {
            "id": "b9b7b072-fedc-496d-89cc-f8295dd5ee2b",
            "knowledgeMapId": "9e0c7332-e91f-4bbb-95a6-8bc7e18c47d9",
            "auditor": "uuii",
            "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
            "status": "edit",
            "actionType": 1,
            "remark": null,
            "createDate": 1508228553721
          },
          {
            "id": "71efc4a9-c737-45ec-a4d1-5eeccb1c3daa",
            "knowledgeMapId": "9e0c7332-e91f-4bbb-95a6-8bc7e18c47d9",
            "auditor": "uuii",
            "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
            "status": "review",
            "actionType": 1,
            "remark": null,
            "createDate": 1508228556744
          },
          {
            "id": "b661c14d-ebf1-4066-b79a-817970618ebf",
            "knowledgeMapId": "9e0c7332-e91f-4bbb-95a6-8bc7e18c47d9",
            "auditor": "uuii",
            "auditorId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
            "status": "pass",
            "actionType": 1,
            "remark": null,
            "createDate": 1508228561103
          }
        ],
        "approvers": "uuii",
        "approverIds": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
        "mode": null,
        "approverHistorys": [
          {
            "approverId": "11e7-a1fd-13d2f69b-8d43-3528ba91253b",
            "approver": "oliver2",
            "status": "initiate"
          },
          {
            "approverId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
            "approver": "uuii",
            "status": "initiate"
          },
          {
            "approverId": "11e7-9b79-885eede2-8848-c9fe21dcc7c4",
            "approver": "uuii",
            "status": "standard"
          }
        ],
        "lastOperation": "submit"
      }
    ],
    "pageCount": 2
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» title	string	false	none	none
»»» serialNumber	string	false	none	none
»»» content	string	false	none	none
»»» creatorId	string	false	none	none
»»» creator	string	false	none	none
»»» createDate	string	false	none	none
»»» lastModifyDate	string	false	none	none
»»» knowledgeReamlId	string	false	none	none
»»» status	string	false	none	none
»»» flowHistorys	[object]	false	none	none
»»»» id	string	true	none	none
»»»» knowledgeMapId	string	true	none	none
»»»» auditor	string	true	none	none
»»»» auditorId	string	true	none	none
»»»» status	string	true	none	none
»»»» actionType	integer	true	none	none
»»»» remark	null	true	none	none
»»»» createDate	integer	true	none	none
»»» approvers	string	false	none	none
»»» approverIds	string	false	none	none
»»» mode	null	false	none	none
»»» approverHistorys	[object]	false	none	none
»»»» approverId	string	true	none	none
»»»» approver	string	true	none	none
»»»» status	string	true	none	none
»»» lastOperation	string	false	none	none
»» pageCount	integer	true	none	none

知识文档/水印配置

POST 生成水印文件

POST /kms/watermark/pdf

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
fileId	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取水印配置信息

GET /kms/watermark/config

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "status": false,
    "preview": false,
    "download": true,
    "print": true,
    "mode": "custom",
    "customContent": "的风格"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	none
»» status	boolean	true	none	none
»» preview	boolean	true	none	none
»» download	boolean	true	none	none
»» print	boolean	true	none	none
»» mode	string	true	none	none
»» customContent	string	true	none	none

PUT 保存水印配置文件

PUT /kms/watermark/config

Body 请求参数

{
  "status": false,
  "preview": false,
  "download": true,
  "print": true,
  "mode": "custom",
  "customContent": "的风格"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» status	body	boolean	是	none
» preview	body	boolean	是	none
» download	body	boolean	是	none
» print	body	boolean	是	none
» mode	body	string	是	none
» customContent	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "status": false,
    "preview": false,
    "download": true,
    "print": true,
    "mode": "custom",
    "customContent": "的风格"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» status	boolean	true	none	none
»» preview	boolean	true	none	none
»» download	boolean	true	none	none
»» print	boolean	true	none	none
»» mode	string	true	none	none
»» customContent	string	true	none	none

知识文档/标签

DELETE 删除文件单个标签

DELETE /kms/files/deleteFileCategory

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
fileId	query	string	否	文件id
categoryName	query	string	否	标签名称

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "779fcb07-2e2f-483f-a5ce-eb7426bde7cb",
    "name": "选择框调用视图.xlsx",
    "creatorId": "M88FvL0rnPRvkCTzLkF",
    "creator": "sam01",
    "createDate": "2020-09-14",
    "lastModifyDate": "2020-09-14T05:50:54.000+0000",
    "diskId": "M88FvL0rnPRvkCTzLkF",
    "folderId": "c3864c0d-0434-45e5-9e87-0b84fcfc095c",
    "folder": false,
    "size": 20052,
    "path": "M88FvL0rnPRvkCTzLkF/c3864c0d-0434-45e5-9e87-0b84fcfc095c",
    "type": "xlsx",
    "url": "M88FvL0rnPRvkCTzLkF/202009/779fcb07-2e2f-483f-a5ce-eb7426bde7cb.xlsx",
    "originType": 1,
    "originId": null,
    "categorys": "1112",
    "categorysJson": [
      {
        "categoryName": "1112",
        "categoryId": "a995653a-04e1-412f-976e-3fecc6cca026",
        "isAuto": false
      }
    ],
    "views": 0,
    "lastViewDate": null,
    "downloads": 0,
    "lastDownloadDate": null,
    "shares": 0,
    "lastShareDate": null,
    "collects": 0,
    "lastCollectDate": null,
    "lastEditDate": null,
    "good": 0,
    "bad": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码

PUT 批量对文件贴标签

PUT /kms/files/categorys/paste

Body 请求参数

[
  {
    "fileId": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
    "categorys": [
      {
        "categoryId": "123456",
        "categoryName": "知识文档",
        "fileId": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
        "isAuto": true
      },
      {
        "categoryId": "123456",
        "categoryName": "广州市",
        "fileId": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
        "isAuto": true
      }
    ]
  },
  {
    "fileId": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
    "categorys": [
      {
        "categoryId": "123456",
        "categoryName": "知识文档",
        "fileId": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
        "isAuto": true
      },
      {
        "categoryId": "123456",
        "categoryName": "广州市",
        "fileId": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
        "isAuto": true
      }
    ]
  }
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	array[object]	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "fileId": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
      "categorys": [
        {
          "categoryId": "123456",
          "categoryName": "知识文档",
          "fileId": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
          "isAuto": true
        },
        {
          "categoryId": "123456",
          "categoryName": "广州市",
          "fileId": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
          "isAuto": true
        }
      ]
    },
    {
      "fileId": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
      "categorys": [
        {
          "categoryId": "123456",
          "categoryName": "知识文档",
          "fileId": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
          "isAuto": true
        },
        {
          "categoryId": "123456",
          "categoryName": "广州市",
          "fileId": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
          "isAuto": true
        }
      ]
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	true	none	返回的视图对象
»» fileId	string	true	none	none
»» categorys	[object]	true	none	none
»»» categoryId	string	true	none	none
»»» categoryName	string	true	none	none
»»» fileId	string	true	none	none
»»» isAuto	boolean	true	none	none

PUT 单个对文件贴标签

PUT /kms/file/categorys/paste

Body 请求参数

{
  "fileId": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
  "categorys": [
    {
      "categoryId": "123456",
      "categoryName": "知识文档",
      "fileId": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
      "isAuto": true
    },
    {
      "categoryId": "123456",
      "categoryName": "广州市",
      "fileId": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
      "isAuto": true
    }
  ]
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» fileId	body	string	是	none
» categorys	body	[object]	是	none
»» categoryId	body	string	是	none
»» categoryName	body	string	是	none
»» fileId	body	string	是	none
»» isAuto	body	boolean	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
    "name": "2018.09.05 温国辉 在全市治理违法建设工作会议上的讲话.docx",
    "creatorId": "zPsp2hk7CEwtqeMCwtj",
    "creator": "管理员",
    "createDate": "2020-05-29",
    "lastModifyDate": "2020-05-29T08:32:12.000+0000",
    "diskId": "0dd1e1c1-b5dd-41f4-8e3e-c0479448faf9",
    "folderId": "a56f8f78-52b4-44ef-af2e-fe4136974500",
    "folder": false,
    "size": 31383,
    "path": "0dd1e1c1-b5dd-41f4-8e3e-c0479448faf9/a56f8f78-52b4-44ef-af2e-fe4136974500",
    "type": "docx",
    "url": "0dd1e1c1-b5dd-41f4-8e3e-c0479448faf9/202005/59c07a5a-d323-4fb0-a0f5-4aaa1e774056.docx",
    "originType": 1,
    "originId": null,
    "categorys": "知识文档,广州市",
    "categorysJson": [
      {
        "categoryId": "123456",
        "categoryName": "知识文档",
        "fileId": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
        "isAuto": true
      },
      {
        "categoryId": "123456",
        "categoryName": "广州市",
        "fileId": "59c07a5a-d323-4fb0-a0f5-4aaa1e774056",
        "isAuto": true
      }
    ],
    "views": 0,
    "lastViewDate": null,
    "downloads": 0,
    "lastDownloadDate": null,
    "shares": 0,
    "lastShareDate": null,
    "collects": 0,
    "lastCollectDate": null,
    "lastEditDate": null,
    "good": 0,
    "bad": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» id	string	true	none	none
»» name	string	true	none	none
»» creatorId	null	true	none	none
»» creator	null	true	none	none
»» createDate	null	true	none	none
»» lastModifyDate	null	true	none	none
»» diskId	string	true	none	none
»» folderId	string	true	none	none
»» folder	boolean	true	none	none
»» size	integer	true	none	none
»» path	string	true	none	none
»» type	null	true	none	none
»» url	null	true	none	none
»» originType	integer	true	none	none
»» originId	null	true	none	none
»» categorys	string	true	none	none
»» categorysJson	[object]	true	none	none
»»» categoryId	string	true	none	none
»»» categoryName	string	true	none	none
»»» fileId	string	true	none	none
»»» isAuto	boolean	true	none	none
»» views	integer	true	none	none
»» lastViewDate	null	true	none	none
»» downloads	integer	true	none	none
»» lastDownloadDate	null	true	none	none
»» shares	integer	true	none	none
»» lastShareDate	null	true	none	none
»» collects	integer	true	none	none
»» lastCollectDate	null	true	none	none
»» lastEditDate	string	true	none	none
»» good	integer	true	none	none
»» bad	integer	true	none	none

GET 获取标签树

GET /kms/categorys/tree

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "name": "顶层",
      "id": "fd7be7e0-3a5b-46cb-b275-29ca71efbc2c",
      "Children": [],
      "parentId": ""
    },
    {
      "name": "大管",
      "id": "fdf83788-b087-4397-b114-cac8de74353f",
      "Children": [],
      "parentId": ""
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errcode	integer	true	none		返回码
» errmsg	string	true	none		对返回码的文本描述内容

POST 批量新建标签

POST /kms/categorys

Body 请求参数

{
  "name": [
    "sd"
  ],
  "parentId": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» name	body	[string]	是	none
» parentId	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "c9a78981-63d9-427c-8520-f2a1cde9f173",
      "name": "sd",
      "parentId": null,
      "domainId": "3CffNlgt9B9StIjIUPB"
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	true	none	返回的视图对象
»» id	string	false	none	none
»» name	string	false	none	none
»» parentId	null	false	none	none
»» domainId	string	false	none	none

PUT 更新标签

PUT /kms/categorys

Body 请求参数

{
  "id": "01137638-d5e2-4a2a-9a79-91cc676e4422",
  "name": "精细dfdf",
  "parentId": "",
  "parentName": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» id	body	string	是	none
» name	body	string	是	none
» parentId	body	string	是	none
» parentName	body	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "01137638-d5e2-4a2a-9a79-91cc676e4422",
    "name": "精细dfdf",
    "parentId": "",
    "domainId": "3CffNlgt9B9StIjIUPB"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的视图对象
»» id	string	true	none	none
»» name	string	true	none	none
»» parentId	string	true	none	none
»» domainId	string	true	none	none

DELETE 删除标签

DELETE /kms/categorys

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取标签集合

GET /kms/categorys

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

PUT 批量对文件夹中文件贴标签

PUT /kms/folderFiles/categorys/paste

Body 请求参数

[
  {
    "folderId": "c3864c0d-0434-45e5-9e87-0b84fcfc095c",
    "categorys": [
      {
        "categoryId": "09082a0e-3b48-4633-a503-7935aa371b2e",
        "categoryName": "标签测试2",
        "isAuto": false
      }
    ]
  }
]

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	array[object]	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "folderId": "c3864c0d-0434-45e5-9e87-0b84fcfc095c",
      "categorys": [
        {
          "categoryId": "09082a0e-3b48-4633-a503-7935aa371b2e",
          "categoryName": "标签测试2",
          "isAuto": false
        }
      ]
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	[object]	true	none	返回的视图对象
»» folderId	string	false	none	none
»» categorys	[object]	false	none	none
»»» categoryId	string	false	none	none
»»» categoryName	string	false	none	none
»»» isAuto	boolean	false	none	none

GET 获取父级标签集合

GET /kms/categorys/parent

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取标签

GET /kms/categorys/{id}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
id	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取标签的文件数量

GET /kms/categorys/files/count

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

知识文档/个人设置（UserSetups）

POST 个人信息设置

POST /kms/usersetups/detail

Body 请求参数

{
  "name": "1111",
  "email": "1111",
  "telephone": "1111"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» name	body	string	是	用户名称
» email	body	string	是	用户邮箱
» telephone	body	string	是	用户电话

返回示例

200 Response

{
  "errmsg": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errmsg	string	true	none		对返回码的文本描述内容

POST 密码设置

POST /kms/usersetups/password

Body 请求参数

{
  "oldPassword": "1111",
  "newpassword": "1111",
  "confirmPassword": "1111"
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» oldPassword	body	string	是	原密码
» newpassword	body	string	是	新密码
» confirmPassword	body	string	是	确认密码

返回示例

200 Response

{
  "errmsg": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errmsg	string	true	none		对返回码的文本描述内容

知识文档/日志

GET 查询我的日志

GET /kms/users/{userId}/logs

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userId	path	string	是	查询用户ID
keyWord	query	string	否	查询关键字
operationType	query	string	是	操作类型
pageNo	query	string	是	当前页
linesPerPage	query	string	是	每页条数
linesPerPage	query	string	否	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 2,
    "linesPerPage": 2,
    "pageNo": 1,
    "datas": [
      {
        "id": "86477af4-37ea-4447-9673-86a4f2b65a28",
        "resourceId": "d46b2ed9-ec75-40c6-9bdf-d35e7aa309dc",
        "resourceName": "技术研发部_二级目录1_1.txt",
        "resourceType": 1,
        "creator": "邢专员（行政专员）",
        "creatorId": "b27f525b-f44f-4519-8bf1-2087382d4f56",
        "deptId": "11e7-7045-1c91a1dc-85f9-cbfc8973e987",
        "deptName": "XXX",
        "createDate": "2017-08-18",
        "operationType": 4
      }
    ],
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的对象数据
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» resourceId	string	false	none	none
»»» resourceName	string	false	none	none
»»» resourceType	integer	false	none	none
»»» creator	string	false	none	none
»»» creatorId	string	false	none	none
»»» deptId	string	false	none	none
»»» deptName	string	false	none	none
»»» createDate	string	false	none	none
»»» operationType	integer	false	none	none
»» pageCount	integer	true	none	none

GET KM访问明细

GET /kms/logs

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
userId	query	string	否	查询用户ID
deptId	query	string	否	部门ID
startDate	query	string	否	开始时间
endDate	query	string	否	结束时间
keyWord	query	string	否	none
operationType	query	string	否	none
pageNo	query	string	是	none
linesPerPage	query	string	是	none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "rowCount": 2,
    "linesPerPage": 2,
    "pageNo": 1,
    "datas": [
      {
        "id": "86477af4-37ea-4447-9673-86a4f2b65a28",
        "resourceId": "d46b2ed9-ec75-40c6-9bdf-d35e7aa309dc",
        "resourceName": "技术研发部_二级目录1_1.txt",
        "resourceType": 1,
        "creator": "邢专员（行政专员）",
        "creatorId": "b27f525b-f44f-4519-8bf1-2087382d4f56",
        "deptId": "11e7-7045-1c91a1dc-85f9-cbfc8973e987",
        "deptName": "XXX",
        "createDate": "2017-08-18",
        "operationType": 4
      }
    ],
    "pageCount": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» errcode	integer	true	none	返回码
» errmsg	string	true	none	对返回码的文本描述内容
» data	object	true	none	返回的对象数据
»» rowCount	integer	true	none	none
»» linesPerPage	integer	true	none	none
»» pageNo	integer	true	none	none
»» datas	[object]	true	none	none
»»» id	string	false	none	none
»»» resourceId	string	false	none	none
»»» resourceName	string	false	none	none
»»» resourceType	integer	false	none	none
»»» creator	string	false	none	none
»»» creatorId	string	false	none	none
»»» deptId	string	false	none	none
»»» deptName	string	false	none	none
»»» createDate	string	false	none	none
»»» operationType	integer	false	none	none
»» pageCount	integer	true	none	none

知识文档/文档托盘控制模块(convert)

GET 检查word文档是否可编辑(Ajax)

GET /portal/dynaform/document/checkWordFieldIsEdit

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 退出word文档编辑(Ajax)

GET /portal/dynaform/document/doExixtWordField

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取预览水印

GET /portal/dynaform/document/previewWaterMark

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
waterMarkSetting	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 文件套红

GET /portal/dynaform/document/cover

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
templateFile	query	string	否	none
sourceFile	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 水印文件打印

POST /api/runtime/{applicationId}/views/{viewId}/activities/exportExcel

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
applicationId	path	string	是	软件id
viewId	path	string	是	视图id
actId	query	string	否	按钮id
filename	query	string	否	文件名
body	body	object	否	none
» id	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

知识文档/历史（history）

GET 获取历史版本列表

GET /kms/attachmentHistorys

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
name	query	string	否	none
path	query	string	否	none
id	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

DELETE 删除文件

DELETE /kms/attachmentHistorys/{id}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
id	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 文档迁入（保存）

POST /kms/attachmenthistory/checkin

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
path	query	string	否	none
id	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 文档迁出(编辑)

POST /kms/attachmentHistory

Body 请求参数

{
  "id": ""
}

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
name	query	string	否	none
path	query	string	否	none
id	query	string	否	none
body	body	object	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

知识文档/speech

GET 根据任务id查看完成状态

GET /kms/speech/speechToText/status

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
taskId	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 科大讯飞根据任务id查看文本

GET /kms/speech/speechToText/text

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
taskId	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 上传doc,docx文档

POST /kms/speech/upload

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
file	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 科大讯飞查看任务id历史

GET /kms/speech/speechToText/iflyTek/history

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
pageNo	query	string	否	none
linesPerPage	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

知识文档/wordb编辑

GET 退出word文档编辑(Ajax)

GET /kms/doExixtWordField

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
wordid	query	string	否	none
userId	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 检查word文档是否可编辑(Ajax)

GET /kms/checkWordFieldIsEdit

请求参数

名称	位置	类型	必选	说明
accessToken	cookie	string	否	none
adminToken	cookie	string	否	none
wordid	query	string	否	none
userId	query	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

数据模型

文档更新时间: 2023-09-12 11:52 作者：admin