Tracing

Verfolgen von Verbindungen zwischen Objekten.

1 cable.tracing.between_locations
2 cable.tracing.between_objects
3 cable.tracing.shortest_path
4 cable.tracing.least_number_of_hops

cable.tracing.between_locations

Beschreibung

Gibt alle Verbindungen (belegt und frei) zwischen zwei Standorten zurück.

Beispielaufruf

{
	"method":"cable.tracing.between_locations",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"location_start": 8,
			"location_end": 14
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
location_start	int	ID des ausgehenden Standortes	ab Version 1.0
location_end	int	ID des eingehenden Standortes	ab Version 1.0

Rückgabewert

Liste aller Verbindungen zwischen den angegebenen Standorten.

Wert	Typ	Beschreibung	Version
nodes	array	Alle Objekte zwischen den Standorten	ab Version 1.0
edges	array	Alle Verbindungen zwischen den Objekten	ab Version 1.0

cable.tracing.between_objects

Beschreibung

Gibt alle Verbindungen (belegt und frei) zwischen zwei Objekten zurück.

Beispielaufruf

{
	"method":"cable.tracing.between_objects",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"object_start": 44,
			"object_end": 125
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
object_start	int	ID des ausgehenden Objektes	ab Version 1.0
object_end	int	ID des eingehenden Objektes	ab Version 1.0

Rückgabewert

Liste aller Verbindungen zwischen den angegebenen Objekten.

Wert	Typ	Beschreibung	Version
nodes	array	Alle Objekte zwischen den beiden angegebenen Objekten	ab Version 1.0
edges	array	Alle Verbindungen zwischen den angegebenen Objekten	ab Version 1.0

cable.tracing.shortest_path

Beschreibung

Gibt den kürzesten, freien Weg zwischen zwei Objekten, gewichtet nach Kabellänge, zurück.

Beispielaufruf

{
	"method":"cable.tracing.shortest_path",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"object_start": 44,
			"object_end": 125
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter

Typ

Beschreibung

Version

object_start

int

ID des ausgehenden Objektes

ab Version 1.0

object_end

int

ID des eingehenden Objektes

ab Version 1.0

exclude_sections

boolean

Optional: Strecken bei der Berechnung nicht berücksichtigen

Zulässige Werte:

0: Strecken berücksichtigen
1: Strecken nicht berücksichtigen

ab Version 1.0

Rückgabewert

Liste der Pfad-Elemente.

Wert

Typ

Beschreibung

Version

from

int

ID des ausgehenden Objektes

ab Version 1.0

to

int

ID des eingehenden Objektes

ab Version 1.0

wires

array

Verbindungen zwischen den Objekten

(Mehrere Verbindungen kommen nur bei gleicher Kabellänge vor.)

ab Version 1.0

cable.tracing.least_number_of_hops

Beschreibung

Gibt den freien Weg mit den wenigsten Zwischen-Objekten zwischen zwei Objekten zurück.

Beispielaufruf

{
	"method":"cable.tracing.least_number_of_hops",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"object_start": 44,
			"object_end": 125
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter

Typ

Beschreibung

Version

object_start

int

ID des ausgehenden Objektes

ab Version 1.0

object_end

int

ID des eingehenden Objektes

ab Version 1.0

exclude_sections

boolean

Optional: Strecken bei der Berechnung nicht berücksichtigen

Zulässige Werte:

0: Strecken berücksichtigen
1: Strecken nicht berücksichtigen

ab Version 1.0

Rückgabewert

Liste der Pfad-Elemente.

Wert	Typ	Beschreibung	Version
from	int	ID des ausgehenden Objektes	ab Version 1.0
to	int	ID des eingehenden Objektes	ab Version 1.0
wires	array	Verbindungen zwischen den Objekten	ab Version 1.0