Skip to main content

`"deleteTransform"`

JSON transform `"deleteTransform"` action deletes transforms in FairCom MQ and FairCom Edge

The "deleteTransform" action deletes one or more transforms. It returns a full description of each deleted transform so that the transform can be recreated easily.

Request examples

Minimal request

{
    "api": "transform",
    "apiVersion": "1.0",
    "authToken":  "anAuthorizationTokenFromTheServer",
    "requestId": "00000003",
    "action": "deleteTransform",
    "params": {
        "transformName": "SensorsTransform1"
    }
}

Response examples

Note

If the target object does not exist, the response returns success and the debug property contains a warning that the object was not found.

Minimal response

{
  "authToken": "anAuthorizationTokenFromTheServer",
  "result": {},
  "requestId": "00000003",
  "debugInfo": {
    "request": {
      "authToken": "anAuthorizationTokenFromTheServer",
      "api": "transform",
      "action": "deleteTransform",
      "params": {
        "transformName": "FieldToField"
      },
      "requestId": "00000003",
      "debug": "max"
    },
    "warnings": [
      {
        "code": 100,
        "message": "deleteTransform - Transform pipeline [FieldToField] was not found."
      }
    ]
  },
  "errorCode": 0,
  "errorMessage": ""
}

Use the deleteTransform JSON API action to delete transforms

JSON transform APIAPI actionsjsonActiontransform actionsdelete transformdeleteTransform

`"params"`

The "params" property is an object that contains an action's parameters. Each action defines its own required and optional properties.

Properties summary

Table 1. "params" properties summary

Property	Description	Default	Type	Limits (inclusive)
transformName	specifies the name of a transform process. The name cannot be one of the FairCom-provided transform names	`""`	string	0 to 256 bytes