Ader

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

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
color	string	Farbe der Ader	ab Version 1.0
state_in	string	eingehender Status der Ader zulässige Werte: H = hängend VH = vorbereitet, hängend R = reserviert	ab Version 1.0
state_out	string	ausgehender Status der Ader zulässige Werte: H = hängend VH = vorbereitet, hängend R = reserviert	ab Version 1.0
description_incoming	string	Bezeichnung eingehend	ab Version 1.0
description_outgoing	string	Bezeichnung ausgehend	ab Version 1.0
classification	string	Leiter-Typ	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
color	string	Optional: Farbe der Ader	ab Version 1.0
state_in	string	Optional: eingehender Status der Ader zulässige Werte: H = hängend VH = vorbereitet, hängend R = reserviert	ab Version 1.0
state_out	string	Optional: ausgehender Status der Ader zulässige Werte: H = hängend VH = vorbereitet, hängend R = reserviert	ab Version 1.0
description_incoming	string	Optional: Bezeichnung eingehend	ab Version 1.0
description_outgoing	string	Optional: Bezeichnung ausgehend	ab Version 1.0
classification	string	Optional: Leiter-Typ	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
color	string	Optional: Farbe der Ader	ab Version 1.0
state_in	string	Optional: eingehender Status der Ader zulässige Werte: H = hängend VH = vorbereitet, hängend R = reserviert	ab Version 1.0
state_out	string	Optional: ausgehender Status der Ader zulässige Werte: H = hängend VH = vorbereitet, hängend R = reserviert	ab Version 1.0
description_incoming	string	Optional: Bezeichnung eingehend	ab Version 1.0
description_outgoing	string	Optional: Bezeichnung ausgehend	ab Version 1.0
classification	string	Optional: Leiter-Typ	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
start_pattern	string	Optional: Anfangs-Muster, anhand dessen die laufenden Nummern der Adern gebildet werden. Unterstützt werden: einzelne numerische Werte Muster im Format: XX-YYY-ZZ mit jeweils beliebiger Länge der einzelnen Teile	ab Version 1.0
end_pattern	string	Optional: End-Muster, bis zu welchem die laufenden Nummern der Adern gebildet werden. Unterstützt werden: einzelne numerische Werte Muster im Format: XX-YYY-ZZ mit jeweils beliebiger Länge der einzelnen Teile Beispiel 1: Anfangs-Muster: "4" End-Muster: "8" Vorsilbe: "Ader-" Ergebnis: Es werden fünf Adern generiert "Ader-4" "Ader-5" "Ader-6" "Ader-7" "Ader-8" Beispiel 2: Anfangs-Muster: "01-010" End-Muster: "03-012" Vorsilbe: "Ader-" Ergebnis: Es werden neun Adern generiert "Ader-01-010" "Ader-01-011" "Ader-01-012" "Ader-02-010" "Ader-02-011" "Ader-02-012" "Ader-03-010" "Ader-03-011" "Ader-03-012"	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