6 Commits
1.0.4 ... main

Author SHA1 Message Date
Jason SECULA
3a77226870 Updated build number
All checks were successful
Build python package / Build (push) Successful in 32s
2026-04-27 14:57:37 +02:00
8b34682e59 Added entities selection methods and updated profile selection methods
All checks were successful
Build python package / Build (push) Successful in 36s
2026-04-25 21:56:37 +02:00
d433b2957e Updated profile interaction methods 2026-04-25 21:20:06 +02:00
Jason SECULA
5a464316f1 fixed misplace of +1 for fieldstodisplay
All checks were successful
Build python package / Build (push) Successful in 33s
2026-04-23 16:39:26 +02:00
Jason SECULA
8dec92b43a Adding profile selection methods
All checks were successful
Build python package / Build (push) Successful in 32s
2026-04-23 16:26:03 +02:00
Jason SECULA
9ac724ed4c Fixed error with id not shown in GetItems() 2026-04-23 16:07:31 +02:00
2 changed files with 106 additions and 6 deletions

View File

@@ -3,7 +3,7 @@ import json
from datetime import datetime from datetime import datetime
class GLPIAPI: class GLPIAPI:
def __init__(self, Server, AppToken, UserToken, UserAgent="GLPI API"): def __init__(self, Server, AppToken, UserToken, UserAgent="GLPI API", Profile=None):
self.Server = Server self.Server = Server
self.AppToken = AppToken self.AppToken = AppToken
self.UserToken = UserToken self.UserToken = UserToken
@@ -11,7 +11,16 @@ class GLPIAPI:
self.SessionToken = None self.SessionToken = None
self.StatusCode = None self.StatusCode = None
self.Headers = None self.Headers = None
self.ActiveProfile = None
self.ActiveEntity = None
self.RecurseEntity = True
self.InitConnection() self.InitConnection()
if(Profile == None):
self.ActiveProfile = self.GetActiveProfile()[0]
else:
self.ActiveProfile = Profile
profileId = self.GetItems('Profile', 'Profile.name', Profile)[1]['2']
self.SetActiveProfile(profileId)
def InitConnection(self): def InitConnection(self):
initURI = '/apirest.php/initSession/' initURI = '/apirest.php/initSession/'
@@ -32,6 +41,20 @@ class GLPIAPI:
"Session-Token": self.SessionToken, "Session-Token": self.SessionToken,
"App-Token": self.AppToken "App-Token": self.AppToken
} }
if(self.GetActiveProfile()[0] != self.ActiveProfile and self.ActiveProfile != None):
profile = [p for p in self.GetUserProfiles() if p["name"] == self.ActiveProfile]
if(profile != []):
self.SetActiveProfile(profile[0]["id"])
else:
raise Exception(f"{self.ActiveProfile} is not in user profiles")
ActiveEntities = self.GetActiveEntity()
if((ActiveEntities[0] != self.ActiveEntity or ActiveEntities[1] != self.RecurseEntity) and self.ActiveEntity != None):
entity = [e for e in self.GetUserEntities() if e["id"] == self.ActiveEntity]
if(entity != []):
self.SetActiveEntity(entity[0]["id"], self.RecurseEntity)
else:
raise Exception(f"{self.ActiveEntity} is not in user entities")
else: else:
raise Exception(f"{result.status_code} - {result.json()[0]}") raise Exception(f"{result.status_code} - {result.json()[0]}")
@@ -40,7 +63,82 @@ class GLPIAPI:
result = requests.get(sessionUri, headers=self.Headers) result = requests.get(sessionUri, headers=self.Headers)
if(result.status_code != 200 and result.json()[0] == 'ERROR_SESSION_TOKEN_INVALID'): if(result.status_code != 200 and result.json()[0] == 'ERROR_SESSION_TOKEN_INVALID'):
self.InitConnection() self.InitConnection()
return return result.status_code
def GetUserProfiles(self):
self.CheckConnection()
uri = f"{self.Server}/apirest.php/getMyProfiles"
req = requests.get(uri, headers=self.Headers)
if(req.status_code == 200):
return req.json()['myprofiles']
else:
return req.status_code
def GetActiveProfile(self):
self.CheckConnection()
uri = f"{self.Server}/apirest.php/getActiveProfile"
req = requests.get(uri, headers=self.Headers)
if(req.status_code == 200):
return (req.json()['active_profile']['name'],req.json()['active_profile']['id'])
else:
return req.status_code
def SetActiveProfile(self, profile):
self.CheckConnection()
if(type(profile) == str):
profileFound = [p for p in self.GetUserProfiles() if p["name"] == profile]
if(profileFound != []):
profileId = profileFound[0]["id"]
else:
profileId = profile
body = {
"profiles_id" : profileId
}
uri = f"{self.Server}/apirest.php/changeActiveProfile"
req = requests.post(uri, headers=self.Headers, json=body)
if(req.status_code == 200):
self.ActiveProfile = self.GetActiveProfile()[0]
return req.status_code
def GetUserEntities(self):
self.CheckConnection()
uri = f"{self.Server}/apirest.php/getMyEntities"
req = requests.get(uri, headers=self.Headers)
if(req.status_code == 200):
return req.json()["myentities"]
else:
return req.status_code
def GetActiveEntity(self):
self.CheckConnection()
uri = f"{self.Server}/apirest.php/getActiveEntities"
req = requests.get(uri, headers=self.Headers)
if(req.status_code == 200):
return (req.json()['active_entity']['id'], req.json()['active_entity']['active_entity_recursive'], req.json()['active_entity']['active_entities'])
else:
return req.status_code
def SetActiveEntity(self, entity, recurse=True):
self.CheckConnection()
if(type(entity) == str):
entityFound = [e for e in self.GetUserEntities() if e["name"] == entity]
if(entityFound != []):
entityId = entityFound[0]["id"]
else:
entityId = entity
body = {
"entities_id" : entityId,
"is_recursive" : recurse
}
uri = f"{self.Server}/apirest.php/changeActiveEntities"
req = requests.post(uri, headers=self.Headers, json=body)
if(req.status_code == 200):
ActiveEntities = self.GetActiveEntity()
self.ActiveEntity = ActiveEntities[0]
self.RecurseEntity = ActiveEntities[1]
return req.status_code
def GetComputers(self, deviceName=None, serialNumber=None, user=None, imei=None, airwatchDevice=None, fieldsToDisplay=[], trashbin=0): def GetComputers(self, deviceName=None, serialNumber=None, user=None, imei=None, airwatchDevice=None, fieldsToDisplay=[], trashbin=0):
''' '''
@@ -146,9 +244,12 @@ class GLPIAPI:
else: else:
searchUri = f"{self.Server}/apirest.php/search/{itemType}?{search_parameter}" searchUri = f"{self.Server}/apirest.php/search/{itemType}?{search_parameter}"
idFieldNumber = list(self.GetSearchOptions(itemType, f'{itemType}.id'))[0]
searchUri += f"&forcedisplay[0]={idFieldNumber}"
if(fieldsToDisplay != []): if(fieldsToDisplay != []):
for i in range(len(fieldsToDisplay)): for i in range(1, len(fieldsToDisplay)+1):
searchUri += f"&forcedisplay[{i}]={fieldsToDisplay[i]}" searchUri += f"&forcedisplay[{i}]={fieldsToDisplay[i-1]}"
search = requests.get(searchUri, headers=self.Headers) search = requests.get(searchUri, headers=self.Headers)
@@ -161,7 +262,6 @@ class GLPIAPI:
return itemID, data, search["totalcount"] return itemID, data, search["totalcount"]
elif(search["totalcount"] > 1): elif(search["totalcount"] > 1):
if(searchAll): if(searchAll):
idFieldNumber = list(self.GetSearchOptions(itemType, f'{itemType}.id'))[0]
itemID = [i[idFieldNumber] for i in search["data"]] itemID = [i[idFieldNumber] for i in search["data"]]
else: else:
itemID = list(search["data"].keys()) itemID = list(search["data"].keys())

View File

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
[project] [project]
name = "GLPIAPI" name = "GLPIAPI"
version = "1.0.4" version = "1.0.6"
description = "A module python to make it easier to use GLPI API" description = "A module python to make it easier to use GLPI API"
readme = "README.md" readme = "README.md"
dependencies = [ dependencies = [