Seitenvergleich

...

Beschreibung

Gibt alle Mikrorohr-Segment Segmente zurück.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.micro_pipe.get_micro_pipe_segments",
	"params":{
		"apikey":"24174j3tqj",
		"data": ,
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
micro_pipe_id	int	Optional: ID des Mikrorohres	ab Version 1.0
segment_ids	array	Optional: Liste von Mikrorohr-Segmenten	ab Version 1.0

Rückgabewert

Wert	Typ	Beschreibung	Version
id	int	ID des Mikrorohr-Segmentes	ab Version 2024.3.0
title	string	Titel des Mikrorohr-Segmentes	ab Version 2024.3.0
number	int	Reihenfolgen-Nummer des Mikrorohr-Segmentes	ab Version 2024.3.0
length	int	Länge des Mikrorohr-Segmentes	ab Version 2024.3.0
is_section_start	boolean	Flag, ob das Mikrorohr-Segment den Startpunkt einer Mikrorohr-Strecke kennzeichnet	ab Version 2024.3.0
cable_id	int	ID des zugewiesenen Kabels	ab Version 2024.3.0
cable_title	string	Titel des zugewiesenen Kabels	ab Version 2024.3.0
micro_pipe_id	int	ID des zugewiesenen Mikrorohres	ab Version 2024.3.0
micro_pipe_title	string	Titel des zugewiesenen Mikrorohres	ab Version 2024.3.0
micro_pipe_group_id	int	ID des zugewiesenen Mikrorohr-Verbundes	ab Version 2024.3.0
micro_pipe_group_title	string	Titel des zugewiesenen Mikrorohr-Verbundes	ab Version 2024.3.0
left_connector_id	int	ID des Mikrorohr-Verbinders links	ab Version 2024.3.0
left_branching_point_id	int	ID der Abzweigstelle links	ab Version 2024.3.0
right_connector_id	int	ID des Mikrorohr-Verbinders rechts	ab Version 2024.3.0
right_branching_point_id	int	ID der Abzweigstelle rechts	ab Version 2024.3.0

...

cable.micro_pipe.get_ending_micro_pipe_segments

Beschreibung

Aktualisiert einen bestehenden AnschlussGibt alle Mikrorohr-Segmente am Anfang und am Ende zurück.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.micro_pipe.get_ending_micro_pipe_segments",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"data": {
			"description":"Anschluss 1",
			"number":1,
			"type":"in"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
micro_pipe_id	int	Optional: ID des Mikrorohres	ab Version 2024.3.0
only_without_cable_assignment	boolean	Optional: Nur Mikrorohr-Segmente ohne Kabel-Zuweisung	ab Version 2024.3.0

Rückgabewert

Wert	Typ	Beschreibung	Version
id	int	ID des

Datenbankeintrages

Mikrorohr-Segmentes

ab Version

1

2024.3.0

description

title

string

Beschreibung

Titel des

Anschlusses

Mikrorohr-Segmentes

ab Version

1

2024.3.0
number	int	Reihenfolgen-Nummer des

Anschlusses

Mikrorohr-Segmentes

ab Version

1

2024.3.0

type

length

stringWertTypVersioncurrent_datestringab Version 1.0idintab Version 1.0messagestringab Version 1

int

Typ des Anschlusses

(zulässige Werte: "in" oder "out")

ab Version 1.0internal_pin_idint

Referenz auf einen anderen Anschluss, mit welchem dieser Anschluss

intern verbunden ist

(bspw. wenn ein Eingang mit einem Ausgang eines Gerätes verbunden ist)

ab Version 1.0patch_pin_idint

Referenz auf einen anderen Anschluss, mit welchem dieser Anschluss

über einen Patch verbunden ist

(bspw. wenn Verbindungen an einem Gerät per Patch verbunden sind)

ab Version 1.0connected_wire_pin_idintReferenz auf einen verbundenen Ader-Anschlussab Version 1.0connector_idintReferenz auf einen verbundenen Anschluss aus der Verkabelungab Version 1.0classificationstringAnschluss-Typab Version 1.0

Rückgabewert

Länge des Mikrorohr-Segmentes	ab Version 2024.3.0
is_section_start	boolean	Flag, ob das Mikrorohr-Segment den Startpunkt einer Mikrorohr-Strecke kennzeichnet	ab Version 2024.3.0
cable_id	int	ID des zugewiesenen Kabels	ab Version 2024.3.0
cable_title	string	Titel des zugewiesenen Kabels	ab Version 2024.3.0
micro_pipe_id	int	ID des zugewiesenen Mikrorohres	ab Version 2024.3.0
micro_pipe_title	string	Titel des zugewiesenen Mikrorohres	ab Version 2024.3.0
micro_pipe_group_id	int	ID des zugewiesenen Mikrorohr-Verbundes	ab Version 2024.3.0
micro_pipe_group_title	string	Titel des zugewiesenen Mikrorohr-Verbundes	ab Version 2024.3.0
left_connector_id	int	ID des Mikrorohr-Verbinders links	ab Version 2024.3.0
left_branching_point_id	int	ID der Abzweigstelle links	ab Version 2024.3.0
right_connector_id	int	ID des Mikrorohr-Verbinders rechts	ab Version 2024.3.0
right_branching_point_id	int	ID der Abzweigstelle rechts	ab Version 2024.3.0

...

cable.micro_pipe.get_connectors

Beschreibung

Findet die Objekte, die mit dem angegebenen Anschluss verbunden sindGibt alle Mikrorohr-Verbinder zurück.

Beispielaufruf

Codeblock

language	bash
theme	RDark

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

...

Parameter	Typ	Beschreibung	Version
idconnector_ids	intarray	Liste von ID des Anschlussesder Anschlüsse	ab Version 12024.3.0

Rückgabewert

...

1Name des Objektes 1type Objekttyps 1typeName Objekttyps 1
Wert Typ Beschreibung Version
id int Kategorie-ID des Objektes ab Version 1.0 objID des Mikrorohr-Verbinders ab Version 2024.3.0
title string Titel des Mikrorohr-Verbinders ab Version 2024.3.0
left_segment_id int
ID des verbundenen Mikrorohr-Segmentes links
ab Version 2024.3.0
right_segment_id int
ID des
Objektes
verbundenen Mikrorohr-Segmentes rechts
ab Version 2024.3.0
branching_point_id int ID der verbundenen Abzweigstelle ab Version 2024.3.0
branching_point_title string Titel der verbundenen Abzweigstelle ab Version 2024.3.0
location_id int ID des Standortes der Abzweigstelle ab Version 2024.3.0
location_title string Titel des Standortes der Abzweigstelle ab Version 2024.3.0

...

cable.micro_pipe.trace_by_micro_pipe_segment

Beschreibung

Löscht einen bestehenden AnschlussGibt die Verbindungen einer Mikrorohr-Strecke anhand eines Mikrorohr-Segmentes aus.

Beispielaufruf

Codeblock

language	bash
theme	RDark

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

Parameter

Parameter	Typ	Beschreibung
segment_id	int	ID des Mikrorohr-Segmentes
error_on_cable_assignment	boolean	Optional:
load_extended_information	boolean	Optional:

Rückgabewert

Wert	Typ	Beschreibung	Version
connector_id	int	ID des Mikrorohr-Verbinders	ab Version 2024.3.0
branching_point_id	int	ID der Abzweigstelle
left_segment_id	int	ID des Mikrorohr-Segmentes links
left_segment_title	string	Titel des Mikrorohr-Segmentes links
right_segment_id	int	ID des Mikrorohr-Segmentes rechts
right_segment_title	string	Titel des Mikrorohr-Segmentes rechts
mit erweiterter Ausgabe:
connector	Connector	Daten des Mikrorohr-Verbinders Die Datenstruktur ist in der Tabelle "Rückgabewerte" des Aufrufes "cable.micro_pipe.get_connectors" beschrieben.
left_segment	Segment	Daten des Mikrorohr-Segmentes links Die Datenstruktur ist in der Tabelle "Rückgabewerte" des Aufrufes "cable.micro_pipe.get_micro_pipe_segments" beschrieben.
right_segment	Segment	Daten des Mikrorohr-Segmentes rechts Die Datenstruktur ist in der Tabelle "Rückgabewerte" des Aufrufes "cable.micro_pipe.get_micro_pipe_segments" beschrieben.

...

cable.micro_pipe.assign_cable_to_micro_pipe_section

...

Codeblock

language	bash
theme	RDark

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

Parameter

Parameter	Typ	Beschreibung	Version
segment_id

Rückgabewert

Wert	Typ	Beschreibung	Version
id	int	ID des Mikrorohr-Verbinders	ab Version 2024.3.0
title	string	Titel des Mikrorohr-Verbinders	ab Version 2024.3.0

...

cable.micro_pipe.reject_cable_from_micro_pipe_section

...

Parameter	Typ	Beschreibung	Version
id	int	ID des zu löschenden Anschlusses	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 4

Schlüssel

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

cable.micro_pipe.get_ending_micro_pipe_segments

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

Rückgabewert

cable.micro_pipe.get_connectors

Beschreibung

Beispielaufruf

Rückgabewert

cable.micro_pipe.trace_by_micro_pipe_segment

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

cable.micro_pipe.assign_cable_to_micro_pipe_section

Parameter

Rückgabewert

cable.micro_pipe.reject_cable_from_micro_pipe_section

Rückgabewert

Wert	Typ	Beschreibung	Version
id	int	Kategorie-ID des Objektes	ab Version 1.0	objID des Mikrorohr-Verbinders	ab Version 2024.3.0
title	string	Titel des Mikrorohr-Verbinders	ab Version 2024.3.0
left_segment_id	int	ID des verbundenen Mikrorohr-Segmentes links	ab Version 2024.3.0
right_segment_id	int	ID des Objektes verbundenen Mikrorohr-Segmentes rechts	ab Version 2024.3.0
branching_point_id	int	ID der verbundenen Abzweigstelle	ab Version	2024.3.0
branching_point_title	string	Titel der verbundenen Abzweigstelle	ab Version	2024.3.0
location_id	int	ID des	Standortes der Abzweigstelle	ab Version	2024.3.0
location_title	string	Titel des	Standortes der Abzweigstelle	ab Version	2024.3.0