Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

...

WertTypBeschreibungVersion
idintID des Netzwegesab Version 1.0
obj_idintID des referenzierten Netzweg-Objektesab Version 1.0
descriptionstringBeschreibung des Netzwegesab Version 1.0
connection_countintAnzahl Verbindungenab Version 1.0
current_connection_countintAktuelle Anzahl der Verbindungenab Version 1.0
permissionstringBerechtigungab Version 1.0
locationstringStandortab Version 1.0
roomstringRaumab Version 1.0
device_typestringEndgerätetypab Version 1.0
device_numberstringGeräte Nummerab Version 1.0
phone_numberstringRufnummerab Version 1.0
phone_subscriberstringTeilnehmerab Version 1.0
route_usage_idint

ID der zugewiesenen Netzweg-Verwendung

Siehe: https://smdocu.atlassian.net/l/c/ikSExjur

ab Version 1.0
hintstringHinweisab Version 1.0
start_obj_idintID des ersten StreckenelementesNetzwegelementesab Version 1.0
end_obj_idintID des letzten StreckenelementesNetzwegelementesab Version 1.0
measured_lengthintGemessene Länge des virtuellen Netzweges in Meterab Version 1.0
measure_datestringMessdatum des virtuellen Netzwegesab Version 1.0
tka_participantstringName des TKA-Teilnehmersab Version 1.0
is_externalintGibt an, ob ein Netzweg vermietet istab Version 1.0
associated_routeintID des zugehörigen Netzwegesab Version 1.0
damping_left1stringDämpfung des Netzweges (A → E 1310nm)ab Version 1.0
damping_left2stringDämpfung des Netzweges (A → E 1550nm)ab Version 1.0
damping_right1stringDämpfung des Netzweges (E → A 1310nm)ab Version 1.0
damping_right2stringDämpfung des Netzweges (E → A 1550nm)ab Version 1.0


...

cable.route.create

Beschreibung

...

ParameterTypBeschreibungVersion
obj_idintID des referenzierten Netzweg-Objektesab Version 1.0
descriptionstringBeschreibung des Netzwegesab Version 1.0
connection_countintOptional: Anzahl Verbindungenab Version 1.0
current_connection_countintOptional: Aktuelle Anzahl der Verbindungenab Version 1.0
permissionstringOptional: Berechtigungab Version 1.0
locationstringOptional: Standortab Version 1.0
roomstringOptional: Raumab Version 1.0
device_typestringOptional: Endgerätetypab Version 1.0
device_numberstringOptional: Geräte Nummerab Version 1.0
phone_numberstringOptional: Rufnummerab Version 1.0
phone_subscriberstringOptional: Teilnehmerab Version 1.0
route_usage_idint

ID der zugewiesenen Netzweg-Verwendung

Siehe: https://smdocu.atlassian.net/l/c/ikSExjur

ab Version 1.0
hintstringOptional: Hinweisab Version 1.0
start_obj_idintOptional: ID des ersten StreckenelementesNetzwegelementesab Version 1.0
end_obj_idintOptional: ID des letzten StreckenelementesNetzwegelementesab Version 1.0
measured_lengthintGemessene Länge des virtuellen Netzweges in Meterab Version 1.0
measure_datestringMessdatum des virtuellen Netzwegesab Version 1.0
tka_participantstringOptional: Name des TKA-Teilnehmersab Version 1.0
is_externalint

Optional: Gibt an, ob ein Netzweg vermietet ist.

Zulässige Werte:

  • 1 (Netzweg ist vermietet)
  • 0 (Netzweg ist nicht vermietet)
ab Version 1.0
associated_routeintOptional: ID des zugehörigen Netzwegesab Version 1.0
damping_left1stringOptional: Dämpfung des Netzweges (A → E 1310nm)ab Version 1.0
damping_left2stringOptional: Dämpfung des Netzweges (A → E 1550nm)ab Version 1.0
damping_right1stringOptional: Dämpfung des Netzweges (E → A 1310nm)ab Version 1.0
damping_right2stringOptional: Dämpfung des Netzweges (E → A 1550nm)ab Version 1.0
redundant_routesstringOptional: Kommaseparierte Liste von redundanten Netzweg-IDsab Version 1.0

Rückgabewert

WertTypVersion
current_datestringab Version 1.0
idintab Version 1.0
messagestringab Version 1.0

...

ParameterTypBeschreibungVersion
idintID des Netzwegesab Version 1.0
descriptionstringBeschreibung des Netzwegesab Version 1.0
connection_countintAnzahl Verbindungenab Version 1.0
current_connection_countintAktuelle Anzahl der Verbindungenab Version 1.0
permissionstringBerechtigungab Version 1.0
locationstringStandortab Version 1.0
roomstringRaumab Version 1.0
device_typestringEndgerätetypab Version 1.0
device_numberstringGeräte Nummerab Version 1.0
phone_numberstringRufnummerab Version 1.0
phone_subscriberstringTeilnehmerab Version 1.0
route_usage_idint

ID der zugewiesenen Netzweg-Verwendung

Siehe: https://smdocu.atlassian.net/l/c/ikSExjur

ab Version 1.0
hintstringHinweisab Version 1.0
start_obj_idintID des ersten StreckenelementesNetzwegelementesab Version 1.0
end_obj_idintID des letzten StreckenelementesNetzwegelementesab Version 1.0
measured_lengthintGemessene Länge des virtuellen Netzweges in Meterab Version 1.0
measure_datestringMessdatum des virtuellen Netzwegesab Version 1.0
tka_participantstringName des TKA-Teilnehmersab Version 1.0
is_externalint

Gibt an, ob ein Netzweg vermietet ist.

Zulässige Werte:

  • 1 (Netzweg ist vermietet)
  • 0 (Netzweg ist nicht vermietet)
ab Version 1.0
associated_routeintID des zugehörigen Netzwegesab Version 1.0
damping_left1stringDämpfung des Netzweges (A → E 1310nm)ab Version 1.0
damping_left2stringDämpfung des Netzweges (A → E 1550nm)ab Version 1.0
damping_right1stringDämpfung des Netzweges (E → A 1310nm)ab Version 1.0
damping_right2stringDämpfung des Netzweges (E → A 1550nm)ab Version 1.0
redundant_routesstringKommaseparierte Liste von redundanten Netzweg-IDsab Version 1.0

Rückgabewert

WertTypVersion
current_datestringab Version 1.0
idintab Version 1.0
messagestringab Version 1.0

...

WertTypBeschreibungVersion
resultarrayAuflistung der Netzweg-Elementeab Version 1.0


...

cable.route.get_calculated_damping

Beschreibung

Gibt die automatisch berechnete Dämpfung eines Netzweges aus.

Beispielaufruf

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

Parameter

ParameterTypBeschreibungVersion
obj_idintID des Netzweg-Objektesab Version 1.0

Rückgabewert

WertTypBeschreibungVersion
lengthintGesamtlänge des Netzwegesab Version 1.0
length_1310floatWellenlänge 1310nmab Version 1.0
length_1550floatWellenlänge 1550nmab Version 1.0
sum_1310floatGesamtdämpfung 1310nmab Version 1.0
sum_1550floatGesamtdämpfung 1550nmab Version 1.0
connectorsarrayListe der beteiligten Anschlüsse mit deren Anzahl und oberer Übergangsdämpfungab Version 1.0


...

cable.route.get_redundant_routes

Beschreibung

Gibt die redundanten Netzwege zu einem Netzweg aus.

Beispielaufruf

Codeblock
{
    "method":"cable.route.get_redundant_routes",
    "params":{
        "apikey":"24174j3tqj",
        "obj_id":4
    },
    "version":"2.0",
    "id": 1
}

Parameter

ParameterTypBeschreibungVersion
obj_idintID des Netzweg-Objektesab Version 1.0

Rückgabewert

Auflistung aller redundaten Netzwege.

WertTypBeschreibungVersion
idintID des Netzweg-Objektesab Version 1.0
ltitlestringBezeichnung des Netzweg-Objektesab Version 1.0


...

cable.route.delete

Beschreibung

Löscht einen Netzweg.

Beispielaufruf

Codeblock
languagebash
themeRDark
{
	"method":"cable.route.delete",
	"params":{
		"apikey":"24174j3tqj",
		"id":4
	},
	"version":"2.0",
    "id": 1
}

Parameter

ParameterTypBeschreibungVersion
idintID des zu löschenden Netzwegesab Version 1.0

Rückgabewert

WertTypVersion
current_datestringab Version 1.0
idintab Version 1.0
messagestringab Version 1.0

...