Seitenvergleich

...

Gibt die Adern eines Kabels zurück.

Beispielaufruf

Lesen einer speziellen Ader:

Codeblock

language	bash
theme	RDark

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

Filtern von Adern:

Codeblock

language	bash
theme	RDark

{
	"method":"cable.wire.read",
	"params":{
		"apikey":"24174j3tqj",
		"filter": {
			"description": "Ader %"
		}
	},

...


	"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 Adern

Der Filter unterstützt alle Eigenschaften der Ader (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
description	string	Beschreibung der Ader	ab Version 1.0
color	string	Farbe der Ader	ab Version 1.0
scope	string	Leiter-Bereich	ab Version 1.0	state_in
string	eingehender Status der Ader zulässige Werte: H = hängend VH = vorbereitet, hängend R = reserviert	scope_index	int	Bereichs-Index	ab Version 1.0
reserved	int	Ader ist reserviert oder nicht Zulässige Werte: 0 1	ab Version 1.0
user_state_outid	string	ausgehender Status der Ader zulässige Werte: H = hängend VH = vorbereitet, hängend R = reserviertint	ID des Nutzer-Status	ab Version 1.0
user_state	string	Nutzer-Status	ab Version 1.0
descriptionconnection_type_incomingid	string	Bezeichnung eingehendint	Verbindungs-Typ	ab Version 1.0
description_outgoingdamping	stringBezeichnung ausgehend	Dämpfung der Ader	ab Version 1.0
classificationnotice	string	Leiter-TypBemerkung	ab Version 1.0

...

cable.wire.create

...

Legt eine neue Ader zu einem Kabel an.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.wire.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"obj_id":19,
			"description":"Ader 1",
			"number":1
		}
	},

...


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

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des referenzierten Kabels	ab Version 1.0
description	string	Beschreibung der Ader	ab Version 1.0
color	string	Optional: Farbe der Ader	ab Version 1.0	state_in
stringscope	string	Optional: Leiter-Bereich	ab Version 1.0
scope_index	int	Optional: Bereichs-Index	ab Version 1.0
reserved	int	Optional: eingehender Status der Aderzulässige Ader ist reserviert oder nicht Zulässige Werte: H = hängend VH = vorbereitet, hängend R = reserviert0 1	ab Version 1.0
user_state_outid	stringint	Optional: ausgehender Status der Ader zulässige Werte: H = hängend VH = vorbereitet, hängend R = reserviertID des Nutzer-Status	ab Version 1.0
user_state	string	Optional: Nutzer-Status	ab Version 1.0
descriptionconnection_type_incomingid	stringint	Optional: Bezeichnung eingehendVerbindungs-Typ	ab Version 1.0
description_outgoingdamping	string	Optional: Bezeichnung ausgehendDämpfung der Ader	ab Version 1.0
classificationnotice	string	Optional: Leiter-TypBemerkung	ab Version 1.0

Rückgabewert

...

Aktualisiert eine bestehende Ader zu einem Kabel.

Beispielaufruf

Codeblock

language	bash
theme	RDark

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

...

id":4,
		"data": {
			"description":"Ader 1",
			"number":1
		}
	},

...


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

Parameter

Parameter	Typ	Beschreibung	Version
wire_id	int	ID des Datenbankeintrages	ab Version 1.0
description	string	Beschreibung der Ader	ab Version 1.0
color	string	Optional: Farbe der Ader	ab Version 1.0
scope	string	Leiter-Bereich	ab Version 1.0	state_in
string	Optional: eingehender Status der Ader zulässige Werte: H = hängend VH = vorbereitet, hängend R = reserviert	scope_index	int	Bereichs-Index	ab Version 1.0
reserved	int	Ader ist reserviert oder nicht Zulässige Werte: 0 1	ab Version 1.0
user_state_outid	string	Optional: ausgehender Status der Ader zulässige Werte: H = hängend VH = vorbereitet, hängend R = reserviertint	ID des Nutzer-Status	ab Version 1.0
user_state	string	Nutzer-Status	ab Version 1.0
descriptionconnection_type_incomingid	string	Optional: Bezeichnung eingehendint	Verbindungs-Typ	ab Version 1.0
description_outgoingdamping	stringOptional: Bezeichnung ausgehend	Dämpfung der Ader	ab Version 1.0
classificationnotice	string	Optional: Leiter-TypBemerkung	ab Version 1.0

Rückgabewert

...

Generiert automatisch alle Adern eines Kabels, basierend auf dessen Kabeltyp.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.wire.generate_wires",
	"params":{
		"apikey":"24174j3tqj",
		"id":123,

...


		"data": {
			"generator_id":

...

 4,
			"start_pattern": "

...

01/01-10"

...


			"end_pattern": "01/03-14"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des referenzierten Kabels	ab Version 1.0
prefix	string	Optional: Vorsilbe, welche vor den Namen jeder Ader angefügt wirdgenerator_id	int	ID des entsprechenden Generators Weitere Informationen zu Generatoren finden Sie hier: Generator	ab Version 1.0
start_pattern	string	Startwert z.B.: 01/02/1	ab Version 1.0
end_pattern	string	Endwert z.B.: 02/04/4	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.wire.

...

find_usages

Beschreibung

Löscht eine Ader eines KabelsFindet die Objekte, in denen eine angegebene Ader verwendet wird.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.wire.

...

find_usages",
	"params":{
		"apikey":"24174j3tqj",
		"

...

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

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID der Ader	ab Version 1.0

Rückgabewert

Auflistung der Objekte, in denen die Ader verwendet wird.

Wert	Typ	Beschreibung	Version
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
type_title	string	Name des Objekttyps	ab Version 1.0

...

cable.wire.delete

Beschreibung

Löscht eine Ader eines Kabels.

Beispielaufruf

Codeblock

language	bash
theme	RDark

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

Parameter

Parameter	Typ	Beschreibung	Version
wire_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

...

cable.wire.delete_all

Beschreibung

Löscht alle Adern eines Kabels.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.wire.delete_all",
	"params":{
		"apikey":"24174j3tqj",
		"

...

id":123
	},

...


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

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des referenzierten Kabels	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 8

Neue Version Aktuell

Schlüssel

Beispielaufruf

Parameter

cable.wire.create

Beispielaufruf

Parameter

Rückgabewert

Beispielaufruf

Parameter

Rückgabewert

Beispielaufruf

Parameter

Rückgabewert

cable.wire.

find_usages

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

cable.wire.delete

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

cable.wire.delete_all

Beschreibung

Beispielaufruf

Parameter

Rückgabewert