DataMesh FactVerse Cloud API v1.0 使用说明

创建于2024年7月23日

上次更新时间2024年11月21日

使用 API

获取 token

参考用户登录接口，登录成功后返回结果中的 token 字段，将在后续请求中使用。

添加 header

在 http 请求头中添加 Authorization：Bearer + {token}

加密

涉及密码的接口都需要加密传输字符串，获取技术支持请联系 support@datamesh.com。

js 加密示例

引用组件 JSEncrypt：

				
					export function encryption(password) {
  let encryptor = new JSEncrypt();
  encryptor.setPublicKey(RSA_PUBLIC_KEY);
  let result = encryptor.encrypt(password);
  return result;
}

API 接口

用户接口

参数名称	参数说明	请求类型	必须	数据类型
password	用户密码	query	true	string
username	用户名	query	true	string
captcha	验证码	query	false	string
captchaId	验证码编码	query	false	string
tenantId	租户编码	query	false	string

状态码	说明	schema
200	OK	Result«UserLoginResponseVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data
refreshToken	用户刷新令牌	string
token	用户令牌	string
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

登出

接口地址

POST /api/v1/auth/logout

接口描述

用户登出接口

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

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

响应状态

状态码	说明	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": null, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

refresh token

接口地址

POST /api/v6/auth/refresh

接口描述

刷新用户token

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
token	token	query	false	string

响应状态

状态码	说明	schema
200	OK	Result«Tokens»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		Tokens	Tokens
refreshToken	refresh token	string
token	access token	string
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": {
        "refreshToken": "", 
        "token": ""
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

通过用户名查找所有租户信息

接口地址

GET /api/v6/auth/user/tenants

接口描述

通过用户名查询包含当前用户名成员的所有租户信息

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
username	用户名	query	false	string

响应状态

状态码	说明	schema
200	OK	Result«Map«String,Object»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		Map«String,Object»	Map«String,Object»
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": {
        "tenants": [
            {
                "id": "", 
                "loginSign": "", 
                "name": "", 
                "logoUri": "", 
                "loginTypeList": [ ]
            }
        ]
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

查询当前用户信息

接口地址

GET /api/v6/auth/user/userinfo

接口描述

查询当前用户信息

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
userId	用户编码	query	true	string

响应状态

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		UserInfoVO	UserInfoVO
accountNonLocked		boolean	TenantVO
company	用户所属企业信息	TenantVO
contactEmail	租户联系人邮箱	string
contactMobile	联系人手机	string
contactName	联系人姓名	string
createBy		string
createTime		integer
customConfig	定制化配置	string
delFlag		boolean
domainName	自定义域名（全局唯一）	string
id	ID	string
isThirdParty	是否为第三方登录	boolean
loginSign	登录标志	string	TenantLoginTypeVO
loginTypeList	登录配置列表	array
id		string
loginType	可用值: ACTIVE_DIRECTORY, AZURE_CN, AZURE_DE, AZURE_GLOBAL, BIM_AIRPORT, USERNAME_PASSWORD	string
logoUri	logo图片地址	string
mqConnInfoList	mq信息列表	array	用户简单返回实体（只包括用户名和昵称）
address	链接地址	string
port	端口	integer
protocol	协议	string
type	当前地址类型 1.默认地址 , 2 用户指定地址	integer
name	租户（企业/平台/个人）名称	string
owner	租户所有者信息	JSONString
headPic		string
realName		string	TenantSpatialAnchorsConfigVO
userId		string
username		string
parentId	企业租户所属平台租户ID	string
platformApproval	平台是否审核	boolean
platformMode	平台模式（单企业/多企业）	string
source	用户来源	string
status	租户状态0 1 2	string
tenantSpatialAnchorsConfig	空间定位配置记录	TenantSpatialAnchorsConfigVO
accountDomain		string
accountId		string
accountKey		string
type	租户类型	string
updateBy		string
updateTime		integer
createBy		string
createTime		integer(int64)	RoleVO
depts	部门	array
createBy	创建人id	string	PermissionsVO
createTime	创建时间	integer
creator	创建人	UserInfoVO
id		string
name	部门名称	string
parentId	父级id	string
tenantId	租户id	string
updateTime	更新时间	integer
email	邮箱	string
firstLogin	是否首次登录标识	boolean
headPic	用户头像	string
id	userID	string
mobile	手机	string
nickName	用户昵称	string
realName	用户姓名	string
roles	用户角色	array
createBy	创建人id	string
createTime	创建时间	integer	integer(int32)
creator	创建人	UserInfoVO	integer(int64)
depts	部门	array
createBy	创建人id	string
createTime	创建时间	integer
creator	创建人	UserInfoVO
id		string
name	部门名称	string
parentId	父级id	string
tenantId	租户id	string
updateTime	更新时间	integer
description	描述	string
id	主键	string
name		string
orderNum	排序	integer
roleCode	角色code，企业管理员：ENTERPRISE_ADMIN 平台管理员：PLATFORM_ADMIN 部门管理员：DEPT_ADMIN 普通岗位：NORMAL, 可用值: ENTERPRISE, HIDDEN, NORMAL, PLATFORM, PLATFORM_CUSTOMIZE	string
status	0：启动，1：禁用	integer
tenantId	租户id	string
updateTime	更新时间	integer
showRetentionTime	显示留存时间	boolean
source	用户来源	string
tenantId	租户ID	string
thirdparty		boolean
updateBy		string
updateTime		integer(int64)
userStatus	用户状态, 可用值:DISABLE,NORMAL	string
username	用户名	string
msg		string
msg_i18n		object
status		integer(int32)
timestamp		integer(int64)

响应示例

				
					{
	"code": 0,
	"data": {
		"accountNonLocked": true,
		"company": {
			"contactEmail": "",
			"contactMobile": "",
			"contactName": "",
			"createBy": "",
			"createTime": 0,
			"customConfig": "",
			"delFlag": true,
			"domainName": "",
			"id": "",
			"isThirdParty": false,
			"loginSign": "",
			"loginTypeList": [
				{
					"id": "",
					"loginType": ""
				}
			],
			"logoUri": "",
			"mqConnInfoList": [
				{
					"address": "",
					"port": 0,
					"protocol": "",
					"type": 0
				}
			],
			"name": "",
			"owner": {
				"headPic": "",
				"realName": "",
				"userId": "",
				"username": ""
			},
			"parentId": "",
			"platformApproval": false,
			"platformMode": "",
			"source": "",
			"status": "",
			"tenantSpatialAnchorsConfig": {
				"accountDomain": "",
				"accountId": "",
				"accountKey": ""
			},
			"type": "",
			"updateBy": "",
			"updateTime": 0
		},
		"createBy": "",
		"createTime": 0,
		"depts": [
			{
				"createBy": "",
				"createTime": 0,
				"creator": {},
				"id": "",
				"name": "",
				"parentId": "",
				"tenantId": "",
				"updateTime": 0
			}
		],
		"email": "",
		"firstLogin": false,
		"headPic": "",
		"id": "",
		"mobile": "",
		"nickName": "",
		"realName": "",
		"roles": [
			{
				"createBy": "",
				"createTime": 0,
				"creator": {},
				"depts": [
					{
						"createBy": "",
						"createTime": 0,
						"creator": {},
						"id": "",
						"name": "",
						"parentId": "",
						"tenantId": "",
						"updateTime": 0
					}
				],
				"description": "",
				"id": "",
				"name": "",
				"orderNum": 0,
				"roleCode": "",
				"status": 0,
				"tenantId": "",
				"updateTime": 0
			}
		],
		"showRetentionTime": false,
		"source": "",
		"tenantId": "",
		"thirdparty": true,
		"updateBy": "",
		"updateTime": 0,
		"userStatus": "",
		"username": ""
	},
	"msg": "",
	"msg_i18n": {},
	"status": 0,
	"timestamp": 0
｝

扫码登录相关接口

网页端确认前扫码端取消登录

接口地址

POST /api/v6/auth/scan/before/cancel

接口描述

扫码登录流程中，扫码端取消登录

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
codeKey	码唯一标识	query	false	string
deviceId	设备ID	query	false	string

响应状态

状态码	说明	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "args": { }, 
    "code": 0, 
    "data": null, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

扫码端向服务端传递参数

接口地址

POST /api/v6/auth/scan/device/receive

接口描述

扫码登录流程中，扫码端向服务端发送扫码端相关参数

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
codeKey	二维码唯一标示	query	false	string
deviceId	设备Id（设备唯一标示）	query	false	string
deviceName	设备名称（设备唯一标示）	query	false	string
deviceType	设备类型（设备唯一标示）	query	false	string
scanCodeType	扫码类型,可用值:LoginCode,ShareCode,ResourceCode	query	false	string

响应状态

状态码	说明	schema
200	OK	Result«Map«string,object»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": {
        "pairCode": 0000  //4位配对码
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

网页端同意后客户端登录或取消

接口地址

POST /api/v6/auth/scan/loginOrCancel

接口描述

扫码登录流程中，扫码端发送完参数后，在网页端点击同意后，扫码端登录或者取消登录

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
codeKey	二维码唯一标识	query	false	string
deviceId	设备ID	query	false	string
isLogin	登录/取消登录	query	false	boolean

响应状态

状态码	说明	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": null, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

客户端轮询获取 token

接口地址

GET /api/v6/auth/scan/token

接口描述

扫码登录流程中，扫码端轮询token

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
codeKey	二维码唯一标识	query	false	string
deviceId	设备ID	query	false	string

响应状态

状态码	说明	schema
200	OK	Result«ScanCodeTokenVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		ScanCodeTokenVO	ScanCodeTokenVO
state	扫码状态	integer(int32)
token	登录令牌	string
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": {
        "state": 0, 
        "token": ""
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

令牌验证接口

获取 License 信息

接口地址

GET /api/v6/auth/license

接口描述

获取当前用户license信息（有效时间、自定义功能范围、活动相关限制）

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

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

响应状态

状态码	说明	schema
200	OK	Result«LicenseUnityResponseVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		LicenseUnityResponseVO	LicenseUnityResponseVO
customFunction	自定义功能	object
expiryDate	license失效时间	integer(int64)
grantStatus	授权状态	boolean
licenseType	license类型	string
maxEventUsers	最大活动人数	integer(int64)
startDate	license开始时间	integer(int64)
status	license状态	boolean
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": {
        "customFunction": { }, 
        "expiryDate": 0, 
        "grantStatus": true, 
        "licenseType": "", 
        "maxEventUsers": 0, 
        "startDate": 0, 
        "status": true
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

标签管理接口

分页查询 label 列表

接口地址

POST /api/v6/auth/label/labelList

接口描述

查询当前企业的标签列表，支持分页功能

请求数据类型

application/json

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
queryLabelListPageUseCase	标签查询实例	body	true	JSONString	QueryLabelListPageUseCase
name	标签名称		false	string
page	是否分页		false	boolean
pageNo	当前页数		false	integer(int32)
pageSize	分页条数		false	integer(int32)
systemLabel	是否包含系统标签		false	boolean

响应状态

状态码	说明	schema
200	OK	Result«IPage«LabelVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		分页结果«LabelVO»	分页结果«LabelVO»
list	数据	array	LabelVO
createUserName	创建者	string
i18nLabel	标签多语言	string
id	标签ID	string
name	标签名称	string
refSum	引用数量	integer
pageNo	页码，从 1 开始	integer(int64)
pageSize	每页条数	integer(int64)
total	总量	integer(int64)
totalPage	总页数	integer(int64)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
	"code": 0,
	"data": {
		"list": [
			{
				"createUserName": "",
				"i18nLabel": "",
				"id": "",
				"name": "",
				"refSum": 0
			}
		],
		"pageNo": 0,
		"pageSize": 0,
		"total": 0,
		"totalPage": 0
	},
	"msg": "",
	"msg_i18n": {},
	"status": 0,
	"timestamp": 0
}

版本更新管理接口

获取当前 app 版本

接口地址

GET /api/v6/appversion/get

接口描述

根据当前App标识符，获取App最新版本号

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

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

响应状态

状态码	说明	schema
200	OK	Result«VersionVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		VersionVO	VersionVO
clientType	客户端类型	integer(int32)
configTime	配置时间	integer(int64)
createTime	创建时间	integer(int64)
descriptionEn	英文描述	string
descriptionJa	日文描述	string
descriptionTw	繁体描述	string
downloadLink	下载地址	string
forcedUpdate	是否强制更新	integer(int32)
id	版本编码	string
translationMsg	多语言消息	object
updateBy	更新人	string
updateDescription	描述信息	string
version	版本	string
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": {
        "clientType": 0, 
        "configTime": 0, 
        "createTime": 0, 
        "descriptionEn": "", 
        "descriptionJa": "", 
        "descriptionTw": "", 
        "downloadLink": "", 
        "forcedUpdate": 0, 
        "id": "", 
        "translationMsg": { }, 
        "updateBy": "", 
        "updateDescription": "", 
        "version": ""
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

任务和资源接口

任务调用 API

主文件更新 ext 信息

接口地址

POST /api/v6/resource/rpc/file/ext

接口描述

更新主文件的附件ext信息

请求数据类型

application/json

响应数据类型

*/*

请求示例

				
					{
    "ext": "", 
    "field": "", 
    "metaId": "", 
    "tenantId": "", 
    "version": 0
}

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
fileExtUpload	文件ext信息实例	body	true	JSONString	FileExtUpload
ext	主文件ext信息		true	string
field	关键字		false	string
metaId	资源id		true	string
version	版本信息		true	integer(int32)
tenantId	租户id		false	string

响应状态

状态码	说明	schema
200	OK	Result
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "args": { }, 
    "code": 0, 
    "data": null, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

文件管理系统 API

接口地址

POST /api/v6/resource/list

接口描述

获取目录列表

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
listINodeDTIO	资源查询DTO, 排序字段：name, create_time, category, update_time	body	true	JSONString	资源查询DTO, 排序字段：name, create_time, category, update_time
catalogId	目录id；如果catalogId 有值，则 rootCatalogId & path 参数需要为空；否则 rootCatalogId & path 必须有值		true	string
categories	类别值列表		false	array	string
isLately	查询最近编辑资源，如果使用该字段，则 catalogId 或者 rootCatalogId & path 需为空		false	boolean
labelIds	标签ID列表		false	array	string
lately			false	boolean
metaId	文件id		false	string
name	资源名称		false	string
pageNo	页码，从 1 开始		true	integer(int32)
pageSize	每页条数，最大值为 100		true	integer(int32)
path	文件夹路径，格式： “/”开头，不以”/”结尾，结合rootCatalogId一起使用		false	string
rootCatalogId	根目录id, 使用的时候必须和path一起传入		false	string
searchType	web端使用搜索类型 1.全局 2.目录参数必填		true	integer(int32)
sorts	排序规则		false	array	排序元素
asc	是否正序排序		false	boolean
field	排序字段		false	string

响应状态

状态码	说明	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		分页结果«INodePermissionResponseVO»	分页结果«INodePermissionResponseVO»
list	数据	array	INodePermissionResponseVO
additional	封面文件id列表	array	Mime
blockInfoList		array	BlockInfo
hash		string
id	块下载id	string
md5Hash		string
size		integer
category		integer
downloadPolicy		integer
ext		object
fileType		string
hash		string
id		string
isBlock		boolean
isDownloadable		boolean
md5Hash		string
name		string
purpose		string
size		integer
block		boolean
blockInfoList		array	BlockInfo
hash		string
id	块下载id	string
md5Hash		string
size		integer
category	inode 类型	integer
categoryIdList		array	string
ctime		integer
downloadPolicy		integer
ext		object
fileDataId	file download id, 当type为2时为空	string
fileHasChanged		boolean
filename	文件/文件夹名称	string
groupId		string
groupPermission		integer
groupPermissionCanEdit		integer
hash		string
isDownloadable		boolean
lockInfo		EditorLockResponseVO	EditorLockResponseVO
ctime		integer
lockType		string
mtime		integer
userId		string
username		string
md5Hash		string
metaId	inode meta id	string
metaType		integer
mtime		integer
otherPermission		integer
ownerId		string
ownerPermission		integer
pId		string
path		string
permission		ResourcePermissionBO	ResourcePermissionBO
isDeletable		boolean
isManageable		boolean
isMovable		boolean
isReadable		boolean
isWritable		boolean
pid		string
preset		boolean
shareType	可用值:EXPIRED,NOT_SHARE,SHARED	string
size	文件大小(bytes)	integer
suffix		string
tags		array	LabelVO
createUserName	创建者	string
i18nLabel	标签多语言	string
id	标签ID	string
name	标签名称	string
refSum	引用数量	integer
thumbnailUrl		string
username		string
version		integer
pageNo	页码，从 1 开始	integer(int64)
pageSize	每页条数	integer(int64)
total	总量	integer(int64)
totalPage	总页数	integer(int64)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
	"code": 0,
	"data": {
		"list": [
			{
				"additional": [
					{
						"blockInfoList": [
							{
							   "hash": "",
							   "id": "",
							   "md5Hash": "",
							   "size": 0
							}
						],
						"category": 0,
						"downloadPolicy": 0,
						"ext": {},
						"fileType": "",
						"hash": "",
						"id": "",
						"isBlock": true,
						"isDownloadable": true,
						"md5Hash": "",
						"name": "",
						"purpose": "",
						"size": 0
					}
				],
				"block": true,
				"blockInfoList": [
					{
						"hash": "",
						"id": "",
						"md5Hash": "",
						"size": 0
					}
				],
				"category": 0,
				"categoryIdList": [],
				"ctime": 0,
				"downloadPolicy": 0,
				"ext": {},
				"fileDataId": "",
				"fileHasChanged": true,
				"filename": "",
				"groupId": "",
				"groupPermission": 0,
				"groupPermissionCanEdit": 0,
				"hash": "",
				"isDownloadable": true,
				"lockInfo": {
					"ctime": 0,
					"lockType": "",
					"mtime": 0,
					"userId": "",
					"username": ""
				},
				"md5Hash": "",
				"metaId": "",
				"metaType": 0,
				"mtime": 0,
				"otherPermission": 0,
				"ownerId": "",
				"ownerPermission": 0,
				"pId": "",
				"path": "",
				"permission": {
					"isDeletable": true,
					"isManageable": true,
					"isMovable": true,
					"isReadable": true,
					"isWritable": true
				},
				"pid": "",
				"preset": true,
				"shareType": "",
				"size": 0,
				"suffix": "",
				"tags": [
					{
						"createUserName": "",
						"i18nLabel": "",
						"id": "",
						"name": "",
						"refSum": 0
					}
				],
				"thumbnailUrl": "",
				"username": "",
				"version": 0
			}
		],
		"pageNo": 0,
		"pageSize": 0,
		"total": 0,
		"totalPage": 0
	},
	"msg": "",
	"msg_i18n": {},
	"status": 0,
	"timestamp": 0
}

批量文件详情接口

接口地址

POST /api/v6/resource/details

接口描述

根据资源id，资源版本、资源路径批量获取文件详情

请求数据类型

application/json

响应数据类型

*/*

请求示例

				
					{
  "eventId": "",
  "metaList": [
    {
      "metaId": "",
      "path": "",
      "version": 0
    }
  ]
}

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
metaDetailQueryDTO	资源详情检索DTO	body	true	JSONString	资源详情检索DTO
eventId	活动id		false	string
metaList			false	array	MetaSimpleInfo
metaId	资源id		true	string
path	资源路径		false	string
version	资源版本		true	integer

响应状态

状态码	说明	schema
200	OK	Result«MetaResponseVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		MetaResponseVO	MetaResponseVO
failedMetaList		array	MetaFailedResponseVO
code		integer
message		string
resource		string
successMetaList		array	INodeResponseVO
additional	封面文件id列表	array	Mime
blockInfoList		array	BlockInfo
hash		string
id	块下载id	string
md5Hash		string
size		integer
category		integer
downloadPolicy		integer
ext		object
fileType		string
hash		string
id		string
isBlock		boolean
isDownloadable		boolean
md5Hash		string
name		string
purpose		string
size		integer
block		boolean
blockInfoList		array	BlockInfo
hash		string
id	块下载id	string
md5Hash		string
size		integer
category	inode 类型	integer
categoryIdList		array	string
ctime		integer
downloadPolicy		integer
ext		object
fileDataId	file download id, 当type为2时为空	string
filename	文件/文件夹名称	string
groupId		string
groupPermission		integer
groupPermissionCanEdit		integer
hash		string
isDownloadable		boolean
lockInfo		EditorLockResponseVO	EditorLockResponseVO
ctime		integer
lockType		string
mtime		integer
userId		string
username		string
md5Hash		string
metaId	inode meta id	string
metaType		integer
mtime		integer
otherPermission		integer
ownerId		string
ownerPermission		integer
pId		string
path		string
pid		string
preset		boolean
shareType	可用值:EXPIRED,NOT_SHARE,SHARED	string
size	文件大小(bytes)	integer
suffix		string
tags		array	LabelVO
createUserName	创建者	string
i18nLabel	标签多语言	string
id	标签ID	string
name	标签名称	string
refSum	引用数量	integer
version		integer
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
	"code": 0,
	"data": {
		"failedMetaList": [
			{
				"code": 0,
				"message": "",
				"resource": ""
			}
		],
		"successMetaList": [
			{
				"additional": [
					{
						"blockInfoList": [
							{
							   "hash": "",
							   "id": "",
							   "md5Hash": "",
							   "size": 0
							}
						],
						"category": 0,
						"downloadPolicy": 0,
						"ext": {},
						"fileType": "",
						"hash": "",
						"id": "",
						"isBlock": true,
						"isDownloadable": true,
						"md5Hash": "",
						"name": "",
						"purpose": "",
						"size": 0
					}
				],
				"block": true,
				"blockInfoList": [
					{
						"hash": "",
						"id": "",
						"md5Hash": "",
						"size": 0
					}
				],
				"category": 0,
				"categoryIdList": [],
				"ctime": 0,
				"downloadPolicy": 0,
				"ext": {},
				"fileDataId": "",
				"filename": "",
				"groupId": "",
				"groupPermission": 0,
				"groupPermissionCanEdit": 0,
				"hash": "",
				"isDownloadable": true,
				"lockInfo": {
					"ctime": 0,
					"lockType": "",
					"mtime": 0,
					"userId": "",
					"username": ""
				},
				"md5Hash": "",
				"metaId": "",
				"metaType": 0,
				"mtime": 0,
				"otherPermission": 0,
				"ownerId": "",
				"ownerPermission": 0,
				"pId": "",
				"path": "",
				"pid": "",
				"preset": true,
				"shareType": "",
				"size": 0,
				"suffix": "",
				"tags": [
					{
						"createUserName": "",
						"i18nLabel": "",
						"id": "",
						"name": "",
						"refSum": 0
					}
				],
				"version": 0
			}
		]
	},
	"msg": "",
	"msg_i18n": {},
	"status": 0,
	"timestamp": 0
}

小文件主文件下载地址生成

接口地址

GET /api/v6/resource/small/master/download

接口描述

获取主文件下载地址，针对大小不超过128M 的文件

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
fileDataId	fileDataId	query	false	string
metaId	metaId	query	false	string

响应状态

状态码	说明	schema
200	OK	Result«DownloadLinkResponseVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		DownloadLinkResponseVO	DownloadLinkResponseVO
url	下载地址	string
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": {
        "url": ""
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

批量小文件主文件下载地址生成

接口地址

GET /api/v6/resource/small/master/batch/download

接口描述

批量获取主文件下载地址，针对大小不超过128M 的文件

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
fileDataIds	fileDataIds	query	false	array	string

响应状态

状态码	说明	schema
200	OK	Result«List«DownloadLinkResponseVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		array	DownloadLinkResponseVO
url	下载url	string
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": [
        {
            "url": ""
        }
    ], 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

主文件创建接口

接口地址

POST /api/v6/resource/file/create

接口描述

文件上传流程中，主文件创建

请求数据类型

application/json

响应数据类型

*/*

请求示例

				
					{
  "blockInfoList": [
    {
      "hash": "",
      "md5Hash": "",
      "num": 0,
      "size": 0
    }
  ],
  "catalogId": "",
  "categories": "",
  "ext": {},
  "extGenerateStrategy": "",
  "groupPermission": 6,
  "groupPermissionCanEdit": 0,
  "hash": "",
  "inodeCategory": "",
  "machineKey": "",
  "md5Hash": "",
  "metaType": 0,
  "name": "",
  "nameStrategy": "",
  "otherPermission": 0,
  "ownerPermission": 7,
  "pId": "",
  "pid": "",
  "purpose": "",
  "size": 123,
  "tags": ""
}

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
blockCreateDTO	主文件创建实例	body	true	JSONString	BlockCreateDTO
blockInfoList			false	array	RequestBlockInfo
hash			false	string
md5Hash			false	string
num			false	integer
size			false	integer
catalogId	目录id		false	string
categories			false	string
ext			false	object
extGenerateStrategy	当前策略是只生成ab文件，不生成图片, 可用值: MODEL_ALL, MODEL_NULL, MODEL_WITHOUT_IMG, NO_TASK		false	string
groupPermission	当前组用户权限(默认读 7 4 0) 0:无任何权限 4:读权限(默认) 2:写权限 1:高級写权限		false	integer(int32)
groupPermissionCanEdit	当前组用户权限是否可编辑 0 否 1 是		false	integer(int32)
hash	文件hash值(MD5)		true	string
inodeCategory	手动指定类型, 可用值: AB, ASSET, AUDIO, DIR, DIRPKG, DIRPROJ, DMCM, DOC, EXCEL, FOLDER, FZZXDIRPKG, GADGET, IMAGE, IOTSIM, JSON, LOG, MODEL3D, MODEL3Dv2, OTHER, PDF, PIXYZ, PPT, RVT, SCENE, VIDEO		false	string
machineKey			false	string
md5Hash			false	string
metaType	手动指定mate 是否包含主文件(0:包含，1：不包含)		false	integer(int32)
name	文件名		true	string
nameStrategy	文件覆盖重命名策略, 默认是RENAME, 可用值: COVER, RENAME, THROW_EXCEPTION		false	string
otherPermission	其他组用户权限(默认没有 0 0 0) 0:无任何权限 4:读权限 2:写权限 1:高級写权限		false	integer(int32)
ownerPermission	所有者权限(默认所有 7 0 0) 0:无任何权限 4:读权限 2:写权限 1:高級写权限		false	integer(int32)
pId	父级ID, 创建组的话 pId 为 0		true	string
pid			false	string
purpose			false	string
size	文件总大小, byte 为单位		true	integer(int64)
tags	标签		false	string

响应状态

状态码	说明	schema
200	OK	Result«FileCreateResponseVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		FileCreateResponseVO	FileCreateResponseVO
blockList		array	BlockCreateResponseVO
blockId		string
formFields		array	Pair
key		string
value		object
httpHeaders		array	Pair
key		string
value		object
httpMethod		string
httpProtocol		string
num		integer
type		string
uploadFormField		string
url		string
fileId		string
metaId		string
version		integer(int32)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": {
        "blockList": [
            {
                "blockId": "", 
                "formFields": [
                    {
                        "key": "", 
                        "value": { }
                    }
                ], 
                "httpHeaders": [
                    {
                        "key": "", 
                        "value": { }
                    }
                ], 
                "httpMethod": "", 
                "httpProtocol": "", 
                "num": 0, 
                "type": "", 
                "uploadFormField": "", 
                "url": ""
            }
        ], 
        "fileId": "", 
        "metaId": "", 
        "version": 0
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

主文件块文件上传回调

接口地址

POST /api/v6/resource/file/block/create/callback

接口描述

文件上传流程中，主文件上传，主文件块文件上传完成后调用

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
blockId	blockId	query	true	string
code	code 为0表示上传成功，否则都表示失败	query	true	integer(int32)
message	消息，可选字段	query	false	string
tenantId	租户id	query	false	string

响应状态

状态码	说明	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": null, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

主文件上传完成回调

接口地址

POST /api/v6/resource/file/create/callback

接口描述

文件上传流程中，主文件上传完成后调用

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
code	code 为0表示上传成功，否则都表示失败	query	true	integer(int32)
metaId	metaId	query	true	string
version	version	query	true	integer(int32)
message	消息，可选字段	query	false	string

响应状态

状态码	说明	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		INodeResponseVO	INodeResponseVO
additional	封面文件id列表	array	Mime
blockInfoList		array	BlockInfo
hash	Hash	string
id	块下载id	string
md5Hash	MD5	string
size	文件大小	integer
category	inode 类型	integer
downloadPolicy	下载策略	integer
ext	附件信息	object
fileType	文件类型	string
hash	Hash	string
id	编码	string
isBlock	是否分块	boolean
isDownloadable	能否下载	boolean
md5Hash	MD5	string
name	文件名称	string
purpose	用途	string
size	大小	integer
block	是否分块	boolean
blockInfoList		array	BlockInfo
hash	Hash	string
id	块下载id	string
md5Hash	MD5	string
size	大小	integer
category	inode 类型	integer(int32)
categoryIdList	inode 类型列表	array	string
ctime	创建时间	integer(int64)
downloadPolicy	下载策略	integer(int32)
ext	附件信息	object
fileDataId	file download id, 当type为2时为空	string
filename	文件/文件夹名称	string
groupId	工作组ID	string
groupPermission	工作组权限	integer(int32)
groupPermissionCanEdit	当前组用户权限是否可编辑 0 否 1 是	integer(int32)
hash	Hash	string
isDownloadable	能否下载	boolean
lockInfo		EditorLockResponseVO	EditorLockResponseVO
ctime	创建时间	integer
lockType	锁类型	string
mtime	更新时间	integer
userId	用户编码	string
username	用户名称	string
md5Hash	MD5	string
metaId	inode meta id	string
metaType	是否包含主文件	integer(int32)
mtime	更新时间	integer(int64)
otherPermission	其它权限	integer(int32)
ownerId	所有者ID	string
ownerPermission	所有者权限	integer(int32)
path	路径	string
pid	父目录ID	string
preset	是否是预设	boolean
shareType	可用值: NOT_SHARE, SHARED,EXPIRED	string
size	文件大小(bytes)	integer(int64)
suffix	后缀名	string
tags		array	LabelVO
createUserName	创建者	string
i18nLabel	标签多语言	string
id	标签ID	string
name	标签名称	string
refSum	引用数量	integer
version	版本	integer(int32)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": {
        "additional": [
            {
                "blockInfoList": [
                    {
                        "hash": "", 
                        "id": "", 
                        "md5Hash": "", 
                        "size": 0
                    }
                ], 
                "category": 0, 
                "downloadPolicy": 0, 
                "ext": { }, 
                "fileType": "", 
                "hash": "", 
                "id": "", 
                "isBlock": true, 
                "isDownloadable": true, 
                "md5Hash": "", 
                "name": "", 
                "purpose": "", 
                "size": 0
            }
        ], 
        "block": true, 
        "blockInfoList": [
            {
                "hash": "", 
                "id": "", 
                "md5Hash": "", 
                "size": 0
            }
        ], 
        "category": 0, 
        "categoryIdList": [ ], 
        "ctime": 0, 
        "downloadPolicy": 0, 
        "ext": { }, 
        "fileDataId": "", 
        "filename": "", 
        "groupId": "", 
        "groupPermission": 0, 
        "groupPermissionCanEdit": 0, 
        "hash": "", 
        "isDownloadable": true, 
        "lockInfo": {
            "ctime": 0, 
            "lockType": "", 
            "mtime": 0, 
            "userId": "", 
            "username": ""
        }, 
        "md5Hash": "", 
        "metaId": "", 
        "metaType": 0, 
        "mtime": 0, 
        "otherPermission": 0, 
        "ownerId": "", 
        "ownerPermission": 0, 
        "path": "", 
        "pid": "", 
        "preset": true, 
        "shareType": "", 
        "size": 0, 
        "suffix": "", 
        "tags": [
            {
                "createUserName": "", 
                "i18nLabel": "", 
                "id": "", 
                "name": "", 
                "refSum": 0
            }
        ], 
        "version": 0
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

附件文件创建

接口地址

POST /api/v6/resource/ext/create

接口描述

文件上传流程中，附件文件创建调用

请求数据类型

application/json

响应数据类型

*/*

请求示例

				
					{
    "blockInfoList": [
        {
            "hash": "", 
            "md5Hash": "", 
            "num": 0, 
            "size": 0
        }
    ], 
    "ext": { }, 
    "hash": "", 
    "md5Hash": "", 
    "metaId": "", 
    "name": "", 
    "purpose": "", 
    "size": 1, 
    "tenantId": "", 
    "version": 1
}

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
requestVO	requestVO	body	true	ExtBigCreateRequestVO	ExtBigCreateRequestVO
blockInfoList			false	array	RequestBlockInfo
hash	hash		false	string
md5Hash	MD5		false	string
num	数量		false	integer
size	大小		false	integer
ext	附件信息		false	object
hash	文件hash值(SHA256)		true	string
md5Hash	MD5		false	string
metaId	资源id		true	string
name	名称		false	string
purpose	附加文件的用途		false	string
size	文件的大小		true	integer(int64)
tenantId	租户ID		false	string
version	资源版本号		true	integer(int32)

响应状态

状态码	说明	schema
200	OK	Result«FileCreateResponseVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		FileCreateResponseVO	FileCreateResponseVO
blockList		array	BlockCreateResponseVO
blockId	块编码	string
formFields		array	Pair
key	关键字	string
value	值	object
httpHeaders		array	Pair
key	关键字	string
value	值	object
httpMethod	http方法	string
httpProtocol	http协议	string
num	数量	integer
type	类型	string
uploadFormField	请求类型	string
url	url	string
fileId	文件ID	string
metaId	资源ID	string
version	版本	integer(int32)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{ 
    "code": 0, 
    "data": {
        "blockList": [
            {
                "blockId": "", 
                "formFields": [
                    {
                        "key": "", 
                        "value": { }
                    }
                ], 
                "httpHeaders": [
                    {
                        "key": "", 
                        "value": { }
                    }
                ], 
                "httpMethod": "", 
                "httpProtocol": "", 
                "num": 0, 
                "type": "", 
                "uploadFormField": "", 
                "url": ""
            }
        ], 
        "fileId": "", 
        "metaId": "", 
        "version": 0
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

附件块文件上传回调

接口地址

POST /api/v6/resource/ext/block/create/callback

接口描述

文件上传流程中，附件上传，每一个附件块上传完成后调用

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
blockId	blockId	query	true	string
code	code 为0表示上传成功，否则都表示失败	query	true	integer(int32)
message	消息，可选字段	query	false	string
tenantId	租户id	query	false	string

响应状态

状态码	说明	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{ 
    "code": 0, 
    "data": null, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

附件上传回调

接口地址

POST /api/v6/resource/ext/create/callback

接口描述

文件上传流程中，附件文件上传完成后调用

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
code	code 为0表示上传成功，否则都表示失败	query	true	integer(int32)
fileId	fileId	query	true	string
message	消息，可选字段	query	false	string

响应状态

状态码	说明	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": null, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

主文件覆盖接口

接口地址

POST /api/v6/resource/file/cover

接口描述

主文件覆盖

请求数据类型

application/json

响应数据类型

*/*

请求示例

				
					{
    "blockInfoList": [
        {
            "hash": "", 
            "md5Hash": "", 
            "num": 0, 
            "size": 0
        }
    ],  
    "ext": { }, 
    "extGenerateStrategy": "", 
    "groupPermission": 6, 
    "groupPermissionCanEdit": 0, 
    "hash": "", 
    "id": "", 
    "inodeCategory": "", 
    "machineKey": "", 
    "md5Hash": "", 
    "metaType": 0, 
    "otherPermission": 0, 
    "ownerPermission": 7, 
    "size": 123, 
    "tags": ""
}

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
requestVO	requestVO	body	true	BlockCoverRequestDTO	BlockCoverRequestDTO
blockInfoList			false	array	RequestBlockInfo
hash	Hash		false	string
md5Hash	MD5		false	string
num	数量		false	integer
size	大小		false	integer
ext	附件信息		false	object
extGenerateStrategy	当前策略是只生成ab文件，不生成图片, 可用值: MODEL_WITHOUT_IMG, MODEL_ALL, MODEL_NULL, NO_TASK		false	string
groupPermission	当前组用户权限(默认读 7 4 0) 0:无任何权限 4:读权限(默认) 2:写权限 1:高級写权限		false	integer(int32)
groupPermissionCanEdit	当前组用户权限是否可编辑 0 否 1 是		false	integer(int32)
hash	文件hash值(MD5)		true	string
id	资源Id		true	string
inodeCategory	手动指定类型, 可用值: FOLDER, MODEL3D, AB, IMAGE, VIDEO, AUDIO, DOC, PDF, EXCEL, PPT, DIR, LOG, DIRPROJ, DIRPKG, FZZXDIRPKG, IOTSIM, MODEL3Dv2, PIXYZ, DMCM, ASSET, GADGET, SCENE, OTHER		false	string
machineKey	机器key		false	string
md5Hash	MD5		false	string
metaType	手动指定mate 是否包含主文件(0:包含，1：不包含)		false	integer(int32)
otherPermission	其他组用户权限(默认没有 0 0 0) 0:无任何权限 4:读权限 2:写权限 1:高級写权限		false	integer(int32)
ownerPermission	所有者权限(默认所有 7 0 0) 0:无任何权限 4:读权限 2:写权限 1:高級写权限		false	integer(int32)
size	文件总大小, byte 为单位		true	integer(int64)
tags	文件标签，逗号隔开		false	string

响应状态

状态码	说明	schema
200	OK	Result«FileCreateResponseVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		FileCreateResponseVO	FileCreateResponseVO
blockList		array	BlockCreateResponseVO
blockId	块ID	string
formFields		array	Pair
key	关键字	string
value	值	object
httpHeaders		array	Pair
key	关键字	string
value	值	object
httpMethod	http方法	string
httpProtocol	http协议	string
num	数量	integer
type	类型	string
uploadFormField	请求类型	string
url	url	string
fileId	文件ID	string
metaId	资源ID	string
version	版本	integer(int32)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": {
        "blockList": [
            {
                "blockId": "", 
                "formFields": [
                    {
                        "key": "", 
                        "value": { }
                    }
                ], 
                "httpHeaders": [
                    {
                        "key": "", 
                        "value": { }
                    }
                ], 
                "httpMethod": "", 
                "httpProtocol": "", 
                "num": 0, 
                "type": "", 
                "uploadFormField": "", 
                "url": ""
            }
        ], 
        "fileId": "", 
        "metaId": "", 
        "version": 0
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

路径主文件创建接口

接口地址

POST /api/v6/resource/file/create/path

接口描述

根据路径创建主文件

请求数据类型

application/json

响应数据类型

*/*

请求示例

				
					{
    "blockInfoList": [
        {
            "hash": "", 
            "md5Hash": "", 
            "num": 0, 
            "size": 0
        }
    ], 
    "catalogId": "", 
    "ext": { }, 
    "extGenerateStrategy": "",  
    "groupPermission": 6, 
    "groupPermissionCanEdit": 0, 
    "hash": "", 
    "inodeCategory": "", 
    "machineKey": "", 
    "md5Hash": "", 
    "metaType": 0, 
    "name": "", 
    "nameStrategy": "", 
    "otherPermission": 0, 
    "ownerPermission": 7, 
    "path": "", 
    "size": 123, 
    "tags": ""
}

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
requestVO	requestVO	body	true	FilePathCreateRequestVO	FilePathCreateRequestVO
blockInfoList			false	array	RequestBlockInfo
hash	Hash		false	string
md5Hash	MD5		false	string
num	数量		false	integer
size	大小		false	integer
catalogId	目录id		false	string
ext	附件信息		false	object
extGenerateStrategy	当前策略是只生成ab文件，不生成图片, 可用值: MODEL_WITHOUT_IMG, MODEL_ALL, MODEL_NULL, NO_TASK		false	string
groupPermission	当前组用户权限(默认读 7 4 0) 0:无任何权限 4:读权限(默认) 2:写权限 1:高級写权限		false	integer(int32)
groupPermissionCanEdit	当前组用户权限是否可编辑 0 否 1 是		false	integer(int32)
hash	文件hash值(SHA256)		true	string
inodeCategory	手动指定类型, 可用值: FOLDER, MODEL3D, AB, IMAGE, VIDEO, AUDIO, DOC, PDF, EXCEL, PPT, DIR, LOG, DIRPROJ, DIRPKG, FZZXDIRPKG, IOTSIM, MODEL3Dv2, PIXYZ, DMCM, ASSET, GADGET, SCENE, OTHER		false	string
machineKey	机器key		false	string
md5Hash	MD5		false	string
metaType	手动指定mate 是否包含主文件(0:包含，1：不包含)		false	integer(int32)
name	名称		true	string
nameStrategy	文件覆盖重命名策略, 默认是RENAME, 可用值: RENAME, COVER, THROW_EXCEPTION		false	string
otherPermission	其他组用户权限(默认没有 0 0 0) 0:无任何权限 4:读权限 2:写权限 1:高級写权限		false	integer(int32)
ownerPermission	所有者权限(默认所有 7 0 0) 0:无任何权限 4:读权限 2:写权限 1:高級写权限		false	integer(int32)
path	文件上传路径		true	string
size	文件总大小, byte 为单位		true	integer(int64)
tags	标签		false	string

响应状态

状态码	说明	schema
200	OK	Result«FileCreateResponseVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		FileCreateResponseVO	FileCreateResponseVO
blockList		array	BlockCreateResponseVO
blockId	块ID	string
formFields		array	Pair
key	关键字	string
value	值	object
httpHeaders		array	Pair
key	关键字	string
value	值	object
httpMethod	http方法	string
httpProtocol	http协议	string
num	数量	integer
type	类型	string
uploadFormField	请求类型	string
url	url	string
fileId	文件ID	string
metaId	资源ID	string
version	版本	integer(int32)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					console.log( 'Code is Poetry' );{ 
    "code": 0, 
    "data": {
        "blockList": [
            {
                "blockId": "", 
                "formFields": [
                    {
                        "key": "", 
                        "value": { }
                    }
                ], 
                "httpHeaders": [
                    {
                        "key": "", 
                        "value": { }
                    }
                ], 
                "httpMethod": "", 
                "httpProtocol": "", 
                "num": 0, 
                "type": "", 
                "uploadFormField": "", 
                "url": ""
            }
        ], 
        "fileId": "", 
        "metaId": "", 
        "version": 0
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

路径日志文件创建接口

接口地址

POST /api/v1/resource/file/log/create/path

接口描述

根据路径创建日志文件

请求数据类型

application/json

响应数据类型

*/*

请求示例

				
					{
    "blockInfoList": [
        {
            "hash": "", 
            "md5Hash": "", 
            "num": 0, 
            "size": 0
        }
    ], 
    "catalogId": "", 
    "ext": { }, 
    "extGenerateStrategy": "", 
    "groupId": "", 
    "groupPermission": 6, 
    "groupPermissionCanEdit": 0, 
    "hash": "", 
    "inodeCategory": "", 
    "machineKey": "", 
    "md5Hash": "", 
    "metaType": 0, 
    "name": "", 
    "nameStrategy": "", 
    "otherPermission": 0, 
    "ownerPermission": 7, 
    "path": "", 
    "size": 123, 
    "tags": ""
}

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
requestVO	requestVO	body	true	FilePathCreateRequestVO	FilePathCreateRequestVO
blockInfoList			false	array	RequestBlockInfo
hash	Hash		false	string
md5Hash	MD5		false	string
num	数量		false	integer
size	大小		false	integer
catalogId	目录id		false	string
ext	附加信息		false	object
extGenerateStrategy	当前策略是只生成ab文件，不生成图片, 可用值: MODEL_WITHOUT_IMG, MODEL_ALL, MODEL_NULL, NO_TASK		false	string
groupId	当前工作组，当 path 不存在的时候创建使用		true	string
groupPermission	当前组用户权限(默认读 7 4 0) 0:无任何权限 4:读权限(默认) 2:写权限 1:高級写权限		false	integer(int32)
groupPermissionCanEdit	当前组用户权限是否可编辑 0 否 1 是		false	integer(int32)
hash	文件hash值(SHA256)		true	string
inodeCategory	手动指定类型, 可用值: FOLDER, MODEL3D, AB, IMAGE, VIDEO, AUDIO, DOC, PDF, EXCEL, PPT, DIR, LOG, DIRPROJ, DIRPKG, FZZXDIRPKG, IOTSIM, MODEL3Dv2, PIXYZ, DMCM, ASSET, GADGET, SCENE, OTHER		false	string
machineKey	机器Key		false	string
md5Hash	MD5		false	string
metaType	手动指定mate 是否包含主文件(0:包含，1：不包含)		false	integer(int32)
name	文件名		true	string
nameStrategy	文件覆盖重命名策略, 默认是RENAME, 可用值: RENAME, COVER, THROW_EXCEPTION		false	string
otherPermission	其他组用户权限(默认没有 0 0 0) 0:无任何权限 4:读权限 2:写权限 1:高級写权限		false	integer(int32)
ownerPermission	所有者权限(默认所有 7 0 0) 0:无任何权限 4:读权限 2:写权限 1:高級写权限		false	integer(int32)
path	文件上传路径		true	string
size	文件总大小, byte 为单位		true	integer(int64)
tags	标签		false	string

响应状态

状态码	说明	schema
200	OK	Result«FileCreateResponseVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
args		object
code		integer(int32)	integer(int32)
data		FileCreateResponseVO	FileCreateResponseVO
blockList		array	BlockCreateResponseVO
blockId		string
formFields		array	Pair
key	关键字	string
value	值	object
httpHeaders		array	Pair
key	关键字	string
value	值	object
httpMethod	http方法	string
httpProtocol	http协议	string
num	数量	integer
type	类型	string
uploadFormField	请求类型	string
url	url	string
fileId	文件ID	string
metaId	资源ID	string
version	版本	integer(int32)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "args": { }, 
    "code": 0, 
    "data": {
        "blockList": [
            {
                "blockId": "", 
                "formFields": [
                    {
                        "key": "", 
                        "value": { }
                    }
                ], 
                "httpHeaders": [
                    {
                        "key": "", 
                        "value": { }
                    }
                ], 
                "httpMethod": "", 
                "httpProtocol": "", 
                "num": 0, 
                "type": "", 
                "uploadFormField": "", 
                "url": ""
            }
        ], 
        "fileId": "", 
        "metaId": "", 
        "version": 0
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

活动相关接口

活动接口

活动列表

接口地址

GET /api/v6/director/event/unity/list

接口描述

unity活动列表

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

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

响应状态

状态码	说明	schema
200	OK	Result«object»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		JSONString	unity活动列表响应数据
list	event list	array	EventListVO
activityType	活动类型	integer
allowJoin	是否允许加入 0 允许 1 不允许	integer
capability	活动容量	integer
clientNumber	客户端数量	integer
cover	活动封面	string
createTime		integer
defaultClientRole	默认客户端角色 0 主持人 1 观察者 2 第三方视角	integer
description	活动描述	string
editMode	是否是编辑模式	integer
endTime	活动结束时间	integer
id	ID	string
name	活动名称	string
offLine	是否是离线活动	boolean
owner	所有者信息	JSONString	用户简单返回实体
headPic		string
realName		string
userId		string
username		string
ownerId	活动所有者ID	string
playingScript	是否正在播放剧本 0 未播放 1 播放	integer
protocol	长连接协议	string
scenesId	场景Id	string
scriptNumber	剧本数量	integer
socketUrl	长连接地址	string
startTime	活动开始时间	integer
status	活动状态 0 未开始 1 正在进行 2 已过期	integer
tags	活动标签	array	EventTag对象
createTime		integer
id		string
name	标签名称	string
tenantId	租户ID	string
updateTime		integer
type	活动时间类型 0 有期限 1 无期限	integer
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
	"code": 0,
	"data": {
		"list": [
			{
				"activityType": 0,
				"allowJoin": 0,
				"capability": 0,
				"clientNumber": 0,
				"cover": "",
				"createTime": 0,
				"defaultClientRole": 0,
				"description": "",
				"editMode": 0,
				"endTime": 0,
				"id": "",
				"name": "",
				"offLine": false,
				"owner": {
					"headPic": "",
					"realName": "",
					"userId": "",
					"username": ""
				},
				"ownerId": "",
				"playingScript": 0,
				"protocol": "",
				"scenesId": "",
				"scriptNumber": 0,
				"socketUrl": "",
				"startTime": 0,
				"status": 0,
				"tags": [
					{
						"createTime": 0,
						"id": "",
						"name": "",
						"tenantId": "",
						"updateTime": 0
					}
				],
				"type": 0
			}
		]
	},
	"msg": "",
	"msg_i18n": {},
	"status": 0,
	"timestamp": 0
}

按条件查询活动列表

接口地址

GET /api/v6/director/event/list

接口描述

按照条件查询活动列表

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
activityType	活动类型(0 剧本活动 1 场景活动), 可用值: SCRIPT_ACTIVITY, SCENES_ACTIVITY	query	false	string
eventIds	活动Id 列表	query	false	array	string
labelIds	标签ID列表	query	false	array	string
name	活动名称	query	false	string
ownerNickname	所有者昵称	query	false	string
pageNo	当前页数	query	false	integer(int32)
pageSize	分页条数	query	false	integer(int32)
status	活动状态, 可用值: 0 未开始, 1 进行中, 2 已结束, 3 已取消, 4 闲置中, 5 占用中, 6 准备中	query	false	string
sorts[0].asc	是否正序排序	query	false	boolean
sorts[0].field	排序字段	query	false	string

响应状态

状态码	说明	schema
200	OK	Result«IPage«EventListVO»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		JSONString	分页结果«EventListVO»
list	数据	array	EventListVO
activityType	活动类型	integer
allowJoin	是否允许加入 0 允许 1 不允许	integer
capability	活动容量	integer
clientNumber	客户端数量	integer
cover	活动封面	string
createTime		integer
defaultClientRole	默认客户端角色 0 主持人 1 观察者 2 第三方视角	integer
description	活动描述	string
editMode	是否是编辑模式	integer
endTime	活动结束时间	integer
id	ID	string
name	活动名称	string
offLine	是否是离线活动	boolean
owner	所有者信息	JSONString	用户简单返回实体
headPic		string
realName		string
userId		string
username		string
ownerId	活动所有者ID	string
playingScript	是否正在播放剧本 0 未播放 1 播放	integer
protocol	长连接协议	string
scenesId	场景Id	string
scriptNumber	剧本数量	integer
socketUrl	长连接地址	string
startTime	活动开始时间	integer
status	活动状态 0 未开始 1 正在进行 2 已过期	integer
tags	活动标签	array	EventTag对象
createTime		integer
id		string
name	标签名称	string
tenantId	租户ID	string
updateTime		integer
type	活动时间类型 0 有期限 1 无期限	integer
pageNo	页码，从 1 开始	integer(int64)
pageSize	每页条数	integer(int64)
total	总量	integer(int64)
totalPage	总页数	integer(int64)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
	"code": 0,
	"data": {
		"list": [
			{
				"activityType": 0,
				"allowJoin": 0,
				"capability": 0,
				"clientNumber": 0,
				"cover": "",
				"createTime": 0,
				"defaultClientRole": 0,
				"description": "",
				"editMode": 0,
				"endTime": 0,
				"id": "",
				"name": "",
				"offLine": false,
				"owner": {
					"headPic": "",
					"realName": "",
					"userId": "",
					"username": ""
				},
				"ownerId": "",
				"playingScript": 0,
				"protocol": "",
				"scenesId": "",
				"scriptNumber": 0,
				"socketUrl": "",
				"startTime": 0,
				"status": 0,
				"tags": [
					{
						"createTime": 0,
						"id": "",
						"name": "",
						"tenantId": "",
						"updateTime": 0
					}
				],
				"type": 0
			}
		],
		"pageNo": 0,
		"pageSize": 0,
		"total": 0,
		"totalPage": 0
	},
	"msg": "",
	"msg_i18n": {},
	"status": 0,
	"timestamp": 0
}

活动详情

接口地址

GET /api/v6/director/event/detail

接口描述

获取活动详细信息

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
eventId	活动编码	query	true	string

响应状态

状态码	说明	schema
200	OK	Result«EventDetailsVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	code
data		EventDetailsVO	data
activityType	活动类型	integer(int32)	activityType
adminIds		string	adminIds
allowJoin	是否允许加入 0 允许 1 不允许	integer(int32)	allowJoin
capability	活动容量	integer(int32)	capability
category	活动种类快速活动预定活动, 可用值: FAST_EVENT, PUBLIC_EVENT, RESERVE_EVENT	string	category
clientNumber	客户端数量	integer(int32)	clientNumber
cover	活动封面	string	cover
createTime	创建时间	integer(int64)	createTime
defaultClientRole	默认客户端角色 0 主持人 1 观察者 2 第三方视角	integer(int32)	defaultClientRole
description	活动描述	string	description
editMode	是否是编辑模式	integer(int32)	editMode
endTime	活动结束时间	integer(int64)	endTime
groupId	组ID	string	groupId
id	ID	string	id
labelList	标签列表	array	labelList
createUserName	创建者	string	createUserName
i18nLabel	标签多语言	string	i18nLabel
id	标签ID	string	id
name	标签名称	string	name
refSum	引用数量	integer	refSum
name	活动名称	string	name
num	编号	string	num
offLine	是否是离线活动	boolean	offLine
owner		JSONString	owner
headPic		string	headPic
realName		string	realName
userId		string	userId
username		string	username
ownerId	活动所有者ID	string	ownerId
playingScript	是否正在播放剧本 0 未播放 1 播放	integer(int32)	playingScript
protocol	长连接协议	string	protocol
scriptNumber	剧本数量	integer(int32)	scriptNumber
socketUrl	长连接地址	string	socketUrl
startTime	活动开始时间	integer(int64)	startTime
status	活动状态 0 未开始 1 正在进行 2 已过期	integer(int32)	status
substate	活动子状态, 可用值: IDLE, PLAYING, WAITING	string	substate
tags	活动标签	array	tags
createTime		integer	createTime
id		string	id
name	标签名称	string	name
tenantId	租户ID	string	tenantId
updateTime		integer	updateTime
type	活动类型 0 有期限 1 无期限	integer(int32)	type
msg		string	msg
msg_i18n		object	msg_i18n
status		integer(int32)	status
timestamp		integer(int64)	timestamp

响应示例

				
					{
	"code": 0,
	"data": {
		"activityType": 0,
		"adminIds": "",
		"allowJoin": 0,
		"capability": 0,
		"category": "",
		"clientNumber": 0,
		"cover": "",
		"createTime": 0,
		"defaultClientRole": 0,
		"description": "",
		"editMode": 0,
		"endTime": 0,
		"groupId": "",
		"id": "",
		"labelList": [
			{
				"createUserName": "",
				"i18nLabel": "",
				"id": "",
				"name": "",
				"refSum": 0
			}
		],
		"name": "",
		"num": "",
		"offLine": false,
		"owner": {
			"headPic": "",
			"realName": "",
			"userId": "",
			"username": ""
		},
		"ownerId": "",
		"playingScript": 0,
		"protocol": "",
		"scriptNumber": 0,
		"socketUrl": "",
		"startTime": 0,
		"status": 0,
		"substate": "",
		"tags": [
			{
				"createTime": 0,
				"id": "",
				"name": "",
				"tenantId": "",
				"updateTime": 0
			}
		],
		"type": 0
	},
	"msg": "",
	"msg_i18n": {},
	"status": 0,
	"timestamp": 0
}

活动-创建

接口地址

POST /api/v6/director/event/create

接口描述

创建活动

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
eventCreateDTO	活动创建请求实体	body	true	JSONString	活动创建请求实体
activityType	活动类型(0 剧本活动 1 场景活动), 可用值:0,1		false	string
category	活动种类, 可用值: FAST_EVENT, PUBLIC_EVENT, RESERVE_EVENT		false	string
cover	活动封面		false	string
days	所选天数		false	integer(int32)
description	活动描述		false	string
endTime	活动结束时间		false	integer(int64)
labelIds	标签ID列表		false	array	string
name	活动名称		true	string
startTime	活动开始时间		false	integer(int64)
tags	活动标签		false	string
type	活动时间限制 0 无时间限制 1 有时间限制		true	integer(int32)

响应状态

状态码	说明	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		Map<String,String>
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": {
        "eventId": 1		//活动ID
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

活动校验是否存在

接口地址

GET /api/v6/director/event/eventCheckNameExists

接口描述

校验是否存在相同名称的活动

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
name	活动名称	query	false	string

响应状态

状态码	说明	schema
200	OK	Result«boolean»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		boolean
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{ 
    "code": 0, 
    "data": true, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

活动更新

接口地址

POST /api/v6/director/event/update

接口描述

活动更新

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
eventUpdate	活动更新请求实体	body	true	JSONString	活动更新请求实体
allowJoin	活动是否允许加入		false	integer(int32)
capability	活动最大人数		false	integer(int32)
catalogId	目录ID		false	string
cover	封面文件，服务器路径		false	string
description	活动描述		false	string
endTime	活动结束时间		false	integer(int64)
id	id		true	string
labelIds	标签ID列表		false	array	string
name	活动名称		true	string
num			false	string
startTime	活动开始时间		false	integer(int64)
tags	活动标签		false	array	string
type	活动类型 0 无时间限制 1 有时间限制		true	integer(int32)

响应状态

状态码	说明	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		string
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": "", 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

判断是否有权限加入活动

接口地址

GET /api/v6/director/event/join/permissions

接口描述

判断是否有权限加入活动

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
eventId	活动编码	body	false	string

响应状态

状态码	说明	schema
200	OK	Result«EventPermissionVO»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		EventPermissionVO	EventPermissionVO
hasPermission	是否有权限进入活动 0-没有 1-有权限	integer(int32)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": {
        "hasPermission": 0
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

取消活动

接口地址

POST /api/v6/director/event/cancel

接口描述

取消活动

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
eventId	活动id	body	true	string

响应状态

状态码	说明	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": null, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

活动关闭

接口地址

POST /api/v6/director/event/close

接口描述

活动关闭

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
eventId	活动id	body	true	string

响应状态

状态码	说明	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		Map<String,Boolean>
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{ 
    "code": 0, 
    "data": {
        "success": true		//活动关闭状态
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

活动剧本管理接口

剧本列表

接口地址

GET /api/v6/director/script/list

接口描述

获取指定活动的剧本

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
eventId	活动ID	query	false	string

响应状态

状态码	说明	schema
200	OK	Result«object»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		array	ScriptVO
eventId	活动ID	string
latestVersion	最新版本	integer(int32)
metaId	剧本资源ID	string
path	剧本path	string
scriptId	剧本ID	string
tenantId	租户ID	string
uploadTime	剧本上传时间	integer(int64)
version	版本	integer(int32)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": {
        "list": [
            {
                "scriptId": "", 	//剧本ID
                "tenantId": "", 	//租户ID
                "eventId": "", 		//活动ID
                "metaId": "", 		//资源ID
                "path": "", 		//资源路径
                "version": 0, 		//资源版本
                "latestVersion": 0, //资源最新版本
                "uploadTime": 0 	//更新时间
            }
        ]
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

活动添加剧本

接口地址

POST /api/v6/director/script/add

接口描述

活动添加剧本

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
eventId	活动ID	query	false	string
scriptDtoList	剧本列表	query	false	string

响应状态

状态码	说明	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": null, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

活动剧本删除

接口地址

POST /api/v6/director/script/delete

接口描述

删除自定活动的剧本

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
scriptId	剧本ID	query	false	string

响应状态

状态码	说明	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": null, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

活动更换剧本(先删除后加)

接口地址

POST /api/v6/director/script/change

接口描述

活动更换剧本，与先删除剧本再添加剧本功能相同

请求数据类型

application/x-www-form-urlencoded

响应数据类型

*/*

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
eventId	活动ID	query	false	string
scriptDtoList	剧本列表	query	false	string

响应状态

状态码	说明	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

响应示例

				
					{
    "code": 0, 
    "data": null, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

附录一

0	成功
10400001	系统错误，请联系support@datamesh.com
10400002	未授权
10400004	禁止访问
10400005	未找到
10400006	请求方式不允许
10400007	服务器内部错误
10400010	系统错误，请联系support@datamesh.com
10500012	第三方认证失败
10500013	用户不存在
10500014	此用户已在组织中，请勿重复添加
10500015	用户不存在或密码错误
10500016	错误次数过多,请稍后重试
10500017	验证码错误
10500018	用户账户过期
10500019	验证码已过期
10500020	修改密码失败,旧密码与新密码相同
10500021	修改密码失败,旧密码错误
10500026	用户凭证不存在
10500027	用户凭证无效
10500028	验证码无效
10500029	已经关注
10500030	License 过期
10500031	License 无效
10500032	License 不存在
10500033	超出 License 限制
10500034	二维码已过期
10500035	用户名已存在
10500036	租户不存在
10500037	工作组不存在
10500038	用户已经是管理员，不能重复添加
10500039	用户不是管理员
10500040	用户已在工作组中
10500041	已发送过请求，请等待管理员审核
10500042	当前角色下面关联用户，请先解绑用户关系
10500043	角色编码已存在
10500044	用户认证信息不存在
10500045	审核信息不存在
10500046	链接已失效
10500047	用户名格式错误
10500048	默认匿名租户不存在
10500049	企业标识已存在
10500050	平台信息不存在
10500051	域名已存在
10500052	平台已经初始化
10500053	默认个人租户不存在
10500054	默认主账号不存在
10500055	主账号配置错误，请联系租户管理员
10500056	昵称已存在
10500057	增加失败，权限项已存在
10500058	权限项不存在
10500059	分级管理员已存在
10500060	订阅不存在或者已过期
10500061	超出订阅限制
10500062	该账号未分配License，请联系您的企业管理员
10500063	该用户已分配License
10500064	订阅时间重复
10500065	订阅不存在或者已过期
10500066	企业总管理员不存在
10500067	企业管总理员已存在
10500068	用户已是企业总管理员
10500069	服务器选择错误
10500074	用户已经是管理员不能添加为分级管理员
10500075	用户为工作组所有者无需添加为管理员
10500076	已经存在订阅包括需要签发的过期时间的订阅
10500077	用户凭证过期
10500080	请勿重复提交
10500081	对象已被引用，无法删除
10500082	数据为必填项
10500083	该物体存在必填属性未被填写，请填写后重试
10500085	您的账号已在其他设备登录
10500090	只能重置收到邮件的邮箱账号，请核对后重新输入
10500099	错误次数过多,请${lockTime}分钟后重试
10500100	密码错误
11500001	文件保存出错
11500007	不能将文件夹移动到自己或其子目录下
11500009	文件/文件夹名字冲突
11500010	文件夹内必须为空才能删除
11500011	父级文件夹不存在
11500012	文件上传未完成
11500014	文件不存在
11500015	文件不完整
11500016	文件超出大小限制
11500017	文件已被用户编辑
11500018	分类名重复
11500019	资源版本冲突,禁止上传重名文件
11500020	资源分享密码错误
11500021	资源分享次数达到上限
11500022	资源分享已过期
11510019	文件访问未授权
11510020	文件上传未授权
11510021	目录访问未授权
11510022	目录修改未授权
11510023	目录创建未授权
11510024	文件修改未授权
12500001	活动不存在
12500002	签名错误
12500003	邀请已过期
12500004	活动不在进行中
12500006	客户端不在活动中
12500008	活动已经开始
12500009	起止时间不能为空
12500010	超出活动上限
12500011	用户权限不足
12500012	不是编辑模式
12500013	活动已存在
12500014	活动已满
12500015	剧本不存在
12500016	该组无法访问
12500017	该帐号已在活动中
12500018	播放中,活动中剧本不能更改
12500019	只有未开始的活动才可以更换所有者
12500020	只有未开始的活动才可以取消
12500021	该用户已经是活动的管理员
12500022	该用户不是活动的管理员
12500023	活动标签不存在
12500024	活动编码已存在
12500025	客户端尚未准备完成，请确认后重试
12500026	活动未绑定数据场景，无法加入
12500027	无法扮演，该物体已被其他用户扮演
12500028	当前活动已结束
12500029	当前版本不允许创建此类型活动
15500001	此规格商品不存在
15500002	商品不存在,请联系管理员
15500003	兑换码生成错误
15500004	兑换码不存在
15500005	兑换码已兑换或者已失效
15500006	订单已支付
15500007	支付单不存在
15500008	支付单已取消或者已支付
15500009	订单信息不存在
15500010	名称已存在
15500011	兑换码输入有误，请重新输入
15500012	兑换码已过期
15500013	兑换码已作废
15500014	兑换码已兑换
15500015	兑换码对应配置不存在
15500016	订单已取消
15500017	超出兑换码有效期上限
15500018	超出兑换码生成数量上限
15500019	兑换码无效
17500001	任务不存在
17500002	任务步骤已提交，无法删除附件
17500003	任务模板步骤不存在
17500004	待执行的任务调度计划才可以编辑
17500005	模板已关联计划或任务，无法删除
17500006	任务与设备二维码不匹配，请重新扫码
16500001	建筑场景数据分块出错
16500002	当前文件状态,禁止该操作
16500003	建筑场景创建失败
16500004	定位点不存在
30000001	请下载最新版本以访问功能
30000002	如需体验完整功能，请下载最新版本

我们能帮你什么吗？

DataMesh FactVerse Cloud API v1.0 使用说明

使用 API

获取 token

添加 header

加密

js 加密示例

API 接口

用户接口

登录

登出

refresh token

通过用户名查找所有租户信息

查询当前用户信息

扫码登录相关接口

网页端确认前扫码端取消登录

扫码端向服务端传递参数

网页端同意后客户端登录或取消

客户端轮询获取 token

令牌验证接口

获取 License 信息

标签管理接口

分页查询 label 列表

版本更新管理接口

获取当前 app 版本

任务和资源接口

任务调用 API

主文件更新 ext 信息

文件管理系统 API

目录下的列表文件（包含目录）

批量文件详情接口

小文件主文件下载地址生成

批量小文件主文件下载地址生成

主文件创建接口

主文件块文件上传回调

主文件上传完成回调

附件文件创建

附件块文件上传回调

附件上传回调

主文件覆盖接口

路径主文件创建接口

路径日志文件创建接口

活动相关接口

活动接口

活动列表

按条件查询活动列表

活动详情

活动-创建

活动校验是否存在

活动更新

判断是否有权限加入活动

取消活动

活动关闭

活动剧本管理接口

剧本列表

活动添加剧本

活动剧本删除

活动更换剧本(先删除后加)

附录一