创作服务相关接口API

注意事项

• 所有API接口的域名前缀：http://gateway--cnki--net--https.cnki.mdjsf.utuvpn.utuedu.com:9000/openx/
• 所有接口未显性指明申请JWT的方式，统一为用户名+密码的方式
• 所有接口统一认证方式：Header请求头中添加Authorization字段，值为"Bearer " +JWT

获取创作列表

接口地址:/psmc/create/document/mind/project

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:获取用户的创作列表

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
kw	kw	query	false	string
lastTime	cTime_week_1-创建时间最近一周;cTime_month_1-创建时间最近1个月;cTime_month_3-创建时间最近3个月;uTime_week_1-编辑时间最近一周；uTime_month_1-编辑时间最近1个月;uTime_month_3-编辑时间最近3个月	query	false	string
only	only	query	false	string
order	nameDesc-名字倒序;name-名字正序;uTimeDesc-最后编辑时间倒叙;uTime-最后编辑时间正序;cTimeDesc-最后编辑时间倒叙;cTime-最后编辑时间正序	query	false	string
pageIndex	pageIndex	query	false	integer(int32)
pageSize	pageSize	query	false	integer(int32)
projectId	projectId	query	false	string

响应状态:

状态码	说明
200	OK
404001	系统异常
404011	参数缺失
404401	参数校验失败
404402	接口权益异常
404406	会员权限不足
404500	参数错误

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据
countId		string
current		integer(int64)
maxLimit		integer(int64)
optimizeCountSql		boolean
orders		array	OrderItem
asc		boolean
column		string
pages		integer(int64)
records		array	DocumentAndProjectAndMindVo
cTime		string
detailUrl	跳转创作地址	string
id	id	string
mindThumbnails	导图缩略图	string
name		string
parentInfo	路径	CreateParentInfo	CreateParentInfo
parentInfo		CreateParentInfo	CreateParentInfo
projectId		string
projectName		string
type	1-文件夹；2-创作；3-Mind	integer
uTime		string
searchCount		boolean
size		integer(int64)
total		integer(int64)
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
    "success": true,
    "message": "SUCCESS",
    "content": {
        "records": [
            {
                "id": "2f94d560-8a9c-****-9a2c-511288072827",
                "name": "大数据时代企业数据权益保护论",
                "cTime": "2024-03-04 08:47:31",
                "uTime": "2024-03-04 08:47:31",
                "type": 3,
                "detailUrl": "http://x--cnki--net--https.cnki.mdjsf.utuvpn.utuedu.com:9000/Mind/Mind/MindCore?template=0&from=psmc&uid=2f94d560-8a9c-****-9a2c-511288072827",
                "mindThumbnails": null,
                "parentInfo": null
            },
            {
                "id": "13448d85-c302-425e-****-5e5d5297b0cc",
                "name": "测试",
                "cTime": "0001-01-01 00:00:00",
                "uTime": "2024-03-04 08:46:23",
                "type": 3,
                "detailUrl": "http://x--cnki--net--https.cnki.mdjsf.utuvpn.utuedu.com:9000/Mind/Mind/MindCore?template=0&from=psmc&uid=13448d85-c302-425e-****-5e5d5297b0cc",
                "mindThumbnails": null,
                "parentInfo": null
            },
            {
                "id": "c7bc023b-fef7-4bbd-****-ef89aeb5aa1d",
                "name": "test",
                "cTime": "2023-12-01 10:31:50",
                "uTime": "2023-12-01 10:32:39",
                "type": 1,
                "detailUrl": null,
                "mindThumbnails": null,
                "parentInfo": null
            }
        ],
        "total": "3",
        "size": "10",
        "current": "1",
        "orders": [],
        "optimizeCountSql": true,
        "searchCount": true,
        "countId": null,
        "maxLimit": null,
        "pages": "1"
    },
    "count": null,
    "total": null,
    "code": 200
}

创建转换任务

接口地址:/psmc/create/task

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:创建转换任务

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
documentId	documentId	query	true	string
type	可选值：docx、pdf	query	true	string

响应状态:

状态码	说明
200	OK
404001	系统异常
404011	参数缺失
404401	参数校验失败
404402	接口权益异常
404406	会员权限不足
404500	参数错误

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	CreateAddTaskResult	CreateAddTaskResult
hasContent		boolean
isExist		boolean
result		boolean
taskId		integer(int32)
xmlFileCode		string
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
	"code": 0,
	"content": {
		"hasContent": true,
		"isExist": true,
		"result": true,
		"taskId": 0,
		"xmlFileCode": ""
	},
	"count": 0,
	"message": "",
	"success": true,
	"total": 0
}

查询转换状态

接口地址:/psmc/create/status

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:查询转换任务的状态

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
documentId	documentId	query	false	string
taskId	taskId	query	false	integer(int32)
type	type	query	false	string

响应状态:

状态码	说明
200	OK
404001	系统异常
404011	参数缺失
404401	参数校验失败
404402	接口权益异常
404406	会员权限不足
404500	参数错误

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	object
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
    "success": true,
    "message": "SUCCESS",
    "content": {
        "status": "done",
        "statusCode": 4
    },
    "count": null,
    "total": null,
    "code": 200
}

下载

接口地址:/psmc/create/download

请求方式:GET

请求数据类型:

响应数据类型:*/*

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
documentId	documentId	query	false	string
type	type	query	false	string

响应状态:

状态码	说明
200	OK
404001	系统异常
404011	参数缺失
404401	参数校验失败
404402	接口权益异常
404406	会员权限不足
404500	参数错误

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	object
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
	"code": 0,
	"content": {},
	"count": 0,
	"message": "",
	"success": true,
	"total": 0
}

移动

接口地址:/psmc/create/move

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:移动文档到指定目录

请求示例:

{
  "items": [
    {
      "id": "",
      "type": 2
    }
  ],
  "toProjectId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
item	item	body	true	MoveParam	MoveParam
items			false	array	CreateVoParam
id	导图id，创作id，文件夹id		false	string
type	类型，1-文件夹；2-创作；3-Mind		false	integer
toProjectId	目标文件夹Id		false	string

响应状态:

状态码	说明
200	OK
404001	系统异常
404011	参数缺失
404401	参数校验失败
404402	接口权益异常
404406	会员权限不足
404500	参数错误

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	integer(int32)	integer(int32)
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
    "success": true,
    "message": "SUCCESS",
    "content": 1,
    "count": null,
    "total": null,
    "code": 200
}

重命名

接口地址:/psmc/create/rename

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:创作文档重命名

请求示例:

{
    "id": "d7d096e2-6321-46b1-**-85303257e573",
    "type": 2,
    "name": "20231025-V2_02"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
item	item	body	true	RenameParam	RenameParam
id	导图id，创作id，文件夹id		false	string
name			false	string
type	类型，1-文件夹；2-创作；3-Mind		false	integer(int32)

响应状态:

状态码	说明
200	OK
404001	系统异常
404011	参数缺失
404401	参数校验失败
404402	接口权益异常
404406	会员权限不足
404500	参数错误

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	integer(int32)	integer(int32)
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
    "success": true,
    "message": "SUCCESS",
    "content": 1,
    "count": null,
    "total": null,
    "code": 200
}

新建创作

接口地址:/psmc/document/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:创建在线文档

请求示例:

{
  "documentId": "",
  "level": 0,
  "mind": {
    "mindId": "",
    "mindJson": ""
  },
  "name": "",
  "projectId": "",
  "templateId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
item	item	body	true	DocumentParam	DocumentParam
documentId			false	string
level	导图模板对象,导图抽取级别		false	integer(int32)
mind	导图模板对象,不使用导图时传空		false
mindId	导图id，对应原来的id字段		false	string
mindJson			false	string
name			false	string
projectId			false	string
templateId	模板id，不使用模板时传空		false	string

响应状态:

状态码	说明
200	OK
404001	系统异常
404011	参数缺失
404401	参数校验失败
404402	接口权益异常
404406	会员权限不足
404500	参数错误

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	AddUploadResult	AddUploadResult
documentId		string
message		string
readUrl		string
result		boolean
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
    "success": true,
    "message": "SUCCESS",
    "content": {
        "result": true,
        "readUrl": "http://x--cnki--net--https.cnki.mdjsf.utuvpn.utuedu.com:9000/XmlEditor/PersonalBook/Index/751ee533-****-4fda-aaa5-6648bb73ace9",
        "documentId": "751ee533-e758-4fda-****-6648bb73ace9",
        "message": null
    },
    "count": null,
    "total": null,
    "code": 200
}

新建创作，通过上传

接口地址:/psmc/document/create/upload

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:通过文件上传创建在线文档

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
file		formData	false	file
projectId	projectId	query	false	string

响应状态:

状态码	说明
200	OK
404001	系统异常
404011	参数缺失
404401	参数校验失败
404402	接口权益异常
404406	会员权限不足
404500	参数错误

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	AddUploadResult	AddUploadResult
documentId		string
message		string
readUrl		string
result		boolean
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
    "success": true,
    "message": "SUCCESS",
    "content": {
        "result": true,
        "readUrl": "http://x--cnki--net--https.cnki.mdjsf.utuvpn.utuedu.com:9000/XmlEditor/PersonalBook/Index/92c4ec11-****-4398-8996-f5dc03acbff4",
        "documentId": "92c4ec11-618a-4398-****-f5dc03acbff4",
        "message": null
    },
    "count": null,
    "total": null,
    "code": 200
}

另存为

接口地址:/psmc/document/new/version

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "documentId": "",
  "id": "",
  "name": "",
  "projectId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
item	item	body	true	DocumentNewVersionParam	DocumentNewVersionParam
documentId			false	string
id			false	string
name			false	string
projectId			false	string

响应状态:

状态码	说明
200	OK
404001	系统异常
404011	参数缺失
404401	参数校验失败
404402	接口权益异常
404406	会员权限不足
404500	参数错误

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	AddUploadResult	AddUploadResult
documentId		string
message		string
readUrl		string
result		boolean
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
    "success": true,
    "message": "SUCCESS",
    "content": {
        "result": false,
        "readUrl": null,
        "documentId": null,
        "message": "id不存在"
    },
    "count": null,
    "total": null,
    "code": 200
}

保存为模板

接口地址:/psmc/document/template

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "documentId": "",
  "id": "",
  "name": "",
  "projectId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
item	item	body	true	DocumentNewVersionParam	DocumentNewVersionParam
documentId			false	string
id			false	string
name			false	string
projectId			false	string

响应状态:

状态码	说明
200	OK
404001	系统异常
404011	参数缺失
404401	参数校验失败
404402	接口权益异常
404406	会员权限不足
404500	参数错误

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	integer(int32)	integer(int32)
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
	"code": 0,
	"content": 0,
	"count": 0,
	"message": "",
	"success": true,
	"total": 0
}

新建导图

接口地址:/psmc/mindmap/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "mindId": "",
  "mindJson": "",
  "mindName": "",
  "projectId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
item	item	body	true	MindParam	MindParam
mindId	导图id，对应原来的id		false	string
mindJson			false	string
mindName			false	string
projectId	文件夹id,没有传空		false	string

响应状态:

状态码	说明
200	OK
404001	系统异常
404011	参数缺失
404401	参数校验失败
404402	接口权益异常
404406	会员权限不足
404500	参数错误

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	object
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
    "success": true,
    "message": "SUCCESS",
    "content": {
        "result": true,
        "readUrl": "http://x--cnki--net--https.cnki.mdjsf.utuvpn.utuedu.com:9000/Mind/Mind/MindCore?template=0&from=psmc&uid=cb8e76d7-4698-****-b839-5f74d2824c05"
    },
    "count": null,
    "total": null,
    "code": 200
}

获取导图列表

接口地址:/psmc/mindmap/getList

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
kw	kw	query	false	string
pageIndex	pageIndex	query	false	integer(int32)
pageSize	pageSize	query	false	integer(int32)

响应状态:

状态码	说明
200	OK
404001	系统异常
404011	参数缺失
404401	参数校验失败
404402	接口权益异常
404406	会员权限不足
404500	参数错误

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	Page«MindUserMind»	Page«MindUserMind»
countId		string
current		integer(int64)
maxLimit		integer(int64)
optimizeCountSql		boolean
orders		array	OrderItem
asc		boolean
column		string
pages		integer(int64)
records		array	MindUserMind
createTime		string
deleteTime		string
folderId		string
isNoteMind		integer
mindId	导图id，对应原来的id字段	string
mindJson		string
mindName		string
size		integer
status	1-创建；2-更新；3-删除；4-删除恢复；5-从历史记录恢复	string
thumbnails	缩略图	string
updateTime		string
userId		string
userSaveVersion	用户手动保存版本，0-系统保存，>0用户手动保存版本	integer
version		integer
searchCount		boolean
size		integer(int64)
total		integer(int64)
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
	"code": 0,
	"content": {
		"countId": "",
		"current": 0,
		"maxLimit": 0,
		"optimizeCountSql": true,
		"orders": [
			{
				"asc": true,
				"column": ""
			}
		],
		"pages": 0,
		"records": [
			{
				"createTime": "",
				"deleteTime": "",
				"folderId": "",
				"isNoteMind": 0,
				"mindId": "",
				"mindJson": "",
				"mindName": "",
				"size": 0,
				"status": "",
				"thumbnails": "",
				"updateTime": "",
				"userId": "",
				"userSaveVersion": 0,
				"version": 0
			}
		],
		"searchCount": true,
		"size": 0,
		"total": 0
	},
	"count": 0,
	"message": "",
	"success": true,
	"total": 0
}

新建文件夹

接口地址:/psmc/project/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "id": "",
  "name": "测试文件夹",
  "projectId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
item	item	body	true	ProjectParam	ProjectParam
id	文件夹id,新建时传空		false	string
name	文件夹名字		false	string
projectId	父文件夹id,没有父级传空		false	string

响应状态:

状态码	说明
200	OK
404001	系统异常
404011	参数缺失
404401	参数校验失败
404402	接口权益异常
404406	会员权限不足
404500	参数错误

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	integer(int32)	integer(int32)
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
    "success": true,
    "message": "SUCCESS",
    "content": 1,
    "count": null,
    "total": null,
    "code": 200
}

获取个人所有的文件夹

接口地址:/psmc/project/lists

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema

响应状态:

状态码	说明
200	OK
404001	系统异常
404011	参数缺失
404401	参数校验失败
404402	接口权益异常
404406	会员权限不足
404500	参数错误

响应参数:

参数名称	参数说明	类型	schema
code	接口返回状态码	integer(int32)	integer(int32)
content	接口返回数据	array	PsmcUserProject
available	项目是否可用(0 不可用,1 可用)	integer(int32)
contentTempletId	模板ID	string
createTime	创建时间	string(date-time)
departmentCode	部门编码	string
description	描述	string
endTime	创作结束时间	string(date-time)
id	项目唯一标识	string
isComplete	是否完成1：进行中;2：已完成	integer(int32)
isRecycled		integer(int32)
name	项目名称	string
organzationId	机构ID	string
projectId		string
sourceId	来源ID	string
sourceTitle	来源名称	string
sourceType	创作来源 1 个人创作 2 专题	integer(int32)
startTime	创作开始时间	string(date-time)
status	当前项目进行到哪一步骤号，完成为-1	string
updateTime	更新时间	string(date-time)
userId		string
count	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)
message	接口返回信息	string
success	接口返回是否成功	boolean
total	接口返回数据条数，用于分页查询	integer(int32)	integer(int32)

响应示例:

{
	"code": 0,
	"content": [
		{
			"available": 0,
			"contentTempletId": "",
			"createTime": "",
			"departmentCode": "",
			"description": "",
			"endTime": "",
			"id": "",
			"isComplete": 0,
			"isRecycled": 0,
			"name": "",
			"organzationId": "",
			"projectId": "",
			"sourceId": "",
			"sourceTitle": "",
			"sourceType": 0,
			"startTime": "",
			"status": "",
			"updateTime": "",
			"userId": ""
		}
	],
	"count": 0,
	"message": "",
	"success": true,
	"total": 0
}