2024年3月5日发(作者：)
logicalDoc webservice API
logicalDoc 的部署位置 HOST_URL = "localhost:8080";
1. AUTH_ENDPOINT = HOST_URL +"/services/Auth";//用户登录URL
关键类：AuthClient
方法：login（登陆）
operation: login
input
username
password
output
string The newly
identifier(sid)
created session
string
string
username used to log in
password used to log in
方法：logout（退出）
operation: logout
input
sid string session identifier
2. DOC_ENDPOINT = HOST_URL +"/services/Document";//文档URL
关键类：WSDocument
方法：create（新建文档）
operation: create
input
sid
document
string
WsDocument
session identifier
value object containing the
document metadata
content
output
binary
WsDocument
file content
value object containing the
document metadata
方法：update（更新文档）
operation: update
input
sid
document
string
WsDocument
session identifier
value object containing the
document metadata
方法：删除（删除文档）
operation: delete
input
sid
docId
string
long
session identifier
document identifier
方法：下载（下载文档）
operation: getDocument
input
sid
docId
output
WsDocument value object containing the
document metadata
string
long
session identifier
document identifier
方法：获取内容
operation: getContent
input
sid
docId
output
binary requested document's binary
string
long
session identifier
document identifier
方法：获取文档名
operation: getFileName
output
string
requested document's FileName
方法：listDocuments（获取多个文件）
operation: listDocuments
input
sid
folderId
Null
output
WsDocument[ ] list of value objects containing
the documents metadata
string
long
Null
session identifier
folder identifier
Null
还有getID等方法，直接获取所有信息的方法。
3. FOLDER_ENDPOINT = HOST_URL +"/services/Folder";//文件夹新建URL
关键类：WSFolder
方法：createPath（新建文件夹路径）
operation: createPath
input
sid
parentFolderId
string
long
session identifier
当前文件夹的父文件夹
folder WsFolder value object containing the folder
metadata
output
WsFolder value object containing the folder
metadata
这边需要说明在6.8.0版本下，create可以创建文件夹，这个比createpath多一个设置新建文件夹的名称，但是也得
在使用之间注入parentFolderId。
operation: create
input
sid string session identifier
folder WsFolder value object containing the folder
metadata
output
WsFolder value object containing the folder
metadata
方法：getFolder获取文件夹目录
operation: getFolder
input
sid
folderId
output
WsFolder value object containing the
folder metadata
string
long
session identifier
folder identifier
方法：delete删除文件夹
operation: delete
input
sid
folderId
string
long
session identifier
folder identifier
4. SEARCH_ENDPOINT = HOST_URL +"/services/Search";//搜索URL
主要类：SearchClient，WSSearchOptions，WSSearchResult
方法：find 根据类型获取文档
operation: find
input
sid string session identifier
options FullTextSearchOthe query options
ptions
output
WSSearchResult search hits
这个方法的options的设置时根据文件名称来查找。包括设置查找文件的语言，一次性查找文件的数量。
方法：findByFilename 根据文件名称查找
operation: findByFilename
input
sid
filename
output
WsDocument[ ] list of value objects containing
the documents metadata
string
String
session identifier
file name
注：
1. 文档的更新也是用WSdocument的create方法，与直接新建相比，区别在于，直接的update的文件名要与已存在的文件名一致。
2. MassiveImport，MassiveImportSack.,RecursiveImport这三个方法是测试效果的，压力测试的那种。
发布评论