Transformers

Update transformer

Updates an existing custom transformer with new configuration

put/api/transformers/{transformerId}

Path parameters

transformerIdstring required

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 updated successfully

Changes

Changed in 12 of the 73 revisions of this API.28337

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusArrayAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusBooleanAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusCertificateAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusCodeAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusInstantAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusNumberAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusScanModeAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusSecretAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusStringAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusStringSelectAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusTimezoneAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/validators/items/type

      request-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusArrayAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusBooleanAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusCertificateAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusCodeAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusInstantAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusNumberAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusScanModeAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusSecretAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusStringAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusStringSelectAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusTimezoneAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/validators/items/type

      request-property-enum-value-removed

    This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusArrayAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusBooleanAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusCertificateAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusCodeAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusInstantAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusNumberAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusScanModeAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusSecretAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusStringAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusStringSelectAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusTimezoneAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/validators/items/type

      request-property-enum-value-added

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusArrayAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusBooleanAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusCertificateAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusCodeAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusInstantAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusNumberAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusScanModeAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusSecretAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusStringAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusStringSelectAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/attributes/items/anyOf[OIBusTimezoneAttribute]/validators/items/type

      request-property-enum-value-removed

    • removed the enum value PLATFORM of the request property customManifest/validators/items/type

      request-property-enum-value-removed

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusArrayAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusBooleanAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusCertificateAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusCodeAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusInstantAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusNumberAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusScanModeAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusSecretAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusStringAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusStringSelectAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/attributes/items/anyOf[OIBusTimezoneAttribute]/validators/items/type

      request-property-enum-value-added

    • added the new PLATFORM enum value to the request property customManifest/validators/items/type

      request-property-enum-value-added

    • added the new NOT_EQUAL enum value to the request property customManifest/enablingConditions/items/operator

      request-property-enum-value-added

    • added the new required request property timeout

      new-required-request-property

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the request property timeout

      request-property-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new required request property timeout

      new-required-request-property

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the request property timeout

      request-property-removed

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog