connector.update

Beschrijving

object connector.update(object/array connectors)

Deze methode maakt het mogelijk om bestaande connectors bij te werken.

Deze methode is alleen beschikbaar voor gebruikers van het Super admin gebruikerstype. Rechten om de methode aan te roepen kunnen worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruikersrollen voor meer informatie.

Parameters

(object/array) Eigenschappen van de connector die moeten worden bijgewerkt.

De eigenschap connectorid moet voor elke connector worden gedefinieerd, alle andere eigenschappen zijn optioneel. Alleen de doorgegeven eigenschappen worden bijgewerkt, alle andere blijven ongewijzigd.

Naast de standaard connector eigenschappen, accepteert de methode de volgende parameters.

Parameter Type Beschrijving
tags array Connector tag filter om het huidige tag filter te vervangen.

Teruggegeven waarden

(object) Geeft een object terug met de IDs van de bijgewerkte connectors onder de eigenschap connectorids.

Voorbeelden

Wijzigen van HTTP authenticatie type

Verander het HTTP authenticatie type naar Bearer voor de connector met ID "3".

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "connector.update",
           "params": {
               "connectorid": 3,
               "authtype": 5,
               "token": "{$DATA_EXPORT_BEARER_TOKEN}"
           },
           "id": 1
       }

Reactie:

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

Bijwerken van tag filter

Verander het tag filter voor de connector met ID "5".

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "connector.update",
           "params": [
               {
                   "connectorid": 5,
                   "tags_evaltype": 2,
                   "tags": [
                       {
                           "tag": "service",
                           "operator": 0,
                           "value": "mysqld"
                       },
                       {
                           "tag": "error",
                           "operator": 12,
                           "value": ""
                       }
                   ]
               }
           ],
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "result": {
               "connectorids": [
                   "5"
               ]
           },
           "id": 1
       }

Bron

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