[comment]: # ({b75e4c49-b75e4c49})
# regexp.get

[comment]: # ({/b75e4c49-b75e4c49})

[comment]: # ({f8d7cecb-15aa8348})
### 説明

`integer/array regexp.get(object parameters)`

このメソッドは、指定されたパラメータに従ってグローバルな正規表現を取得することができます。

::: noteclassic
このメソッドは*スーパ管理者*のみ利用可能です。メソッドの呼び出し権限はユーザーロール設定で取り消すことができます。詳細は[ユーザーロール](/manual/web_interface/frontend_sections/users/user_roles)を参照してください。
:::

[comment]: # ({/f8d7cecb-15aa8348})

[comment]: # ({29278b62-9693dfa8})
### パラメータ

`(object)` 目的の出力を定義するパラメータです。

このメソッドは以下のパラメータをサポートしています。

|パラメータ|[型](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|regexpids|ID/array|指定したIDを持つ正規表現のみを返します。|
|selectExpressions|query|[`expressions`](/manual/api/reference/regexp/object#expressions) プロパティを返します。|
|sortfield|string/array|指定したプロパティで結果をソートします。<br><br>指定可能な値: `regexpid`, `name`。|
|countOutput|boolean|これらのパラメータは[リファレンスコメント](/manual/api/reference_commentary#common-get-method-parameters)で説明されています。|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/29278b62-9693dfa8})

[comment]: # ({7223bab1-7223bab1})
### 戻り値

`(integer/array)` 次のいずれかを返します:

-   オブジェクトの配列
-   `countOutput`パラメータが使用されている場合、取得されたオブジェクトの数

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### 例

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({5132e368-196e1642})
#### グローバル正規表現の取得

[リクエスト](/manual/api#performing-requests):

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

レスポンス:

```json
{
  "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
}
```

[comment]: # ({/5132e368-196e1642})

[comment]: # ({71855296-71855296})
### ソース

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

[comment]: # ({/71855296-71855296})