push module

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

mainframe-rpc

    {
      "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"
        }
      }
    }
    ```
    ```json Response
    {
      "moduleId": "00000000-0000-0000-0000-000000000011",
      "moduleName": "module-mainframe-rpc",
      "testCasesCreated": 0
    }
    ```

  

#### as400-rpc

```json Request
    {
      "name": "module-as400-rpc",
      "config": {
        "connectorName": "as400-rpc",
        "connectorVersion": "latest"
      },
      "type": "as400Rpc",
      "profiles": {
        "$default": {
          "codePage": "037",
          "host": "ibmi.example.internal",
          "user": "example-user",
          "password": "example-password"
        }
      }
    }
    ```
    ```json Response
    {
      "moduleId": "00000000-0000-0000-0000-000000000022",
      "moduleName": "module-as400-rpc",
      "testCasesCreated": 0
    }
    ```

  

#### ims-rpc

```json Request
      {
        "name": "module-ims-rpc",
        "config": {
          "connectorName": "mf-ims",
          "connectorVersion": "latest"
        },
        "type": "imsRpc",
        "profiles": {
          "$default": {
            "host": "cics.example.internal",
            "username": "example-username",
            "password": "example-password",
            "groupName": "GROUP1",
            "dataStoreName": "IVP1",
            "port": 9999,
            "codePage": "cp037",
            "sslProperties": {
              "isSslEnabled": false
            },
            "transactionProperties": {
              "commitMode": "SEND_AND_COMMIT"
            }
          }
        }
      }
    ```
    ```json Response
    {
      "moduleId": "00000000-0000-0000-0000-000000000033",
      "moduleName": "module-ims-rpc",
      "testCasesCreated": 0
    }
    ```