regexp.get

Beschrijving

integer/array regexp.get(object parameters)

Deze methode maakt het mogelijk om globale reguliere expressies op te halen volgens de opgegeven parameters.

Deze methode is alleen beschikbaar voor Superbeheerders. Rechten om de methode te bellen kunnen worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruikersrollen voor meer informatie.

Parameters

(object) Parameters die de gewenste output definiëren.

De methode ondersteunt de volgende parameters.

Parameter	Type	Beschrijving
regexpids	string/array	Geef alleen reguliere expressies terug met de opgegeven IDs.
selectExpressions	query	Geef een expressions eigenschap terug.
sortfield	string/array	Sorteer het resultaat op basis van de opgegeven eigenschappen. Mogelijke waarden: `regexpid`, `name`.
countOutput	boolean	Deze parameters, die gemeenschappelijk zijn voor alle `get` methoden, worden in detail beschreven in de referentie toelichting.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Retourwaarden

(integer/array) Retourneert ofwel:

een reeks objecten;
het aantal opgehaalde objecten, als de countOutput parameter heeft gebruikt.

Voorbeelden

Hier is het voorbeeld van het ophalen van globale reguliere expressies met specifieke eigenschappen en geselecteerde expressies:

Verzoek:

{
           "jsonrpc": "2.0",
           "method": "regexp.get",
           "params": {
               "output": ["regexpid", "name"],
               "selectExpressions": ["expression", "expression_type"],
               "regexpids": [1, 2],
               "preservekeys": true
           },
           "id": 1
       }

Reactie:

{
         "jsonrpc": "2.0",
         "result": {
           "1": {
             "regexpid": "1",
             "name": "Bestandssystemen voor ontdekking",
             "expressions": [
               {
                 "expression": "^(btrfs|ext2|ext3|ext4|reiser|xfs|ffs|ufs|jfs|jfs2|vxfs|hfs|apfs|refs|ntfs|fat32|zfs)$",
                 "expression_type": "3"
               }
             ]
           },
           "2": {
             "regexpid": "2",
             "name": "Netwerkinterfaces voor ontdekking",
             "expressions": [
               {
                 "expression": "^Software Loopback Interface",
                 "expression_type": "4"
               },
               {
                 "expression": "^(In)?[Ll]oop[Bb]ack[0-9._]*$",
                 "expression_type": "4"
               },
               {
                 "expression": "^NULL[0-9.]*$",
                 "expression_type": "4"
               },
               {
                 "expression": "^[Ll]o[0-9.]*$",
                 "expression_type": "4"
               },
               {
                 "expression": "^[Ss]ystem$",
                 "expression_type": "4"
               },
               {
                 "expression": "^Nu[0-9.]*$",
                 "expression_type": "4"
               }
             ]
           }
         },
         "id": 1
       }

Dit voorbeeld laat zien hoe je een verzoek kunt maken om specifieke eigenschappen van globale reguliere expressies op te halen, en ook hoe je geselecteerde expressies kunt opnemen in de reactie.

Bron

CRegexp::get() in ui/include/classes/api/services/CRegexp.php.

Documentation