Combodo-api-playground
- name:
- Combodo-api-playground
- description:
- Rest API Playground
- version:
- 1.0.0
- release:
- 2024-09-20
- itop-version-min:
- 2.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.
Revision History
Version | Release Date | Comments |
---|---|---|
1.0.0 | 2024-09-20 | First version |
Limitations
Classes to select are limited (if they exist) to UserRequest / Person /Server.
Requirements
iTop 3.0 min
Installation
as usual
Configuration
No need to configure REST nor token authentication nor add Rest Profile to any user. The extension shows how Rest APIs work apart from any authentication.
The data displayed will respect your connected user authorizations (ie silos/data/classes that he can see).
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.