Sign in
latestOpenAPI 3.0.0EUPLraw.githubusercontent.com2026-08-191426201.0 MB

fe8fd32c9fdc

Transformers

Create transformer

Creates a new data transformer with the provided configuration

post/api/transformers

Request body

type'custom' required

The type of the transformer (always 'custom' for this interface).

inputTypestring required

The input data type that the transformer accepts.

outputTypestring required

The output data type that the transformer produces.

namestring required

The name of the custom transformer.

descriptionstring required

A description of what the custom transformer does.

customCodestring required

The custom JavaScript code that implements the transformation logic.

languagestring required
timeoutnumber double required

The maximum execution time for the custom code in milliseconds.

Example request

{
  "inputType": "string",
  "outputType": "number",
  "name": "String to Number",
  "description": "Converts string input to numeric output",
  "customCode": "function transform(input) { return parseFloat(input); }",
  "customManifest": {
    "key": "serverUrl",
    "translationKey": "connection.serverUrl",
    "validators": [
      {
        "arguments": []
      }
    ],
    "attributes": [
      {
        "key": "serverUrl",
        "translationKey": "connection.serverUrl",
        "validators": [
          {
            "arguments": []
          }
        ],
        "displayProperties": {
          "row": 1,
          "columns": 6,
          "displayInViewMode": true
        },
        "defaultValue": "oibus-client"
      }
    ],
    "enablingConditions": [
      {
        "targetPathFromRoot": "protocol",
        "referralPathFromRoot": "connection.type",
        "values": [
          "MQTT"
        ],
        "operator": "EQUALS"
      }
    ],
    "displayProperties": {
      "visible": true,
      "wrapInBox": true
    }
  },
  "timeout": 2000
}

Response

Transformer created successfully

idstring required

The unique identifier of the transformer.

type'custom' required

The type of the transformer (always 'custom' for this interface).

inputTypestring required
outputTypestring required
namestring required

The name of the custom transformer.

descriptionstring required

A description of what the custom transformer does.

customCodestring required

The custom JavaScript code that implements the transformation logic.

languagestring required
timeoutnumber double required

The maximum execution time for the custom code in milliseconds.

createdAtstring required

Represents an instant in time as an ISO 8601 string.

updatedAtstring required

Represents an instant in time as an ISO 8601 string.

Example response

{
  "id": "transformer123",
  "manifest": {
    "key": "serverUrl",
    "translationKey": "connection.serverUrl",
    "validators": [
      {
        "arguments": []
      }
    ],
    "attributes": [
      {
        "key": "serverUrl",
        "translationKey": "connection.serverUrl",
        "validators": [
          {
            "arguments": []
          }
        ],
        "displayProperties": {
          "row": 1,
          "columns": 6,
          "displayInViewMode": true
        },
        "defaultValue": "oibus-client"
      }
    ],
    "enablingConditions": [
      {
        "targetPathFromRoot": "protocol",
        "referralPathFromRoot": "connection.type",
        "values": [
          "MQTT"
        ],
        "operator": "EQUALS"
      }
    ],
    "displayProperties": {
      "visible": true,
      "wrapInBox": true
    }
  },
  "name": "String to Number",
  "description": "Converts string input to numeric output",
  "customCode": "function transform(input) { return parseFloat(input); }",
  "timeout": 2000,
  "createdBy": {
    "id": "abc123",
    "friendlyName": "John Doe (john.doe)"
  },
  "updatedBy": {
    "id": "abc123",
    "friendlyName": "John Doe (john.doe)"
  },
  "createdAt": "2023-10-31T12:34:56.789Z",
  "updatedAt": "2023-10-31T12:34:56.789Z"
}