Verwaltung von Mikrorohr-Segmenten.
Seitenverzeichnis:
cable.micro_pipe_segment.read
Beschreibung
Gibt alle Mikrorohr-Segmente zurück.
Beispielaufruf
{
"method":"cable.micro_pipe_segment.read",
"params":{
"apikey":"24174j3tqj",
"micro_pipe_id": 4,
},
"version":"2.0",
"id": 1
}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| micro_pipe_id | int | Optional: ID des Mikrorohres | ab Version 2024.3.0 |
| segment_ids | array | Optional: Liste von IDs von Mikrorohr-Segmenten | ab Version 2024.3.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_segment.get_ending_micro_pipe_segments
Beschreibung
Gibt alle Mikrorohr-Segmente am Anfang und am Ende zurück.
Beispielaufruf
{
"method":"cable.micro_pipe.get_ending_micro_pipe_segments",
"params":{
"apikey":"24174j3tqj",
"id":4,
"micro_pipe_id": 4
},
"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 ausgeben | ab Version 2024.3.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.trace_by_micro_pipe_segment
Beschreibung
Gibt die Verbindungen einer Mikrorohr-Strecke anhand eines Mikrorohr-Segmentes aus.
Beispielaufruf
{
"method":"cable.micro_pipe.trace_by_micro_pipe_segment",
"params":{
"apikey":"24174j3tqj",
"segment_id":4
},
"version":"2.0",
"id": 1
}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| segment_id | int | ID des Mikrorohr-Segmentes | ab Version 2024.3.0 |
| error_on_cable_assignment | boolean | Optional: Gibt einen Fehler aus, wenn einem Segment bereits ein Kabel zugewiesen ist | ab Version 2024.3.0 |
| load_extended_information | boolean | Optional: Lädt erweiterte Informationen (siehe Rückgabewerte) | ab Version 2024.3.0 |
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 | ab Version 2024.3.0 |
| left_segment_id | int | ID des Mikrorohr-Segmentes links | ab Version 2024.3.0 |
| left_segment_title | string | Titel des Mikrorohr-Segmentes links | ab Version 2024.3.0 |
| right_segment_id | int | ID des Mikrorohr-Segmentes rechts | ab Version 2024.3.0 |
| right_segment_title | string | Titel des Mikrorohr-Segmentes rechts | ab Version 2024.3.0 |
| 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. | ab Version 2024.3.0 |
| 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. | ab Version 2024.3.0 |
| 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. | ab Version 2024.3.0 |