IO

Aktualisiert am 4. September 2026APIPDF herunterladen

Mit KI verwenden

Als Markdown ansehen In Claude öffnen In ChatGPT öffnen

Auf dieser Seite

POST /io/filter
Anfragekörper
Antworten
GET /io/getByDevice/{deviceId}
Parameter
Antworten
POST /io/singleIO
Anfrage‑Body
Antworten
GET /io/singleIO/{uniqueId}/{deviceId}/{type}
Parameter
Antworten
PUT /io/singleIO/{uniqueId}/{deviceId}/{type}
Parameter
Anfragekörper
Antworten
DELETE /io/singleIO/{uniqueId}/{deviceId}/{type}
Parameter
Antworten
GET /io/triggerIO?deviceId={deviceId}&relay={relay}&action={action}
Parameter
Antworten

Operationen für io-Ressourcen. 7 Endpunkte, jeweils relativ zu https://api.nxgen.cloud/api/v1 und authentifiziert wie unter Authentifizierung.

POST /io/filter

Ruft die IO-Liste mit Filterung, Sortierung und Pagination ab. Es ermöglicht die Suche auf hierarchischer Ebene. Es kann anhand einer angegebenen Hierarchie gefiltert werden oder verwendet die Hierarchie des angemeldeten Benutzers. Dadurch kann man zusätzliche Entitätsfelder in der Antwort erhalten. Außerdem werden Konfigurations-Metadaten zur Entität bereitgestellt.

Anfragekörper

IO-Filterung und -Sortierung

json

{
  "filters": [
    {
      "columnName": "string (required)",
      "type": "distinctList | date | number | StringConditionFilter (required)",
      "filter": "object (required)"
    }
  ],
  "sortOrder": [
    {
      "columnName": "string",
      "isAscending": "boolean"
    }
  ],
  "primaryColumns": [
    "string"
  ],
  "hierarchyLevel": "string",
  "hierarchyId": "string",
  "nPerPage": "number",
  "pageNumber": "number",
  "isConfigDetailRequired": "boolean",
  "getConfig": "boolean",
  "getChildOrParent": "boolean"
}

Antworten

Status	Beschreibung	Inhalt
200	Erfolg	Objekt
204	Kein Inhalt
400	Ungültige Eingabe
401	Nicht autorisiert
403	Verboten

Beispiel 200 Antwort:

json

{
  "config": {
    "columns": [
      {
        "visibility": true,
        "columnName": "name",
        "DisplayName": "Name",
        "isFilterable": true,
        "filterType": "stringCondition",
        "sticky": true,
        "isMandatory": true,
        "isNotDraggable": true
      }
    ],
    "defaultNPerPage": 50,
    "defaultFilterCondition": [],
    "defaultSortingOrder": [
      {
        "columnName": "dateTime",
        "isAscending": false
      }
    ],
    "maxVisibleColumnCount": 6,
    "exportLimitNPerPage": 500
  },
  "dataResult": [
    {
      "dateTime": 1658329286975,
      "id": 1601,
      "name": "output test 1",
      "uniqueId": "e9fa037e0f2f4aa1a25c49da6f45ff84",
      "type": "output",
      "deviceId": "a6183f1072554391b99e7acc9428de26",
      "deviceName": "Device",
      "siteId": "f2b51c0f62c64d15a7b1acc5ea13082d",
      "siteName": "Axxon Site1",
      "customerId": "93b4ce9e41534f548d396ba4d2d5a2ed",
      "serviceProviderId": "e7f417cf4a434b5093a8173cdb40004f",
      "isLinkedWithMap": "false",
      "isEnabled": "true"
    }
  ],
  "totalRecordsCount": 3552,
  "filteredBy": [],
  "sortedBy": [
    {
      "columnName": "dateTime",
      "isAscending": false
    }
  ],
  "dispatchedAll": false,
  "isDefaultProjectionMutated": false,
  "isDefaultFilterMutated": false,
  "isDefaultSortingMutated": false
}

GET /io/getByDevice/{deviceId}

IO nach Device Id abrufen

Parameter

Name	In	Typ	Erforderlich	Beschreibung
deviceId	path	string	ja

Antworten

Status	Beschreibung	Body
200	Erfolg
204	Kein Inhalt
401	Nicht autorisiert
403	Verboten
404	Nicht gefunden

POST /io/singleIO

Neues Single‑IO‑Gerät hinzufügen

Anfrage‑Body

Single‑IO‑Gerät hinzufügen

json

{
  "name": "string (required)",
  "id": "number (required)",
  "type": "input | output (required)",
  "deviceId": "string (required)",
  "jsonSchemaResult": "object"
}

Antworten

Status	Beschreibung	Body
200	Erfolg
204	Kein Inhalt
401	Nicht autorisiert
403	Verboten
404	Nicht gefunden

Beispiel 200 Antwort:

json

{
  "isSuccess": true
}

GET /io/singleIO/{uniqueId}/{deviceId}/{type}

Einzel‑IO‑Detail abrufen

Parameter

Name	In	Typ	Erforderlich
uniqueId	path	Zeichenkette	ja
deviceId	path	Zeichenkette	ja
Typ	path	Zeichenkette	ja

Antworten

Status	Beschreibung	Inhalt
200	Erfolg	Objekt
400	Ungültige Eingabe
401	Nicht autorisiert
403	Verboten
404	Nicht gefunden

Beispiel 200 Antwort:

json

{
  "id": 4547,
  "name": "output 3",
  "uniqueId": "9ccadb73fdde4760a6e64479706090b8",
  "associatedDeviceId": "2781f633d4334d189211320596db4dc6",
  "dateTime": 1657874428326,
  "jsonSchemaResult": {}
}

PUT /io/singleIO/{uniqueId}/{deviceId}/{type}

Einzelnes IO-Gerät aktualisieren

Parameter

Name	In	Typ	Erforderlich
uniqueId	Pfad	Zeichenkette	ja
deviceId	Pfad	Zeichenkette	ja
Typ	Pfad	Zeichenkette	ja

Anfragekörper

Um ein IO zu aktualisieren, geben Sie die vorhandene UniqueId an

json

{
  "id": "number",
  "name": "string",
  "jsonSchemaResult": "object"
}

Antworten

Status	Beschreibung	Inhalt
200	Erfolg
400	Ungültige Eingabe
401	Nicht autorisiert
403	Verboten
404	Nicht gefunden

Beispiel 200Antwort:

json

{
  "isSuccess": true
}

DELETE /io/singleIO/{uniqueId}/{deviceId}/{type}

Einzelnes IO-Gerät löschen

Parameter

Name	In	Typ	Erforderlich
uniqueId	Pfad	Zeichenkette	ja
deviceId	Pfad	Zeichenkette	ja
Typ	Pfad	Zeichenkette	ja

Antworten

Status	Beschreibung	Inhalt
200	Erfolg
400	Ungültige Eingabe
401	Nicht autorisiert
403	Verboten
404	Nicht gefunden

Beispiel 200 response:

json

{
  "isSuccess": true
}

GET /io/triggerIO?deviceId={deviceId}&relay={relay}&action={action}

IO auslösen

Parameter

Name	In	Typ	Erforderlich	Beschreibung
deviceId	query	Zeichenkette	ja	Device Id
Relais	Abfrage	String	ja	IO Device Id(IO id)
Aktion	Abfrage	String	ja	IO Zustand

Antworten

Status	Beschreibung	Inhalt
200	Erfolg
401	Nicht autorisiert
404	Nicht gefunden

War diese Seite hilfreich?

Vielen Dank — Ihr Feedback geht an das Team, das diese Seite betreut.