Transformers

Test a transformer with input data

Changed on

Runs a configured transformer (standard or custom, by id) with the given options against the provided input data, returning both the wrapped input and the transformed output. Used to test a north/history transformer with its configured options.

post/api/transformers/{transformerId}/test

Request

  • Base URL: http://localhost:2223
  • URL: http://localhost:2223/api/transformers/{transformerId}/test
  • Auth: none required

Path parameters

transformerIdstring required

Request body

inputDatastring required

The raw input data string to pass to the transformer. The expected format depends on the transformer's inputType (e.g. a JSON-serialised array of time-values, or a raw file path for any).

optionsobject

Optional transformer-specific options object passed alongside the input data.

Example request

{
  "inputData": "[{\"timestamp\":\"2024-01-01T00:00:00.000Z\",\"pointId\":\"sensor1\",\"value\":\"42.0\"}]",
  "options": {
    "precision": 2
  }
}

Response

The wrapped input and transformed output

connectionDurationnumber double required
queryDurationnumber double required

Example response

{
  "raw": {
    "type": "time-values",
    "content": [
      {
        "pointId": "point1",
        "timestamp": "2023-10-31T12:34:56.789Z"
      }
    ]
  },
  "transformed": {
    "type": "time-values",
    "content": [
      {
        "pointId": "point1",
        "timestamp": "2023-10-31T12:34:56.789Z"
      }
    ]
  }
}

Changes

  • 0df3f625a5c2Revision changes
    • info

      added to the response property anyOf list for the response status

    • info

      added to the //// response property anyOf list for the response status

  • 21b34a490fa3Revision changes
    • info

      removed from the response property anyOf list for the response status

    • info

      removed from the //// response property anyOf list for the response status