...
| Codeblock |
|---|
|
{
"method":"cable.section.get_connected_objects",
"params":{
"apikey":"24174j3tqj",
"obj_id": 1234
},
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|
| obj_id | int | ID des Ausgangs-Objektes | ab Version 1.0 |
| wire_id | int | Optional: ID der Ader, von welcher aus das Ausgangs-Objekt verbunden ist | ab Version 1.0 |
Rückgabewert
| Wert | Typ | Beschreibung | Version |
|---|
| element | array | Informationen zum Ausgangs-Objekt | ab Version 1.0 |
| objects | array | Auflistung aller freien Verbindungen | ab Version 1.0 |
...
cable.section.get_section_elements
Beschreibung
Gibt eine Liste aller Elemente einer Strecke zurück.
Beispielaufruf
| Codeblock |
|---|
|
{
"method":"cable.section.get_section_elements",
"params":{
"apikey":"24174j3tqj",
"obj_id":4
},
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|
| obj_id | int | ID des Strecken-Objektes | ab Version 1.0 |
| add_connection_information | int | Listet alle weiteren, freien Verbindungen zwischen den beiden Strecken-Elementen auf. Zulässige Werte: - 1 (Verbindungen werden angezeigt - Standardeinstellung)
- 0 (Verbindungen werden nicht angezeigt)
| ab Version 1.0 |
| add_capacity_information | int | Gibt die Auslastung des verwendeten Kabels zwischen den beiden Strecken-Elementen an. Zulässige Werte: - 1 (Auslastung wird angezeigt - Standardeinstellung)
- 0 (Auslastung wird nicht angezeigt)
| ab Version 1.0 |
Rückgabewert
| Wert | Typ | Beschreibung | Version |
|---|
| result | array | Auflistung der Strecken-Elemente | ab Version 1.0 |
...
cable.section.delete
Beschreibung
Löscht eine Strecke.
Beispielaufruf
| Codeblock |
|---|
|
{
"method":"cable.section.delete",
"params":{
"apikey":"24174j3tqj",
"id":4
},
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|
| id | int | ID der zu löschenden Strecke | 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 |
...