Skip to main content

iTOP API Python Lib

Project description

# A developer friedly iTOP API Lib for Python3

- Support all extensions;
- Chained methods;
- Data manipulation with NoSQL similar style;
- Creation and updates objects containing lookup fields;
- Parallel methods;

## Install
pip install itoptop

## Usage
>>> from itoptop import Itop
>>> url = 'https://itop_server_name/webservices/rest.php'
>>> ver = '1.3'
>>> usr = 'user'
>>> pwd = 'password'
>>> data_model = 'path/to/datamodel.xml' # default is itop_folder/data/datamodel-production.xml

### With Data Model
>>> itop = Itop(url, ver, usr, pwd, data_model)
Get id from Organization which code is SOMECODE

>>> query = {'code': 'SOMECODE'}
>>> projection = ['id']
>>> result = itop.Organization.find(query, projection)
'1'

Insert list of person

>>> object_list = [
>>> {'name': 'NAME', 'first_name': 'FIRST_NAME', 'org_name': 'My Company/Department'},
>>> {'name': 'NAME', 'first_name': 'OTHER_NAME', 'org_name': 'My Company/Department'}
>>> ]
>>> itop.Person.insert(object_list)
[
{
'email': '',
'employee_number': '',
'finalclass': 'Person',
'first_name': 'FIRST_NAME',
'friendlyname': 'FIRST_NAME NAME',
'function': '',
'id': '3',
(...)
'org_id': '1',
'org_id_friendlyname': 'My Company/Department',
'org_id_obsolescence_flag': '',
'org_name': 'My Company/Department',
},
{
'email': '',
'employee_number': '',
'finalclass': 'Person',
'first_name': 'OTHER_NAME',
'friendlyname': 'OTHER_NAME NAME',
'function': '',
'id': '2',
(...)
'org_id': '1',
'org_id_friendlyname': 'My Company/Department',
'org_id_obsolescence_flag': '',
'org_name': 'My Company/Department',
}
]

Update field first_name to FIRST_NAME and Organization relationship to My Company/Department in person where name is NAME

>>> query= {'name': 'NAME'}
>>> update = {'first_name': 'FIRST_NAME', 'org_name': 'My Company/Department'}
>>> itop.Person.update(query, update, multi=True, upsert=True)
[
{
'email': '',
'employee_number': '',
'finalclass': 'Person',
'first_name': 'FIRST_NAME',
'friendlyname': 'FIRST_NAME NAME',
'function': '',
'id': '3',
(...)
'org_id': '1',
'org_id_friendlyname': 'My Company/Department',
'org_id_obsolescence_flag': '',
'org_name': 'My Company/Department',
},
{
'email': '',
'employee_number': '',
'finalclass': 'Person',
'first_name': 'FIRST_NAME',
'friendlyname': 'OTHER_NAME NAME',
'function': '',
'id': '2',
(...)
'org_id': '1',
'org_id_friendlyname': 'My Company/Department',
'org_id_obsolescence_flag': '',
'org_name': 'My Company/Department',
}
]


Remove all persons which Name is NAME and First Name is FIRST_NAME

>>> result = itop.Person.remove({'name': 'NAME', 'first_name': 'FIRST_NAME'})
[
{'friendlyname': 'FIRST_NAME NAME', 'id': '2'},
{'friendlyname': 'FIRST_NAME NAME', 'id': '3'}
]

### Without Data Model
>>> itop = Itop(uri, ver, usr, pwd)
Get id from Organization which code is SOMECODE

>>> query = {'code': 'SOMECODE'}
>>> projection = ['id']
>>> result = itop.schema('Organization).find(query, projection)

Insert list of person

>>> object_list = [
>>> {'name': 'NAME', 'first_name': 'FIRST_NAME', 'org_id': 1},
>>> {'name': 'NAME', 'first_name': 'OTHER_NAME', 'org_id': 1}
>>> ]
>>> result = itop.schema('Person').insert(object_list)

Update field first_name to FIRST_NAME and org_id to 2 of objects in person where name is NAME

>>> query= {'name': 'NAME'}
>>> update = {'first_name': 'FIRST_NAME', 'org_id': 1}
>>> result = itop.schema('Person').update(query, update, multi=True, upsert=True)

Remove all persons which Name is NAME and First Name is FIRST_NAME

>>> result = itop.schema('Person').remove({'name': 'NAME', 'first_name': 'FIRST_NAME'})

## Contributing
Pull requests for new features, bug fixes, and suggestions are welcome!

## License
GNU General Public License v3 (GPLv3)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for itoptop, version 1.0.8
Filename, size File type Python version Upload date Hashes
Filename, size itoptop-1.0.8.tar.gz (19.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page