Prerequisites

The caller must provide a module name and connector type.

Authorization

API key (via the X-API-KEY header).

Parameters

Request Body

Field name	Description	Format
name	The name of the module	String
config	Connector configuration	Object
type	The connector type identifier	String
profiles	Module profiles	Map
connectionRef	Connection ID (pre-existing profiles)	UUID

Response Body

Field name	Description	Format
moduleId	The ID of the created module	UUID
moduleName	The name of the created module	String
testCasesCreated	Number of test cases created	Integer

Config Structure

Field name	Description	Format
connectorName	The name of the connector	String
connectorVersion	The version of the connector	String

Profile Structure

Field name	Description	Format
profileName	Key	String
profileValue	Profile config	JsonElement

Examples

{
  "name": "module-mainframe-rpc",
  "config": {
    "connectorName": "mf-cics-cobol",
    "connectorVersion": "latest"
  },
  "type": "mainFrameRpc",
  "profiles": {
    "$default": {
      "baseUrl": "http://cics.example.internal",
      "uriMap": "/example/latest",
      "port": 12345,
      "codePage": "cp037"
    }
  }
}

{
  "moduleId": "00000000-0000-0000-0000-000000000011",
  "moduleName": "module-mainframe-rpc",
  "testCasesCreated": 0
}