Mikrorohr-Strecke

Verwaltung von Mikrorohr-Strecken.

Seitenverzeichnis:

1 cable.micro_pipe_section.read
2 cable.micro_pipe_section.read_by_micro_pipe
3 cable.micro_pipe_section.create
4 cable.micro_pipe_section.update
5 cable.micro_pipe_section.delete

cable.micro_pipe_section.read

Beschreibung

Gibt eine Mikrorohr-Strecken anhand der ID eines Mikrorohr-Segmentes zurück.

Beispielaufruf

Lesen einer Mikrorohr-Strecke:

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

Parameter

Parameter	Typ	Beschreibung	Version

Parameter	Typ	Beschreibung	Version
segment_id	int	Optional: ID eines Mikrorohr-Strecken Segmentes	ab Version 2025.1.0
section_id	int	Optional: ID einer Mikrorohr-Strecke	ab Version 2025.1.0
Hinweis: Einer der beiden Parameter muss angegeben werden.

Rückgabewert

Die mit dem Segment verbundene Mikrorohr-Strecke.

Wert	Typ	Beschreibung	Version

Wert	Typ	Beschreibung	Version
id	int	ID der Mikrorohr-Strecke	ab Version 2025.1.0
title	string	Name der Mikrorohr-Strecke	ab Version 2025.1.0
cable_id	int	ID des zugewiesenen Kabels	ab Version 2025.1.0
elements	int	Mikrorohr-Strecken Segmente Jedes Element besitzt folgende Eigenschaften: order_no: Reihenfolgen-Nummer segment_id: ID des Segments segment: Segment-Objekt connector_id: ID des Verbinders connector: Verbinder-Objekt branching_point_id: ID der Abzweigstelle	ab Version 2025.1.0

cable.micro_pipe_section.read_by_micro_pipe

Beschreibung

Gibt eine Mikrorohr-Strecken anhand der ID eines Mikrorohr-Segmentes zurück.

Beispielaufruf

Lesen einer Mikrorohr-Strecke:

{
	"method":"cable.micro_pipe_section.read_by_micro_pipe",
	"params":{
		"apikey":"24174j3tqj",
		"micro_pipe_id": 4
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

Parameter

Typ

Beschreibung

Version

micro_pipe_id

int

ID des Mikrorohres

ab Version 2026.1.0

without_cable_assignment

boolean

Optional: Filtert alle Strecken ohne zugewiesenes Kabel

Standard: false

Rückgabewert

Die mit dem Mikrorohr verbundenen Mikrorohr-Strecken.

Wert	Typ	Beschreibung	Version

Wert	Typ	Beschreibung	Version
id	int	ID der Mikrorohr-Strecke	ab Version 2025.1.0
title	string	Name der Mikrorohr-Strecke	ab Version 2025.1.0
cable_id	int	ID des zugewiesenen Kabels	ab Version 2025.1.0
elements	int	Mikrorohr-Strecken Segmente Jedes Element besitzt folgende Eigenschaften: order_no: Reihenfolgen-Nummer segment_id: ID des Segments segment: Segment-Objekt connector_id: ID des Verbinders connector: Verbinder-Objekt branching_point_id: ID der Abzweigstelle	ab Version 2025.1.0

cable.micro_pipe_section.create

Beschreibung

Legt eine neue Mikrorohr-Strecke an.

Beispielaufruf

{
	"method":"cable.micro_pipe_section.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"title": "Strecke 01",
			"elements": [
				{
					"segment_id": 1,
					"connector_id": 2,
					"branching_point_id": 3
				},
				{
					"segment_id": 11,
					"connector_id": 22,
					"branching_point_id": 33
				}
			]
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

Parameter

Typ

Beschreibung

Version

title

string

Name der Mikrorohr-Strecke

ab Version 2025.1.0

elements

array

Elemente der Mikrorohr-Strecke, welche in der übergebenen Reihenfolge angelegt werden

Jedes Element besitzt folgende Eigenschaften:

segment_id: ID des Mikrorohr-Segmentes
connector_id: ID des Verbinders
branching_point_id: ID der Abzweigstelle

ab Version 2025.1.0

Rückgabewert

Wert	Typ	Version

Wert	Typ	Version
current_date	string	ab Version 2025.1.0
id	int	ab Version 2025.1.0
message	string	ab Version 2025.1.0

cable.micro_pipe_section.update

Beschreibung

Aktualisiert eine bestehende Mikrorohr-Strecke.

Beispielaufruf

{
	"method":"cable.micro_pipe_section.update",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"data": {
			"id": 4,
			"title": "Strecke 01",
			"elements": [
				{
					"segment_id": 1,
					"connector_id": 2,
					"branching_point_id": 3
				},
				{
					"segment_id": 11,
					"connector_id": 22,
					"branching_point_id": 33
				}
			]
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

Parameter

Typ

Beschreibung

Version

id

int

ID der Strecke

ab Version 2025.1.0

title

string

Name der Mikrorohr-Strecke

ab Version 2025.1.0

elements

array

Elemente der Mikrorohr-Strecke, welche in der übergebenen Reihenfolge angelegt werden

Jedes Element besitzt folgende Eigenschaften:

segment_id: ID des Mikrorohr-Segmentes
connector_id: ID des Verbinders
branching_point_id: ID der Abzweigstelle

ab Version 2025.1.0

Rückgabewert

Wert	Typ	Version

Wert	Typ	Version
current_date	string	ab Version 2025.1.0
id	int	ab Version 2025.1.0
message	string	ab Version 2025.1.0

cable.micro_pipe_section.delete

Beschreibung

Löscht eine Mikrorohr-Strecke.

Beispielaufruf

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

Parameter

Parameter	Typ	Beschreibung	Version

Parameter	Typ	Beschreibung	Version
id	int	ID der zu löschenden Mikrorohr-Strecke	ab Version 2025.1.0

Rückgabewert

Wert	Typ	Version

Wert	Typ	Version
current_date	string	ab Version 2025.1.0
id	int	ab Version 2025.1.0
message	string	ab Version 2025.1.0