Ader

Verwaltung von Adern eines Kabels.

Seitenverzeichnis:

cable.wire.read

Beschreibung

Gibt die Adern eines Kabels zurück.

Beispielaufruf

Lesen einer speziellen Ader:

{
	"method":"cable.wire.read",
	"params":{
		"apikey":"24174j3tqj",
		"id": 4
	},
	"version":"2.0"
}

Filtern von Adern:

{
	"method":"cable.wire.read",
	"params":{
		"apikey":"24174j3tqj",
		"filter": {
			"description": "Ader %"
		}
	},
	"version":"2.0"
}

Parameter

Typ

Beschreibung

Version

id

int

Optional: ID des Datenbankeintrages

ab Version 1.0

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
scope	string	Leiter-Bereich	ab Version 1.0
scope_index	int	Bereichs-Index	ab Version 1.0
reserved	int	Ader ist reserviert oder nicht Zulässige Werte: 0 1	ab Version 1.0

cable.wire.create

Beschreibung

Legt eine neue Ader zu einem Kabel an.

Beispielaufruf

{
	"method":"cable.wire.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"obj_id":19,
			"description":"Ader 1",
			"number":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
scope	string	Optional: Leiter-Bereich	ab Version 1.0
scope_index	int	Optional: Bereichs-Index	ab Version 1.0
reserved	int	Optional: Ader ist reserviert oder nicht Zulässige Werte: 0 1	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",
		"id":4,
		"data": {
			"description":"Ader 1",
			"number":1
		}
	},
	"version":"2.0"
}

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	ab Version 1.0
description	string	Beschreibung der Ader	ab Version 1.0
color	string	Farbe der Ader	ab Version 1.0
scope	string	Leiter-Bereich	ab Version 1.0
scope_index	int	Bereichs-Index	ab Version 1.0
reserved	int	Ader ist reserviert oder nicht Zulässige Werte: 0 1	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",
		"id":123,
		"data": {
			"prefix":"MyWire",
			"start_pattern": "01/01-10",
			"end_pattern": "01/03-14"
		}
	},
	"version":"2.0"
}

Parameter

Parameter	Typ	Beschreibung	Version
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 Folgende Trenner sind für Muster erlaubt: - , /	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 Folgende Trenner sind für Muster erlaubt: - , / 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",
		"id":4
	},
	"version":"2.0"
}

Parameter

Parameter	Typ	Beschreibung	Version
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",
		"id":123
	},
	"version":"2.0"
}

Parameter

Parameter	Typ	Beschreibung	Version
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