iTop icon

iTop

Interact with iTop CMDB via REST API

Object → Update

AI-generated

Summary

Update a single iTop CMDB object identified by class and key, modifying specified fields and returning selected output fields.

Inputs

  • authentication (required) — Authentication method: Username and Password (credentials) or Token (token). Defaults to credentials.
  • class (required) — The iTop object class to work with (e.g. Person, UserRequest, Server).
  • key (required) — Object identifier: numeric ID or search criteria. Must identify exactly one object; bulk updates are not supported.
  • fields (required) — Fixed collection of field-name/value pairs to update on the object.
  • output_fields — Comma-separated list of fields to return. Use '' for all fields or '+' for all fields including subclass attributes. Defaults to *.
  • comment — Optional comment to attach to the operation for audit purposes.
  • additionalOptions.simulate — When true, simulates the update without persisting changes to the object.

Output shape

object

Returns the updated iTop object data formatted by the node's response handler, with fields determined by the output_fields parameter.

Examples

Example 1: Update a person's status

Set authentication to credentials, class to Person, key to the person's ID, fields to [{name: status, value: active}], output_fields to status, and comment to Workflow update.

Discussion