城市信息模型基础平台基本服务接口示例.docxVIP

城市信息模型基础平台基本服务接口示例

A.1资源服务信息查询（资源访问类接口）

A.1.1getServiceBasicInfo操作

getServiceBasicInfo操作包含请求信息与响应内容两方面：

a）请求：获取服务的基本信息。具体请求参数描述见表A.1。

getServiceBasicInfo操作请求参数描述

参数名

描述

数据类型

取值范围

参数类别

备注

serviceId

服务唯一标识符

String/UUID

已注册服务的ID

必填

路径参数（如/services/{id}）

b）响应：以XML、JSON、RJSON等格式返回服务基本信息结果，如果请求地址及参数正确，则返回对应的服务描述信息，如不正确则返回错误原因：{“error”:[错误原因]}。

A.1.2getServiceStatus操作

getServiceStatus操作包含请求信息与响应内容两方面：

a）请求：查询服务的实时状态。具体请求参数描述见表A.2。

getServiceStatus操作请求参数描述

参数名

描述

数据类型

取值范围

参数类别

备注

serviceId

服务唯一标识符

String/UUID

已注册服务的ID

必填

路径参数（如/services/{id}）

b）响应：以XML、JSON、RJSON等格式返回服务状态信息结果，如果请求地址及参数正确，则返回对应的服务描述信息，如不正确则返回错误原因：{“error”:[错误原因]}。

A.1.3searchServicesByMetadata操作

searchServicesByMetadata操作包含请求信息与响应内容两方面：

a）请求：根据元数据键值对过滤服务列表。具体请求参数描述见表A.3。

searchServicesByMetadata操作请求参数描述

参数名

描述

数据类型

取值范围

参数类别

备注

serviceId

服务唯一标识符

String/UUID

已注册服务的ID

必填

路径参数（如/services/{id}）

depth

依赖关系递归深度

Integer

1-5，默认1

可选

防止过度递归导致性能问题

b）响应：以XML、JSON、RJSON等格式返回服务过滤列表结果，如果请求地址及参数正确，则返回对应的服务描述信息，如不正确则返回错误原因：{“error”:[错误原因]}。

A.1.4getServiceLogs操作

getServiceLogs操作包含请求信息与响应内容两方面：

a）请求：获取服务访问日志。具体请求参数描述见表A.4。

getServiceLogs操作请求参数描述

参数名

描述

数据类型

取值范围

参数类别

备注

serviceId

服务唯一标识符

String/UUID

已注册服务的ID

必填

路径参数（如/services/{id}）

logLevel

日志级别过滤

String

“ERROR”，“WARN”，“INFO”

可选

默认返回全部级别

limit

返回日志条目数量上限

Integer

1-1000，默认100

可选

查询参数

b）响应：以XML、JSON、RJSON等格式返回服务访问日志，如果请求地址及参数正确，则返回对应的服务描述信息，如不正确则返回错误原因：{“error”:[错误原因]}。

A.1.5listServicesByTag操作

listServicesByTag操作包含请求信息与响应内容两方面：

a）请求：根据标签名称或值筛选服务列表。具体请求参数描述见表A.5。

listServicesByTag操作请求参数描述

参数名

描述

数据类型

取值范围

参数类别

备注

tag

标签名称或值

String

非空字符串

必填

查询参数

matchMode

匹配模式

String

“exact”,“prefix”

可选

默认精确匹配（“exact”）

b）响应：以XML、JSON、RJSON等格式返回服务列表筛选结果，如果请求地址及参数正确，则返回对应的服务描述信息，如不正确则返回错误原因：{“error”:[错误原因]}。

A.2项目信息接口（项目类）

GetProjectInfo操作包含请求信息与响应内容两方面：

a）请求：请求依据项目代码获取项目信息。具体请求参数描述见表A.6。

GetProjectInfo操作请求参数描述表

参数名

描述

数据类型

取值范围

参数类别

备注

XMDM

项目代码

字符串

必选参数

b）响应：返回项目信息。具体返回参数描述见表A.7。

GetProjectInfo操作返回参数描述表

参数名

描述

数据类型

取值范围

参数类别

备注

XMMC

项目名称

字符串

必选参数

GCHYFL

工程行业分类

字符串

必选参数

JSXZ

建设性