i-doit icon

i-doit

i-doit JSON-RPC API

Actions7

Read

AI-generated

Overview

This n8n node integrates with the i-doit JSON-RPC API, specifically targeting the "Default" resource and supporting the "Read" operation. It allows users to retrieve various types of configuration management database (CMDB) information from an i-doit instance, such as objects, categories, dialogs, object type categories, and more. The node is useful for automating IT documentation, asset management, or synchronizing CMDB data with other systems.

Practical examples:

  • Fetching details about a specific CMDB object by its ID.
  • Retrieving all entries in a particular category for a given object.
  • Searching across the CMDB using a search string.
  • Listing dialog options for a category property.

Properties

Name Type Meaning
Namespace options Selects the i-doit API namespace to use (e.g., CMDB Object, Category, Dialog, etc.).
Category options Specifies the category within the selected namespace (loaded dynamically).
Object Type options Filters by object type (e.g., Server, Switch; loaded dynamically).
Id string The unique identifier of the resource to read (object, category, or object type category).
Search String string The term to search for when using the search or objects namespace.
Property string The attribute/property name within a category (for dialog reads).
Retrieve and Split Data Items boolean If enabled, splits array results into separate items in the output.

Note: Some properties are only shown depending on the selected Namespace and Operation.

Output

  • The node outputs data under the json field.
  • The structure of the output depends on the selected Namespace:
    • For most namespaces (e.g., cmdb.object, cmdb.category), the output is the direct result of the corresponding i-doit API call.
    • If "Retrieve and Split Data Items" is enabled and the API returns an array, each item in the array will be output as a separate n8n item (json field contains one element of the array).
    • If splitting is disabled, the entire array or object is returned in a single item.
  • If an error occurs and "Continue On Fail" is enabled, the output will contain an error field with the error message.

Example output (split enabled):

{
  "json": {
    "id": "123",
    "title": "Server01",
    "type": "Server",
    ...
  }
}

Example output (error):

{
  "json": {
    "error": "Resource not found"
  }
}

Dependencies

  • External Service: Requires access to an i-doit instance with the JSON-RPC API enabled.
  • API Key: You must provide valid i-doit credentials (API key) via n8n's credential system.
  • n8n Configuration: No special environment variables required beyond standard credential setup.

Troubleshooting

Common Issues:

  • Invalid Credentials: If the API key is missing or incorrect, authentication errors will occur.
  • Missing Required Fields: Not providing required fields like "Id" will result in validation errors.
  • Incorrect Namespace/Operation Combination: Selecting incompatible combinations may lead to unexpected errors or empty results.
  • API Errors: Any issues from the i-doit API (e.g., resource not found, permission denied) will be passed through in the error field if "Continue On Fail" is enabled.

Error Messages:

  • "Resource not found": The specified ID does not exist in i-doit. Check your input.
  • "Invalid API key": The provided API key is incorrect or expired. Update your credentials.
  • "Missing required parameter": Ensure all required fields are filled based on the selected namespace and operation.

Links and References

Discussion