Seitenvergleich

...

Lesen einer speziellen Strecke:

Codeblock

language	bash
theme	RDark

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

Filtern von Strecken:

Codeblock

language	bash
theme	RDark

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

Parameter

Typ

Beschreibung

Version

id

int

Optional: ID der Strecke

ab Version 1.0

filter

array

Optional: Filter für Strecken

Der Filter unterstützt alle Eigenschaften der Strecke (siehe Rückgabewerte).

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

ab Version 1.0

...

Wert	Typ	Beschreibung	Version
id	int	ID der Strecke	ab Version 1.0
obj_id	int	ID des referenzierten Strecken-Objektes	ab Version 1.0
description	string	Beschreibung der Strecke	ab Version 1.0
user_state_id	int	Nutzer-Status der Strecke	ab Version 1.0
channel_count	int	Anzahl logischer Kanäle	ab Version 1.0
current_channel_count	int	Aktuelle Anzahl logischer Kanäle	ab Version 1.0
start_obj_id	int	ID des ersten Streckenelementes	ab Version 1.0
end_obj_id	int	ID des letzten Streckenelementes	ab Version 1.0
length	int	Länge der Strecken in Meter Hinweis: Die Streckenlänge wird automatisch berechnet.	ab Version 1.0

...

cable.section.create

Beschreibung

Legt eine neue Strecke an.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.section.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"obj_id": 14,
			"description":"Strecke A"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des referenzierten Strecken-Objektes	ab Version 1.0
description	string	Optional: Beschreibung der Strecke	ab Version 1.0
user_state_id	int	Nutzer-Status der Strecke	ab Version 1.0
channel_count	int	Optional: Anzahl logischer Kanäle	ab Version 1.0
current_channel_count	int	Optional: Aktuelle Anzahl logischer Kanäle	ab Version 1.0
start_obj_id	int	Optional: ID des ersten Streckenelementes	ab Version 1.0
end_obj_id	int	Optional: ID des letzten Streckenelementes	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

...

Aktualisiert eine bestehende Strecke.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.section.update",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"data": {
			"description":"Strecke A"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID der Strecke	ab Version 1.0
description	string	Beschreibung der Strecke	ab Version 1.0
user_state_id	int	Nutzer-Status der Strecke	ab Version 1.0
channel_count	int	Anzahl logischer Kanäle	ab Version 1.0
current_channel_count	int	Aktuelle Anzahl logischer Kanäle	ab Version 1.0
start_obj_id	int	ID des ersten Streckenelementes	ab Version 1.0
end_obj_id	int	ID des letzten Streckenelementes	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.section.find_usages

Beschreibung

Findet die Objekte (Netzwege), in denen eine angegebene Strecke verwendet wird.

Beispielaufruf

Codeblock

language	bash
theme	RDark

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

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID des referenzierten Strecken-Objektes	ab Version 1.0

Rückgabewert

Auflistung der Netzwege, in denen die Strecke verwendet wird.

Wert	Typ	Beschreibung	Version
id	int	ID der Netzweg-Kategorie	ab Version 1.0
obj_id	int	ID des Netzweg-Objektes	ab Version 1.0
title	string	Name des Netzweges	ab Version 1.0
type_id	int	ID des Objekttyps (ID des Objekttyps "Netzweg")	ab Version 1.0
type_title	string	Name des Objekttyps (Name des Objekttyps "Netzweg")	ab Version 1.0

...

cable.section.get_connected_objects

Beschreibung

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

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.section.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

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.section.get_section_elements

Beschreibung

Gibt eine Liste aller Elemente einer Strecke zurück.

Beispielaufruf

Codeblock

language	bash
theme	RDark

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

Parameter

Typ

Beschreibung

Version

obj_id

int

ID des Strecken-Objektes

ab Version 1.0

add_connection_information

int

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

Zulässige Werte:

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

ab Version 1.0

add_capacity_information

int

Optional: Gibt die Auslastung des verwendeten Kabels zwischen den beiden Strecken-Elementen an.

Zulässige Werte:

1 (Auslastung wird angezeigt - Standardeinstellung)
0 (Auslastung wird nicht angezeigt)

ab Version 1.0

Rückgabewert

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

...

cable.section.get_calculated_damping

Beschreibung

Gibt die automatisch berechnete Dämpfung einer Strecke aus.

Beispielaufruf

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

Parameter

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

Rückgabewert

Wert	Typ	Beschreibung	Version
length	int	Gesamtlänge der Strecke	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.section.delete

Beschreibung

Löscht eine Strecke.

Beispielaufruf

Codeblock

language	bash
theme	RDark

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

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID der zu löschenden Strecke	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

...

Versionen im Vergleich

Alte Version 3

Neue Version Aktuell

Schlüssel

Parameter

cable.section.create

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

Beispielaufruf

Parameter

Rückgabewert

cable.section.find_usages

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

cable.section.get_connected_objects

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

cable.section.get_section_elements

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

cable.section.get_calculated_damping

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

cable.section.delete

Beschreibung

Beispielaufruf

Parameter

Rückgabewert