SimManager REST服务接口简介

CAE大拿

1 概述
SimManager 提供的REST服务接口允许客户端应用程序简单的通过RESTful URLs从SimManager数据库和文件仓库获取数据，及执行服务器中的操作。

对数据的访问是基于Web的，使用HTTP协议。客户端程序可运行在个人电脑或移动设备。接口生成的标准XML格式的输出很容易解析，它不依赖于任何一种编程语言及额外的软件。

通过此接口获取数据和通过WEB界面查看数据使用同样的安全机制，用户都需要首先登录到系统才可以访问数据，并且只能访问自己有权限查看的数据。

2 语法
接口是基于RESTFful设计原则，数据是使用URLs获取的。URLs由以下几部分组成：

• Web应用服务上下文，如：http://localhost:8080/SimManager
  

• 基准URL：/servlet/rest
  

• 命令：/query
  

• 命令参数，例如：type=InputDeck&page=4
  

一个典型的例子如：http://localhost:8080/SimManager/servlet/rest/query?type=InputDeck&page=4

接口支持的命令见后面“5 命令”一节，每种命令都有自己的参数、输出格式、错误代码等定义。

3 输出
数据缺省采用XML格式，可通过在命令后加“format=JSON”参数变更为JSON格式。另外，如命令请求的是文件仓库中的文件，输出即是请求的文件本身。

4 出错处理
出错时，标准的HTTP错误代码会返回。例如请求一个服务器中不存在的文件会返回404错误。

常见的错误代码如下：

• 401（未被授权）：用户未登录
  

• 500（内部服务器错误）：一般是内部应用程序问题
  

错误的细节信息以XML或JSON格式返回。

5 命令
接口支持的命令如下：

• query – 获取数据
  

• vault – 从文件仓库中读文件
  

• count – 匹配查询条件的对象数
  

• any – 测试是否有对象满足查询条件
  

• curve – 获取曲线图
  

• login – 验证用户
  

• logoff – 断开当前的使用者
  

• action – 调用操作
  

• upload – 上传文件
  

• units – 访问操作系统
  

• tree – 获取导航树
  

6 小结
综上，SimManager提供基于REST 的查询、文件传输和操作执行接口。该接口为应用程序和移动设备提供了一个统一的语言无关的集成平台。