Seitenvergleich

...

cable.micro_pipe.get_micro_pipe_groups

Beschreibung

Gibt alle konfigurierten Anschlüsse eines Objektes Mikrorohr-Verbände zurück.

Beispielaufruf

Lesen eines speziellen Anschlusses:

Codeblock

language	bash
theme	RDark

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

Parameter

keine

Rückgabewert

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

Wert

Typ

Beschreibung

Version

id

int

ID des Mikrorohr-Verbundes

ab Version 2024.3.0

title

string

Titel des Mikrorohr-Verbundes

ab Version 2024.3.0

micro_pipes

array

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

Legt einen neuen Anschluss anGibt alle Mikrorohr-Verbinder zurück.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.pin.createmicro_pipe.get_connectors",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"obj_id":19,
			"description":"Anschluss 1"connector_ids":[4,18],
			"number":1,
			"type":"in"
		}branching_point_ids":[231]
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

obj

connector_

id

ids

intID des referenzierten Objektes

array

Liste von IDs der Mikrorohr-Verbinder

ab Version

1.0descriptionstringBeschreibung des Anschlussesab Version 1.0typestring

Typ des Anschlusses

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

ab Version 1.0numberintOptional: Nummer des Anschlussesab Version 1.0internal_pin_idint

Optional: 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

Optional: 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_idintOptional: Referenz auf einen verbundenen Ader-Anschlussab Version 1.0connector_idintReferenz auf einen verbundenen Anschluss aus der Verkabelungab Version 1.0classificationstringOptional: Anschluss-Typab Version 1

2024.3.0
branching_point_ids	array	Liste von IDs der Abzweigstellen	ab Version 2024.3.0

Rückgabewert

Wert	Typ

Versioncurrent_datestringab Version 1.0idintab Version 1.0messagestringab Version 1.0

cable.micro_pipe.get_ending_micro_pipe_segments

Beschreibung

...

Aktualisiert einen bestehenden Anschluss.

Beispielaufruf

...

Parameter

ParameterTypBeschreibung

...

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

Version
id	int	ID des

Datenbankeintrages

Mikrorohr-Verbinders

ab Version

1

2024.3.0

description

title

string

Beschreibung

Titel des

Anschlusses

Mikrorohr-Verbinders

ab Version

1

2024.3.0

number

left_segment_id

int

Nummer des Anschlusses

ID des verbundenen Mikrorohr-Segmentes links

ab Version

1.0typestring

Typ des Anschlusses

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

ab Version 1

2024.3.0

internal

right_

pinpatch_pin

segment_id

int

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.0WertTypVersioncurrent_datestringab Version 1.0idintab Version 1.0messagestringab Version 1

ID des verbundenen Mikrorohr-Segmentes rechts	ab Version 2024.3.0
branching_point_id	int

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

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.

...

Beschreibung

...

assign_cable_to_micro_pipe_section

Beschreibung

Weist ein Kabel einer Mikrorohr-Strecke zu.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.pin.find_usagesmicro_pipe.assign_cable_to_micro_pipe_section",
	"params":{
		"apikey":"24174j3tqj",
		"cable_id":4,
		"segment_id":8
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID des Anschlusses	ab Version 1.0

Rückgabewert

Auflistung der Objekte, in denen die Ader verwendet wird.

obj Objektes 1.0ab Version 1

Wert	Typ	Beschreibung	Version
id	int	Kategorie-ID des Objektes	ab Version 1.0
cable_id	int	ID des	Kabels	ab Version	title	string	Name des Objektes	2024.3.0
typesegment_id	int	ID des ObjekttypsMikrorohr-Segmentes	ab Version 1.0
type_title	string	Name des Objekttyps	ab Version 1.0

cable.micro_pipe.trace_by_micro_pipe_segment

Beschreibung

Löscht einen bestehenden Anschluss.

cable.micro_pipe.assign_cable_to_micro_pipe_section

Beschreibung

Löscht einen bestehenden Anschluss.

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

language	bash
theme	RDark

{
	"method":"cable.pin.deletemicro_pipe.reject_cable_from_micro_pipe_section",
	"params":{
		"apikey":"24174j3tqj",
		"cable_id":4
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
cable_id	int	ID des zu löschenden AnschlussesKabels	ab Version 12024.3.0

Rückgabewert

...

kein Rückgabewert

Versionen im Vergleich

Alte Version 1

Neue Version Aktuell

Schlüssel

cable.micro_pipe.get_micro_pipe_groups

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

cable.micro_pipe.get_

connectors

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

cable.micro_pipe.get_ending_micro_pipe_segments

Beispielaufruf

Parameter

Rückgabewert

cable.micro_pipe.

Beschreibung

assign_cable_to_micro_pipe_section

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

cable.micro_pipe.trace_by_micro_pipe_segment

Beschreibung

cable.micro_pipe.assign_cable_to_micro_pipe_section

Beschreibung

Rückgabewert

cable.micro_pipe.reject_cable_from_micro_pipe_section

Beschreibung

Beispielaufruf

Parameter

Rückgabewert