Documentation
Table of Contents
regexp.get
Descrição
integer/array regexp.get(object parameters)
O método permite recuperar expressões regulares globais de acordo com os parâmetros fornecidos.
Este método está disponível apenas para Super Admin. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Consulte Funções de usuário para obter mais informações.
Parâmetros
(object) Parâmetros que definem a saída desejada.
O método suporta os seguintes parâmetros.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| regexpids | string/array | Retorna apenas expressões regulares com os IDs fornecidos. |
| selectExpressions | query | Retorna uma propriedade expressions. |
| sortfield | string/array | Classifique o resultado pelas propriedades fornecidas. Os valores possíveis são: regexpid e name. |
| countOutput | boolean | Esses parâmetros sendo comuns para todos os métodos get são descritos em detalhes no comentário de referência. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valores de retorno
(integer/array) Retorna:
- uma matriz de objetos;
- a contagem de objetos recuperados, se o parâmetro
countOutputfoi usado.
Exemplos
Recuperando expressões regulares globais.
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 }Fonte
CRegexp::get() in ui/include/classes/api/services/CRegexp.php.