Content Comparison

...

Gibt die spezifische Eigenschaften eines Kabels zurück.

Beispielaufruf

Lesen eines speziellen Kabels:

Codeblock

language	bash
theme	RDark

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

Filtern von Kabeln:

Codeblock

language	bash
theme	RDark

{
	"method":"cable.cable.read",
	"params":{
		"apikey":"24174j3tqj",
		"filter": {
			"state": "ok"
		}
	},

...


	"version":"2.0",
    "id": 1
}

Parameter

Typ

Beschreibung

Version

id

int

Optional: ID des Datenbankeintrages

ab Version 1.0

filter

array

Optional: Filter für Kabel

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

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

ab Version 1.0

...

Wert	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	ab Version 1.0
obj_id	int	ID des referenzierten Kabels	ab Version 1.0
state_id	stringint	Nutzer-Status des Kabels	ab Version 1.0
user_state	string	Nutzerstatus	ab Version 1.0
group_id	int	Zugehörige Kabelgruppe	ab Version 1.0
type_id	int	Zugehöriger Kabeltyp	ab Version 1.0
length	int	Länge des Kabels	ab Version 1.0
capacity	int	Angabe zur Kabelauslastung in Prozent	ab Version 1.0
admin_unit_id	int	Verwaltungseinheit des Kabels	ab Version 1.0
net_type	string	Netzart	ab Version 1.0
connectionlocation_typein_id	intVerbindungs	-TypStandort ankommend	ab Version 1.0
location_inout_id	int	Standort ankommendabgehend	ab Version 1.0	location_out_id	int
Standort abgehendwire_count	int	Anzahl der Adern des Kabels	ab Version 1.0
free_wires	int	Anzahl der freien Adern des Kabels	ab Version 1.0
wirepatched_countwires	int	Anzahl der gepatchten Adern des Kabels	ab Version 1.0

...

Legt neue Eigenschaften zu einem Kabel an.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.cable.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"obj_id":19,
			"state_id":

...

4,
			"group_id":

...

8,
			"length":100
		}

...


	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des referenzierten Kabels	ab Version 1.0
state_id	stringint	Optional: Nutzer-Status des Kabels	ab Version 1.0
user_state	string	Optional: Nutzerstatus	ab Version 1.0
group_id	int	Optional: Zugehörige Kabelgruppe	ab Version 1.0
type_id	int	Optional: Zugehöriger Kabeltyp	ab Version 1.0
length	int	Optional: Länge des Kabels	ab Version 1.0
capacity	int	Optional: Angabe zur Kabelauslastung in Prozent	ab Version 1.0
admin_unit_id	int	Optional: Verwaltungseinheit des Kabels	ab Version 1.0
net_type	string	Optional: Netzart	ab Version 1.0	connection_type_id	int	Optional: Verbindungs-Typ	ab Version 1.0
location_in_id	int	Optional: Standort ankommend	ab Version 1.0
location_out_id	int	Optional: Standort abgehend	ab Version 1.0

...

Aktualisiert bestehende Eigenschaften zu einem Kabel.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.cable.update",
	"params":{
		"apikey":"24174j3tqj",
		"

...

id":4,
		"

...

data":

...

 {
			"state_id":24,
			"group_id":14,
			"length":100
		}
	},

...


	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
cable_id	int	ID des Datenbankeintrages	ab Version 1.0
state_id	stringint	Optional: Nutzer-Status des Kabels	ab Version 1.0
user_state	string	Nutzerstatus	ab Version 1.0
group_id	int	Optional: Zugehörige Kabelgruppe	ab Version 1.0
type_id	int	Optional: Zugehöriger Kabeltyp	ab Version 1.0
length	int	Optional: Länge des Kabels	ab Version 1.0
capacity	int	Optional: Angabe zur Kabelauslastung in Prozent	ab Version 1.0
admin_unit_id	int	Optional: Verwaltungseinheit des Kabels	ab Version 1.0
net_type	string	Optional: Netzart	ab Version 1.0
connectionlocation_typein_id	intOptional	: Verbindungs-TypStandort ankommend	ab Version 1.0
location_inout_id	int	Optional: Standort ankommendStandort abgehend	ab Version 1.0

Rückgabewert

Optional: Standort abgehend

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

...

cable.cable.find_usages

Beschreibung

Findet die Objekte, in denen ein angegebenes Kabel verwendet wird.

Beispielaufruf

Codeblock

language	bash
theme	RDark

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

Parameter

Paramter	Typ	Beschreibung	Version
id	int	ID des referenzierten Kabel-Objektes	ab Version 1.0

Rückgabewert

Auflistung der Objekte, in denen das Kabel verwendet wird.

Wert	Typ	Beschreibung	Version

current_datestring


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

message

type_title

string

Name des Objekttyps

ab Version 1.0

...

cable.cable.delete

Beschreibung

Löscht die spezifischen Eigenschaften eines Kabels.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.cable.delete",
	"params":{
		"apikey":"24174j3tqj",
		"

...

id":4
	},

...


	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
cable_id	int	ID des zu löschenden Datenbankeintrages	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

...

Version	Alte Version 14	Neue Version Aktuell
Änderungen wurden vorgenommen von	Steve Gröber	Steve Gröber
Gespeichert am	Juli 18, 2018	Juli 30, 2020

Versionen im Vergleich

Schlüssel

Beispielaufruf

Parameter

Beispielaufruf

Parameter

Beispielaufruf

Parameter

Rückgabewert

cable.cable.find_usages

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

cable.cable.delete

Beschreibung

Beispielaufruf

Parameter

Rückgabewert