Friday, September 30, 2022
Home Uncategorized Learn Mirth Connect's Client API Now

Learn Mirth Connect’s Client API Now

Prerequisites

  • Basic Knowledge of Mirth Connect
  • Basic Knowledge of REST APIs

Introduction

Mirth’s client API allows you to execute certain engine operations that would typically be done manually. For example, channels don’t deploy themselves. This is a manual action that the user must perform. However, the Client API allows you to deploy channels programmatically.

Unlike the User API, Mirth’s Client API is RESTful in nature. While this article is not intended to go over REST APIs, you should know that the Client API is accessed by hitting an endpoint while the User API is accessed by invoking methods of Java classes.

To view Mirth’s Client API, log in to Mirth Connect Administrator.

When you log in to Mirth Connect, select View Client API under Other.

Your browser will open immediately; however, you will likely get a certificate error (see below) that you have to proceed through. If you cannot proceed through the certificate error, you can proceed by typing “thisisunsafe” or “badidea” after you browse to the website. Just start typing the phrase and it will let you proceed.

Note: this is not recommended for any other site.

You will see the following screen once you get past the certificate error.

The bolded text to the left-hand side of the screen represents the different API calls available to the Client. To the right of each call, you will see Show/Hide, List Operations, and Expand Operations.

Using the Client API

Additionally, notice the login on the top of your screen. Take a second to enter your Mirth Connect Administrator credentials and click Sign In. This will allow you to test client APIs for this Mirth Connect instance right in your browser.

For instance, click on the Channels API.

You will notice that several endpoints appear underneath the Channels header. The endpoints that use theGET,POST, andDELETEmethods will be colored blue, green, and red, respectively.

To the right of each endpoint, you will notice a description of what the API does. Notice that /channels can remove channel(s), retrieve a list of channels, or create a new channel depending on which HTTP method you use (DELETE, GET, or POST) when you hit the endpoint.

Next, open up one of APIs by clicking on the row.

Ignore the Model Schema for a moment and focus on the Parameters. The GET /channels API takes two parameters: channelId and pollingOnly.

ChannelId

The channelId is the UUID (Universally Unique Identifiers) that Mirth Connect assigns to every channel. This id uniquely identifies each channel from Mirth’s perspective.

In order to get more than one channel back, you can provide multiple channelIds with each on a new line (see value column above).

To find channelId for your channel, go to Channels after logging in to Mirth Connect.

Next, double-click on your channel.

Once inside your channel, you will find your channelId on the top right-hand side of your screen.

Copy your id (i.e. e285e6c7-f360-4aca-b2d3-2700ade96bb3) and paste it into the Client API.

PollingOnly

The pollingOnly parameter gives you the ability to only return channels with source connectors that poll a directory, database, etc. at a specific time of day or at an interval.

Expand the drop-down and notice that your only two options are true or false. If the parameter is not filled out, it will default to false.

Finally, click Try it out!

Additionally, notice that all parameters have value, description, parameter type, and data type columns. If the parameter name appears bold that means it is required.

After execution completes, you will see the results, which will include your API call as a curl, the requested URL, response body, response code, and response headers.

Note: curl is a set of software commands (usually in a linux command line) that allows users to leverage the HTTP protocol.

Here see that the invoked endpoint is

https://localhost:8443/api/channels?channelId=e285e6c7-f360-4aca-b2d3-2700ade96bb3&pollingOnly=false

And the curl command is

curl -X GET --header 'Accept: application/xml' 'https://localhost:8443/api/channels?channelId=e285e6c7-f360-4aca-b2d3-2700ade96bb3&pollingOnly=false'

Note: you will need to replace localhost with the DNS of the Mirth server if you are invoking the API from a different machine. If you are running Mirth Connect on your personal machine, localhost will work just fine. However, if you are working in a corporate setting you will definitely be working with a dedicated Mirth server.

Notable Client APIs

Channels

You got a good taste of the channel client API in the above example. The Channels API is one of the most useful client APIs since channels and messages are the basic building blocks of everything in Mirth Connect. This section will review several useful endpoints in the channels API.

/channels

The /channels endpoint can be invoked with the GET, POST, or DELETE methods.

POST

curl -X POST --header 'Content-Type: application/xml' --header 'Accept: application/xml' -d '{
  "id": "string",
  "nextMetaDataId": 0,
  "name": "string",
  "description": "string",
  "revision": 0,
  "sourceConnector": {
    "metaDataId": 0,
    "name": "string",
    "properties": {
      "pluginProperties": [
        {
          "name": "string",
          "purgedProperties": {}
        }
      ],
      "purgedProperties": {},
      "name": "string",
      "protocol": "string"
    },
    "transformer": {
      "elements": [
        {
          "name": "string",
          "sequenceNumber": "string",
          "enabled": false,
          "purgedProperties": {},
          "responseVariables": [
            "string"
          ],
          "type": "string"
        }
      ],
      "inboundTemplate": "string",
      "outboundTemplate": "string",
      "inboundDataType": "string",
      "outboundDataType": "string",
      "inboundProperties": {
        "serializationProperties": {
          "serializationType": "RAW",
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "deserializationProperties": {
          "serializationType": "RAW",
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "batchProperties": {
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "responseGenerationProperties": {
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "responseValidationProperties": {
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "serializerProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          }
        },
        "purgedProperties": {}
      },
      "outboundProperties": {
        "serializationProperties": {
          "serializationType": "RAW",
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "deserializationProperties": {
          "serializationType": "RAW",
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "batchProperties": {
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "responseGenerationProperties": {
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "responseValidationProperties": {
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "serializerProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          }
        },
        "purgedProperties": {}
      },
      "purgedProperties": {},
      "enabledElements": [
        {
          "name": "string",
          "sequenceNumber": "string",
          "enabled": false,
          "purgedProperties": {},
          "responseVariables": [
            "string"
          ],
          "type": "string"
        }
      ]
    },
    "responseTransformer": {
      "elements": [
        {
          "name": "string",
          "sequenceNumber": "string",
          "enabled": false,
          "purgedProperties": {},
          "responseVariables": [
            "string"
          ],
          "type": "string"
        }
      ],
      "inboundTemplate": "string",
      "outboundTemplate": "string",
      "inboundDataType": "string",
      "outboundDataType": "string",
      "inboundProperties": {
        "serializationProperties": {
          "serializationType": "RAW",
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "deserializationProperties": {
          "serializationType": "RAW",
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "batchProperties": {
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "responseGenerationProperties": {
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "responseValidationProperties": {
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "serializerProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          }
        },
        "purgedProperties": {}
      },
      "outboundProperties": {
        "serializationProperties": {
          "serializationType": "RAW",
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "deserializationProperties": {
          "serializationType": "RAW",
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "batchProperties": {
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "responseGenerationProperties": {
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "responseValidationProperties": {
          "propertyDescriptors": {},
          "properties": {},
          "purgedProperties": {}
        },
        "serializerProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          }
        },
        "purgedProperties": {}
      },
      "purgedProperties": {},
      "enabledElements": [
        {
          "name": "string",
          "sequenceNumber": "string",
          "enabled": false,
          "purgedProperties": {},
          "responseVariables": [
            "string"
          ],
          "type": "string"
        }
      ]
    },
    "filter": {
      "elements": [
        {
          "name": "string",
          "sequenceNumber": "string",
          "enabled": false,
          "operator": "AND",
          "purgedProperties": {},
          "responseVariables": [
            "string"
          ],
          "type": "string"
        }
      ],
      "purgedProperties": {},
      "enabledElements": [
        {
          "name": "string",
          "sequenceNumber": "string",
          "enabled": false,
          "operator": "AND",
          "purgedProperties": {},
          "responseVariables": [
            "string"
          ],
          "type": "string"
        }
      ]
    },
    "transportName": "string",
    "mode": "SOURCE",
    "enabled": false,
    "waitForPrevious": false,
    "purgedProperties": {}
  },
  "destinationConnectors": [
    {
      "metaDataId": 0,
      "name": "string",
      "properties": {
        "pluginProperties": [
          {
            "name": "string",
            "purgedProperties": {}
          }
        ],
        "purgedProperties": {},
        "name": "string",
        "protocol": "string"
      },
      "transformer": {
        "elements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "purgedProperties": {},
            "responseVariables": [
              "string"
            ],
            "type": "string"
          }
        ],
        "inboundTemplate": "string",
        "outboundTemplate": "string",
        "inboundDataType": "string",
        "outboundDataType": "string",
        "inboundProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "responseGenerationProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "responseValidationProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "serializerProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            }
          },
          "purgedProperties": {}
        },
        "outboundProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "responseGenerationProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "responseValidationProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "serializerProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            }
          },
          "purgedProperties": {}
        },
        "purgedProperties": {},
        "enabledElements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "purgedProperties": {},
            "responseVariables": [
              "string"
            ],
            "type": "string"
          }
        ]
      },
      "responseTransformer": {
        "elements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "purgedProperties": {},
            "responseVariables": [
              "string"
            ],
            "type": "string"
          }
        ],
        "inboundTemplate": "string",
        "outboundTemplate": "string",
        "inboundDataType": "string",
        "outboundDataType": "string",
        "inboundProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "responseGenerationProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "responseValidationProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "serializerProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            }
          },
          "purgedProperties": {}
        },
        "outboundProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "responseGenerationProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "responseValidationProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "serializerProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            }
          },
          "purgedProperties": {}
        },
        "purgedProperties": {},
        "enabledElements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "purgedProperties": {},
            "responseVariables": [
              "string"
            ],
            "type": "string"
          }
        ]
      },
      "filter": {
        "elements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "operator": "AND",
            "purgedProperties": {},
            "responseVariables": [
              "string"
            ],
            "type": "string"
          }
        ],
        "purgedProperties": {},
        "enabledElements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "operator": "AND",
            "purgedProperties": {},
            "responseVariables": [
              "string"
            ],
            "type": "string"
          }
        ]
      },
      "transportName": "string",
      "mode": "SOURCE",
      "enabled": false,
      "waitForPrevious": false,
      "purgedProperties": {}
    }
  ],
  "preprocessingScript": "string",
  "postprocessingScript": "string",
  "deployScript": "string",
  "undeployScript": "string",
  "properties": {
    "clearGlobalChannelMap": false,
    "messageStorageMode": "DEVELOPMENT",
    "encryptData": false,
    "removeContentOnCompletion": false,
    "removeOnlyFilteredOnCompletion": false,
    "removeAttachmentsOnCompletion": false,
    "initialState": "UNDEPLOYED",
    "storeAttachments": false,
    "metaDataColumns": [
      {
        "name": "string",
        "type": "STRING",
        "mappingName": "string",
        "purgedProperties": {}
      }
    ],
    "attachmentProperties": {
      "className": "string",
      "type": "string",
      "properties": {},
      "purgedProperties": {}
    },
    "resourceIds": {},
    "purgedProperties": {}
  },
  "exportData": {
    "metadata": {
      "enabled": false,
      "lastModified": "2021-08-29T19:57:13.205Z",
      "pruningSettings": {
        "pruneMetaDataDays": 0,
        "pruneContentDays": 0,
        "archiveEnabled": false,
        "purgedProperties": {}
      },
      "purgedProperties": {}
    },
    "codeTemplateLibraries": [
      {
        "id": "string",
        "name": "string",
        "revision": 0,
        "lastModified": "2021-08-29T19:57:13.205Z",
        "description": "string",
        "includeNewChannels": false,
        "enabledChannelIds": [
          "string"
        ],
        "disabledChannelIds": [
          "string"
        ],
        "codeTemplates": [
          {
            "id": "string",
            "name": "string",
            "revision": 0,
            "lastModified": "2021-08-29T19:57:13.205Z",
            "contextSet": [
              "GLOBAL_DEPLOY"
            ],
            "properties": {
              "type": "FUNCTION",
              "description": "string",
              "functionDefinition": {
                "name": "string",
                "parameters": [
                  {
                    "name": "string",
                    "type": "string",
                    "description": "string"
                  }
                ],
                "returnType": "string",
                "returnDescription": "string",
                "transferData": "string"
              },
              "pluginPointName": "string",
              "code": "string",
              "purgedProperties": {}
            },
            "purgedProperties": {},
            "description": "string",
            "type": "FUNCTION",
            "code": "string",
            "addToScripts": false,
            "functionDefinition": {
              "name": "string",
              "parameters": [
                {
                  "name": "string",
                  "type": "string",
                  "description": "string"
                }
              ],
              "returnType": "string",
              "returnDescription": "string",
              "transferData": "string"
            }
          }
        ],
        "purgedProperties": {}
      }
    ],
    "dependentIds": [
      "string"
    ],
    "dependencyIds": [
      "string"
    ],
    "channelTags": [
      {
        "id": "string",
        "name": "string",
        "channelIds": [
          "string"
        ],
        "backgroundColor": {
          "red": 0,
          "green": 0,
          "blue": 0,
          "alpha": 0,
          "rgb": 0,
          "colorSpace": {
            "type": 0,
            "numComponents": 0,
            "cs_sRGB": false
          },
          "transparency": 0
        },
        "purgedProperties": {}
      }
    ],
    "purgedProperties": {}
  },
  "purgedProperties": {},
  "enabledDestinationConnectors": [
    {
      "metaDataId": 0,
      "name": "string",
      "properties": {
        "pluginProperties": [
          {
            "name": "string",
            "purgedProperties": {}
          }
        ],
        "purgedProperties": {},
        "name": "string",
        "protocol": "string"
      },
      "transformer": {
        "elements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "purgedProperties": {},
            "responseVariables": [
              "string"
            ],
            "type": "string"
          }
        ],
        "inboundTemplate": "string",
        "outboundTemplate": "string",
        "inboundDataType": "string",
        "outboundDataType": "string",
        "inboundProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "responseGenerationProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "responseValidationProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "serializerProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            }
          },
          "purgedProperties": {}
        },
        "outboundProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "responseGenerationProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "responseValidationProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "serializerProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            }
          },
          "purgedProperties": {}
        },
        "purgedProperties": {},
        "enabledElements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "purgedProperties": {},
            "responseVariables": [
              "string"
            ],
            "type": "string"
          }
        ]
      },
      "responseTransformer": {
        "elements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "purgedProperties": {},
            "responseVariables": [
              "string"
            ],
            "type": "string"
          }
        ],
        "inboundTemplate": "string",
        "outboundTemplate": "string",
        "inboundDataType": "string",
        "outboundDataType": "string",
        "inboundProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "responseGenerationProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "responseValidationProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "serializerProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            }
          },
          "purgedProperties": {}
        },
        "outboundProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "responseGenerationProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "responseValidationProperties": {
            "propertyDescriptors": {},
            "properties": {},
            "purgedProperties": {}
          },
          "serializerProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            }
          },
          "purgedProperties": {}
        },
        "purgedProperties": {},
        "enabledElements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "purgedProperties": {},
            "responseVariables": [
              "string"
            ],
            "type": "string"
          }
        ]
      },
      "filter": {
        "elements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "operator": "AND",
            "purgedProperties": {},
            "responseVariables": [
              "string"
            ],
            "type": "string"
          }
        ],
        "purgedProperties": {},
        "enabledElements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "operator": "AND",
            "purgedProperties": {},
            "responseVariables": [
              "string"
            ],
            "type": "string"
          }
        ]
      },
      "transportName": "string",
      "mode": "SOURCE",
      "enabled": false,
      "waitForPrevious": false,
      "purgedProperties": {}
    }
  ]
}' 'https://localhost:8443/api/channels'

Note: the -d parameter contains the body of the post request. Fill in the body with the appropriate values for your channel.

DELETE

curl -X DELETE --header 'Accept: application/xml' 'https://localhost:8443/api/channels?channelId=e285e6c7-f360-4aca-b2d3-2700ade96bb3'

/channels/_removeChannels

This API removes all specified channels and serves as an alternative to the DELETE option above.

POST

curl -X POST --header 'Content-Type: application/xml' --header 'Accept: application/xml' -d 'f9c8228b-95fb-44ae-acd3-e7018815811b' 'https://localhost:8443/api/channels/_removeChannels'

Note: the -d option contains the body of your request.

/channels/{channelId}

GET

curl -X GET --header 'Accept: application/xml' 'https://localhost:8443/api/channels/e285e6c7-f360-4aca-b2d3-2700ade96bb3'

PUT

Ncurl -X PUT --header 'Content-Type: application/xml' --header 'Accept: application/xml' -d '{
  "id": "string",
  "nextMetaDataId": 0,
  "name": "string",
  "description": "string",
  "revision": 0,
  "sourceConnector": {
    "metaDataId": 0,
    "name": "string",
    "properties": {
      "pluginProperties": [
        {
          "name": "string",
          "purgedProperties": {}
        }
      ],
      "name": "string",
      "protocol": "string",
      "purgedProperties": {}
    },
    "transformer": {
      "elements": [
        {
          "name": "string",
          "sequenceNumber": "string",
          "enabled": false,
          "responseVariables": [
            "string"
          ],
          "type": "string",
          "purgedProperties": {}
        }
      ],
      "inboundTemplate": "string",
      "outboundTemplate": "string",
      "inboundDataType": "string",
      "outboundDataType": "string",
      "inboundProperties": {
        "serializationProperties": {
          "serializationType": "RAW",
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "deserializationProperties": {
          "serializationType": "RAW",
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "batchProperties": {
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "responseGenerationProperties": {
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "responseValidationProperties": {
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "serializerProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          }
        },
        "purgedProperties": {}
      },
      "outboundProperties": {
        "serializationProperties": {
          "serializationType": "RAW",
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "deserializationProperties": {
          "serializationType": "RAW",
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "batchProperties": {
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "responseGenerationProperties": {
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "responseValidationProperties": {
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "serializerProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          }
        },
        "purgedProperties": {}
      },
      "purgedProperties": {},
      "enabledElements": [
        {
          "name": "string",
          "sequenceNumber": "string",
          "enabled": false,
          "responseVariables": [
            "string"
          ],
          "type": "string",
          "purgedProperties": {}
        }
      ]
    },
    "responseTransformer": {
      "elements": [
        {
          "name": "string",
          "sequenceNumber": "string",
          "enabled": false,
          "responseVariables": [
            "string"
          ],
          "type": "string",
          "purgedProperties": {}
        }
      ],
      "inboundTemplate": "string",
      "outboundTemplate": "string",
      "inboundDataType": "string",
      "outboundDataType": "string",
      "inboundProperties": {
        "serializationProperties": {
          "serializationType": "RAW",
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "deserializationProperties": {
          "serializationType": "RAW",
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "batchProperties": {
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "responseGenerationProperties": {
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "responseValidationProperties": {
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "serializerProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          }
        },
        "purgedProperties": {}
      },
      "outboundProperties": {
        "serializationProperties": {
          "serializationType": "RAW",
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "deserializationProperties": {
          "serializationType": "RAW",
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "batchProperties": {
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "responseGenerationProperties": {
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "responseValidationProperties": {
          "properties": {},
          "propertyDescriptors": {},
          "purgedProperties": {}
        },
        "serializerProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          }
        },
        "purgedProperties": {}
      },
      "purgedProperties": {},
      "enabledElements": [
        {
          "name": "string",
          "sequenceNumber": "string",
          "enabled": false,
          "responseVariables": [
            "string"
          ],
          "type": "string",
          "purgedProperties": {}
        }
      ]
    },
    "filter": {
      "elements": [
        {
          "name": "string",
          "sequenceNumber": "string",
          "enabled": false,
          "operator": "AND",
          "purgedProperties": {},
          "responseVariables": [
            "string"
          ],
          "type": "string"
        }
      ],
      "enabledElements": [
        {
          "name": "string",
          "sequenceNumber": "string",
          "enabled": false,
          "operator": "AND",
          "purgedProperties": {},
          "responseVariables": [
            "string"
          ],
          "type": "string"
        }
      ],
      "purgedProperties": {}
    },
    "transportName": "string",
    "mode": "SOURCE",
    "enabled": false,
    "waitForPrevious": false,
    "purgedProperties": {}
  },
  "destinationConnectors": [
    {
      "metaDataId": 0,
      "name": "string",
      "properties": {
        "pluginProperties": [
          {
            "name": "string",
            "purgedProperties": {}
          }
        ],
        "name": "string",
        "protocol": "string",
        "purgedProperties": {}
      },
      "transformer": {
        "elements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "responseVariables": [
              "string"
            ],
            "type": "string",
            "purgedProperties": {}
          }
        ],
        "inboundTemplate": "string",
        "outboundTemplate": "string",
        "inboundDataType": "string",
        "outboundDataType": "string",
        "inboundProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "responseGenerationProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "responseValidationProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "serializerProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            }
          },
          "purgedProperties": {}
        },
        "outboundProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "responseGenerationProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "responseValidationProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "serializerProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            }
          },
          "purgedProperties": {}
        },
        "purgedProperties": {},
        "enabledElements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "responseVariables": [
              "string"
            ],
            "type": "string",
            "purgedProperties": {}
          }
        ]
      },
      "responseTransformer": {
        "elements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "responseVariables": [
              "string"
            ],
            "type": "string",
            "purgedProperties": {}
          }
        ],
        "inboundTemplate": "string",
        "outboundTemplate": "string",
        "inboundDataType": "string",
        "outboundDataType": "string",
        "inboundProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "responseGenerationProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "responseValidationProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "serializerProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            }
          },
          "purgedProperties": {}
        },
        "outboundProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "responseGenerationProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "responseValidationProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "serializerProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            }
          },
          "purgedProperties": {}
        },
        "purgedProperties": {},
        "enabledElements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "responseVariables": [
              "string"
            ],
            "type": "string",
            "purgedProperties": {}
          }
        ]
      },
      "filter": {
        "elements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "operator": "AND",
            "purgedProperties": {},
            "responseVariables": [
              "string"
            ],
            "type": "string"
          }
        ],
        "enabledElements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "operator": "AND",
            "purgedProperties": {},
            "responseVariables": [
              "string"
            ],
            "type": "string"
          }
        ],
        "purgedProperties": {}
      },
      "transportName": "string",
      "mode": "SOURCE",
      "enabled": false,
      "waitForPrevious": false,
      "purgedProperties": {}
    }
  ],
  "preprocessingScript": "string",
  "postprocessingScript": "string",
  "deployScript": "string",
  "undeployScript": "string",
  "properties": {
    "clearGlobalChannelMap": false,
    "messageStorageMode": "DEVELOPMENT",
    "encryptData": false,
    "removeContentOnCompletion": false,
    "removeOnlyFilteredOnCompletion": false,
    "removeAttachmentsOnCompletion": false,
    "initialState": "UNDEPLOYED",
    "storeAttachments": false,
    "metaDataColumns": [
      {
        "name": "string",
        "type": "STRING",
        "mappingName": "string",
        "purgedProperties": {}
      }
    ],
    "attachmentProperties": {
      "className": "string",
      "type": "string",
      "properties": {},
      "purgedProperties": {}
    },
    "resourceIds": {},
    "purgedProperties": {}
  },
  "exportData": {
    "metadata": {
      "enabled": false,
      "lastModified": "2021-08-30T12:07:19.913Z",
      "pruningSettings": {
        "pruneMetaDataDays": 0,
        "pruneContentDays": 0,
        "archiveEnabled": false,
        "purgedProperties": {}
      },
      "purgedProperties": {}
    },
    "codeTemplateLibraries": [
      {
        "id": "string",
        "name": "string",
        "revision": 0,
        "lastModified": "2021-08-30T12:07:19.913Z",
        "description": "string",
        "includeNewChannels": false,
        "enabledChannelIds": [
          "string"
        ],
        "disabledChannelIds": [
          "string"
        ],
        "codeTemplates": [
          {
            "id": "string",
            "name": "string",
            "revision": 0,
            "lastModified": "2021-08-30T12:07:19.913Z",
            "contextSet": [
              "GLOBAL_DEPLOY"
            ],
            "properties": {
              "type": "FUNCTION",
              "description": "string",
              "functionDefinition": {
                "name": "string",
                "parameters": [
                  {
                    "name": "string",
                    "type": "string",
                    "description": "string"
                  }
                ],
                "returnType": "string",
                "returnDescription": "string",
                "transferData": "string"
              },
              "code": "string",
              "pluginPointName": "string",
              "purgedProperties": {}
            },
            "code": "string",
            "addToScripts": false,
            "functionDefinition": {
              "name": "string",
              "parameters": [
                {
                  "name": "string",
                  "type": "string",
                  "description": "string"
                }
              ],
              "returnType": "string",
              "returnDescription": "string",
              "transferData": "string"
            },
            "type": "FUNCTION",
            "description": "string",
            "purgedProperties": {}
          }
        ],
        "purgedProperties": {}
      }
    ],
    "dependentIds": [
      "string"
    ],
    "dependencyIds": [
      "string"
    ],
    "channelTags": [
      {
        "id": "string",
        "name": "string",
        "channelIds": [
          "string"
        ],
        "backgroundColor": {
          "red": 0,
          "green": 0,
          "blue": 0,
          "alpha": 0,
          "rgb": 0,
          "colorSpace": {
            "type": 0,
            "numComponents": 0,
            "cs_sRGB": false
          },
          "transparency": 0
        },
        "purgedProperties": {}
      }
    ],
    "purgedProperties": {}
  },
  "purgedProperties": {},
  "enabledDestinationConnectors": [
    {
      "metaDataId": 0,
      "name": "string",
      "properties": {
        "pluginProperties": [
          {
            "name": "string",
            "purgedProperties": {}
          }
        ],
        "name": "string",
        "protocol": "string",
        "purgedProperties": {}
      },
      "transformer": {
        "elements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "responseVariables": [
              "string"
            ],
            "type": "string",
            "purgedProperties": {}
          }
        ],
        "inboundTemplate": "string",
        "outboundTemplate": "string",
        "inboundDataType": "string",
        "outboundDataType": "string",
        "inboundProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "responseGenerationProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "responseValidationProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "serializerProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            }
          },
          "purgedProperties": {}
        },
        "outboundProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "responseGenerationProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "responseValidationProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "serializerProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            }
          },
          "purgedProperties": {}
        },
        "purgedProperties": {},
        "enabledElements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "responseVariables": [
              "string"
            ],
            "type": "string",
            "purgedProperties": {}
          }
        ]
      },
      "responseTransformer": {
        "elements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "responseVariables": [
              "string"
            ],
            "type": "string",
            "purgedProperties": {}
          }
        ],
        "inboundTemplate": "string",
        "outboundTemplate": "string",
        "inboundDataType": "string",
        "outboundDataType": "string",
        "inboundProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "responseGenerationProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "responseValidationProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "serializerProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            }
          },
          "purgedProperties": {}
        },
        "outboundProperties": {
          "serializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "deserializationProperties": {
            "serializationType": "RAW",
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "batchProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "responseGenerationProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "responseValidationProperties": {
            "properties": {},
            "propertyDescriptors": {},
            "purgedProperties": {}
          },
          "serializerProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "properties": {},
              "propertyDescriptors": {},
              "purgedProperties": {}
            }
          },
          "purgedProperties": {}
        },
        "purgedProperties": {},
        "enabledElements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "responseVariables": [
              "string"
            ],
            "type": "string",
            "purgedProperties": {}
          }
        ]
      },
      "filter": {
        "elements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "operator": "AND",
            "purgedProperties": {},
            "responseVariables": [
              "string"
            ],
            "type": "string"
          }
        ],
        "enabledElements": [
          {
            "name": "string",
            "sequenceNumber": "string",
            "enabled": false,
            "operator": "AND",
            "purgedProperties": {},
            "responseVariables": [
              "string"
            ],
            "type": "string"
          }
        ],
        "purgedProperties": {}
      },
      "transportName": "string",
      "mode": "SOURCE",
      "enabled": false,
      "waitForPrevious": false,
      "purgedProperties": {}
    }
  ]
}' 'https://localhost:8443/api/channels/e285e6c7-f360-4aca-b2d3-2700ade96bb3?override=false'

Note: the -d parameter contains the body of the post request. Fill in the body with the appropriate values for your channel.

DELETE

curl -X DELETE --header 'Accept: application/xml' 'https://localhost:8443/api/channels/e285e6c7-f360-4aca-b2d3-2700ade96bb3'

Messages

This section will review several available endpoints in the messages API.

/channels/_removeAllMessages

This API serves to remove all messages within the specified Mirth connect channel(s).

DELETE

curl -X DELETE --header 'Accept: application/xml' 'https://localhost:8443/api/channels/_removeAllMessages?channelId=e285e6c7-f360-4aca-b2d3-2700ade96bb3&restartRunningChannels=false&clearStatistics=true'

/channels/{channelId}/messages

Retrieve or deletes all messages based on specified criteria. If using the POST method creates the messages and processes them through the channel.

GET

curl -X GET --header 'Accept: application/xml' 'https://localhost:8443/api/channels/e285e6c7-f360-4aca-b2d3-2700ade96bb3/messages?includeContent=false&offset=0&limit=20'

POST

curl -X POST --header 'Content-Type: text/plain' --header 'Accept: application/xml' -d '{}' 'https://localhost:8443/api/channels/e285e6c7-f360-4aca-b2d3-2700ade96bb3/messages'

DELETE

curl -X DELETE --header 'Accept: application/xml' 'https://localhost:8443/api/channels/e285e6c7-f360-4aca-b2d3-2700ade96bb3/messages'

/channels/{channelId}/messages/{messageId}

Retrieves or removes on the individual message level.

GET

curl -X GET --header 'Accept: application/xml' 'https://localhost:8443/api/channels/e285e6c7-f360-4aca-b2d3-2700ade96bb3/messages/2'

DELETE

curl -X DELETE --header 'Accept: application/xml' 'https://localhost:8443/api/channels/e285e6c7-f360-4aca-b2d3-2700ade96bb3/messages/2'

System Configuration

This section will demonstrate several available endpoints in the system configuration API.

/server/configuration

GET

curl -X GET --header 'Accept: application/xml' 'https://localhost:8443/api/server/configuration'

PUT

curl -X PUT --header 'Content-Type: application/xml' --header 'Accept: application/xml' -d '{
  "date": "string",
  "channelGroups": [
    {
      "id": "string",
      "name": "string",
      "revision": 0,
      "lastModified": "2021-08-29T19:57:13.241Z",
      "description": "string",
      "channels": [
        {
          "id": "string",
          "nextMetaDataId": 0,
          "name": "string",
          "description": "string",
          "revision": 0,
          "sourceConnector": {
            "metaDataId": 0,
            "name": "string",
            "properties": {
              "pluginProperties": [
                {
                  "name": "string",
                  "purgedProperties": {}
                }
              ],
              "purgedProperties": {},
              "name": "string",
              "protocol": "string"
            },
            "transformer": {
              "elements": [
                {
                  "name": "string",
                  "sequenceNumber": "string",
                  "enabled": false,
                  "purgedProperties": {},
                  "responseVariables": [
                    "string"
                  ],
                  "type": "string"
                }
              ],
              "inboundTemplate": "string",
              "outboundTemplate": "string",
              "inboundDataType": "string",
              "outboundDataType": "string",
              "inboundProperties": {
                "serializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "deserializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "batchProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "responseGenerationProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "responseValidationProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "serializerProperties": {
                  "serializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "deserializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "batchProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  }
                },
                "purgedProperties": {}
              },
              "outboundProperties": {
                "serializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "deserializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "batchProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "responseGenerationProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "responseValidationProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "serializerProperties": {
                  "serializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "deserializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "batchProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  }
                },
                "purgedProperties": {}
              },
              "purgedProperties": {},
              "enabledElements": [
                {
                  "name": "string",
                  "sequenceNumber": "string",
                  "enabled": false,
                  "purgedProperties": {},
                  "responseVariables": [
                    "string"
                  ],
                  "type": "string"
                }
              ]
            },
            "responseTransformer": {
              "elements": [
                {
                  "name": "string",
                  "sequenceNumber": "string",
                  "enabled": false,
                  "purgedProperties": {},
                  "responseVariables": [
                    "string"
                  ],
                  "type": "string"
                }
              ],
              "inboundTemplate": "string",
              "outboundTemplate": "string",
              "inboundDataType": "string",
              "outboundDataType": "string",
              "inboundProperties": {
                "serializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "deserializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "batchProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "responseGenerationProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "responseValidationProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "serializerProperties": {
                  "serializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "deserializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "batchProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  }
                },
                "purgedProperties": {}
              },
              "outboundProperties": {
                "serializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "deserializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "batchProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "responseGenerationProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "responseValidationProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "serializerProperties": {
                  "serializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "deserializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "batchProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  }
                },
                "purgedProperties": {}
              },
              "purgedProperties": {},
              "enabledElements": [
                {
                  "name": "string",
                  "sequenceNumber": "string",
                  "enabled": false,
                  "purgedProperties": {},
                  "responseVariables": [
                    "string"
                  ],
                  "type": "string"
                }
              ]
            },
            "filter": {
              "elements": [
                {
                  "name": "string",
                  "sequenceNumber": "string",
                  "enabled": false,
                  "operator": "AND",
                  "purgedProperties": {},
                  "responseVariables": [
                    "string"
                  ],
                  "type": "string"
                }
              ],
              "purgedProperties": {},
              "enabledElements": [
                {
                  "name": "string",
                  "sequenceNumber": "string",
                  "enabled": false,
                  "operator": "AND",
                  "purgedProperties": {},
                  "responseVariables": [
                    "string"
                  ],
                  "type": "string"
                }
              ]
            },
            "transportName": "string",
            "mode": "SOURCE",
            "enabled": false,
            "waitForPrevious": false,
            "purgedProperties": {}
          },
          "destinationConnectors": [
            {
              "metaDataId": 0,
              "name": "string",
              "properties": {
                "pluginProperties": [
                  {
                    "name": "string",
                    "purgedProperties": {}
                  }
                ],
                "purgedProperties": {},
                "name": "string",
                "protocol": "string"
              },
              "transformer": {
                "elements": [
                  {
                    "name": "string",
                    "sequenceNumber": "string",
                    "enabled": false,
                    "purgedProperties": {},
                    "responseVariables": [
                      "string"
                    ],
                    "type": "string"
                  }
                ],
                "inboundTemplate": "string",
                "outboundTemplate": "string",
                "inboundDataType": "string",
                "outboundDataType": "string",
                "inboundProperties": {
                  "serializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "deserializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "batchProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "responseGenerationProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "responseValidationProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "serializerProperties": {
                    "serializationProperties": {
                      "serializationType": "RAW",
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    },
                    "deserializationProperties": {
                      "serializationType": "RAW",
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    },
                    "batchProperties": {
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    }
                  },
                  "purgedProperties": {}
                },
                "outboundProperties": {
                  "serializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "deserializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "batchProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "responseGenerationProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "responseValidationProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "serializerProperties": {
                    "serializationProperties": {
                      "serializationType": "RAW",
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    },
                    "deserializationProperties": {
                      "serializationType": "RAW",
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    },
                    "batchProperties": {
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    }
                  },
                  "purgedProperties": {}
                },
                "purgedProperties": {},
                "enabledElements": [
                  {
                    "name": "string",
                    "sequenceNumber": "string",
                    "enabled": false,
                    "purgedProperties": {},
                    "responseVariables": [
                      "string"
                    ],
                    "type": "string"
                  }
                ]
              },
              "responseTransformer": {
                "elements": [
                  {
                    "name": "string",
                    "sequenceNumber": "string",
                    "enabled": false,
                    "purgedProperties": {},
                    "responseVariables": [
                      "string"
                    ],
                    "type": "string"
                  }
                ],
                "inboundTemplate": "string",
                "outboundTemplate": "string",
                "inboundDataType": "string",
                "outboundDataType": "string",
                "inboundProperties": {
                  "serializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "deserializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "batchProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "responseGenerationProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "responseValidationProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "serializerProperties": {
                    "serializationProperties": {
                      "serializationType": "RAW",
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    },
                    "deserializationProperties": {
                      "serializationType": "RAW",
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    },
                    "batchProperties": {
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    }
                  },
                  "purgedProperties": {}
                },
                "outboundProperties": {
                  "serializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "deserializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "batchProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "responseGenerationProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "responseValidationProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "serializerProperties": {
                    "serializationProperties": {
                      "serializationType": "RAW",
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    },
                    "deserializationProperties": {
                      "serializationType": "RAW",
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    },
                    "batchProperties": {
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    }
                  },
                  "purgedProperties": {}
                },
                "purgedProperties": {},
                "enabledElements": [
                  {
                    "name": "string",
                    "sequenceNumber": "string",
                    "enabled": false,
                    "purgedProperties": {},
                    "responseVariables": [
                      "string"
                    ],
                    "type": "string"
                  }
                ]
              },
              "filter": {
                "elements": [
                  {
                    "name": "string",
                    "sequenceNumber": "string",
                    "enabled": false,
                    "operator": "AND",
                    "purgedProperties": {},
                    "responseVariables": [
                      "string"
                    ],
                    "type": "string"
                  }
                ],
                "purgedProperties": {},
                "enabledElements": [
                  {
                    "name": "string",
                    "sequenceNumber": "string",
                    "enabled": false,
                    "operator": "AND",
                    "purgedProperties": {},
                    "responseVariables": [
                      "string"
                    ],
                    "type": "string"
                  }
                ]
              },
              "transportName": "string",
              "mode": "SOURCE",
              "enabled": false,
              "waitForPrevious": false,
              "purgedProperties": {}
            }
          ],
          "preprocessingScript": "string",
          "postprocessingScript": "string",
          "deployScript": "string",
          "undeployScript": "string",
          "properties": {
            "clearGlobalChannelMap": false,
            "messageStorageMode": "DEVELOPMENT",
            "encryptData": false,
            "removeContentOnCompletion": false,
            "removeOnlyFilteredOnCompletion": false,
            "removeAttachmentsOnCompletion": false,
            "initialState": "UNDEPLOYED",
            "storeAttachments": false,
            "metaDataColumns": [
              {
                "name": "string",
                "type": "STRING",
                "mappingName": "string",
                "purgedProperties": {}
              }
            ],
            "attachmentProperties": {
              "className": "string",
              "type": "string",
              "properties": {},
              "purgedProperties": {}
            },
            "resourceIds": {},
            "purgedProperties": {}
          },
          "exportData": {
            "metadata": {
              "enabled": false,
              "lastModified": "2021-08-29T19:57:13.244Z",
              "pruningSettings": {
                "pruneMetaDataDays": 0,
                "pruneContentDays": 0,
                "archiveEnabled": false,
                "purgedProperties": {}
              },
              "purgedProperties": {}
            },
            "codeTemplateLibraries": [
              {
                "id": "string",
                "name": "string",
                "revision": 0,
                "lastModified": "2021-08-29T19:57:13.244Z",
                "description": "string",
                "includeNewChannels": false,
                "enabledChannelIds": [
                  "string"
                ],
                "disabledChannelIds": [
                  "string"
                ],
                "codeTemplates": [
                  {
                    "id": "string",
                    "name": "string",
                    "revision": 0,
                    "lastModified": "2021-08-29T19:57:13.244Z",
                    "contextSet": [
                      "GLOBAL_DEPLOY"
                    ],
                    "properties": {
                      "type": "FUNCTION",
                      "description": "string",
                      "functionDefinition": {
                        "name": "string",
                        "parameters": [
                          {
                            "name": "string",
                            "type": "string",
                            "description": "string"
                          }
                        ],
                        "returnType": "string",
                        "returnDescription": "string",
                        "transferData": "string"
                      },
                      "pluginPointName": "string",
                      "code": "string",
                      "purgedProperties": {}
                    },
                    "purgedProperties": {},
                    "description": "string",
                    "type": "FUNCTION",
                    "code": "string",
                    "addToScripts": false,
                    "functionDefinition": {
                      "name": "string",
                      "parameters": [
                        {
                          "name": "string",
                          "type": "string",
                          "description": "string"
                        }
                      ],
                      "returnType": "string",
                      "returnDescription": "string",
                      "transferData": "string"
                    }
                  }
                ],
                "purgedProperties": {}
              }
            ],
            "dependentIds": [
              "string"
            ],
            "dependencyIds": [
              "string"
            ],
            "channelTags": [
              {
                "id": "string",
                "name": "string",
                "channelIds": [
                  "string"
                ],
                "backgroundColor": {
                  "red": 0,
                  "green": 0,
                  "blue": 0,
                  "alpha": 0,
                  "rgb": 0,
                  "colorSpace": {
                    "type": 0,
                    "numComponents": 0,
                    "cs_sRGB": false
                  },
                  "transparency": 0
                },
                "purgedProperties": {}
              }
            ],
            "purgedProperties": {}
          },
          "purgedProperties": {},
          "enabledDestinationConnectors": [
            {
              "metaDataId": 0,
              "name": "string",
              "properties": {
                "pluginProperties": [
                  {
                    "name": "string",
                    "purgedProperties": {}
                  }
                ],
                "purgedProperties": {},
                "name": "string",
                "protocol": "string"
              },
              "transformer": {
                "elements": [
                  {
                    "name": "string",
                    "sequenceNumber": "string",
                    "enabled": false,
                    "purgedProperties": {},
                    "responseVariables": [
                      "string"
                    ],
                    "type": "string"
                  }
                ],
                "inboundTemplate": "string",
                "outboundTemplate": "string",
                "inboundDataType": "string",
                "outboundDataType": "string",
                "inboundProperties": {
                  "serializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "deserializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "batchProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "responseGenerationProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "responseValidationProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "serializerProperties": {
                    "serializationProperties": {
                      "serializationType": "RAW",
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    },
                    "deserializationProperties": {
                      "serializationType": "RAW",
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    },
                    "batchProperties": {
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    }
                  },
                  "purgedProperties": {}
                },
                "outboundProperties": {
                  "serializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "deserializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "batchProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "responseGenerationProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "responseValidationProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "serializerProperties": {
                    "serializationProperties": {
                      "serializationType": "RAW",
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    },
                    "deserializationProperties": {
                      "serializationType": "RAW",
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    },
                    "batchProperties": {
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    }
                  },
                  "purgedProperties": {}
                },
                "purgedProperties": {},
                "enabledElements": [
                  {
                    "name": "string",
                    "sequenceNumber": "string",
                    "enabled": false,
                    "purgedProperties": {},
                    "responseVariables": [
                      "string"
                    ],
                    "type": "string"
                  }
                ]
              },
              "responseTransformer": {
                "elements": [
                  {
                    "name": "string",
                    "sequenceNumber": "string",
                    "enabled": false,
                    "purgedProperties": {},
                    "responseVariables": [
                      "string"
                    ],
                    "type": "string"
                  }
                ],
                "inboundTemplate": "string",
                "outboundTemplate": "string",
                "inboundDataType": "string",
                "outboundDataType": "string",
                "inboundProperties": {
                  "serializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "deserializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "batchProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "responseGenerationProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "responseValidationProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "serializerProperties": {
                    "serializationProperties": {
                      "serializationType": "RAW",
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    },
                    "deserializationProperties": {
                      "serializationType": "RAW",
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    },
                    "batchProperties": {
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    }
                  },
                  "purgedProperties": {}
                },
                "outboundProperties": {
                  "serializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "deserializationProperties": {
                    "serializationType": "RAW",
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "batchProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "responseGenerationProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "responseValidationProperties": {
                    "propertyDescriptors": {},
                    "properties": {},
                    "purgedProperties": {}
                  },
                  "serializerProperties": {
                    "serializationProperties": {
                      "serializationType": "RAW",
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    },
                    "deserializationProperties": {
                      "serializationType": "RAW",
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    },
                    "batchProperties": {
                      "propertyDescriptors": {},
                      "properties": {},
                      "purgedProperties": {}
                    }
                  },
                  "purgedProperties": {}
                },
                "purgedProperties": {},
                "enabledElements": [
                  {
                    "name": "string",
                    "sequenceNumber": "string",
                    "enabled": false,
                    "purgedProperties": {},
                    "responseVariables": [
                      "string"
                    ],
                    "type": "string"
                  }
                ]
              },
              "filter": {
                "elements": [
                  {
                    "name": "string",
                    "sequenceNumber": "string",
                    "enabled": false,
                    "operator": "AND",
                    "purgedProperties": {},
                    "responseVariables": [
                      "string"
                    ],
                    "type": "string"
                  }
                ],
                "purgedProperties": {},
                "enabledElements": [
                  {
                    "name": "string",
                    "sequenceNumber": "string",
                    "enabled": false,
                    "operator": "AND",
                    "purgedProperties": {},
                    "responseVariables": [
                      "string"
                    ],
                    "type": "string"
                  }
                ]
              },
              "transportName": "string",
              "mode": "SOURCE",
              "enabled": false,
              "waitForPrevious": false,
              "purgedProperties": {}
            }
          ]
        }
      ],
      "purgedProperties": {}
    }
  ],
  "channels": [
    {
      "id": "string",
      "nextMetaDataId": 0,
      "name": "string",
      "description": "string",
      "revision": 0,
      "sourceConnector": {
        "metaDataId": 0,
        "name": "string",
        "properties": {
          "pluginProperties": [
            {
              "name": "string",
              "purgedProperties": {}
            }
          ],
          "purgedProperties": {},
          "name": "string",
          "protocol": "string"
        },
        "transformer": {
          "elements": [
            {
              "name": "string",
              "sequenceNumber": "string",
              "enabled": false,
              "purgedProperties": {},
              "responseVariables": [
                "string"
              ],
              "type": "string"
            }
          ],
          "inboundTemplate": "string",
          "outboundTemplate": "string",
          "inboundDataType": "string",
          "outboundDataType": "string",
          "inboundProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "responseGenerationProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "responseValidationProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "serializerProperties": {
              "serializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "deserializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "batchProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              }
            },
            "purgedProperties": {}
          },
          "outboundProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "responseGenerationProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "responseValidationProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "serializerProperties": {
              "serializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "deserializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "batchProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              }
            },
            "purgedProperties": {}
          },
          "purgedProperties": {},
          "enabledElements": [
            {
              "name": "string",
              "sequenceNumber": "string",
              "enabled": false,
              "purgedProperties": {},
              "responseVariables": [
                "string"
              ],
              "type": "string"
            }
          ]
        },
        "responseTransformer": {
          "elements": [
            {
              "name": "string",
              "sequenceNumber": "string",
              "enabled": false,
              "purgedProperties": {},
              "responseVariables": [
                "string"
              ],
              "type": "string"
            }
          ],
          "inboundTemplate": "string",
          "outboundTemplate": "string",
          "inboundDataType": "string",
          "outboundDataType": "string",
          "inboundProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "responseGenerationProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "responseValidationProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "serializerProperties": {
              "serializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "deserializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "batchProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              }
            },
            "purgedProperties": {}
          },
          "outboundProperties": {
            "serializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "deserializationProperties": {
              "serializationType": "RAW",
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "batchProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "responseGenerationProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "responseValidationProperties": {
              "propertyDescriptors": {},
              "properties": {},
              "purgedProperties": {}
            },
            "serializerProperties": {
              "serializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "deserializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "batchProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              }
            },
            "purgedProperties": {}
          },
          "purgedProperties": {},
          "enabledElements": [
            {
              "name": "string",
              "sequenceNumber": "string",
              "enabled": false,
              "purgedProperties": {},
              "responseVariables": [
                "string"
              ],
              "type": "string"
            }
          ]
        },
        "filter": {
          "elements": [
            {
              "name": "string",
              "sequenceNumber": "string",
              "enabled": false,
              "operator": "AND",
              "purgedProperties": {},
              "responseVariables": [
                "string"
              ],
              "type": "string"
            }
          ],
          "purgedProperties": {},
          "enabledElements": [
            {
              "name": "string",
              "sequenceNumber": "string",
              "enabled": false,
              "operator": "AND",
              "purgedProperties": {},
              "responseVariables": [
                "string"
              ],
              "type": "string"
            }
          ]
        },
        "transportName": "string",
        "mode": "SOURCE",
        "enabled": false,
        "waitForPrevious": false,
        "purgedProperties": {}
      },
      "destinationConnectors": [
        {
          "metaDataId": 0,
          "name": "string",
          "properties": {
            "pluginProperties": [
              {
                "name": "string",
                "purgedProperties": {}
              }
            ],
            "purgedProperties": {},
            "name": "string",
            "protocol": "string"
          },
          "transformer": {
            "elements": [
              {
                "name": "string",
                "sequenceNumber": "string",
                "enabled": false,
                "purgedProperties": {},
                "responseVariables": [
                  "string"
                ],
                "type": "string"
              }
            ],
            "inboundTemplate": "string",
            "outboundTemplate": "string",
            "inboundDataType": "string",
            "outboundDataType": "string",
            "inboundProperties": {
              "serializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "deserializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "batchProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "responseGenerationProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "responseValidationProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "serializerProperties": {
                "serializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "deserializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "batchProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                }
              },
              "purgedProperties": {}
            },
            "outboundProperties": {
              "serializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "deserializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "batchProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "responseGenerationProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "responseValidationProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "serializerProperties": {
                "serializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "deserializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "batchProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                }
              },
              "purgedProperties": {}
            },
            "purgedProperties": {},
            "enabledElements": [
              {
                "name": "string",
                "sequenceNumber": "string",
                "enabled": false,
                "purgedProperties": {},
                "responseVariables": [
                  "string"
                ],
                "type": "string"
              }
            ]
          },
          "responseTransformer": {
            "elements": [
              {
                "name": "string",
                "sequenceNumber": "string",
                "enabled": false,
                "purgedProperties": {},
                "responseVariables": [
                  "string"
                ],
                "type": "string"
              }
            ],
            "inboundTemplate": "string",
            "outboundTemplate": "string",
            "inboundDataType": "string",
            "outboundDataType": "string",
            "inboundProperties": {
              "serializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "deserializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "batchProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "responseGenerationProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "responseValidationProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "serializerProperties": {
                "serializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "deserializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "batchProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                }
              },
              "purgedProperties": {}
            },
            "outboundProperties": {
              "serializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "deserializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "batchProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "responseGenerationProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "responseValidationProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "serializerProperties": {
                "serializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "deserializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "batchProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                }
              },
              "purgedProperties": {}
            },
            "purgedProperties": {},
            "enabledElements": [
              {
                "name": "string",
                "sequenceNumber": "string",
                "enabled": false,
                "purgedProperties": {},
                "responseVariables": [
                  "string"
                ],
                "type": "string"
              }
            ]
          },
          "filter": {
            "elements": [
              {
                "name": "string",
                "sequenceNumber": "string",
                "enabled": false,
                "operator": "AND",
                "purgedProperties": {},
                "responseVariables": [
                  "string"
                ],
                "type": "string"
              }
            ],
            "purgedProperties": {},
            "enabledElements": [
              {
                "name": "string",
                "sequenceNumber": "string",
                "enabled": false,
                "operator": "AND",
                "purgedProperties": {},
                "responseVariables": [
                  "string"
                ],
                "type": "string"
              }
            ]
          },
          "transportName": "string",
          "mode": "SOURCE",
          "enabled": false,
          "waitForPrevious": false,
          "purgedProperties": {}
        }
      ],
      "preprocessingScript": "string",
      "postprocessingScript": "string",
      "deployScript": "string",
      "undeployScript": "string",
      "properties": {
        "clearGlobalChannelMap": false,
        "messageStorageMode": "DEVELOPMENT",
        "encryptData": false,
        "removeContentOnCompletion": false,
        "removeOnlyFilteredOnCompletion": false,
        "removeAttachmentsOnCompletion": false,
        "initialState": "UNDEPLOYED",
        "storeAttachments": false,
        "metaDataColumns": [
          {
            "name": "string",
            "type": "STRING",
            "mappingName": "string",
            "purgedProperties": {}
          }
        ],
        "attachmentProperties": {
          "className": "string",
          "type": "string",
          "properties": {},
          "purgedProperties": {}
        },
        "resourceIds": {},
        "purgedProperties": {}
      },
      "exportData": {
        "metadata": {
          "enabled": false,
          "lastModified": "2021-08-29T19:57:13.248Z",
          "pruningSettings": {
            "pruneMetaDataDays": 0,
            "pruneContentDays": 0,
            "archiveEnabled": false,
            "purgedProperties": {}
          },
          "purgedProperties": {}
        },
        "codeTemplateLibraries": [
          {
            "id": "string",
            "name": "string",
            "revision": 0,
            "lastModified": "2021-08-29T19:57:13.248Z",
            "description": "string",
            "includeNewChannels": false,
            "enabledChannelIds": [
              "string"
            ],
            "disabledChannelIds": [
              "string"
            ],
            "codeTemplates": [
              {
                "id": "string",
                "name": "string",
                "revision": 0,
                "lastModified": "2021-08-29T19:57:13.248Z",
                "contextSet": [
                  "GLOBAL_DEPLOY"
                ],
                "properties": {
                  "type": "FUNCTION",
                  "description": "string",
                  "functionDefinition": {
                    "name": "string",
                    "parameters": [
                      {
                        "name": "string",
                        "type": "string",
                        "description": "string"
                      }
                    ],
                    "returnType": "string",
                    "returnDescription": "string",
                    "transferData": "string"
                  },
                  "pluginPointName": "string",
                  "code": "string",
                  "purgedProperties": {}
                },
                "purgedProperties": {},
                "description": "string",
                "type": "FUNCTION",
                "code": "string",
                "addToScripts": false,
                "functionDefinition": {
                  "name": "string",
                  "parameters": [
                    {
                      "name": "string",
                      "type": "string",
                      "description": "string"
                    }
                  ],
                  "returnType": "string",
                  "returnDescription": "string",
                  "transferData": "string"
                }
              }
            ],
            "purgedProperties": {}
          }
        ],
        "dependentIds": [
          "string"
        ],
        "dependencyIds": [
          "string"
        ],
        "channelTags": [
          {
            "id": "string",
            "name": "string",
            "channelIds": [
              "string"
            ],
            "backgroundColor": {
              "red": 0,
              "green": 0,
              "blue": 0,
              "alpha": 0,
              "rgb": 0,
              "colorSpace": {
                "type": 0,
                "numComponents": 0,
                "cs_sRGB": false
              },
              "transparency": 0
            },
            "purgedProperties": {}
          }
        ],
        "purgedProperties": {}
      },
      "purgedProperties": {},
      "enabledDestinationConnectors": [
        {
          "metaDataId": 0,
          "name": "string",
          "properties": {
            "pluginProperties": [
              {
                "name": "string",
                "purgedProperties": {}
              }
            ],
            "purgedProperties": {},
            "name": "string",
            "protocol": "string"
          },
          "transformer": {
            "elements": [
              {
                "name": "string",
                "sequenceNumber": "string",
                "enabled": false,
                "purgedProperties": {},
                "responseVariables": [
                  "string"
                ],
                "type": "string"
              }
            ],
            "inboundTemplate": "string",
            "outboundTemplate": "string",
            "inboundDataType": "string",
            "outboundDataType": "string",
            "inboundProperties": {
              "serializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "deserializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "batchProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "responseGenerationProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "responseValidationProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "serializerProperties": {
                "serializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "deserializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "batchProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                }
              },
              "purgedProperties": {}
            },
            "outboundProperties": {
              "serializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "deserializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "batchProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "responseGenerationProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "responseValidationProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "serializerProperties": {
                "serializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "deserializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "batchProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                }
              },
              "purgedProperties": {}
            },
            "purgedProperties": {},
            "enabledElements": [
              {
                "name": "string",
                "sequenceNumber": "string",
                "enabled": false,
                "purgedProperties": {},
                "responseVariables": [
                  "string"
                ],
                "type": "string"
              }
            ]
          },
          "responseTransformer": {
            "elements": [
              {
                "name": "string",
                "sequenceNumber": "string",
                "enabled": false,
                "purgedProperties": {},
                "responseVariables": [
                  "string"
                ],
                "type": "string"
              }
            ],
            "inboundTemplate": "string",
            "outboundTemplate": "string",
            "inboundDataType": "string",
            "outboundDataType": "string",
            "inboundProperties": {
              "serializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "deserializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "batchProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "responseGenerationProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "responseValidationProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "serializerProperties": {
                "serializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "deserializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "batchProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                }
              },
              "purgedProperties": {}
            },
            "outboundProperties": {
              "serializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "deserializationProperties": {
                "serializationType": "RAW",
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "batchProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "responseGenerationProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "responseValidationProperties": {
                "propertyDescriptors": {},
                "properties": {},
                "purgedProperties": {}
              },
              "serializerProperties": {
                "serializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "deserializationProperties": {
                  "serializationType": "RAW",
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                },
                "batchProperties": {
                  "propertyDescriptors": {},
                  "properties": {},
                  "purgedProperties": {}
                }
              },
              "purgedProperties": {}
            },
            "purgedProperties": {},
            "enabledElements": [
              {
                "name": "string",
                "sequenceNumber": "string",
                "enabled": false,
                "purgedProperties": {},
                "responseVariables": [
                  "string"
                ],
                "type": "string"
              }
            ]
          },
          "filter": {
            "elements": [
              {
                "name": "string",
                "sequenceNumber": "string",
                "enabled": false,
                "operator": "AND",
                "purgedProperties": {},
                "responseVariables": [
                  "string"
                ],
                "type": "string"
              }
            ],
            "purgedProperties": {},
            "enabledElements": [
              {
                "name": "string",
                "sequenceNumber": "string",
                "enabled": false,
                "operator": "AND",
                "purgedProperties": {},
                "responseVariables": [
                  "string"
                ],
                "type": "string"
              }
            ]
          },
          "transportName": "string",
          "mode": "SOURCE",
          "enabled": false,
          "waitForPrevious": false,
          "purgedProperties": {}
        }
      ]
    }
  ],
  "channelTags": [
    {
      "id": "string",
      "name": "string",
      "channelIds": [
        "string"
      ],
      "backgroundColor": {
        "red": 0,
        "green": 0,
        "blue": 0,
        "alpha": 0,
        "rgb": 0,
        "colorSpace": {
          "type": 0,
          "numComponents": 0,
          "cs_sRGB": false
        },
        "transparency": 0
      },
      "purgedProperties": {}
    }
  ],
  "users": [
    {
      "id": 0,
      "username": "string",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "organization": "string",
      "description": "string",
      "phoneNumber": "string",
      "industry": "string",
      "lastLogin": "2021-08-29T19:57:13.248Z",
      "gracePeriodStart": "2021-08-29T19:57:13.248Z",
      "strikeCount": 0,
      "lastStrikeTime": "2021-08-29T19:57:13.248Z"
    }
  ],
  "alerts": [
    {
      "id": "string",
      "name": "string",
      "enabled": false,
      "trigger": {
        "name": "string"
      },
      "actionGroups": [
        {
          "actions": [
            {
              "protocol": "string",
              "recipient": "string",
              "purgedProperties": {}
            }
          ],
          "subject": "string",
          "template": "string",
          "purgedProperties": {}
        }
      ],
      "properties": {},
      "purgedProperties": {}
    }
  ],
  "codeTemplateLibraries": [
    {
      "id": "string",
      "name": "string",
      "revision": 0,
      "lastModified": "2021-08-29T19:57:13.249Z",
      "description": "string",
      "includeNewChannels": false,
      "enabledChannelIds": [
        "string"
      ],
      "disabledChannelIds": [
        "string"
      ],
      "codeTemplates": [
        {
          "id": "string",
          "name": "string",
          "revision": 0,
          "lastModified": "2021-08-29T19:57:13.249Z",
          "contextSet": [
            "GLOBAL_DEPLOY"
          ],
          "properties": {
            "type": "FUNCTION",
            "description": "string",
            "functionDefinition": {
              "name": "string",
              "parameters": [
                {
                  "name": "string",
                  "type": "string",
                  "description": "string"
                }
              ],
              "returnType": "string",
              "returnDescription": "string",
              "transferData": "string"
            },
            "pluginPointName": "string",
            "code": "string",
            "purgedProperties": {}
          },
          "purgedProperties": {},
          "description": "string",
          "type": "FUNCTION",
          "code": "string",
          "addToScripts": false,
          "functionDefinition": {
            "name": "string",
            "parameters": [
              {
                "name": "string",
                "type": "string",
                "description": "string"
              }
            ],
            "returnType": "string",
            "returnDescription": "string",
            "transferData": "string"
          }
        }
      ],
      "purgedProperties": {}
    }
  ],
  "serverSettings": {
    "environmentName": "string",
    "serverName": "string",
    "clearGlobalMap": false,
    "queueBufferSize": 0,
    "defaultMetaDataColumns": [
      {
        "name": "string",
        "type": "STRING",
        "mappingName": "string",
        "purgedProperties": {}
      }
    ],
    "smtpHost": "string",
    "smtpPort": "string",
    "smtpTimeout": "string",
    "smtpFrom": "string",
    "smtpSecure": "string",
    "smtpAuth": false,
    "smtpUsername": "string",
    "smtpPassword": "string",
    "purgedProperties": {},
    "properties": {}
  },
  "updateSettings": {
    "statsEnabled": false,
    "lastStatsTime": 0,
    "purgedProperties": {},
    "properties": {}
  },
  "globalScripts": {},
  "pluginProperties": {},
  "resourceProperties": {
    "list": [
      {
        "pluginPointName": "string",
        "type": "string",
        "id": "string",
        "name": "string",
        "description": "string",
        "includeWithGlobalScripts": false,
        "purgedProperties": {}
      }
    ]
  },
  "channelDependencies": [
    {
      "dependentId": "string",
      "dependencyId": "string"
    }
  ],
  "configurationMap": {}
}' 'https://localhost:8443/api/server/configuration?deploy=false&overwriteConfigMap=false'

Note: the -d parameter contains the body of the post request. Fill in the body with the appropriate values for your channel.

/server/configurationMap

The configuration map can be found under Settings

Select the Configuration Map tab

Your results will be reflected here upon the successful execution of the configuration map API.

GET

curl -X GET --header 'Accept: application/xml' 'https://localhost:8443/api/server/configurationMap'

PUT

curl -X PUT --header 'Content-Type: application/xml' --header 'Accept: application/xml' -d '{}' 'https://localhost:8443/api/server/configurationMap'

/server/globalScripts

Global scripts can be found under Channels.

Select Edit Global Scripts under Channel Tasks.

Your results will be reflected here upon the successful execution of the global scripts API.

GET

curl -X GET --header 'Accept: application/xml' 'https://localhost:8443/api/server/globalScripts'

PUT

curl -X PUT --header 'Content-Type: application/xml' --header 'Accept: application/xml' -d '{}' 'https://localhost:8443/api/server/globalScripts'
RELATED ARTICLES

Mirth Connect Extensions: What You Need to Know

Prerequisistes Basic Knowledge of Mirth Connect Overview Users can navigate to Mirth Connect's Extensions screen by selecting Extensions on the left-hand side. You should now see the following...

Take a Tour of System Settings in Mirth Connect Now

Prerequisites Basic Knowledge of Mirth Connect Introduction Mirth Connect has a multitude of system settings that are available for configuration. In larger companies, there will often be...

Why You Must Master Mirth’s Message Template Tool Today

Prerequisuites Basic Knowledge of Mirth ConnectKnowledge of Programming in Mirth Connect Introduction When writing scripts in Mirth Connect, you have a message template tool that allows you...

Most Popular

Mirth Connect Extensions: What You Need to Know

Prerequisistes Basic Knowledge of Mirth Connect Overview Users can navigate to Mirth Connect's Extensions screen by selecting Extensions on the left-hand side. You should now see the following...

Take a Tour of System Settings in Mirth Connect Now

Prerequisites Basic Knowledge of Mirth Connect Introduction Mirth Connect has a multitude of system settings that are available for configuration. In larger companies, there will often be...

Why You Must Master Mirth’s Message Template Tool Today

Prerequisuites Basic Knowledge of Mirth ConnectKnowledge of Programming in Mirth Connect Introduction When writing scripts in Mirth Connect, you have a message template tool that allows you...

Make Sense of HL7 v2 Messages Effortlessly Now

Prerequisites Beginner Knowledge of HL7 Introduction If you've been in Healthcare Information Technology for any period of time, you have definitely heard of HL7 (Health Level 7)....

Recent Comments