Ader

Verwaltung von Adern eines Kabels.

Seitenverzeichnis:

1 cable.wire.read
2 cable.wire.create
3 cable.wire.update
4 cable.wire.generate_wires
5 cable.wire.find_usages
6 cable.wire.delete
7 cable.wire.delete_all

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",
    "id": 1
}

Filtern von Adern:

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

Parameter

Parameter	Typ	Beschreibung	Version

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

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
user_state_id	int	ID des Nutzer-Status	ab Version 1.0
user_state	string	Nutzer-Status	ab Version 1.0
connection_type_id	int	Verbindungs-Typ	ab Version 1.0
damping	string	Dämpfung der Ader	ab Version 1.0
notice	string	Bemerkung	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",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

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
user_state_id	int	Optional: ID des Nutzer-Status	ab Version 1.0
user_state	string	Optional: Nutzer-Status	ab Version 1.0
connection_type_id	int	Optional: Verbindungs-Typ	ab Version 1.0
damping	string	Optional: Dämpfung der Ader	ab Version 1.0
notice	string	Optional: Bemerkung	ab Version 1.0

Rückgabewert

Wert	Typ	Version

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",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

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
user_state_id	int	ID des Nutzer-Status	ab Version 1.0
user_state	string	Nutzer-Status	ab Version 1.0
connection_type_id	int	Verbindungs-Typ	ab Version 1.0
damping	string	Dämpfung der Ader	ab Version 1.0
notice	string	Bemerkung	ab Version 1.0

Rückgabewert

Wert	Typ	Version

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": {
			"generator_id": 4,
			"start_pattern": "01/01-10",
			"end_pattern": "01/03-14"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

Parameter	Typ	Beschreibung	Version
id	int	ID des referenzierten Kabels	ab Version 1.0
generator_id	int	ID des entsprechenden Generators Weitere Informationen zu Generatoren finden Sie hier: Generator	ab Version 1.0
start_pattern	string	Startwert z.B.: 01/02/1	ab Version 1.0
end_pattern	string	Endwert z.B.: 02/04/4	ab Version 1.0

Rückgabewert

Wert	Typ	Version

Wert	Typ	Version
current_date	string	ab Version 1.0
id	int	ab Version 1.0
message	string	ab Version 1.0

cable.wire.find_usages

Beschreibung

Findet die Objekte, in denen eine angegebene Ader verwendet wird.

Beispielaufruf

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

Parameter

Parameter	Typ	Beschreibung	Version

Parameter	Typ	Beschreibung	Version
id	int	ID der Ader	ab Version 1.0

Rückgabewert

Auflistung der Objekte, in denen die Ader verwendet wird.

Wert	Typ	Beschreibung	Version

Wert	Typ	Beschreibung	Version
id	int	Kategorie-ID des Objektes	ab Version 1.0
obj_id	int	ID des Objektes	ab Version 1.0
title	string	Name des Objektes	ab Version 1.0
type_id	int	ID des Objekttyps	ab Version 1.0
type_title	string	Name des Objekttyps	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",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

Parameter	Typ	Beschreibung	Version
id	int	ID des zu löschenden Datenbankeintrages	ab Version 1.0