IO

Actualizado el 4 de septiembre de 2026APIDescargar PDF

Usar con IA

Ver como Markdown Abrir en Claude Abrir en ChatGPT

En esta página

POST /io/filter
Cuerpo de la solicitud
Respuestas
GET /io/getByDevice/{deviceId}
Parámetros
Respuestas
POST /io/singleIO
Cuerpo de la solicitud
Respuestas
GET /io/singleIO/{uniqueId}/{deviceId}/{type}
Parámetros
Respuestas
PUT /io/singleIO/{uniqueId}/{deviceId}/{type}
Parámetros
Cuerpo de la solicitud
Respuestas
DELETE /io/singleIO/{uniqueId}/{deviceId}/{type}
Parámetros
Respuestas
GET /io/triggerIO?deviceId={deviceId}&relay={relay}&action={action}
Parámetros
Respuestas

Operaciones sobre recursos de IO. 7 puntos finales, cada uno relativo a https://api.nxgen.cloud/api/v1 y autenticado según lo descrito en Autenticación.

POST /io/filter

Obtiene la lista de IO con filtrado, ordenación y paginación. Permite búsquedas por nivel jerárquico. Puede filtrarse usando la jerarquía especificada o utiliza la jerarquía del usuario autenticado. Esto brinda la opción de obtener campos de entidad adicionales en la respuesta. También proporciona metadatos de configuración sobre la entidad.

Cuerpo de la solicitud

Filtrado y ordenación de IO

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"
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito	objeto
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Prohibido

Ejemplo 200 respuesta:

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}

Obtener IO por Device Id

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
deviceId	path	string	sí

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
204	Sin contenido
401	No autorizado
403	Prohibido
404	No Encontrado

POST /io/singleIO

Agregar nuevo dispositivo IO único

Cuerpo de la solicitud

Agregar dispositivo IO único

json

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

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
204	Sin contenido
401	No autorizado
403	Prohibido
404	No Encontrado

Ejemplo 200 respuesta:

json

{
  "isSuccess": true
}

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

Obtener detalle de IO único

Parámetros

Nombre	En	Tipo	Obligatorio
uniqueId	path	cadena	sí
deviceId	path	cadena	sí
tipo	path	cadena	sí

Respuestas

Estado	Descripción	Cuerpo
200	Éxito	objeto
400	Entrada inválida
401	No autorizado
403	Prohibido
404	No Encontrado

Ejemplo 200 respuesta:

json

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

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

Actualizar dispositivo IO único

Parámetros

Nombre	En	Tipo	Obligatorio
uniqueId	ruta	cadena	sí
deviceId	ruta	cadena	sí
tipo	ruta	cadena	sí

Cuerpo de la solicitud

Para actualizar una IO, proporcione el UniqueId existente

json

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

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
400	Entrada inválida
401	No autorizado
403	Prohibido
404	No Encontrado

Ejemplo 200respuesta:

json

{
  "isSuccess": true
}

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

Eliminar dispositivo IO único

Parámetros

Nombre	En	Tipo	Obligatorio
uniqueId	ruta	cadena	sí
deviceId	ruta	cadena	sí
tipo	ruta	cadena	sí

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
400	Entrada inválida
401	No autorizado
403	Prohibido
404	No Encontrado

Ejemplo 200 respuesta:

json

{
  "isSuccess": true
}

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

Para activar IO

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
deviceId	consulta	cadena	sí	Device Id
relé	consulta	cadena	sí	IO Device Id(IO id)
acción	consulta	cadena	sí	Estado IO

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
401	No autorizado
404	No Encontrado

¿Le ha resultado útil esta página?

Gracias — sus comentarios llegan al equipo responsable de esta página.