Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

Verwaltung von MikrorohrenMikrorohr-Segmenten.

Seitenverzeichnis:

Inhalt
maxLevel2
indent10px
stylesquare

...

cable.micro_pipe

...

Beschreibung

Gibt alle Mikrorohr-Verbände zurück.

Beispielaufruf

Codeblock
languagebash
themeRDark
{
	"method":"cable.micro_pipe.get_micro_pipe_groups",
	"params":{
		"apikey":"24174j3tqj"
	},
	"version":"2.0",
    "id": 1
}

Parameter

keine

Rückgabewert

Gibt alle Mikrorohr-Verbände mit deren Mikrorohren aus.

...

Auflistung der zugewiesenen Mikrorohre mit folgenden Eigenschaften:

  • id → ID des Mikrorohres
  • title → Titel
  • length → Länge
  • color → Farbe
  • diameter_inside → Innendurchmesser
  • diameter_outside → Außendurchmesser
  • thickness → Wandstärke

...

_segment.read

Beschreibung

Gibt alle Mikrorohr-Segmente zurück.

Beispielaufruf

Codeblock
languagebash
themeRDark
{
	"method":"cable.micro_pipe.get_micro_pipe_segments_segment.read",
	"params":{
		"apikey":"24174j3tqj",
		"micro_pipe_id": 4,
	},
	"version":"2.0",
    "id": 1
}

Parameter

ParameterTypBeschreibungVersion
micro_pipe_idintOptional: ID des Mikrorohresab Version 2024.3.0
segment_idsarrayOptional:  Liste von IDs von Mikrorohr-Segmentenab Version 2024.3.0

Rückgabewert

WertTypBeschreibungVersion
idintID des Mikrorohr-Segmentesab Version 2024.3.0
titlestringTitel des Mikrorohr-Segmentesab Version 2024.3.0
numberintReihenfolgen-Nummer des Mikrorohr-Segmentesab Version 2024.3.0
lengthintLänge des Mikrorohr-Segmentesab Version 2024.3.0
is_section_startbooleanFlag, ob das Mikrorohr-Segment den Startpunkt einer Mikrorohr-Strecke kennzeichnetab Version 2024.3.0
cable_idintID des zugewiesenen Kabelsab Version 2024.3.0
cable_titlestringTitel des zugewiesenen Kabelsab Version 2024.3.0
micro_pipe_idintID des zugewiesenen Mikrorohresab Version 2024.3.0
micro_pipe_titlestringTitel des zugewiesenen Mikrorohresab Version 2024.3.0
micro_pipe_group_idintID des zugewiesenen Mikrorohr-Verbundesab Version 2024.3.0
micro_pipe_group_titlestringTitel des zugewiesenen Mikrorohr-Verbundesab Version 2024.3.0
left_connector_idintID des Mikrorohr-Verbinders linksab Version 2024.3.0
left_branching_point_idintID der Abzweigstelle linksab Version 2024.3.0
right_connector_idintID des Mikrorohr-Verbinders rechtsab Version 2024.3.0
right_branching_point_idintID der Abzweigstelle rechtsab Version 2024.3.0


...

cable.micro_pipe_segment.get_ending_micro_pipe_segments

Beschreibung

Gibt alle Mikrorohr-Segmente am Anfang und am Ende zurück.

Beispielaufruf

Codeblock
languagebash
themeRDark
{
	"method":"cable.micro_pipe.get_ending_micro_pipe_segments",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"micro_pipe_id": 4
	},
	"version":"2.0",
    "id": 1
}

Parameter

ParameterTypBeschreibungVersion
micro_pipe_idintOptional: ID des Mikrorohresab Version 2024.3.0
only_without_cable_assignmentbooleanOptional: Nur Mikrorohr-Segmente ohne Kabel-Zuweisung ausgebenab Version 2024.3.0

Rückgabewert

Rückgabewert

WertTypBeschreibungVersionidintID des Mikrorohr-Verbindersab Version 2024.3.0titlestringTitel des Mikrorohr-Verbindersab Version 2024.3.0left_segment_idint

ID des verbundenen Mikrorohr-Segmentes links

ab Version 2024.3.0right_segment_idintID des verbundenen Mikrorohr-Segmentes
WertTypBeschreibungVersion
idintID des Mikrorohr-Segmentesab Version 2024.3.0
titlestringTitel des Mikrorohr-Segmentesab Version 2024.3.0
numberintReihenfolgen-Nummer des Mikrorohr-Segmentesab Version 2024.3.0
lengthintLänge des Mikrorohr-Segmentesab Version 2024.3.0
is_section_startbooleanFlag, ob das Mikrorohr-Segment den Startpunkt einer Mikrorohr-Strecke kennzeichnetab Version 2024.3.0
cable_idintID des zugewiesenen Kabelsab Version 2024.3.0
cable_titlestringTitel des zugewiesenen Kabelsab Version 2024.3.0
micro_pipe_idintID des zugewiesenen Mikrorohresab Version 2024.3.0
micro_pipe_titlestringTitel des zugewiesenen Mikrorohresab Version 2024.3.0
micro_pipe_group_idintID des zugewiesenen Mikrorohr-Verbundesab Version 2024.3.0
micro_pipe_group_titlestringTitel des zugewiesenen Mikrorohr-Verbundesab Version 2024.3.0
left_connector_idintID des Mikrorohr-Verbinders linksab Version 2024.3.0
left_branching_point_idintID der Abzweigstelle linksab Version 2024.3.0
right_connector_idintID des Mikrorohr-Verbinders rechtsab Version 2024.3.0
right_branching_point_idintID der Abzweigstelle rechtsab Version 2024.3.0

cable.micro_pipe.get_connectors

Beschreibung

Gibt alle Mikrorohr-Verbinder zurück.

Beispielaufruf

Codeblock
languagebash
themeRDark
{
	"method":"cable.micro_pipe.get_connectors",
	"params":{
		"apikey":"24174j3tqj",
		"connector_ids":[4,18]
	},
	"version":"2.0",
    "id": 1
}

Parameter

...

rechts
ab Version 2024.3.0
branching_point_idintID der verbundenen Abzweigstelle
ab Version 2024.3.0
branching_point_title
stringTitel der verbundenen Abzweigstelleab Version 2024.3.0location_idintID des Standortes der Abzweigstelleab Version 2024.3.0location_titlestringTitel des Standortes der Abzweigstelleab Version 2024.3.0


...

cable.micro_pipe.trace_by_micro_pipe_segment

Beschreibung

Gibt die Verbindungen einer Mikrorohr-Strecke anhand eines Mikrorohr-Segmentes aus.

Beispielaufruf

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

Parameter

ParameterTypBeschreibungVersion
segment_idintID des Mikrorohr-Segmentesab Version 2024.3.0
error_on_cable_assignmentbooleanOptional: Gibt einen Fehler aus, wenn einem Segment bereits ein Kabel zugewiesen istab Version 2024.3.0
load_extended_informationbooleanOptional: Lädt erweiterte Informationen (siehe Rückgabewerte)ab Version 2024.3.0

Rückgabewert

WertTypBeschreibungVersion
connector_idintID des Mikrorohr-Verbindersab Version 2024.3.0
branching_point_idintID der Abzweigstelleab Version 2024.3.0
left_segment_idintID des Mikrorohr-Segmentes linksab Version 2024.3.0
left_segment_titlestringTitel des Mikrorohr-Segmentes linksab Version 2024.3.0
right_segment_idintID des Mikrorohr-Segmentes rechtsab Version 2024.3.0
right_segment_titlestringTitel des Mikrorohr-Segmentes rechtsab Version 2024.3.0
mit erweiterter Ausgabe:
connectorConnector

Daten des Mikrorohr-Verbinders

Die Datenstruktur ist in der Tabelle "Rückgabewerte" des Aufrufes "cable.micro_pipe.get_connectors" beschrieben.

ab Version 2024.3.0
left_segmentSegment

Daten des Mikrorohr-Segmentes links

Die Datenstruktur ist in der Tabelle "Rückgabewerte" des Aufrufes "cable.micro_pipe.get_micro_pipe_segments" beschrieben.

ab Version 2024.3.0
right_segmentSegment

Daten des Mikrorohr-Segmentes rechts

Die Datenstruktur ist in der Tabelle "Rückgabewerte" des Aufrufes "cable.micro_pipe.get_micro_pipe_segments" beschrieben.

ab Version 2024.3.0

cable.micro_pipe.assign_cable_to_micro_pipe_section

Beschreibung

Weist ein Kabel einer Mikrorohr-Strecke zu.

Beispielaufruf

Codeblock
languagebash
themeRDark
{
	"method":"cable.micro_pipe.assign_cable_to_micro_pipe_section",
	"params":{
		"apikey":"24174j3tqj",
		"cable_id":4,
		"segment_id":8
	},
	"version":"2.0",
    "id": 1
}

Parameter

...

Rückgabewert

kein Rückgabewert

cable.micro_pipe.reject_cable_from_micro_pipe_section

Beschreibung

Löscht die Kabelzuweisung zu einer Mikrorohr-Strecke.

Beispielaufruf

...

languagebash
themeRDark

...

.

...

Parameter

ParameterTypBeschreibungVersioncable_idintID des Kabels

ab Version 2024.3.0

Rückgabewert

...