ModelObject

模型对象资源表示 TADDM 数据库中存在的特定模型对象实例,由 GUID 标识。

描述

使用此类型的资源来查询,更新或删除由其全局唯一标识 (GUID) 标识的单个模型对象实例。

URL

方案//hostname:port/rest/model/ModelObject/guid
其中:
方案
URL 的方案 ( HTTP:HTTPS:)。
hostname
TADDM 服务器的 TCP/IP 主机名或数字 IP 地址。
端口
TADDM 服务器上用于您正在使用的连接类型的 TCP/IP 端口 (9430 表示 HTTP , 9431 表示 HTTPS)。
guid
TADDM 数据库中存在的模型对象实例的全局唯一标识 (GUID)。 如果要更新对象,那么此 GUID 必须与 JSON 或 XML 对象数据中指定的 GUID 匹配。

HTTP 方法

GET
查询模型对象。
PUT
更新模型对象。 必须在 HTTP 请求的主体中以 JSON 或 XML 格式指定新对象数据。 (服务器自动检测输入数据的格式。)
删除
删除模型对象。

参数

深度=
查询的深度。 缺省值为 1。 更新或删除对象时不使用此参数。
feed= {json|xml}

要用于返回的数据的格式。 指定 jsonxml。 此参数是可选的。

如果未指定 feed 参数,那么服务器将使用 HTTP Accept 头 (application/jsonapplication/xml) 指定的格式。 如果未指定此头,那么将以 JSON 格式返回结果。

更新或删除对象时不使用 feed 参数。

longClassName= {true|false}
指定是否使用标准格式 (例如 com.collation.platform.model.topology.sys.ComputerSystem) 指定查询输出中的所有模型对象类名。 指定 truefalse。 此选项仅对 JSON 输出有效。 缺省值为 false
mssGuid=
与对象关联的管理软件系统 (MSS) 的 GUID 值。 此参数是可选的。

退货

如果请求成功,那么服务器将返回 HTTP 返回码 200。 对于查询,服务器还会返回 JSON 或 XML 格式的结果数据 (如 feed 参数或 HTTP Accept 头所指定)。 如果查询未返回任何数据,那么结果集是空的 JSON 数组或 XML 文档,具体取决于订阅源类型。

示例

此示例查询,更新或删除现有对象,具体取决于所使用的 HTTP 方法。 (要更新对象,请求主体必须包含更新后的对象数据。)
http://example.com:9430/rest/model/ModelObject/1D646C44FDEB3857B40B98BD
F9C0F407?mssGuid=CF5EBF574E7F382289B3F35FB5776628