Anschluss
Verwaltung von Anschlüssen an einem beliebigen Objekt.
Seitenverzeichnis:
cable.pin.read
Beschreibung
Gibt alle konfigurierten Anschlüsse eines Objektes zurück.
Beispielaufruf
Lesen eines speziellen Anschlusses:
{
"method":"cable.pin.read",
"params":{
"apikey":"24174j3tqj",
"id": 4
},
"version":"2.0",
"id": 1
}Filtern nach Anschlüssen:
{
"method":"cable.pin.read",
"params":{
"apikey":"24174j3tqj",
"filter": {
"description": "PIN %"
}
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | Optional: ID des Datenbankeintrages | ab Version 1.0 |
filter | array | Optional: Filter für Anschlüsse Der Filter unterstützt alle Eigenschaften der Anschlüsse (siehe Rückgabewerte). Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden. | ab Version 1.0 |
Rückgabewert
Liste aller Anschlüsse zum angegebenen Objekt.
Wert | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | ID des Datenbankeintrages | ab Version 1.0 |
obj_id | int | ID des referenzierten Objektes | ab Version 1.0 |
description | string | Beschreibung des Anschlusses | ab Version 1.0 |
type | string | Typ des Anschlusses (zulässige Werte: "in" oder "out") | ab Version 1.0 |
number | int | Nummer des Anschlusses | ab Version 1.0 |
internal_pin_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.0 |
patch_pin_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.0 |
connected_wire_pin_id | int | Referenz auf einen verbundenen Ader-Anschluss | ab Version 1.0 |
connector_id | int | Referenz auf einen verbundenen Anschluss aus der Verkabelung | ab Version 1.0 |
classification | string | Anschluss-Typ | ab Version 1.0 |
cable.pin.create
Beschreibung
Legt einen neuen Anschluss an.
Beispielaufruf
{
"method":"cable.pin.create",
"params":{
"apikey":"24174j3tqj",
"data": {
"obj_id":19,
"description":"Anschluss 1",
"number":1,
"type":"in"
}
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
obj_id | int | ID des referenzierten Objektes | ab Version 1.0 |
description | string | Beschreibung des Anschlusses | ab Version 1.0 |
type | string | Typ des Anschlusses (zulässige Werte: "in" oder "out") | ab Version 1.0 |
number | int | Optional: Nummer des Anschlusses | ab Version 1.0 |
internal_pin_id | int | 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.0 |
patch_pin_id | int | 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.0 |
connected_wire_pin_id | int | Optional: Referenz auf einen verbundenen Ader-Anschluss | ab Version 1.0 |
connector_id | int | Referenz auf einen verbundenen Anschluss aus der Verkabelung | ab Version 1.0 |
classification | string | Optional: Anschluss-Typ | ab Version 1.0 |
Rückgabewert
Wert | Typ | Version |
|---|---|---|
current_date | string | ab Version 1.0 |
id | int | ab Version 1.0 |
message | string | ab Version 1.0 |
cable.pin.update
Beschreibung
Aktualisiert einen bestehenden Anschluss.
Beispielaufruf
{
"method":"cable.pin.update",
"params":{
"apikey":"24174j3tqj",
"id":4,
"data": {
"description":"Anschluss 1",
"number":1,
"type":"in"
}
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | ID des Datenbankeintrages | ab Version 1.0 |
description | string | Beschreibung des Anschlusses | ab Version 1.0 |
number | int | Nummer des Anschlusses | ab Version 1.0 |
type | string | Typ des Anschlusses (zulässige Werte: "in" oder "out") | ab Version 1.0 |
internal_pin_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.0 |
patch_pin_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.0 |
connected_wire_pin_id | int | Referenz auf einen verbundenen Ader-Anschluss | ab Version 1.0 |
connector_id | int | Referenz auf einen verbundenen Anschluss aus der Verkabelung | ab Version 1.0 |
classification | string | Anschluss-Typ | ab Version 1.0 |
Rückgabewert
Wert | Typ | Version |
|---|---|---|
current_date | string | ab Version 1.0 |
id | int | ab Version 1.0 |
message | string | ab Version 1.0 |
cable.pin.find_usages
Beschreibung
Findet die Objekte, die mit dem angegebenen Anschluss verbunden sind.
Beispielaufruf
{
"method":"cable.pin.find_usages",
"params":{
"apikey":"24174j3tqj",
"id":4
},
"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.
Wert | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | Kategorie-ID des Objektes | ab Version 1.0 |
obj_id | int | ID des Objektes | ab Version 1.0 |
title | string | Name des Objektes | ab Version 1.0 |
type_id | int | ID des Objekttyps | ab Version 1.0 |
type_title | string | Name des Objekttyps | ab Version 1.0 |
cable.pin.delete
Beschreibung
Löscht einen bestehenden Anschluss.
Beispielaufruf
{
"method":"cable.pin.delete",
"params":{
"apikey":"24174j3tqj",
"id":4
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | ID des zu löschenden Anschlusses | ab Version 1.0 |
Rückgabewert
Wert | Typ | Version |
|---|---|---|
current_date | string | ab Version 1.0 |
id | int | ab Version 1.0 |
message | string | ab Version 1.0 |
© 2025 SHD System-Haus-Dresden GmbH | Impressum https://www.shd-online.de/impressum/