Welcome to Python i-doit JSON-RPC API’s documentation!

Contents:

Introduction

Requirements

Supported Python versions:

  • Python 2.7
  • Python > 3.2
  • PyPy

Installation

As a Python egg

You can install the most recent version using pip

$ pip install idoit

From a tarball release

Download the most recent tarball from github, unpack it and run the following command on the command-line.

$ python setup.py install

Install the development version

Install git and run the following commands on the command-line.

$ git clone https://github.com/DinoTools/python-idoit.git
$ cd python-idoit
$ python setup.py install

Usage

API Reference

Low-Level

class idoit.API(url=None, key=None, username=None, password=None)[source]
login(username=None, password=None)[source]

Perform login

Parameters:
  • username (str) – Overrides the current username value
  • password (str) – Overrides the current password value
request(method, params=None, headers=None)[source]
Parameters:
  • method (str) –
  • params (dict) –
  • headers (dict) –
Returns:

Classes

class idoit.Idoit(api=None, api_params=None)[source]
class idoit.CMDBCategory(api=None, api_params=None)[source]
read(object_id, category=None, catg_id=None, cats_id=None)[source]

Read one or more category entries for an object.

Use only one of the optional parameters category, catg_id or cats_id.

Parameters:
  • object_id (int) – Object identifier
  • category (str) – Category constant
  • catg_id (int) – Global category identifier
  • cats_id (int) – Specific category identifier
Returns:

List of result objects
Return type:

dict[]
class idoit.CMDBObjects(api=None, api_params=None)[source]

Exceptions

Changelog

0.x (master)

Note

This version is not yet released and is under development.

0.1.0 (2018-01-09)

  • Initial release.

Indices and tables