regexp.get

Description

integer/array regexp.get(object parameters)

The method allows to retrieve global regular expressions according to the given parameters.

This method is available only to Super Admin. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object) Parameters defining the desired output.

The method supports the following parameters.

Parameter	Type	Description
regexpids	string/array	Return only regular expressions with the given IDs.
selectExpressions	query	Return a expressions property.
sortfield	string/array	Sort the result by the given properties. Possible values are: `regexpid` and `name`.
countOutput	boolean	These parameters being common for all `get` methods are described in detail in the reference commentary.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Повернуті значення

(integer/array) Повертає або:

масив об'єктів;
кількість отриманих об'єктів, якщо використовувався параметр countOutput.

Приклади

Retrieving global regular expressions.

Request:

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

Response:

{
         "jsonrpc": "2.0",
         "result": {
           "1": {
             "regexpid": "1",
             "name": "File systems for discovery",
             "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": "Network interfaces for discovery",
             "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
       }

Джерело

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

Documentation