i-doit icon

i-doit

i-doit JSON-RPC API

Actions7

Archive

AI-generated

Overview

The i-doit n8n node allows you to interact with the i-doit CMDB (Configuration Management Database) system via its JSON-RPC API.
For the Resource: Default and Operation: Archive, this node is used to archive either a CMDB Object or a Category entry within i-doit. Archiving typically means marking an object or category as archived, which can be useful for lifecycle management, compliance, or decluttering active records without deleting them.

Common scenarios:

  • Archiving decommissioned servers or network devices in your CMDB.
  • Archiving specific configuration categories when they are no longer relevant but must be retained for audit purposes.

Practical example:
You have a server that has been retired. Instead of deleting it from the CMDB, you use this node to archive the object, preserving its data for future reference.

Properties

Name Type Meaning
Namespace options Selects the type of resource to operate on (e.g., "CMDB Object" or "CMDB Category").
Category options Specifies the category within the selected namespace. Required if archiving a category entry.
Object Type options The type of object (e.g., Server, Switch). Not required for archive operation.
Id string The unique identifier of the object or category to archive.
Category entry Id string The identifier of the specific category entry to archive (required for category archiving).
Search String string Not used for archive operation.
Retrieve and Split Data Items boolean Not used for archive operation.

Note:

  • For archiving a CMDB Object (Namespace = cmdb.object), only Id is required.
  • For archiving a Category entry (Namespace = cmdb.category), Id, Category, and Category entry Id are required.

Output

  • The output is provided in the json field.
  • The structure of the output reflects the response from the i-doit API's archive method, which typically includes status information and possibly details about the archived object or category.
  • Example output:
{
  "result": {
    // ...details about the archived object/category...
  },
  "id": 1,
  "jsonrpc": "2.0"
}
  • If an error occurs and "Continue On Fail" is enabled, the output will include:
{
  "error": "Error message here"
}
  • No binary data is produced by this operation.

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: The node must be configured with the correct i-doit credentials.

Troubleshooting

Common issues:

  • Missing or invalid credentials: Ensure the i-doit API key is correctly set up in n8n.
  • Incorrect IDs: Supplying an incorrect or non-existent object/category ID will result in an error from the i-doit API.
  • Insufficient permissions: The API user must have permission to archive objects or categories.
  • Required fields missing: For category archiving, both "Id", "Category", and "Category entry Id" must be provided.

Common error messages:

  • "Invalid object id": Check that the "Id" property matches an existing object or category.
  • "Entry identifier required": For category archiving, ensure "Category entry Id" is filled.
  • "Authentication failed": Verify your API key and user permissions.

Links and References

Discussion