...
Lesen eines speziellen Netzweg-Elements:
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{
"method":"cable.route_element.read",
"params":{
"apikey":"24174j3tqj",
"id": 4
},
"version":"2.0",
"id": 1
} |
Filtern von Netzweg-Elementen:
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{
"method":"cable.route_element.read",
"params":{
"apikey":"24174j3tqj",
"filter": {
"descriptionindex": "Typ %"1
}
},
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | Optional: ID des Netzweg-Elementes | ab Version 1.0 |
| filter | array | Optional: Filter für Netzweg-Elemente Der Filter unterstützt alle Eigenschaften des Netzweg-Elementes (siehe Rückgabewerte). Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden. | ab Version 1.0 |
...
| Wert | Typ | Beschreibung | Version | ||||
|---|---|---|---|---|---|---|---|
| id | int | ID des Netzweg-Elementes | ab Version 1.0 | ||||
| route_id | int | ID des referenzierten Netzweges | ab Version 1.0 | ||||
| wire_id | int | ID der referenzierten Ader | ab Version 1.0 | ||||
| section_id | int | ID der referenzierten Strecke | ab Version 1.0 | ||||
| index | int | Index innerhalb der Reihenfolge der Elemente eines Netzweges | ab Version 1.0 | description | string | Beschreibung des Netzweg-Elementes | ab Version 1.0 |
...
cable.route_element.create
...
Legt ein neues Netzweg-Element an.
Beispielaufruf
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{
"method":"cable.route_element.create",
"params":{
"apikey":"24174j3tqj",
"data": {
"route_id":1,
"wire_id":2,
"index":1,
"description":"Netzweg-Element 1"
}
},
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version | ||||
|---|---|---|---|---|---|---|---|
| route_id | int | ID des referenzierten Netzweges | ab Version 1.0 | ||||
| index | int | Index innerhalb der Reihenfolge der Elemente eines Netzweges | ab Version 1.0 | description | string | Optional: Beschreibung des Netzweg-Elementes | ab Version 1.0 |
| wire_id | int | Optional: ID der referenzierten Ader (Hinweis: wire_id oder section_id muss gesetzt werden!) | ab Version 1.0 | ||||
| section_id | int | Optional: ID der referenzierten Strecke (Hinweis: wire_id oder section_id muss gesetzt werden!) | ab Version 1.0 |
...
Aktualisiert ein bestehendes Netzweg-Element.
Beispielaufruf
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{
"method":"cable.route_element.update",
"params":{
"apikey":"24174j3tqj",
"id":4,
"data": {
"descriptionwire_id":"Netzweg-Element 1" 8
}
},
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version | |
|---|---|---|---|---|
| id | int | ID des Netzweg-Elementes | ab Version 1.0 | |
| index | int | Index innerhalb der Reihenfolge der Elemente eines Netzweges | ab Version 1.0 | |
| wire_id | int | ID der referenzierten Ader | ab Version 1.0description | |
| section_id | string | Beschreibung des Netzweg-Elementesint | ID der referenzierten 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 |
...
Wichtig: Es kann immer nur das jeweils letzte Netzweg-Element gelöscht werden. Ein Löschen von Elementen innerhalb eines Netzweges ist nicht möglich.
Beispielaufruf
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{
"method":"cable.route_element.delete",
"params":{
"apikey":"24174j3tqj",
"id":4
},
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID des zu löschenden Netzweg-Elementes | ab Version 1.0 |
...