Implementación de la API genérica (Rest)

La API genérica (Rest) permite a su organización implementar una API de REST personalizada que extraerá la telemetría del sistema. InfoWorks WS Pro e IWLive Pro son clientes de esta API de REST. El departamento de TI proporcionará el servidor para la API de REST.

A continuación, se definen las funciones de API que podrían encontrar InfoWorks WS Pro e IWLive Pro.

Su departamento de TI es responsable de garantizar una seguridad adecuada en la implementación de esta API de REST.

URL base

Base_url tendrá el siguiente formato: https://MyTelemetry:Portnumber

Conexión básica

Base_url / en la página de inicio de sesión del adaptador de datos activos se indicará que se ha completado correctamente la acción "Probar la conexión"

Lista de etiquetas

Base_url /tags devolverá una lista de etiquetas para el menú desplegable Etiquetas de la página de flujos de datos activos.

Solicitud:

• Base_url/tags

Respuesta:

• Correcto
  • {"tags": ["name"…]}
  • Ejemplo
    • {"tags": ["tag name 1","tag name 2","tag name 3","tag name 4"]}
• 500 {error: {message: error detail}}

Comprobar que existe la etiqueta

Base_url/tags/tagname confirma que existe un nombre de etiqueta determinado.

Solicitud:

• Base_url/tags/tagname
• Parámetros
  • limit=x (cantidad)
    • Valor por defecto 1000
  • offset=y (inicio)
    • Valor por defecto 0

Respuesta

• 404 {"error": "Tag not found"}
• 500 {error: {message: error detail}}
• Success {"exists": true}

Resultado de datos variables en el tiempo para una etiqueta

Base_url/tags/tagname/history devolverá datos variables en el tiempo para una etiqueta en particular.

Solicitar

• base_url/tags/tagname/history
  • Parámetros
    • limit=x (cantidad)
      • Valor por defecto 1000
    • offset=y (inicio)
      • Valor por defecto 0
    • startdate=YYYY-MM-DDThh:mm:ssZ
    • enddate= YYYY-MM-DDThh:mm:ssZ
    • order=a (ASC | DESC)
      • ASC por defecto

Respuesta

• 404 {"error": "Tag not found"}
• 404 {"error": "History not found"}
• 500 {error: {message: error detail}}
• Success {"result": {"tagname": "aaa","values": [ {"timestamp":"ISO_datetime": "valueTypeName": value}…]}}
  • ISO datetime YYYY-MM-DDThh:mm:ss.mmmZ
  • ValueTypeName
    • doubleValue
    • integerValue
    • booleanValue
    • stringValue

Respuestas de ejemplo

Ejemplo 1

{
"result": {"tagname":"tag name 2","values": [{"timestamp":"2023-09-01T23:00:00.000Z","integerValue": 0}]
}

Ejemplo 2

{
"result": {"tagname":"tag name 3","values": [{"timestamp":"2023-09-01T23:00:00.000Z","booleanValue": false}]
}

Ejemplo 3

{
"result": {"tagname":"tag name 4","values": [{"timestamp":"2023-09-01T23:00:00.000Z","stringValue": "ABC2460189.5"}]
}

Ejemplo 4

{
 	"result": {
		"tagname": "tag name 15",
		"values": [
			{
				"timestamp": "2024-03-15T09:40:00.000Z",
				"doubleValue": -0.9659258262890684
			},
			{
				"timestamp": "2024-03-15T09:45:00.000Z",
				"doubleValue": -0.9612616959383188
			}
		]
}
}