Updated UpdateUser to UpdateItemUser and added a parameter to set itemType

.gitea/workflows/build.yaml

@@ -10,7 +10,7 @@ jobs:
         uses: actions/checkout@main
       - name: Building the package
         run: |
-          mv ${{ gitea.workspace }}\GLPIAPI.py ${{ gitea.workspace }}\build\src\GLPIAPI\
+          powershell mv ${{ gitea.workspace }}\GLPIAPI.py ${{ gitea.workspace }}\build\src\GLPIAPI\
           cd ${{ gitea.workspace }}\build
           python -m build
       - name: Publish package

GLPIAPI.py

@@ -33,8 +33,26 @@ class GLPIAPI:
                 "App-Token": self.AppToken
             }
     
-    def GetDevice(self, airwatchDevice=None, serialNumber=None, imei=None):
+    def GetComputers(self, deviceName=None, serialNumber=None, user=None, imei=None, airwatchDevice=None):
-        if(airwatchDevice != None):
+        '''
+        Search for computer items in GLPI based on one of the possibles parameters :
+          - deviceName : name of the item
+          - serialNumber : serial number of the item
+          - user : user of the item
+          - imei : custom field using field plugin (only for internal use)
+          - airwatchDevice : an airwatchDevice object from airwatchAPI module
+        If no parameters are set, it will search for all items
+        
+        Return a tuple with item id, item data and item count.
+        '''
+        searchAll = False
+        if(deviceName != None):
+            # Recherche en fonction du nom de l'appareil
+            search_parameter = f'is_deleted=0&criteria[0][field]=1&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{deviceName}$'
+        elif(user != None):
+            # Recherche en fonction de l'utilisateur de l'appareil
+            search_parameter = f'is_deleted=0&criteria[0][field]=70&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{user}$'    
+        elif(airwatchDevice != None):
             if(airwatchDevice.Imei != ''):
                 # Recherche des appareils en fonction du numéro de série ou de l'imei
                 # l'imei pouvant être dans le champ numéro de série ou les champs imei custom (plugin field)
@@ -45,40 +63,67 @@ class GLPIAPI:
             else:
                 # Recherche des appareils en fonction du numéro de série seulement
                 search_parameter = f'is_deleted=0&criteria[0][field]=5&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{airwatchDevice.SerialNumber}$'
-        else:
+
-            if(imei != None):
+        elif(imei != None):
                 # Recherche des appareils en fonction du numéro de série ou de l'imei
                 # l'imei pouvant être dans le champ numéro de série ou les champs imei custom (plugin field)
                 search_parameter = f'is_deleted=0&criteria[0][field]=5&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{serialNumber}$'\
                 f'&criteria[1][link]=OR&criteria[1][field]=5&criteria[1][searchtype]=contains&criteria[1][value]=^{imei}$'\
                 f'&criteria[2][link]=OR&criteria[2][field]=76667&criteria[2][searchtype]=contains&criteria[2][value]=^{imei}$'\
                 f'&criteria[3][link]=OR&criteria[3][field]=76670&criteria[3][searchtype]=contains&criteria[3][value]=^{imei}$'
-            else:
+                
+        elif(serialNumber != None):
             # Recherche des appareils en fonction du numéro de série seulement
             search_parameter = f'is_deleted=0&criteria[0][field]=5&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{serialNumber}$'
             
+        else:
+            # Recherche de l'ensemble des appareils si rien n'est renseigné
+            searchAll = True
+            
+            search_parameter = f'is_deleted=0&criteria[0][link]=AND&criteria[0][field]=view&criteria[0][searchtype]=contains&criteria[0][value]='
+        if(searchAll):
+            searchUri = f"{self.Server}/apirest.php/search/Computer/?range=0-9999999&is_deleted=0"
+        else:
             searchUri = f"{self.Server}/apirest.php/search/Computer?{search_parameter}"
         search = requests.get(searchUri, headers=self.Headers)
         if(search.status_code == 200):
             search = search.json()
             if(search["totalcount"] == 1):
-                deviceID = list(search["data"].keys())[0]
+                itemID = list(search["data"].keys())[0]
-                data = search["data"][deviceID]
+                data = search["data"][itemID]
                 
-                return deviceID, data, search["totalcount"]
+                return itemID, data, search["totalcount"]
             elif(search["totalcount"] > 1):
-                deviceID = list(search["data"].keys())
+                if(searchAll):
-                return deviceID, search["data"], search["totalcount"]
+                    # requires id to be in the display preferences of the api user
+                    itemID = [i["2"] for i in search["data"]]
+                else:
+                    itemID = list(search["data"].keys())
+                return itemID, search["data"], search["totalcount"]
                 
         return None, None, 0
         
-    def GetUser(self, username=None, email=None):
+    def GetUsers(self, username=None, email=None):
+        '''
+        Search for users in GLPI based on one of the possibles parameters :
+          - username : username of the glpi user
+          - email : email of the glpi user
+        If no parameters are set, it will search for all users
         
+        Returns a tuple with user id, user data and user count
+        '''
+        searchAll = False
         if(username != None):
             search_parameter = f'is_deleted=0&criteria[0][field]=1&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{username}$'
         elif(email != None):
             search_parameter = f'is_deleted=0&criteria[0][field]=5&withindexes=true&criteria[0][searchtype]=contains&criteria[0][value]=^{email}$'
-        searchUri = f"{self.Server}/apirest.php/search/user?{search_parameter}"
+        else:
+            searchAll = True
+            
+        if(searchAll):
+            searchUri = f"{self.Server}/apirest.php/search/User/?range=0-9999999&is_deleted=0"
+        else:
+            searchUri = f"{self.Server}/apirest.php/search/User?{search_parameter}"
         search = requests.get(searchUri, headers=self.Headers)
         if(search.status_code == 200):
             search = search.json()
@@ -88,6 +133,10 @@ class GLPIAPI:
                 
                 return userID, data, search["totalcount"]
             elif(search["totalcount"] > 1):
+                if(searchAll):
+                    # requires id to be in the display preferences of the api user
+                    userID = [i["2"] for i in search["data"]]
+                else:
                     userID = list(search["data"].keys())
                 return userID, search["data"], search["totalcount"]
         
@@ -111,12 +160,12 @@ class GLPIAPI:
         files = {file: fileData}
         return requests.post(self.Server+"/apirest.php/Document/", headers=headers, data=data, files=files)
     
-    def SetDocumentToDevice(self, deviceID, documentID):
+    def SetDocumentToItem(self, itemID, itemType, documentID):
         body = { 
             "input": {
                 "documents_id": documentID,
-                "items_id": deviceID,
+                "items_id": itemID,
-                "itemtype": "Computer"
+                "itemtype": itemType
             }
         }
         return requests.post(self.Server+"/apirest.php/Document/"+str(documentID)+"/Document_Item", headers=self.Headers, json=body)
@@ -128,6 +177,25 @@ class GLPIAPI:
         }
         return requests.post(self.Server, headers=headers, data=inventory)
     
+    def SetField(self, itemType, itemId, data):
+        '''Modify fields of a GLPI item.
+           Input must be a dict formatted like this :
+           {
+            "fieldName1": "fieldValue1",
+            "fieldName2": "fieldValue2",
+            ...
+           }
+        '''
+        body = {
+            "input" : {
+                "id" : itemId,
+            }
+        }
+        body["input"] = {**body["input"], **data}
+        
+        uri = f"{self.Server}/apirest.php/{itemType}/"
+        return requests.put(uri, headers=self.Headers, json=body)
+    
     def UpdateSerialNumber(self, deviceid, serialnumber):
     
         body = {
@@ -139,18 +207,18 @@ class GLPIAPI:
         uri = f"{self.Server}/apirest.php/Computer/"
         return requests.put(uri, headers=self.Headers, json=body)
     
-    def UpdateUser(self, deviceid, username):
+    def UpdateItemUser(self, itemID, itemType, username):
     
         body = {
             "input" : {
-                "id" : deviceid,
+                "id" : itemID,
                 "users_id" : username
             }
         }
-        uri = f"{self.Server}/apirest.php/Computer/"
+        uri = f"{self.Server}/apirest.php/itemType/"
         return requests.put(uri, headers=self.Headers, json=body)
 
-    def SetField(self, itemType, containerName, containerID, itemId, fieldName, data):
+    def SetCustomField(self, itemType, containerName, containerID, itemId, fieldName, data):
         '''Requires fields plugin on GLPI server
            - containerName is block label name
            - containerID is block id

build/pyproject.toml

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

build/src/GLPIAPI/__init__.py

@@ -0,0 +1 @@
+__all__ = ["GLPIAPI"]