Virtueller Netzweg

Verwaltung von virtuellen Netzwegen.

Seitenverzeichnis:

cable.virtual_route.read

Beschreibung

Gibt alle virtuellen Netzwege zurück.

Beispielaufruf

Lesen eines speziellen virtuellen Netzweges:

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

Filtern von virtuellen Netzwegen:

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

Parameter

Typ

Beschreibung

Version

id

int

Optional: ID des virtuellen Netzweges

ab Version 1.0

filter

array

Optional: Filter für virtuelle Netzwege

Der Filter unterstützt alle Eigenschaften des virtuellen Netzweges (siehe Rückgabewerte).

Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden.

ab Version 1.0

Rückgabewert

Liste aller virtuellen Netzwege.

Wert	Typ	Beschreibung	Version
id	int	ID des virtuellen Netzweges	ab Version 1.0
obj_id	int	ID des referenzierten virtuellen Netzweg-Objektes	ab Version 1.0
description	string	Beschreibung des virtuellen Netzweges	ab Version 1.0
connection_count	int	Anzahl Verbindungen	ab Version 1.0
current_connection_count	int	Aktuelle Anzahl der Verbindungen	ab Version 1.0
permission	string	Berechtigung	ab Version 1.0
location	string	Standort	ab Version 1.0
room	string	Raum	ab Version 1.0
device_type	string	Endgerätetyp	ab Version 1.0
device_number	string	Geräte Nummer	ab Version 1.0
phone_number	string	Rufnummer	ab Version 1.0
phone_subscriber	string	Teilnehmer	ab Version 1.0
route_usage_id	int	ID der zugewiesenen virtuellen Netzweg-Verwendung Siehe: https://smdocu.atlassian.net/l/c/ikSExjur	ab Version 1.0
hint	string	Hinweis	ab Version 1.0
start_obj_id	int	ID des ersten virtuellen Netzwegelementes	ab Version 1.0
end_obj_id	int	ID des letzten virtuellen Netzwegelementes	ab Version 1.0
length	int	Länge des virtuellen Netzweges in Meter	ab Version 1.0
measured_length	int	Gemessene Länge des virtuellen Netzweges in Meter	ab Version 1.0
measure_date	string	Messdatum des virtuellen Netzweges	ab Version 1.0
tka_participant	string	Name des TKA-Teilnehmers	ab Version 1.0
is_external	int	Gibt an, ob ein virtueller Netzweg vermietet ist	ab Version 1.0
damping_left1	string	Dämpfung des virtuellen Netzweges (A → E 1310nm)	ab Version 1.0
damping_left2	string	Dämpfung des virtuellen Netzweges (A → E 1550nm)	ab Version 1.0
damping_right1	string	Dämpfung des virtuellen Netzweges (E → A 1310nm)	ab Version 1.0
damping_right2	string	Dämpfung des virtuellen Netzweges (E → A 1550nm)	ab Version 1.0

cable.virtual_route.create

Beschreibung

Legt einen neuen virtuellen Netzweg an.

Beispielaufruf

{
	"method":"cable.virtual_route.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"obj_id": 14,
			"description":"Netzweg A",
			"connection_count":40
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des referenzierten virtuellen Netzweg-Objektes	ab Version 1.0
description	string	Beschreibung des virtuellen Netzweges	ab Version 1.0
connection_count	int	Optional: Anzahl Verbindungen	ab Version 1.0
current_connection_count	int	Optional: Aktuelle Anzahl der Verbindungen	ab Version 1.0
permission	string	Optional: Berechtigung	ab Version 1.0
location	string	Optional: Standort	ab Version 1.0
room	string	Optional: Raum	ab Version 1.0
device_type	string	Optional: Endgerätetyp	ab Version 1.0
device_number	string	Optional: Geräte Nummer	ab Version 1.0
phone_number	string	Optional: Rufnummer	ab Version 1.0
phone_subscriber	string	Optional: Teilnehmer	ab Version 1.0
route_usage_id	int	ID der zugewiesenen virtuellen Netzweg-Verwendung Siehe: https://smdocu.atlassian.net/l/c/ikSExjur	ab Version 1.0
hint	string	Optional: Hinweis	ab Version 1.0
start_obj_id	int	Optional: ID des ersten virtuellen Netzwegelementes	ab Version 1.0
end_obj_id	int	Optional: ID des letzten virtuellen Netzwegelementes	ab Version 1.0
length	int	Länge des virtuellen Netzweges in Meter	ab Version 1.0
measured_length	int	Gemessene Länge des virtuellen Netzweges in Meter	ab Version 1.0
measure_date	string	Messdatum des virtuellen Netzweges	ab Version 1.0
tka_participant	string	Optional: Name des TKA-Teilnehmers	ab Version 1.0
is_external	int	Optional: Gibt an, ob ein virtueller Netzweg vermietet ist. Zulässige Werte: 1 (virtuellen Netzweg ist vermietet) 0 (virtuellen Netzweg ist nicht vermietet)	ab Version 1.0
damping_left1	string	Optional: Dämpfung des virtuellen Netzweges (A → E 1310nm)	ab Version 1.0
damping_left2	string	Optional: Dämpfung des virtuellen Netzweges (A → E 1550nm)	ab Version 1.0
damping_right1	string	Optional: Dämpfung des virtuellen Netzweges (E → A 1310nm)	ab Version 1.0
damping_right2	string	Optional: Dämpfung des virtuellen Netzweges (E → A 1550nm)	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.virtual_route.update

Beschreibung

Aktualisiert einen bestehenden virtuellen Netzweg.

Beispielaufruf

{
	"method":"cable.virtual_route.update",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"data": {
			"description":"Netzweg A",
			"connection_count":40
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID des virtuellen Netzweges	ab Version 1.0
description	string	Beschreibung des virtuellen Netzweges	ab Version 1.0
connection_count	int	Anzahl Verbindungen	ab Version 1.0
current_connection_count	int	Aktuelle Anzahl der Verbindungen	ab Version 1.0
permission	string	Berechtigung	ab Version 1.0
location	string	Standort	ab Version 1.0
room	string	Raum	ab Version 1.0
device_type	string	Endgerätetyp	ab Version 1.0
device_number	string	Geräte Nummer	ab Version 1.0
phone_number	string	Rufnummer	ab Version 1.0
phone_subscriber	string	Teilnehmer	ab Version 1.0
route_usage_id	int	ID der zugewiesenen virtuellen Netzweg-Verwendung Siehe: https://smdocu.atlassian.net/l/c/ikSExjur	ab Version 1.0
hint	string	Hinweis	ab Version 1.0
start_obj_id	int	ID des ersten virtuellen Netzwegelementes	ab Version 1.0
end_obj_id	int	ID des letzten virtuellen Netzwegelementes	ab Version 1.0
length	int	Länge des virtuellen Netzweges in Meter	ab Version 1.0
measured_length	int	Gemessene Länge des virtuellen Netzweges in Meter	ab Version 1.0
measure_date	string	Messdatum des virtuellen Netzweges	ab Version 1.0
tka_participant	string	Name des TKA-Teilnehmers	ab Version 1.0
is_external	int	Gibt an, ob ein virtueller Netzweg vermietet ist. Zulässige Werte: 1 (virtuellen Netzweg ist vermietet) 0 (virtuellen Netzweg ist nicht vermietet)	ab Version 1.0
damping_left1	string	Dämpfung des virtuellen Netzweges (A → E 1310nm)	ab Version 1.0
damping_left2	string	Dämpfung des virtuellen Netzweges (A → E 1550nm)	ab Version 1.0
damping_right1	string	Dämpfung des virtuellen Netzweges (E → A 1310nm)	ab Version 1.0
damping_right2	string	Dämpfung des virtuellen Netzweges (E → A 1550nm)	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.virtual_route.get_connected_objects

Beschreibung

Gibt alle freien Verbindungen zu direkt verbundenen Objekten zurück.

Beispielaufruf

{
	"method":"cable.virtual_route.get_connected_objects",
    "params":{
        "apikey":"24174j3tqj",
        "obj_id": 1234
    },
    "version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des Ausgangs-Objektes	ab Version 1.0
wire_id	int	Optional: ID der Ader, von welcher aus das Ausgangs-Objekt verbunden ist	ab Version 1.0
section_id	int	Optional: ID der Strecke, von welcher aus das Ausgangs-Objekt verbunden ist	ab Version 1.0

Rückgabewert

Wert	Typ	Beschreibung	Version
element	array	Informationen zum Ausgangs-Objekt	ab Version 1.0
objects	array	Auflistung aller freien Verbindungen	ab Version 1.0

cable.virtual_route.get_route_elements

Beschreibung

Gibt eine Liste aller Elemente eines virtuellen Netzweges zurück.

Beispielaufruf

{
	"method":"cable.virtual_route.get_route_elements",
	"params":{
		"apikey":"24174j3tqj",
		"obj_id":4
	},
	"version":"2.0",
    "id": 1
}

Parameter

Typ

Beschreibung

Version

obj_id

int

ID des virtuellen Netzweg-Objektes

ab Version 1.0

add_connection_information

int

Optional: Listet alle weiteren, freien Verbindungen zwischen den beiden virtuellen Netzweg-Elementen auf.

Zulässige Werte:

1 (Verbindungen werden angezeigt - Standardeinstellung)
0 (Verbindungen werden nicht angezeigt)

ab Version 1.0

Rückgabewert

Wert	Typ	Beschreibung	Version
result	array	Auflistung der virtuellen Netzweg-Elemente	ab Version 1.0

cable.virtual_route.get_calculated_damping

Beschreibung

Gibt die automatisch berechnete Dämpfung eines virtuellen Netzweges aus.

Beispielaufruf

{
    "method":"cable.virtual_route.get_calculated_damping",
    "params":{
        "apikey":"24174j3tqj",
        "obj_id":4
    },
    "version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des virtuellen Netzweg-Objektes	ab Version 1.0

Rückgabewert

Wert	Typ	Beschreibung	Version
length	int	Gesamtlänge des virtuellen Netzweges	ab Version 1.0
length_1310	float	Wellenlänge 1310nm	ab Version 1.0
length_1550	float	Wellenlänge 1550nm	ab Version 1.0
sum_1310	float	Gesamtdämpfung 1310nm	ab Version 1.0
sum_1550	float	Gesamtdämpfung 1550nm	ab Version 1.0
connectors	array	Liste der beteiligten Anschlüsse mit deren Anzahl und oberer Übergangsdämpfung	ab Version 1.0

cable.virtual_route.validate

Beschreibung

Prüft ob der virtuelle Netzweg als normaler Netzweg ins System übernommen werden kann.

Beispielaufruf

{
	"method":"cable.virtual_route.validate",
    "params":{
        "apikey":"24174j3tqj",
        "obj_id": 1234
    },
    "version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des virtuellen Netzweges	ab Version 1.0

Rückgabewert

Wert	Typ	Beschreibung	Version
is_valid	boolean	Gibt an, ob der virtuelle Netzweg angelegt werden kann oder nicht	ab Version 1.0
message	string	Eine entsprechende Meldung dazu	ab Version 1.0
patched_connectors	array	Falls der Netzweg nicht angelegt kann, werden hier alle bereits gepatchten Anschlüsse aufgelistet	ab Version 1.0

cable.virtual_route.convert

Beschreibung

Übernimmt den virtuellen Netzweg als normalen Netzweg ins System.

Beispielaufruf

{
	"method":"cable.virtual_route.convert",
    "params":{
        "apikey":"24174j3tqj",
        "obj_id": 1234
    },
    "version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des Ausgangs-Objektes	ab Version 1.0

Rückgabewert

Wert	Typ	Beschreibung	Version
current_date	string	Zeitstempel	ab Version 1.0
id	int	ID des neu erzeugten Netzweges	ab Version 1.0
message	string	Ausgabemeldung	ab Version 1.0

cable.virtual_route.delete

Beschreibung

Löscht einen virtuellen Netzweg.

Beispielaufruf

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

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID des zu löschenden virtuellen Netzweges	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