Verwaltung von konkreten Anschluss-Zuweisungen zwischen einer Anschluss-Vorlage und einem Objekt.
Seitenverzeichnis:
patch.grid_connector.read
Beschreibung
Gibt alle konfigurierten Anschluss-Zuweisungen zurück.
Beispielaufruf
Lesen einer speziellen Anschluss-Zuweisung:
{
"method":"patch.grid_connector.read",
"params":{
"apikey":"24174j3tqj",
"id": 4
},
"version":"2.0",
"id": 1
}
Filtern nach Anschluss-Zuweisungen:
{
"method":"patch.grid_connector.read",
"params":{
"apikey":"24174j3tqj",
"filter": {
"connector_template_id": 4
}
},
"version":"2.0",
"id": 1
}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | Optional: ID des Datenbankeintrages | ab Version 1.0 |
| filter | array | Optional: Filter für Anschluss-Zuweisungen Der Filter unterstützt alle Eigenschaften der Anschluss-Zuweisung (siehe Rückgabewerte). Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden. | ab Version 1.0 |
Rückgabewert
Eigenschaften einer Anschluss-Zuweisung.
| Wert | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID des Datenbankeintrages | ab Version 1.0 |
| grid_list_id | int | ID der dazugehörigen Rahmen-Zuweisung (siehe: Rahmen-Zuweisung) | ab Version 1.0 |
| connector_template_id | string | ID der Anschluss-Vorlage | ab Version 1.0 |
| connector_id | int | ID des am Objekt konfigurierten Anschlusses | ab Version 1.0 |
patch.grid_connector.create
Beschreibung
Legt eine neue Anschluss-Zuweisung an.
Beispielaufruf
{
"method":"patch.grid_connector.create",
"params":{
"apikey":"24174j3tqj",
"data": {
"grid_list_id": 1,
"connector_template_id": 2,
"connector_id": 3
}
},
"version":"2.0",
"id": 1
}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| grid_list_id | int | ID der dazugehörigen Rahmen-Zuweisung (siehe: Rahmen-Zuweisung) | ab Version 1.0 |
| connector_template_id | int | ID der Anschluss-Vorlage | ab Version 1.0 |
| connector_id | int | ID des am Objekt konfigurierten Anschlusses | ab Version 1.0 |
Rückgabewert
| Wert | Typ | Version |
|---|---|---|
| current_date | string | ab Version 1.0 |
| id | int | ab Version 1.0 |
| message | string | ab Version 1.0 |
patch.grid_connector.update
Beschreibung
Aktualisiert eine bestehende Anschluss-Zuweisung.
Beispielaufruf
{
"method":"patch.grid_connector.update",
"params":{
"apikey":"24174j3tqj",
"id":4,
"data": {
"connector_template_id":4
}
},
"version":"2.0",
"id": 1
}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| connector_template_id | int | ID der Anschluss-Vorlage | ab Version 1.0 |
| connector_id | int | ID des am Objekt konfigurierten Anschlusses | ab Version 1.0 |
Rückgabewert
| Wert | Typ | Version |
|---|---|---|
| current_date | string | ab Version 1.0 |
| id | int | ab Version 1.0 |
| message | string | ab Version 1.0 |
patch.grid_connector.delete
Beschreibung
Löscht eine bestehende Anschluss-Zuweisung.
Beispielaufruf
{
"method":"patch.grid_connector.delete",
"params":{
"apikey":"24174j3tqj",
"id":4
},
"version":"2.0",
"id": 1
}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID der zu löschenden Anschluss-Zuweisung | ab Version 1.0 |
Rückgabewert
| Wert | Typ | Version |
|---|---|---|
| current_date | string | ab Version 1.0 |
| id | int | ab Version 1.0 |
| message | string | ab Version 1.0 |