[comment]: # ({1cabb47e-0fc7ba20})
# connector.get 

[comment]: # ({/1cabb47e-0fc7ba20})

[comment]: # ({efd10e48-c152f697})
### 説明

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

このメソッドは、与えられたパラメーターに従ってコネクタオブジェクトを取得することができます。

::: noteclassic
このメソッドは、*Super admin*タイプのユーザーのみ利用可能です。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細は[ユーザーの役割](/manual/web_interface/frontend_sections/users/user_roles)を参照してください。
:::

[comment]: # ({/efd10e48-c152f697})

[comment]: # ({0ecbb97e-b096237f})
### パラメータ

`(object)` 必要な出力を定義するパラメータです。

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

|パラメータ|[型](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|connectorids|ID/array|指定されたIDを持つコネクタのみを返します。|
|selectTags|query|コネクタの[tag filter](/manual/api/reference/connector/object#tag-filter)を含む`tags`プロパティを返します。<br><br>`count`をサポートします。|
|sortfield|string/array|指定されたプロパティで結果をソートします。<br><br>指定可能な値: `connectorid`, `name`, `data_type`, `status`。|
|countOutput|boolean|これらのパラメータについては、[reference commentary](/manual/api/reference_commentary#common-get-method-parameters)で説明されています。|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/0ecbb97e-b096237f})

[comment]: # ({fbd15acf-830d8762})
### 戻り値

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

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

[comment]: # ({/fbd15acf-830d8762})

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

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

[comment]: # ({75b302a6-3a1b6d17})
#### すべてのコネクタを取得する

すべてのコネクタとそのプロパティに関するすべてのデータを取得します。

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

```json
{
    "jsonrpc": "2.0",
    "method": "connector.get",
    "params": {
        "output": "extend",
        "selectTags": ["tag", "operator", "value"],
        "preservekeys": true
    },
    "id": 1
}
```

レスポンス :

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "connectorid": "1",
            "name": "Export of item values",
            "protocol": "0",
            "data_type": "0",
            "url": "{$DATA_EXPORT_VALUES_URL}",
            "item_value_type": "31",
            "authtype": "4",
            "username": "{$DATA_EXPORT_VALUES_USERNAME}",
            "password": "{$DATA_EXPORT_VALUES_PASSWORD}",
            "token": "",
            "max_records": "0",
            "max_senders": "4",
            "max_attempts": "2",
            "attempt_interval": "10s",
            "timeout": "10s",
            "http_proxy": "{$DATA_EXPORT_VALUES_PROXY}",
            "verify_peer": "1",
            "verify_host": "1",
            "ssl_cert_file": "{$DATA_EXPORT_VALUES_SSL_CERT_FILE}",
            "ssl_key_file": "{$DATA_EXPORT_VALUES_SSL_KEY_FILE}",
            "ssl_key_password": "",
            "description": "",
            "status": "1",
            "tags_evaltype": "0",
            "tags": [
                {
                    "tag": "component",
                    "operator": "0",
                    "value": "memory"
                }
            ]
        },
        {
            "connectorid": "2",
            "name": "Export of events",
            "protocol": "0",
            "data_type": "1",
            "url": "{$DATA_EXPORT_EVENTS_URL}",
            "item_value_type": "31",
            "authtype": "5",
            "username": "",
            "password": "",
            "token": "{$DATA_EXPORT_EVENTS_BEARER_TOKEN}",
            "max_records": "0",
            "max_senders": "2",
            "max_attempts": "1",
            "attempt_interval": "5s",
            "timeout": "5s",
            "http_proxy": "",
            "verify_peer": "1",
            "verify_host": "1",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "description": "",
            "status": "1",
            "tags_evaltype": "0",
            "tags": [
                {
                    "tag": "scope",
                    "operator": "0",
                    "value": "performance"
                }
            ]
        }
    ],
    "id": 1
}
```

[comment]: # ({/75b302a6-3a1b6d17})

[comment]: # ({572555ee-4963c0b1})
### ソース

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

[comment]: # ({/572555ee-4963c0b1})
