Skip to main content

`"deleteTransform"` (jsonAction)

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

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

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

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

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.

Table 1. "params" property summaries

Property	Description	Default	Type	Limits (inclusive)
transformName	(optional) specifies the name of a transform process you have created. See the "createTransform" and "alterTransform" actions	`""`	string	0 to 256 bytes

Would you like to provide feedback?