DataMesh FactVerse Cloud API v1.0 Referene Guide

Created On08/15/2024

Last Updated On08/16/2024

byzaiyue wu

Using API

Get token

See section Login for login details. After a successful login, the token field in the returned result will be used in subsequent requests.

Add header

Add Authorization: Bearer {token} to the HTTP request header.

Encryption

Interfaces involving passwords must encrypt the transmitted strings. For technical support, please contact support@datamesh.com.

js encryption example

Reference JSEncrypt:

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

API endpoints

User API

Login

Endpoint

POST /api/v6/auth/login

Description

User login API

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
password	User password	query	true	string
username	User name	query	true	string
captcha	Captcha code	query	false	string
captchaId	Captcha code ID	query	false	string
tenantId	Tenant ID	query	false	string

Response status

Code	Description	schema
200	OK	Result«UserLoginResponseVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data
refreshToken	Refresh user token	string
token	User token	string
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Logout

Endpoint

POST /api/v1/auth/logout

Description

User logout API

Request Data Type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
None

Response status

Code	Description	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Refresh token

Endpoint

POST /api/v6/auth/refresh

Description

Refresh user token

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameter

Parameter	Description	Request Type	Required	Data Type	schema
token	token	query	false	string

Response status

Code	Description	schema
200	OK	Result«Tokens»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	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)

Response example

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

Find all tenant information by username

Endpoint

GET /api/v6/auth/user/tenants

Description

Query all tenant information that includes members with the current username.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
username	Username	query	false	string

Response status

Code	Description	schema
200	OK	Result«Map«String,Object»»
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	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)

Response example

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

Query current user information

Endpoint

GET /api/v6/auth/user/userinfo

Description

Query current user information.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
userId	User ID	query	true	string

Response status

Code	Description	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		UserInfoVO	UserInfoVO
accountNonLocked		boolean	TenantVO
company	User’s company information	TenantVO
contactEmail	Tenant contact email	string
contactMobile	Contact mobile phone	string
contactName	Contact name	string
createBy		string
createTime		integer
customConfig	Custom configuration	string
delFlag		boolean
domainName	Custom domain name (globally unique)	string
id	ID	string
isThirdParty	Whether it is a third-party login	boolean
loginSign	Login sign	string	TenantLoginTypeVO
loginTypeList	Login configuration list	array
id		string
loginType	Available values: ACTIVE_DIRECTORY, AZURE_CN, AZURE_DE, AZURE_GLOBAL, BIM_AIRPORT, USERNAME_PASSWORD	string
logoUri	Logo image address	string
mqConnInfoList	mq information list	array	JSONObject of user basic information (includes only username and nickname).
address	Link address	string
port	Port	integer
protocol	Protocol	string
type	Current address type: 1. Default address, 2. User-specified address	integer
name	Tenant (enterprise/ platform/ individual) name	string
owner	Tenant owner information	JSONString
headPic		string
realName		string	TenantSpatialAnchorsConfigVO
userId		string
username		string
parentId	Enterprise tenant’s associated platform tenant ID	string
platformApproval	Whether the platform has reviewed	boolean
platformMode	Platform mode (single enterprise/multiple enterprises)	string
source	User source	string
status	Tenant status 0 1 2	string
tenantSpatialAnchorsConfig	Spatial positioning configuration record	TenantSpatialAnchorsConfigVO
accountDomain		string
accountId		string
accountKey		string
type	Tenant type	string
updateBy		string
updateTime		integer
createBy		string
createTime		integer(int64)	RoleVO
depts	Department	array
createBy	Creator id	string	PermissionsVO
createTime	Creation time	integer
creator	Creator	UserInfoVO
id		string
name	Department name	string
parentId	Parent id	string
tenantId	Tenant id	string
updateTime	Update time	integer
email	Email	string
firstLogin	Whether it is the first-time login sign	boolean
headPic	User avatar	string
id	userID	string
mobile	Mobile phone	string
nickName	User nickname	string
realName	User name	string
roles	User role	array
createBy	Creator id	string
createTime	Creation time	integer	integer(int32)
creator	Creator	UserInfoVO	integer(int64)
depts	Department	array
createBy	Creator id	string
createTime	Creation time	integer
creator	Creator	UserInfoVO
id	id	string
name	Department name	string
parentId	Parent id	string
tenantId	Tenant id	string
updateTime	Update time	integer
description	Description	string
id	Primary key	string
name		string
orderNum	Sorting	integer
roleCode	Role code, Enterprise Administrator: ENTERPRISE_ADMIN Platform Administrator: PLATFORM_ADMIN Department Administrator: DEPT_ADMIN Regular Position: NORMAL, Available values: ENTERPRISE, HIDDEN, NORMAL, PLATFORM, PLATFORM_CUSTOMIZE	string
status	0: Enable，1: Disable	integer
tenantId	Tenant id	string
updateTime	Update time	integer
showRetentionTime	Show retention time	boolean
source	User source	string
tenantId	Tenant ID	string
thirdparty		boolean
updateBy		string
updateTime		integer(int64)
userStatus	User status, available values: DISABLE, NORMAL	string
username	Username	string
msg		string
msg_i18n		object
status		integer(int32)
timestamp		integer(int64)

Response example

				
					{
	"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
｝

QR Code login-related endpoints

Login cancellation on the scan end before web end confirmation

Endpoint

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

Description

Cancel login on the scan end during the QR code login process.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
codeKey	Code unique identifier	query	false	string
deviceId	Device ID	query	false	string

Response status

Code	Description	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Parameters transmission from scan end to server

Endpoint

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

Description

During the QR code login process, the scan end sends relevant parameters to the server.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
codeKey	QR code unique identifier	query	false	string
deviceId	Device Id (Device unique identifier)	query	false	string
deviceName	Device name (Device unique identifier)	query	false	string
deviceType	Device type (Device unique identifier)	query	false	string
scanCodeType	Scan type, available values: LoginCode, ShareCode, ResourceCode	query	false	string

Response status

Code	Description	schema
200	OK	Result«Map«string,object»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

				
					{
    "code": 0, 
    "data": {
        "pairCode": 0000  // 4-digit pairing code
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

Client-side login or cancellation after web end approval

Endpoint

POST /api/v6/auth/scan/loginOrCancel

Description

In the QR code login process, after the scan end sends the parameters and the user clicks “Agree” on the web, the scan end will either log in or cancel the login.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
codeKey	QR code unique identifier	query	false	string
deviceId	Device ID	query	false	string
isLogin	Login/Cancel login	query	false	boolean

Response status

Code	Description	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Client-side polling to obtain the token

Endpoint

GET /api/v6/auth/scan/token

Description

In the QR code login process, the scan end polls for the token.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
codeKey	QR code unique identifier	query	false	string
deviceId	Device ID	query	false	string

Response status

Code	Description	schema
200	OK	Result«ScanCodeTokenVO»
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		ScanCodeTokenVO	ScanCodeTokenVO
state	Scan status	integer(int32)
token	Login token	string
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Token verification endpoint

Get license information

Endpoint

GET /api/v6/auth/license

Description

Retrieve the current user’s license information (validity period, custom feature scope, event-related restrictions).

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema

Response status

Code	Description	schema
200	OK	Result«LicenseUnityResponseVO»
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		LicenseUnityResponseVO	LicenseUnityResponseVO
customFunction	Custom function	object
expiryDate	License expiration time	integer(int64)
grantStatus	Authorization status	boolean
licenseType	License type	string
maxEventUsers	Maximum number of event participants	integer(int64)
startDate	License start date	integer(int64)
status	License status	boolean
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Label management endpoint

Paginated query of the label list

Endpoint

POST /api/v6/auth/label/labelList

Description

Query the list of labels for the current organization, with support for pagination.

Request data type

application/json

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
queryLabelListPageUseCase	Label query example	body	true	JSONString	QueryLabelListPageUseCase
name	Label name		false	string
page	Whether to enable pagination		false	boolean
pageNo	Current page number		false	integer(int32)
pageSize	Number of items per page		false	integer(int32)
systemLabel	Whether to contain a system tag		false	boolean

Response status

Code	Description	schema
200	OK	Result«IPage«LabelVO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		Pagination results «LabelVO»	Pagination results «LabelVO»
list	Data	array	LabelVO
createUserName	Creator	string
i18nLabel	Multilingual labels	string
id	Label ID	string
name	Label name	string
refSum	Reference number	integer
pageNo	Page number, starting from 1	integer(int64)
pageSize	Number of items per page	integer(int64)
total	Total items	integer(int64)
totalPage	Total pages	integer(int64)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

				
					{
	"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
}

Version update management endpoint

Get current app version

Endpoint

GET /api/v6/appversion/get

Description

Based on the current App identifier, obtain the latest version number of the App.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema

Response status

Code	Description	schema
200	OK	Result«VersionVO»
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		VersionVO	VersionVO
clientType	Client type	integer(int32)
configTime	Configuration time	integer(int64)
createTime	Creation time	integer(int64)
descriptionEn	English description	string
descriptionJa	Japanese description	string
descriptionTw	Traditional Chinese description	string
downloadLink	Download address	string
forcedUpdate	Whether to make a mandatory update	integer(int32)
id	Version ID	string
translationMsg	Multilanguage message	object
updateBy	Person who updated	string
updateDescription	Description information	string
version	Version	string
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

				
					{
    "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
}

Task and resource endpoints

Task invocation API

Update the ext information of the main file

Endpoint

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

Description

Update the ext information of the main file.

Request data type

application/json

Response data type

*/*

Request example

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

Request parameter

Parameter	Description	Request Type	Required	Data Type	schema
fileExtUpload	File ext information entity	body	true	JSONString	FileExtUpload
ext	The ext information of the main file		true	string
field	Keywords		false	string
metaId	Resource id		true	string
version	Version information		true	integer(int32)
tenantId	Tenant id		false	string

Response status

Code	Description	schema
200	OK	Result
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

File management system API

List files in the directory (Including directories)

Endpoint

POST /api/v6/resource/list

Description

Get directory list

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
listINodeDTIO	Resource query DTO, sorting fields: name, create_time, category, update_time	body	true	JSONString	Resource query DTO, sorting fields: name, create_time, category, update_time
catalogId	Directory ID; if catalogId has a value, then the rootCatalogId and path parameters must be empty; otherwise, rootCatalogId and path must have values		true	string
categories	Category value list		false	array	string
isLately	Query recently edited resources. If this field is used, then catalogId or rootCatalogId & path must be empty.		false	boolean
labelIds	Label ID list		false	array	string
lately			false	boolean
metaId	File id		false	string
name	Resource name		false	string
pageNo	Page number, starting from 1		true	integer(int32)
pageSize	Number of items per page, with a maximum value of 100		true	integer(int32)
path	Folder path, format: starts with ‘/’, does not end with ‘/’, and is used in conjunction with rootCatalogId		false	string
rootCatalogId	Root directory ID; must be provided together with path when used		false	string
searchType	Search Type for Web: 1. Global 2. Directory Parameters are required Parameters are required.		true	integer(int32)
sorts	Sorting rules		false	array	Sorting element
asc	Whether to sort in ascending order		false	boolean
field	Sorting field		false	string

Response status

Code	Description	schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		Pagination results «INodePermissionResponseVO»	Pagination results «INodePermissionResponseVO»
list	Data	array	INodePermissionResponseVO
additional	Cover file ID list.	array	Mime
blockInfoList		array	BlockInfo
hash		string
id	Block download 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	Block download ID	string
md5Hash		string
size		integer
category	inode type	integer
categoryIdList		array	string
ctime		integer
downloadPolicy		integer
ext		object
fileDataId	File download id, must be empty when type is 2	string
fileHasChanged		boolean
filename	File/folder name	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	Available values: EXPIRED, NOT_SHARE, SHARED	string
size	File size (bytes)	integer
suffix		string
tags		array	LabelVO
createUserName	Creator	string
i18nLabel	Multilanguage label	string
id	Lable ID	string
name	Label name	string
refSum	Reference number	integer
thumbnailUrl		string
username		string
version		integer
pageNo	Page number, starting from 1	integer(int64)
pageSize	Number of items per page	integer(int64)
total	Total items	integer(int64)
totalPage	Total pages	integer(int64)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

				
					{
	"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
}

Batch file details endpoint

Endpoint

POST /api/v6/resource/details

Description

Batch retrieves file details based on resource ID, resource version, and resource path.

Request data type

application/json

Response data type

*/*

Request example

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

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
metaDetailQueryDTO	Resource detail retrieval	body	true	JSONString	Resource detail retrieval
eventId	Event id		false	string
metaList			false	array	MetaSimpleInfo
metaId	Resource id		true	string
path	Resource path		false	string
version	Resource version		true	integer

Response status

Code	Description	schema
200	OK	Result«MetaResponseVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		MetaResponseVO	MetaResponseVO
failedMetaList		array	MetaFailedResponseVO
code		integer
message		string
resource		string
successMetaList		array	INodeResponseVO
additional	Cover file id list	array	Mime
blockInfoList		array	BlockInfo
hash		string
id	Block download 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	Block download ID	string
md5Hash		string
size		integer
category	inode type	integer
categoryIdList		array	string
ctime		integer
downloadPolicy		integer
ext		object
fileDataId	File download id, must be empty when type is 2	string
filename	File/folder name	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	Available values: EXPIRED, NOT_SHARE, SHARED	string
size	File size (bytes)	integer
suffix		string
tags		array	LabelVO
createUserName	Creator	string
i18nLabel	Multilanguage label	string
id	Label ID	string
name	Label name	string
refSum	Reference number	integer
version		integer
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

				
					{
	"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 download URL for the small file of the main file

Endpoint

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

Description

Obtain the main file download URL for files with a size of up to 128MB.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
fileDataId	fileDataId	query	false	string
metaId	metaId	query	false	string

Response status

Code	Description	schema
200	OK	Result«DownloadLinkResponseVO»
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		DownloadLinkResponseVO	DownloadLinkResponseVO
url	Download address	string
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Get download URL for small files of the main file in batches

Endpoint

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

Description

Get main file download URLs for files with a size of up to 128MB in batches.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
fileDataIds	fileDataIds	query	false	array	string

Response status

Code	Description	schema
200	OK	Result«List«DownloadLinkResponseVO»»
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		array	DownloadLinkResponseVO
url	Download url	string
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Main file creation endpoint

Endpoint

POST /api/v6/resource/file/create

Description

Create the main file during the file upload process.

Request data type

application/json

Response data type

*/*

Request example

				
					{
  "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": ""
}

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
blockCreateDTO	Main file creation entity	body	true	JSONString	BlockCreateDTO
blockInfoList			false	array	RequestBlockInfo
hash			false	string
md5Hash			false	string
num			false	integer
size			false	integer
catalogId	Directory id		false	string
categories			false	string
ext			false	object
extGenerateStrategy	The current policy is to only generate ab files and not images. Available values: MODEL_ALL, MODEL_NULL, MODEL_WITHOUT_IMG, NO_TASK		false	string
groupPermission	Current group user permissions (default read: 7 4 0) 0: No permissions 4: Read permissions (default) 2:Write permissions 1: Advanced write permissions		false	integer(int32)
groupPermissionCanEdit	Whether the current group user permissions are editable 0 No 1 Yes		false	integer(int32)
hash	File hash value (MD5)		true	string
inodeCategory	Manually specify type, available values: 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	Manually specify whether the mate includes the main file (0: includes, 1: does not include)		false	integer(int32)
name	File name		true	string
nameStrategy	File overwrite renaming policy, default is RENAME, available values: COVER,RENAME, THROW_EXCEPTION		false	string
otherPermission	Other group user permissions (default: none 0 0 0) 0: No permissions 4: Read permissions (default) 2:Write permissions 1: Advanced write permissions		false	integer(int32)
ownerPermission	Owner permissions (default: all 7 0 0) 0: No permissions 4: Read permissions (default) 2:Write permissions 1: Advanced write permissions		false	integer(int32)
pId	Parent ID; for creating a group, pId is 0		true	string
pid			false	string
purpose			false	string
size	Total file size, in bytes.		true	integer(int64)
tags	Tag		false	string

Response status

Code	Description	schema
200	OK	Result«FileCreateResponseVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	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)

Response example

				
					{
    "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
}

Callback after main file block file upload

Endpoint

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

Description

Callback after the main file block file upload is completed during the file upload process.

Request data type

application/x-www-form-urlencoded

Response data ype

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
blockId	blockId	query	true	string
code	A value of 0 indicates that the upload was successful; otherwise, it indicates failure.	query	true	integer(int32)
message	Message, optional field	query	false	string
tenantId	Tenant id	query	false	string

Response status

Code	Description	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Callback after main file upload

Endpoint

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

Description

Callback after the main file upload is completed during the file upload process.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
code	A value of 0 indicates that the upload was successful; otherwise, it indicates failure.	query	true	integer(int32)
metaId	metaId	query	true	string
version	version	query	true	integer(int32)
message	Message, optional field	query	false	string

Response status

Code	Description	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		INodeResponseVO	INodeResponseVO
additional	Cover file ID list	array	Mime
blockInfoList		array	BlockInfo
hash	Hash	string
id	Block download id	string
md5Hash	MD5	string
size	File size	integer
category	inode type	integer
downloadPolicy	Download strategy	integer
ext	Attachment information	object
fileType	File type	string
hash	Hash	string
id	ID	string
isBlock	Whether it is a block	boolean
isDownloadable	Download or not	boolean
md5Hash	MD5	string
name	File name	string
purpose	Purpose	string
size	Size	integer
block	Whether it is a block	boolean
blockInfoList		array	BlockInfo
hash	Hash	string
id	Block download id	string
md5Hash	MD5	string
size	Size	integer
category	inode type	integer(int32)
categoryIdList	inode type list	array	string
ctime	Creation time	integer(int64)
downloadPolicy	Download strategy	integer(int32)
ext	Attachment information	object
fileDataId	file download id, must be empty when type is 2	string
filename	File/folder name	string
groupId	Workgroup ID	string
groupPermission	Workgroup permission	integer(int32)
groupPermissionCanEdit	Whether the current group user permissions are editable 0 No 1 Yes	integer(int32)
hash	Hash	string
isDownloadable	Whether to download	boolean
lockInfo		EditorLockResponseVO	EditorLockResponseVO
ctime	Creation time	integer
lockType	Lock type	string
mtime	Update time	integer
userId	User ID	string
username	Username	string
md5Hash	MD5	string
metaId	inode meta id	string
metaType	Whether contains main file	integer(int32)
mtime	Update time	integer(int64)
otherPermission	Other permissions	integer(int32)
ownerId	Owner ID	string
ownerPermission	Owner permissions	integer(int32)
path	Path	string
pid	Parent directory ID	string
preset	Whether it is preset	boolean
shareType	Available values: NOT_SHARE, SHARED, EXPIRED	string
size	File size (bytes)	integer(int64)
suffix	suffix	string
tags		array	LabelVO
createUserName	Creator	string
i18nLabel	Multilanguage labels	string
id	Label ID	string
name	Label name	string
refSum	Reference number	integer
version	Version	integer(int32)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

				
					{
    "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
}

Attachment file creation

Ednpoint

POST /api/v6/resource/ext/create

Description

Create and call attachment file during the file upload process.

Request data type

application/json

Response data type

*/*

Request example

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

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
requestVO	requestVO	body	true	ExtBigCreateRequestVO	ExtBigCreateRequestVO
blockInfoList			false	array	RequestBlockInfo
hash	hash		false	string
md5Hash	MD5		false	string
num	Quantity		false	integer
size	Size		false	integer
ext	Attachment information		false	object
hash	File hash value (SHA256)		true	string
md5Hash	MD5		false	string
metaId	Resource id		true	string
name	Name		false	string
purpose	Purpose of the attachment file		false	string
size	File size		true	integer(int64)
tenantId	Tenant ID		false	string
version	Resource version		true	integer(int32)

Response status

Code	Description	schema
200	OK	Result«FileCreateResponseVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		FileCreateResponseVO	FileCreateResponseVO
blockList		array	BlockCreateResponseVO
blockId	Block ID	string
formFields		array	Pair
key	Keywords	string
value	Value	object
httpHeaders		array	Pair
key	Keywords	string
value	Value	object
httpMethod	http method	string
httpProtocol	http protocol	string
num	Number	integer
type	Type	string
uploadFormField	Request type	string
url	url	string
fileId	File ID	string
metaId	Resource ID	string
version	Version	integer(int32)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

				
					{ 
    "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
}

Callback after attachment block file upload

Endpoint

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

Description

Called after each attachment block is uploaded during the file upload process.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
blockId	blockId	query	true	string
code	A value of 0 indicates that the upload was successful; otherwise, it indicates failure.	query	true	integer(int32)
message	Message, optional field	query	false	string
tenantId	Tenant id	query	false	string

Response status

Code	Description	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameter

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Callback after attachment file upload

Endpoint

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

Description

Called after the attachment file had been successfully uploaded during the file upload process.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameter

Parameter	Description	Request Type	Required	Data Type	schema
code	A value of 0 indicates that the upload was successful; otherwise, it indicates failure.	query	true	integer(int32)
fileId	fileId	query	true	string
message	Message, optional field	query	false	string

Response code

Code	Description	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameter

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Main files overwrite endpoint

Endpoint

POST /api/v6/resource/file/cover

Endpoint

Overwrite the main file.

Request data type

application/json

Response data type

*/*

Request example

				
					{
    "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": ""
}

Response parameter

Parameter	Description	Request Type	Required	Data Type	schema
requestVO	requestVO	body	true	BlockCoverRequestDTO	BlockCoverRequestDTO
blockInfoList			false	array	RequestBlockInfo
hash	Hash		false	string
md5Hash	MD5		false	string
num	Quantity		false	integer
size	Size		false	integer
ext	Attachment information		false	object
extGenerateStrategy	The current policy is to only generate ab files and not images. Available values: MODEL_WITHOUT_IMG, MODEL_ALL, MODEL_NULL, NO_TASK		false	string
groupPermission	Current group user permissions (default read: 7 4 0) 0: No permissions 4: Read permissions (default) 2:Write permissions 1: Advanced write permissions		false	integer(int32)
groupPermissionCanEdit	Whether the current group user permissions are editable 0 No 1 Yes		false	integer(int32)
hash	File hash value (MD5)		true	string
id	Resource Id		true	string
inodeCategory	Manually specify the type. Available values: 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	Machine key		false	string
md5Hash	MD5		false	string
metaType	Manually specify whether the mate includes the main file (0: includes, 1: does not include)		false	integer(int32)
otherPermission	Other group user permissions (default: none 0 0 0) 0: No permissions 4: Read permissions (default) 2:Write permissions 1: Advanced write permissions		false	integer(int32)
ownerPermission	Owner permissions (default: all 7 0 0) 0: No permissions 4: Read permissions (default) 2:Write permissions 1: Advanced write permissions		false	integer(int32)
size	Total file size, in bytes		true	integer(int64)
tags	File tags, separated by commas		false	string

Response status

Code	Description	schema
200	OK	Result«FileCreateResponseVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		FileCreateResponseVO	FileCreateResponseVO
blockList		array	BlockCreateResponseVO
blockId	Block ID	string
formFields		array	Pair
key	Keywords	string
value	Value	object
httpHeaders		array	Pair
key	Keywords	string
value	Value	object
httpMethod	http method	string
httpProtocol	http protocol	string
num	Quantity	integer
type	Type	string
uploadFormField	Request type	string
url	url	string
fileId	File ID	string
metaId	Resource ID	string
version	Version	integer(int32)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

				
					{
    "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
}

Path main file creation endpoint

Endpoint

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

Description

Create a main file based on the path.

Request data type

application/json

Response data type

*/*

Request example

				
					{
    "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": ""
}

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
requestVO	requestVO	body	true	FilePathCreateRequestVO	FilePathCreateRequestVO
blockInfoList			false	array	RequestBlockInfo
hash	Hash		false	string
md5Hash	MD5		false	string
num	Quantity		false	integer
size	Size		false	integer
catalogId	Directory id		false	string
ext	Attachment information		false	object
extGenerateStrategy	The current policy is to only generate ab files and not images. Available values: MODEL_WITHOUT_IMG, MODEL_ALL, MODEL_NULL, NO_TASK		false	string
groupPermission	Current group user permissions (default read: 7 4 0) 0: No permissions 4: Read permissions (default) 2:Write permissions 1: Advanced write permissions		false	integer(int32)
groupPermissionCanEdit	Whether the current group user permissions are editable 0 No 1 Yes		false	integer(int32)
hash	File hash value (SHA256)		true	string
inodeCategory	Manually specify the type. Available values: 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	Machine key		false	string
md5Hash	MD5		false	string
metaType	Manually specify whether the mate includes the main file (0: includes, 1: does not include)		false	integer(int32)
name	Name		true	string
nameStrategy	File overwrite rename strategy, default is RENAME. Available values: RENAME, COVER, THROW_EXCEPTION		false	string
otherPermission	Other group user permissions (default: none 0 0 0) 0: No permissions 4: Read permissions (default) 2:Write permissions 1: Advanced write permissions		false	integer(int32)
ownerPermission	Owner permissions (default: all 7 0 0) 0: No permissions 4: Read permissions (default) 2:Write permissions 1: Advanced write permissions		false	integer(int32)
path	File upload path		true	string
size	Total file size, in bytes		true	integer(int64)
tags	Tags		false	string

Response status

Code	Description	schema
200	OK	Result«FileCreateResponseVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		FileCreateResponseVO	FileCreateResponseVO
blockList		array	BlockCreateResponseVO
blockId	Block ID	string
formFields		array	Pair
key	Keywords	string
value	Value	object
httpHeaders		array	Pair
key	Keywords	string
value	Value	object
httpMethod	http method	string
httpProtocol	http protocol	string
num	Quantity	integer
type	Type	string
uploadFormField	Request type	string
url	url	string
fileId	File ID	string
metaId	Resource ID	string
version	Version	integer(int32)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

				
					{ 
    "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
}

Path log file creation endpoint

Endpoint

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

Description

Create a log file based on the path.

Request data type

application/json

Response data type

*/*

Request example

				
					{
    "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": ""
}

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
requestVO	requestVO	body	true	FilePathCreateRequestVO	FilePathCreateRequestVO
blockInfoList			false	array	RequestBlockInfo
hash	Hash		false	string
md5Hash	MD5		false	string
num	Quantity		false	integer
size	Size		false	integer
catalogId	Directory id		false	string
ext	Attachment information		false	object
extGenerateStrategy	The current policy is to only generate ab files and not images. Available values: MODEL_WITHOUT_IMG, MODEL_ALL, MODEL_NULL, NO_TASK		false	string
groupId	Current workgroup, used for creation when the path does not exist		true	string
groupPermission	Current group user permissions (default read: 7 4 0) 0: No permissions 4: Read permissions (default) 2:Write permissions 1: Advanced write permissions		false	integer(int32)
groupPermissionCanEdit	Whether the current group user permissions are editable 0 No 1 Yes		false	integer(int32)
hash	File hash value (SHA256)		true	string
inodeCategory	Manually specify the type. Available values: 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	Machine Key		false	string
md5Hash	MD5		false	string
metaType	Manually specify whether the mate includes the main file (0: includes, 1: does not include)		false	integer(int32)
name	File name		true	string
nameStrategy	File overwrite rename strategy, default is RENAME. Available values: RENAME, COVER, THROW_EXCEPTION		false	string
otherPermission	Other group user permissions (default: none 0 0 0) 0: No permissions 4: Read permissions (default) 2:Write permissions 1: Advanced write permissions		false	integer(int32)
ownerPermission	Owner permissions (default: all 7 0 0) 0: No permissions 4: Read permissions (default) 2:Write permissions 1: Advanced write permissions		false	integer(int32)
path	File upload path		true	string
size	Total file size, in bytes		true	integer(int64)
tags	Tags		false	string

Response status

Code	Description	schema
200	OK	Result«FileCreateResponseVO»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
args		object
code		integer(int32)	integer(int32)
data		FileCreateResponseVO	FileCreateResponseVO
blockList		array	BlockCreateResponseVO
blockId		string
formFields		array	Pair
key	Keywords	string
value	Value	object
httpHeaders		array	Pair
key	Keywords	string
value	Value	object
httpMethod	http method	string
httpProtocol	http protocol	string
num	Quantity	integer
type	Type	string
uploadFormField	Request type	string
url	url	string
fileId	File ID	string
metaId	Resource ID	string
version	Version	integer(int32)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

				
					{
    "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
}

				
					{
	"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
}

Event-related endpoints

Event endpoint

Event list

Endpoint

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

Description

Unity event list

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema

Response status

Code	Description	schema
200	OK	Result«object»
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		Unity event list response data	Unity event list response data
list	event list	array	EventListVO
activityType	Event type	integer
allowJoin	Whether to allow participation 0 Allow 1 Not allow	integer
capability	Event capacity	integer
clientNumber	Number of clients	integer
cover	Event cover	string
createTime		integer
defaultClientRole	Default client role 0 Host 1 Observer 2 Third-party view	integer
description	Event description	string
editMode	Whether it is edit mode	integer
endTime	Event end time	integer
id	ID	string
name	Event name	string
offLine	Whether it is an offline event	boolean
owner	Owner information	JSONString	JSONObject of user basic information
headPic		string
realName		string
userId		string
username		string
ownerId	Event owner ID	string
playingScript	Whether it is playing scenario 0 not playing 1 Playing	integer
protocol	Persistent connection protocol	string
scenesId	Scene Id	string
scriptNumber	Scenario number	integer
socketUrl	Persistent connection address	string
startTime	Event start time	integer
status	Event status 0 Not starting 1 Ongoing 2 Expired	integer
tags	Event tags	array	EventTag object
createTime		integer
id		string
name	Label name	string
tenantId	Tenant ID	string
updateTime		integer
type	Event duration type 0 Time-limited 1 No time-limited	integer
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

Query event list by conditions

Endpoint

GET /api/v6/director/event/list

Description

Query the event list based on conditions.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
activityType	Event type (0 Scenario event 1 Scene event), available values: SCRIPT_ACTIVITY, SCENES_ACTIVITY	query	false	string
eventIds	Event Id list	query	false	array	string
labelIds	Label ID list	query	false	array	string
name	Event name	query	false	string
ownerNickname	Owner nickname	query	false	string
pageNo	Current page number	query	false	integer(int32)
pageSize	Number of items per page	query	false	integer(int32)
status	Event status, available values:0 Not started,1 Ongoing,2 Ended,3 Cancelled,4 Idle,5 Occupied,6 Preparing	query	false	string
sorts[0].asc	Whether to sort in ascending order	query	false	boolean
sorts[0].field	Sort field	query	false	string

Response status

Code	Description	schema
200	OK	Result«IPage«EventListVO»»
401	Unauthorized
403	Forbidden
404	Not Found

Response parameter

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		Pagination results «EventListVO»	Pagination results «EventListVO»
list	Data	array	EventListVO
activityType	Event type	integer
allowJoin	Whether to allow participation 0 Allow 1 Not allow	integer
capability	Event capacity	integer
clientNumber	Number of clients	integer
cover	Event cover	string
createTime		integer
defaultClientRole	Default client role 0 Host 1 Observer 2 Third-party view	integer
description	Event description	string
editMode	Whether it is edit mode	integer
endTime	Event end time	integer
id	ID	string
name	Event name	string
offLine	Whether it is an offline event	boolean
owner	Owner information	JSONString	JSONObject of user basic information
headPic		string
realName		string
userId		string
username		string
ownerId	Event owner ID	string
playingScript	Whether it is playing scenario 0 not playing 1 Playing	integer
protocol	Persistent connection protocol	string
scenesId	Scene Id	string
scriptNumber	Scenario number	integer
socketUrl	Persistent connection address	string
startTime	Event start time	integer
status	Event status 0 Not starting 1 Ongoing 2 Expired	integer
tags	Event tags	array	EventTag object
createTime		integer
id		string
name	Label name	string
tenantId	Tenant ID	string
updateTime		integer
type	Event duration type 0 Time-limited 1 No time-limited	integer
pageNo	Page number, start from 1	integer(int64)
pageSize	Number of items per page	integer(int64)
total	Total items	integer(int64)
totalPage	Total pages	integer(int64)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

				
					{
	"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
}

Event details

Endpoint

GET /api/v6/director/event/detail

Description

Get event details.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
eventId	Event ID	query	true	string

Response status

Code	Description	schema
200	OK	Result«EventDetailsVO»
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	code
data		EventDetailsVO	data
activityType	Event type	integer(int32)	activityType
adminIds		string	adminIds
allowJoin	Whether to allow participation 0 Allow 1 Not allow	integer(int32)	allowJoin
capability	Event capacity	integer(int32)	capability
category	Event type Fast event Reserved event, available values: FAST_EVENT, PUBLIC_EVENT, RESERVE_EVENT	string	category
clientNumber	Number of clients	integer(int32)	clientNumber
cover	Event cover	string	cover
createTime	Creation time	integer(int64)	createTime
defaultClientRole	Default client role 0 Host 1 Observer 2 Third-party view	integer(int32)	defaultClientRole
description	Event description	string	description
editMode	Whether it is edit mode	integer(int32)	editMode
endTime	Event end time	integer(int64)	endTime
groupId	Group ID	string	groupId
id	ID	string	id
labelList	Label list	array	labelList
createUserName	Creator	string	createUserName
i18nLabel	Multilanguage labels	string	i18nLabel
id	Label ID	string	id
name	Label name	string	name
refSum	Reference number	integer	refSum
name	Event name	string	name
num	ID	string	num
offLine	Whether it is an offline event	boolean	offLine
owner		JSONString	owner
headPic		string	headPic
realName		string	realName
userId		string	userId
username		string	username
ownerId	Event owner ID	string	ownerId
playingScript	Whether it is playing scenario 0 not playing 1 Playing	integer(int32)	playingScript
protocol	Persistent connection protocol	string	protocol
scriptNumber	Scenario number	integer(int32)	scriptNumber
socketUrl	Persistent connection address	string	socketUrl
startTime	Event start time	integer(int64)	startTime
status	Event status 0 Not started 1 Ongoing 2 Expired	integer(int32)	status
substate	Event sub status, available values: IDLE,PLAYING,WAITING	string	substate
tags	Event tags	array	tags
createTime		integer	createTime
id		string	id
name	Label name	string	name
tenantId	Tenant ID	string	tenantId
updateTime		integer	updateTime
type	Event type 0 Time-limited 1 No time-limited	integer(int32)	type
msg		string	msg
msg_i18n		object	msg_i18n
status		integer(int32)	status
timestamp		integer(int64)	timestamp

Response example

				
					{
	"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
}

Create events

Endpoint

POST /api/v6/director/event/create

Description

Event creation.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
eventCreateDTO	Event creation request entity	body	true	JSONString	Event creation request entity
activityType	Event type(0 Scenario event 1 Scene event), available value:0,1		false	string
category	Event type, available values: FAST_EVENT, PUBLIC_EVENT, RESERVE_EVENT		false	string
cover	Event cover		false	string
days	Selected days		false	integer(int32)
description	Event description		false	string
endTime	Event end time		false	integer(int64)
labelIds	Label ID list		false	array	string
name	Event name		true	string
startTime	Event start time		false	integer(int64)
tags	Event tags		false	string
type	Event duration type 0 Time-limited 1 No time-limited		true	integer(int32)

Response status

Code	Description	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameter

Parameter	Description	Type	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)

Response example

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

Event verification for existence

Endpoint

GET /api/v6/director/event/eventCheckNameExists

Description

Verifies whether an event with the same name already exists

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
name	Event name	query	false	string

Response status

Code	Description	schema
200	OK	Result«boolean»
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		boolean
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Event update

Endpoint

POST /api/v6/director/event/update

Description

Event update

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
eventUpdate	Event update request entity	body	true	JSONString	Event update request entity
allowJoin	Whether to allow participation		false	integer(int32)
capability	Maximum number of participants		false	integer(int32)
catalogId	Directory ID		false	string
cover	Cover file, server path		false	string
description	Event description		false	string
endTime	Event end time		false	integer(int64)
id	id		true	string
labelIds	Label ID list		false	array	string
name	Event name		true	string
num			false	string
startTime	Event start time		false	integer(int64)
tags	Event tags		false	array	string
type	Event duration type 0 Time-limited 1 No time-limited		true	integer(int32)

Response status

Code	Description	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		string
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Determine whether there is permission to join the event

Endpoint

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

Description

Determine whether there is permission to join the event.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
eventId	Event ID	body	false	string

Response status

Code	Description	schema
200	OK	Result«EventPermissionVO»
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		EventPermissionVO	EventPermissionVO
hasPermission	Whether there is permission to enter the event 0 – No, 1 – Has permission.	integer(int32)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Cancel event

Endpoint

POST /api/v6/director/event/cancel

Description

Cancel event

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
eventId	Event id	body	true	string

Response status

Code	Description	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Close event

Endpoint

POST /api/v6/director/event/close

Description

Close event

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
eventId	Event id	body	true	string

Response status

Code	Description	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	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)

Response example

				
					{ 
    "code": 0, 
    "data": {
        "success": true		//Event close status
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

Event scenario management endpoints

Scenario list

Endpoint

GET /api/v6/director/script/list

Description

Get the scenario for a specified event.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
eventId	Event ID	query	false	string

Response status

Code	Description	schema
200	OK	Result«object»
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		array	ScriptVO
eventId	Event ID	string
latestVersion	Latest version	integer(int32)
metaId	Scenario resource ID	string
path	Scenario path	string
scriptId	Scenario ID	string
tenantId	Tenant ID	string
uploadTime	Scenario upload time	integer(int64)
version	Version	integer(int32)
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

				
					{
    "code": 0, 
    "data": {
        "list": [
            {
                "scriptId": "", 		//Scenario ID
                "tenantId": "", 		//Tenant ID
                "eventId": "", 		//Event ID
                "metaId": "", 		//Resource ID
                "path": "", 		//Resource path
                "version": 0, 		//Resource version
                "latestVersion": 0, 	//Resource latest version
                "uploadTime": 0 		//Update time
            }
        ]
    }, 
    "msg": "", 
    "msg_i18n": { }, 
    "status": 0, 
    "timestamp": 0
}

Add event scenario

Endpoint

POST /api/v6/director/script/add

Description

Add event scenario.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
eventId	Event ID	query	false	string
scriptDtoList	Scenario list	query	false	string

Response status

Code	Description	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Delete event scenario

Endpoint

POST /api/v6/director/script/delete

Description

Delete custom event scenario.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
scriptId	Scenario ID	query	false	string

Response status

Code	Description	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Change event scenario (Delete first, then add)

Endpoint

POST /api/v6/director/script/change

Description

Change event scenario, which is equivalent to first deleting the scenario and then adding a new one.

Request data type

application/x-www-form-urlencoded

Response data type

*/*

Request parameters

Parameter	Description	Request Type	Required	Data Type	schema
eventId	Event ID	query	false	string
scriptDtoList	Scenario list	query	false	string

Response status

Code	Description	schema
200	OK	Result«object»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters

Parameter	Description	Type	schema
code		integer(int32)	integer(int32)
data		object
msg		string
msg_i18n		object
status		integer(int32)	integer(int32)
timestamp		integer(int64)	integer(int64)

Response example

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

Appendix I

0	Success
10400001	System error, please contact support@datamesh.com
10400002	Unauthorized
10400004	Forbidden
10400005	Not found
10400006	Request method not allowed
10400007	Internal Server Error
10400010	System error, please contact support@datamesh.com
10500012	Third-party authentication failed
10500013	User does not exist
10500014	This user is already in the organization; do not add again
10500015	User does not exist or password is incorrect
10500016	Too many errors, please try again later
10500017	Verification code error
10500018	User account has expired
10500019	Verification code has expired
10500020	Password change failed; old password is the same as the new password
10500021	Password change failed; old password is incorrect
10500026	User credential does not exist
10500027	User credential is invalid
10500028	Verification code is invalid
10500029	Already followed
10500030	License expired
10500031	License invalid
10500032	License does not exist
10500033	Exceeded License limit
10500034	QR code has expired
10500035	Username already exists
10500036	Tenant does not exist
10500037	Workgroup does not exist
10500038	User is already an administrator; cannot be added again
10500039	User is not an administrator
10500040	User is already in the workgroup
10500041	Request has already been sent; please wait for administrator review
10500042	There are associated users under the current role; please unbind user relationships first
10500043	Role ID already exists
10500044	User authentication information does not exist
10500045	Reviewed information does not exist
10500046	Link has expired
10500047	Username format is incorrect
10500048	Default anonymous tenant does not exist
10500049	Enterprise identifier already exists
10500050	Platform information does not exist
10500051	Domain name already exists
10500052	Platform has already been initialized
10500053	Personal tenant does not exist in default
10500054	Main account does not exist in default
10500055	Main account configuration error; please contact tenant administrator
10500056	Nickname already exists
10500057	Addition failed; permission item already exists
10500058	Permission item does not exist
10500059	Sub-administrator already exists
10500060	Subscription does not exist or has expired
10500061	Exceeded subscription limit
10500062	The account has not been assigned a license. Please contact your enterprise administrator
10500063	The user has been assigned a license
10500064	Subscription time is duplicated
10500065	The subscription does not exist or has expired
10500066	The enterprise super administrator does not exist
10500067	The enterprise super administrator already exists
10500068	The user is already an enterprise super administrator
10500069	Incorrect server selection
10500074	The user is already an administrator and cannot be added as a sub-administrator.
10500075	The user is a workgroup owner and does not need to be added as an administrator
10500076	A subscription already exists including a subscription needs to be issued due to expiration
10500077	User credentials have expired
10500080	Please do not submit repeatedly
10500081	The object has been referenced and cannot be deleted
10500082	Data is required
10500083	The required attributes of that object have not been filled out. Please fill them in and try again
10500085	Your account is logged in on another device.
10500090	You can only reset your email account that received the email. Please verify and re-enter.
10500099	Too many errors. Please try again after ${lockTime} minutes.
10500100	Incorrect password
11500001	Saving file error
11500007	Cannot move the folder into itself or its subdirectories.
11500009	File/folder name conflict
11500010	The folder must be empty to be deleted
11500011	The parent folder does not exist
11500012	File upload incomplete
11500014	File does not exist
11500015	File is incomplete
11500016	File exceeds size limit
11500017	File has been edited by the user
11500018	Category name is duplicated
11500019	Resource version conflict; uploading files with the same name is prohibited
11500020	Incorrect resource sharing password
11500021	Resource sharing limit has been reached
11500022	Resource sharing has expired
11510019	File access is unauthorized
11510020	File upload is unauthorized
11510021	Directory access is unauthorized
11510022	Directory modification is unauthorized
11510023	Directory creation is unauthorized
11510024	File modification is unauthorized
12500001	The event does not exist
12500002	Signature error
12500003	The invitation has expired
12500004	The event is not ongoing
12500006	The client end is not in the event
12500008	The event has already started
12500009	Start and end times cannot be empty
12500010	Exceeds the event limit
12500011	Insufficient user permissions
12500012	Not in edit mode
12500013	The event already exists
12500014	The event is full
12500015	The scenario does not exist
12500016	This group cannot access
12500017	This account is already in the event
12500018	The event scenario cannot be changed during the playback process.
12500019	Only the event that has not started can change owner
12500020	Only events that have not started can be canceled
12500021	The user is already an administrator of the event
12500022	The user is not an administrator of the event
12500023	Event tag does not exist
12500024	Event ID already exists
12500025	The client end is not yet ready. Please confirm and try again
12500026	The event is not bound to a scenario and cannot be joined.
12500027	Cannot assume role; the object has already been assumed by another user.
12500028	The current event has ended
12500029	The current version does not allow creating this type of event.
15500001	This specification of the product does not exist
15500002	Product does not exist; please contact the administrator
15500003	Redemption code generation error
15500004	Redemption code does not exist
15500005	Redemption code has been redeemed or has expired
15500006	Order has been paid
15500007	Payment order does not exist
15500008	Payment order has been canceled or paid
15500009	Order information does not exist
15500010	Name already exists
15500011	Redemption code is incorrect. Please re-enter
15500012	Redemption code has expired
15500013	Redemption code has been voided
15500014	Redemption code has been redeemed
15500015	Configuration for the redemption code does not exist
15500016	Order has been canceled
15500017	Exceeds the redemption code validity period.
15500018	Exceeds the redemption code generation quantity limit
15500019	Redemption code is invalid
17500001	Task does not exist
17500002	Task steps have been submitted; attachments cannot be deleted
17500003	Task template step does not exist
17500004	Only tasks that are scheduled to execute can be edited.
17500005	The template is associated with a plan or task and cannot be deleted
17500006	Task does not match the equipment QR code. Please scan again
16500001	Architectural scene data chunking error
16500002	Current file status prohibits this operation
16500003	Architectural scene creation failed
16500004	Position code does not exist
30000001	Please download the latest version to access this feature
30000002	To experience all features, please download the latest version

How Can We Help?

DataMesh FactVerse Cloud API v1.0 Referene Guide

Using API

Get token

Add header

Encryption

js encryption example

API endpoints

User API

Login

Logout

Refresh token

Find all tenant information by username

Query current user information

QR Code login-related endpoints

Login cancellation on the scan end before web end confirmation

Parameters transmission from scan end to server

Client-side login or cancellation after web end approval

Client-side polling to obtain the token

Token verification endpoint

Get license information

Label management endpoint

Paginated query of the label list

Version update management endpoint

Get current app version

Task and resource endpoints

Task invocation API

Update the ext information of the main file

File management system API

List files in the directory (Including directories)

Batch file details endpoint

Get download URL for the small file of the main file

Get download URL for small files of the main file in batches

Main file creation endpoint

Callback after main file block file upload

Callback after main file upload

Attachment file creation

Callback after attachment block file upload

Callback after attachment file upload

Main files overwrite endpoint

Path main file creation endpoint

Path log file creation endpoint

Event-related endpoints

Event endpoint

Event list

Query event list by conditions

Event details

Create events

Event verification for existence

Event update

Determine whether there is permission to join the event

Cancel event

Close event

Event scenario management endpoints

Scenario list

Add event scenario

Delete event scenario

Change event scenario (Delete first, then add)

Appendix I

Products

Solutions

About

©DataMesh Inc. All rights reserved

DataMesh® is a registered trademark of DataMesh Inc.