Sidebar

Combodo

iTop Extensions

Rest API Playground

name:
Combodo-api-playground
description:
Rest API Playground
version:
1.0.6
release:
2026-09-11
itop-version-min:
3.0
state:
Prototype

User friendly interface that eases iTop CMDB adoption and API Rest use.

Features

A little bit like POSTMAN, this extension proposes a set of Rest endpoint examples (GET/DELETE/UPDATE/…) in dedicated tabs. The examples are directly generated based on your iTop data.

At first you have to select a class among UserRequest / Person /Server

Then you can deed dive in each endpoint tab where you have:

  • request/response field doc
  • further different examples of request/responses with your live data
  • a CURL CLI command to copy-paste

A last tab shows the selected class datamodel view to quickly understand iTop abstraction and link it to the Rest API.

your iTop data will NOT be harmed. Rest query examples are fake even if they rely on live data. No data modification (CREATE/UDPATE/DELETE) are really performed/applied.

Revision History

Release date Version Comments
2026-09-11 1.0.6 * N°9543 - Datamodel display as tab in all objects can be disabled (enabled by default)
2025-04-17 1.0.4 * iTop 3.0.0 compatibility + remove authent-token dependency
* N°7877 - Update API Playbook to release it
2024-09-20 1.0.0 * SaaS Volume only

Limitations

Classes to select are limited (if they exist) to UserRequest / Person /Server.

Requirements

iTop 3.0 min

Installation

as usual

Configuration

The extension demonstrates how the REST APIs function independently of authentication. No configuration of REST or token authentication is required, nor is it necessary to assign the REST Profile to any user.

The data that is displayed will automatically respect the authorizations of the connected user (i.e., the silos, data, and classes that the user is allowed to view).

The datamodel view is displayed - as a specific “Datamodel” tab - on all iTop objects. You can hide this tab but keep it only in the “REST API” page by setting the following configuration parameter:

$MyModuleSettings = array( 
        'combodo-datamodel-helper' => array (
                'objecttab-enabled' => false,
        ),

Usage

Go to iTop Menu and select //Rest API //

Select an iTop class

Get endpoint tab (UserRequest)

This tab contains further different ways of calling same API. This is based with OQL language. Further sections include also input/output documentation.

Create endpoint tab (Person)

Update endpoint tab (Person)

Apply stimulus endpoint tab (UserRequest)

This tab is available only when selecting classes that have lifecycles like UserRequest.

Delete endpoint tab (Server)

Datamodel view tab (Server)

This tab illustrates iTop object abstraction. it describes all objects/fields and other possible values.

extensions/combodo-api-playground.txt · Last modified: 2026/10/21 15:06 by 127.0.0.1
Back to top
Contact us