connector.create

Beschreibung

object connector.create(object/array connectors)

Mit dieser Methode können Sie neue Konnektor-Objekte erstellen.

Diese Methode ist nur für den Benutzertyp Superadmin verfügbar. Die Berechtigung zum Aufrufen der Methode kann in den Benutzerrolleneinstellungen entzogen werden. Prüfen Sie Benutzerrollen für mehr Informationen.

Parameter

(object/array) Zu erstellende Connector-Objekte.

Zusätzlich zu den Standard-Connector-Eigenschaften akzeptiert die Methode die folgenden Parameter.

Parameter Type Beschreibung
tags array Connector-Tag-Filter.

Rückgabewerte

(object) Gibt ein Objekt zurück, das die IDs der erstellten Verbindungen unter der Eigenschaft connectorids enthält. Die Reihenfolge der zurückgegebenen IDs entspricht der Reihenfolge der übergebenen Konnektoren.

Beispiele

Erstellen eines Verbinders

Erstellen Sie einen Connector, um Auslöser (trigger)-Ereignisse mit einem Tag-Filter zu exportieren. Die HTTP-Authentifizierung wird mit einem Bearer-Token durchgeführt.

Anfrage:

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

Antwort:

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

Quelle

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