iTopInstall

Summary

Retrieve iTop CMDB objects by class and identifier.

Inputs

• authentication (required) — Authentication method for the iTop API connection. Choose between Username and Password (credentials) or Token authentication. Must match the selected iTop API credential (iTopApi or iTopTokenApi).
• class (required) — The iTop object class to query, e.g. Person, UserRequest, Server. This determines the data model and available fields.
• key (required) — Object identifier: a numeric ID (e.g. 123), an OQL query string, or JSON search criteria. Used to specify which object instance to retrieve.
• output_fields — Comma-separated list of fields to return. Use '' to return all fields, or '+' to return all fields including subclass attributes. Defaults to '*'.
• limit — Maximum number of results to return. Must be at least 1. Defaults to 50.
• additionalOptions — Optional collection for advanced settings. Currently supports 'page' for pagination (0-based). Defaults to empty object.

Output shape

Formatted iTop object data returned by the core/get API endpoint, processed by the node's formatITopResponse function. The response structure depends on the object class, key, and output_fields specified.

If the workflow continues on fail, errors are returned as {error: } in the JSON field of the paired item.

Examples

Example 1: Get a single Person by numeric ID

Authentication: Username and Password; Class: Person; Key: 42; Output Fields: friendlyname, email; Limit: 1

Example 2: Search Users by email with pagination

Authentication: Token; Class: UserRequest; Key: SELECT UserRequest WHERE email = 'admin@example.com'; Output Fields: *; Additional Options: page 0; Limit: 20