connector.create

説明

object connector.create(object/array connectors)

このメソッドは、新しいコネクタオブジェクトを作成することができます。

このメソッドは、Super adminタイプのユーザーのみ利用可能です。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。

パラメーター

(object/array) 作成するコネクタオブジェクト。

標準コネクタプロパティに加えて、メソッドは次のパラメータを受け入れます。

パラメーター タイプ 説明
tags array コネクタタグフィルター

戻り値

(object) connectoridsプロパティの下に作成されたコネクタのIDを含むオブジェクトを返します。返されるIDの順序は、渡されたコネクタの順序と一致します。

コネクタの作成

タグフィルターを使用してトリガーイベントをエクスポートするためのコネクタを作成します。HTTP認証はBearerトークンを使用して実行されます。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "connector.create",
    "params": [
        {
            "name": "Export of events",
            "data_type": 1,
            "url": "{$DATA_EXPORT_URL}",
            "authtype": 5,
            "token": "{$DATA_EXPORT_BEARER_TOKEN}",
            "tags": [
                {
                    "tag": "service",
                    "operator": 0,
                    "value": "mysqld"
                }
            ]
        }
    ],
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "connectorid": [
            "3"
        ]
    },
    "id": 1
}

ソース

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