Versionen im Vergleich

Schlüssel

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

...

WertTypBeschreibungVersion
idintID des Mikrorohr-Verbundesab Version 2024.3.0
titlestringTitel des Mikrorohr-Verbundesab Version 2024.3.0
micro_pipesarray

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
ab Version 2024.3.0


...

cable.micro_pipe.get_

...

connectors

Beschreibung

Gibt alle Mikrorohr-Segment Verbinder zurück.

Beispielaufruf


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

Parameter

ParameterTypBeschreibungVersion
micro
connector_
pipe_id
ids
intID des Mikrorohres
arrayListe von IDs der Mikrorohr-Verbinderab Version
1
2024.3.0
segment
branching_point_idsarrayListe von
Mikrorohr-Segmenten
IDs der Abzweigstellenab Version
1
2024.3.0

Rückgabewert

WertTypBeschreibungVersion
idintID des Mikrorohr-
Segmentes
Verbindersab Version 2024.3.0
titlestringTitel des Mikrorohr-
Segmentes
Verbindersab Version 2024.3.0
number
left_segment_idint
Reihenfolgen-Nummer

ID des verbundenen Mikrorohr-Segmentes links

ab Version 2024.3.0
lengthintLänge des Mikrorohr-Segmentesab Version 2024.3.0is_section_startbooleanFlag, ob das Mikrorohr-Segment den Startpunkt einer Mikrorohr-Strecke kennzeichnetab Version 2024.3.0cable
right_segment_idint

ID des

zugewiesenen Kabels

verbundenen Mikrorohr-Segmentes rechts

ab Version 2024.3.0
cable_titlestringTitel des zugewiesenen Kabelsab Version 2024.3.0micro_pipe
branching_point_idintID
des zugewiesenen Mikrorohres
der verbundenen Abzweigstelleab Version 2024.3.0
micro
branching_
pipe
point_titlestringTitel
des zugewiesenen Mikrorohres
der verbundenen Abzweigstelleab Version 2024.3.0
micro_pipe
location_
group_
idintID des
zugewiesenen Mikrorohr-Verbundes
Standortes der Abzweigstelleab Version 2024.3.0
micro
location_
pipe_group_
titlestringTitel des
zugewiesenen Mikrorohr-Verbundesab Version 2024.3.0left_connector_idintID des Mikrorohr-Verbinders linksab Version 2024.3.0left_branching_point_idintID der Abzweigstelle linksab Version 2024.3.0right_connector_idintID des Mikrorohr-Verbinders rechtsab Version 2024.3.0right_branching_point_idintID der Abzweigstelle rechts
Standortes der Abzweigstelleab Version 2024.3.0


...

cable.micro_pipe.

...

assign_cable_

...

to_micro_pipe_

...

section

Beschreibung

Aktualisiert einen bestehenden AnschlussWeist ein Kabel einer Mikrorohr-Strecke zu.

Beispielaufruf

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

Parameter

...

Typ des Anschlusses

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

...

Referenz auf einen anderen Anschluss, mit welchem dieser Anschluss

intern verbunden ist

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

...

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)

...

Rückgabewert

...

cable.micro_pipe.get_connectors

Beschreibung

Findet die Objekte, die mit dem angegebenen Anschluss verbunden sind.

Beispielaufruf

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

Parameter

ParameterTypBeschreibungVersion
idintID des Anschlussesab Version 1.0

Rückgabewert

Auflistung der Objekte, in denen die Ader verwendet wird.

obj Objektes 1.0ab Version 1
WertTypBeschreibungVersion
idintKategorie-ID des Objektesab Version 1.0
cable_idintID des Kabelsab Version titlestringName des Objektes2024.3.0
typesegment_idintID des ObjekttypsMikrorohr-Segmentesab Version 1.0
type_titlestring

Name des Objekttyps

ab Version 1.0

cable.micro_pipe.trace_by_micro_pipe_segment

Beschreibung

Löscht einen bestehenden Anschluss.

Beispielaufruf

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

Parameter

cable.micro_pipe.assign_cable_to_micro_pipe_section

Beschreibung

Löscht einen bestehenden Anschluss.

Beispielaufruf

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

...

2024.3.0

Rückgabewert

kein Rückgabewert


...

cable.micro_pipe.reject_cable_from_micro_pipe_section

Beschreibung

Löscht einen bestehenden Anschlussdie Kabelzuweisung zu einer Mikrorohr-Strecke.

Beispielaufruf

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

Parameter

ParameterTypBeschreibungVersion
cable_idintID des zu löschenden AnschlussesKabelsab Version 12024.3.0

Rückgabewert

...

kein Rückgabewert