Verwaltung von Adern eines Kabels.
Seitenverzeichnis:
cable.wire.read
Beschreibung
Gibt die Adern eines Kabels zurück.
Beispielaufruf
{"method":"cable.wire.read","params":{"apikey":"24174j3tqj", filter: {"description": "Ader %"}},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| filter | array | Optional: Filter für Adern Der Filter unterstützt alle Eigenschaften der Ader (siehe Rückgabewerte). Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden. | ab Version 1.0 |
Rückgabewert
Liste aller Adern zum angegebenen Kabel.
| Wert | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID des Datenbankeintrages | ab Version 1.0 |
| obj_id | int | ID des referenzierten Kabels | ab Version 1.0 |
| description | string | Beschreibung der Ader | ab Version 1.0 |
| number | int | Nummer der Ader | ab Version 1.0 |
| color | string | Farbe der Ader | ab Version 1.0 |
cable.wire.create
Beschreibung
Legt eine neue Ader zu einem Kabel an.
Beispielaufruf
{"method":"cable.wire.create","params":{"apikey":"24174j3tqj","obj_id":19,"description":"Ader 1","number":1},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| obj_id | int | ID des referenzierten Kabels | ab Version 1.0 |
| description | string | Beschreibung der Ader | ab Version 1.0 |
| number | int | Nummer der Ader | ab Version 1.0 |
| color | string | Farbe der Ader | 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 |
cable.wire.update
Beschreibung
Aktualisiert eine bestehende Ader zu einem Kabel.
Beispielaufruf
{"method":"cable.wire.update","params":{"apikey":"24174j3tqj","wire_id":4,"description":"Ader 1","number":1},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| wire_id | int | ID des Datenbankeintrages | ab Version 1.0 |
| description | string | Beschreibung der Ader | ab Version 1.0 |
| number | int | Nummer der Ader | ab Version 1.0 |
| color | string | Farbe der Ader | 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 |
cable.wire.generate_wires
Beschreibung
Generiert automatisch alle Adern eines Kabels, basierend auf dessen Kabeltyp.
Beispielaufruf
{"method":"cable.wire.generate_wires","params":{"apikey":"24174j3tqj","obj_id":123,"prefix":"MyWire"},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| obj_id | int | ID des referenzierten Kabels | ab Version 1.0 |
| prefix | string | Optional: Vorsilbe, welche vor den Namen jeder Ader angefügt wird | 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 |
cable.wire.delete
Beschreibung
Löscht eine Ader eines Kabels.
Beispielaufruf
{"method":"cable.wire.delete","params":{"apikey":"24174j3tqj","wire_id":4},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| wire_id | int | ID des zu löschenden Datenbankeintrages | 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 |
cable.wire.delete_all
Beschreibung
Löscht alle Adern eines Kabels.
Beispielaufruf
{"method":"cable.wire.delete_all","params":{"apikey":"24174j3tqj","obj_id":123},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| obj_id | int | ID des referenzierten Kabels | 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 |