模型对象更新服务
模型对象更新服务资源创建,更新或删除以 JSON 或 XML 格式传递到服务器的模型对象。
描述
使用模型对象更新服务来更新或删除现有模型对象,或者添加新的模型对象。 在每种情况下,操作的目标都是以 JSON 或 XML 格式在请求主体中指定的对象。
URL
方案//hostname:port/rest/model/ModelObject其中:
- 方案
- URL 的方案 (
HTTP:或HTTPS:)。 - hostname
- TADDM 服务器的 TCP/IP 主机名或数字 IP 地址。
- 端口
- TADDM 服务器上用于您正在使用的连接类型的 TCP/IP 端口 (9430 表示 HTTP , 9431 表示 HTTPS)。
HTTP 方法
- POST
- 根据 delete 参数的值创建或删除模型对象。 必须在 HTTP 请求的主体中以 JSON 或 XML 格式指定要创建或删除的对象。 (服务器自动检测输入数据的格式。) 仅指定一个主对象; 不支持对象数组。
如果使用此方法来创建新对象,那么指定的对象在 TADDM 数据库中不得已存在。 (POST 方法不能用于更新现有对象。)
如果使用此方法来删除现有对象,那么在输入数据中仅需要 GUID。 但是,也可以指定整个对象。 如果指定的对象不存在,那么不会返回任何错误。
- PUT
- 更新现有对象或创建新对象。 必须在 HTTP 请求的主体中以 JSON 或 XML 格式指定新对象数据。 仅指定一个主对象; 不支持对象数组。
如果指定的对象已存在,那么将使用新数据对其进行更新。 如果该对象不存在,那么将创建该对象。
如果要更新现有对象,那么可以通过仅包含 GUID 和更新所需的字段 (而不是整个对象) 来提高性能。 例如,对 OperatingSystem 对象描述的更新可能包含以下数据:
更新数据中未指定的任何对象属性保持不变。[{"description":"Validated on February 4","_class":"Linux","guid":"347EE 64E4FA93139A581757EC7F3ED2D"}]
参数
- delete= {true|false}
- 指示是否应删除指定的模型对象。 使用 HTTP POST 方法和
delete=true来删除对象。 - feed= {json|xml}
要用于返回的数据的格式。 指定
json或xml。 此参数是可选的。如果未指定 feed 参数,那么服务器将使用 HTTP Accept 头 (
application/json或application/xml) 指定的格式。 如果未指定此头,那么将以 JSON 格式返回结果。- mssGuid=值
- 与对象关联的管理软件系统 (MSS) 的 GUID 值。 此参数是可选的。
退货
如果请求成功,那么服务器将返回 HTTP 返回码 200。
以下示例将删除由输入数据指定的模型对象:
http://example.com:9430/rest/model/ModelObject?delete=true