知网研学开放平台文档

# 专题相关接口API

注意事项

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

# 获取所有专题

接口地址:/psmc/mystudy/tasks

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:获取当前用户所有专题,默认不包括已经删除的数据

请求参数:

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

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
code 接口返回状态码 integer(int32) integer(int32)
content 接口返回数据 AllTaskVo AllTaskVo
  lastLiteratureCount 专题界面获取最近阅读数量 integer(int32)
  other 操作配置 string
  result 专题列表 array 专题列表
    id 主键id string
    isTop isTop integer
    parentId 父节点id string
    postTime 创建时间 string
    sort 排序 integer
    title 标题 string
    type 类型 integer
count 接口返回数据条数，用于分页查询 integer(int32) integer(int32)
message 接口返回信息 string
success 接口返回是否成功 boolean
total 接口返回数据条数，用于分页查询 integer(int32) integer(int32)

响应示例:

{
    "success": true,
    "message": "SUCCESS",
    "content": {
        "result": [
            {
                "id": "f9905137-2358-410e-8226-8b6ceeefd750",
                "title": "Hadoop",
                "postTime": "2023-10-26 10:49:26",
                "sort": 4,
                "type": 1,
                "parentId": "",
                "isTop": null
            },
            {
                "id": "4840771b-7730-4fd5-9c66-d6722d3be849",
                "title": "分层",
                "postTime": "2023-10-26 11:00:59",
                "sort": 5,
                "type": 1,
                "parentId": "f9905137-2358-410e-8226-8b6ceeefd750",
                "isTop": null
            },
            {
                "id": "b5f0b08c-4bec-449a-ad95-79e60b7231f0",
                "title": "数仓中心",
                "postTime": "2023-10-26 10:49:41",
                "sort": 6,
                "type": 1,
                "parentId": null,
                "isTop": 1
            }
        ],
        "lastLiteratureCount": 14,
        "other": "34340e6f-a24e-4569-9937-b4a55670e8f7"
    },
    "count": null,
    "total": null,
    "code": 200
}

# 添加专题（任务）

接口地址:/psmc/mystudy/add/task

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:当前用户添加专题

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
title title query true string
parentId parentId query false string
searchWord searchWord query false string
summary summary 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": "成功",
    "content": {
        "isOk": 1,
        "state": 1,
        "id": "bd2ccd61-00ff-****-9efd-ac1dbf014a31",
        "mssage": "成功"
    },
    "count": null,
    "total": null,
    "code": 200
}

# 获取上传文件题录

接口地址:/psmc/mystudy/files

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:获取上传文件题录

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
id id 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/mystudy/file/read/history

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:获取用户阅读历史列表

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
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 接口返回数据 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/mystudy/upload/files

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:专题下我的上传

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
documentType 文献类型,多选英文逗号分隔 query false string
kw kw query false string
order 排序,上传时间ctime、上传时间倒序ctimeDesc、文件大小从小到大fileSize、文件大小从大到小fileSizeDesc 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 接口返回数据 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/mystudy/subject/files

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:获取主题下文献列表详情

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
orderBy orderBy query true integer(int32)
cludedChildGroupOk cludedChildGroupOk query false boolean
knsOk knsOk query false boolean
pageIndex pageIndex query false integer(int32)
pageSize pageSize query false integer(int32)
resourceType 传汉字 query false string
subjectId subjectId query false string
titleKeyword titleKeyword query false string

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
code 接口返回状态码 integer(int32) integer(int32)
content 接口返回数据 LearnExList LearnExList
  count 专题列表下文献数量 integer(int32)
  pageCount 专题列表下页数 integer(int32)
  result 专题列表 array LearnEx
    author string
    channel 来源路径 string
    citationTimes string
    collecTime 收藏时间 string
    dbCode string
    downloads string
    fileCode string
    fileSourceType integer
    fileType string
    grade integer
    id string
    impactfactor 复合影响因子 string
    isRead boolean
    lastStudyTime string
    learnId string
    literatureState string
    noteCount integer
    position string
    postTime string
    publicationTime string
    readUrl string
    remark 文献备注 RemarkVo RemarkVo
      learnId string
      remarkData array RemarkData
        content string
        id integer
        title string
        type string
      title string
    resourceType string
    source string
    status integer
    summary string
    tableName string
    title string
count 接口返回数据条数，用于分页查询 integer(int32) integer(int32)
message 接口返回信息 string
success 接口返回是否成功 boolean
total 接口返回数据条数，用于分页查询 integer(int32) integer(int32)

响应示例:

{
    "success": true,
    "message": "SUCCESS",
    "content": {
        "result": [
            {
                "summary": "礼乐生活作为一种时间制度，是仁义作为儒家核心价值在组织化、时机化的礼乐行为上的体现。颜元的礼乐美学针对宋明理学弱化、淡化礼乐生活的时机、时体、时态而发。君子是礼乐之事及时间制度的显现者与承载者。君子既能因应不同的时机，通过正在进行着的礼乐行为的实事来践行仁义，又能维持礼乐生活在时体上的流畅与持久。从公共礼乐生活的时机看，家、社会、国、天下之中的角色担当造就了绵延不绝的时机与时宜，君子应时而起的礼乐行为确保了社会化时机的常态与自然。私人礼乐生活与公共礼乐生活的无缝结合处于“时时”“须臾”的时间机制，即在私人心性修炼与持敬上的回忆、反省与社会化的、原发性礼乐践行之间，在慎独的私人时间制度与人际的社会时间制度之间，实现完满接合。",
                "id": "a2ba9fa2-13c7-4de8-86b0-aef9499626d4",
                "learnId": "f548b1ab-b08d-444b-bdde-f16c47af7ba3",
                "title": "礼乐生活作为时间制度的时机、时体及公私结合的时间机制——兼论颜元的礼乐美学思想",
                "author": "刘彦顺;",
                "source": "内蒙古社会科学",
                "fileType": "XML;EPUB;",
                "fileSourceType": 1,
                "fileCode": "NMGR202202015",
                "dbCode": "CJFD",
                "tableName": "CJFDLAST2022",
                "readUrl": "http://x--cnki--net--https.cnki.mdjsf.utuvpn.utuedu.com:9000/read/readonline.ashx?appid=CRSP_BASIC_PSMC&topic=34340e6f-a24e-4569-9937-b4a55670e8f7&dbcode=CJFD&tablename=CJFDLAST2022&filename=NMGR202202015&fileSourceType=1&taskId=CJFD",
                "position": "",
                "postTime": "2023/12/12 11:15:04",
                "noteCount": 0,
                "status": 0,
                "lastStudyTime": "2023/12/12 11:15:04",
                "grade": 0,
                "resourceType": "期刊",
                "publicationTime": "2022/03/10",
                "isRead": false,
                "literatureState": "",
                "downloads": "284",
                "citationTimes": "0",
                "remark": null,
                "impactfactor": "2.734",
                "channel": "CNKI",
                "collecTime": "2023-12-12 11:15:04"
            }
        ],
        "count": 1,
        "pageCount": 1
    },
    "count": null,
    "total": null,
    "code": 200
}

# 通过doi查询题录,从http:--www.doi.org-查

接口地址:/psmc/mystudy/doi/titles

请求方式:GET

请求数据类型:

响应数据类型:*/*

接口描述:通过doi查询题录,从http:--www.doi.org-查

请求参数:

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

响应状态:

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

响应参数:

参数名称 参数说明 类型 schema
code 接口返回状态码 integer(int32) integer(int32)
content 接口返回数据 Document Document
  analysis UploadPdfPosition UploadPdfPosition
    ctime string
    documentId string
    fileCode string
    id string
    pictureCoordinate string
    processId string
    result integer
    userId string
    utime string
    xmlName string
  appId string
  author string
  authorId string
  category string
  categoryName string
  checkDate string(date-time)
  cited integer(int32)
  cnkiDbCode string
  cnkiFileName string
  cnkiTableName string
  collection string
  collectionName string
  docId string
  documentExtraData array DocumentExtraData
    extraKeyId string
    id string
    name string
    postUser string
    value string
  doi string
  download integer(int32)
  dutyPerson string
  ffd string
  fileFormat integer(int32)
  fileName string
  fileSize integer(int32)
  fullText string
  fund string
  fundId string
  id string
  isCheck integer(int32)
  isModify integer(int32)
  isRecycled integer(int32)
  isRemoved integer(int32)
  issue string
  keyword string
  language integer(int32)
  lastPostUser string
  localUpdateDate string(date-time)
  mediaType integer(int32)
  organization string
  organizationId string
  postDate string(date-time)
  postDateString string
  postIp string
  postUser string
  product string
  pubDate string(date-time)
  pubDateString string
  publisher string
  references string
  rights integer(int32)
  securityClassification integer(int32)
  serverUpdateDate string(date-time)
  smarts string
  source string
  sourceId string
  studyId string
  subject string
  summary string
  taskId string
  title string
  type integer(int32)
  updateDate string(date-time)
  uploadMode integer(int32)
  uri string
  vsm string
  year integer(int32)
count 接口返回数据条数，用于分页查询 integer(int32) integer(int32)
message 接口返回信息 string
success 接口返回是否成功 boolean
total 接口返回数据条数，用于分页查询 integer(int32) integer(int32)

响应示例:

{
	"code": 0,
	"content": {
		"analysis": {
			"ctime": "",
			"documentId": "",
			"fileCode": "",
			"id": "",
			"pictureCoordinate": "",
			"processId": "",
			"result": 0,
			"userId": "",
			"utime": "",
			"xmlName": ""
		},
		"appId": "",
		"author": "",
		"authorId": "",
		"category": "",
		"categoryName": "",
		"checkDate": "",
		"cited": 0,
		"cnkiDbCode": "",
		"cnkiFileName": "",
		"cnkiTableName": "",
		"collection": "",
		"collectionName": "",
		"docId": "",
		"documentExtraData": [
			{
				"extraKeyId": "",
				"id": "",
				"name": "",
				"postUser": "",
				"value": ""
			}
		],
		"doi": "",
		"download": 0,
		"dutyPerson": "",
		"ffd": "",
		"fileFormat": 0,
		"fileName": "",
		"fileSize": 0,
		"fullText": "",
		"fund": "",
		"fundId": "",
		"id": "",
		"isCheck": 0,
		"isModify": 0,
		"isRecycled": 0,
		"isRemoved": 0,
		"issue": "",
		"keyword": "",
		"language": 0,
		"lastPostUser": "",
		"localUpdateDate": "",
		"mediaType": 0,
		"organization": "",
		"organizationId": "",
		"postDate": "",
		"postDateString": "",
		"postIp": "",
		"postUser": "",
		"product": "",
		"pubDate": "",
		"pubDateString": "",
		"publisher": "",
		"references": "",
		"rights": 0,
		"securityClassification": 0,
		"serverUpdateDate": "",
		"smarts": "",
		"source": "",
		"sourceId": "",
		"studyId": "",
		"subject": "",
		"summary": "",
		"taskId": "",
		"title": "",
		"type": 0,
		"updateDate": "",
		"uploadMode": 0,
		"uri": "",
		"vsm": "",
		"year": 0
	},
	"count": 0,
	"message": "",
	"success": true,
	"total": 0
}

← 创作服务 →