API - Gateway

Description
These APIs are used to perform CRUD operations on Gateway. These APIs are available from version 12.1.0.3 onwards.
Create

POST /channels/{icIdOrName}/gateways

Input
Body Parameter – Content-Type: application/json
{
  "audienceLevel": "string",
  "contentMapping": [
    {
      "custom": true,
      "dateFormat": "string",
      "defaultValue": {},
      "endpointFieldName": "string",
      "expression": true,
      "interactFieldName": "string",
      "mandatory": true,
      "size": 0,
      "type": "string"
    }
  ],
  "createBy": 0,
  "createDate": "2020-11-27T04:53:39.602Z",
  "defaultCellCode": "string",
  "defaultCellID": 0,
  "description": "string",
  "effectiveDate": 0,
  "eventMapping": [
    {
      "contentMapping": [
        {
          "custom": true,
          "dateFormat": "string",
          "defaultValue": {},
          "endpointFieldName": "string",
          "expression": true,
          "interactFieldName": "string",
          "mandatory": true,
          "size": 0,
          "type": "string"
        }
      ],
      "endpointEvent": "string",
      "interactEvent": "string"
    }
  ],
  "expirationDate": 0,
  "icId": 0,
  "id": 0,
  "name": "string",
  "noOfMessages": 0,
  "priority": 0,
  "type": 0,
  "updateBy": 0,
  "updateDate": "2020-11-27T04:53:39.602Z" 
}
Output
Table 1. Response Codes
Success 200 Ok
Created 201 Created
Error 400 Bad Request
Server Error 500 Internal Server Error
Example: Content-Type: application/json 
{
  "id": 0,
  "name": "String",
  "description": " String ",
  "icId": 0,
  "defaultCellCode": null,
  "defaultCellID": 0,
  "type": 0,
  "priority": 0,
  "noOfMessages": 0,
  "audienceLevel": "String",
  "effectiveDate": 0,
  "expirationDate": 0,
  "eventMapping": null,
  "contentMapping": [
    {
      "type": "string",
      "interactFieldName": "",
      "endpointFieldName": "String",
      "mandatory": false,
      "size": 0,
      "dateFormat": "",
      "defaultValue": "String",
      "custom": true,
      "expression": false
    }
  ],
  "createDate": 0,
  "createBy": 0,
  "updateDate": 0,
  "updateBy": 0

}
Get All
GET /channels/{icIdOrName}/gateways?page=0&size=10&typeId={1/2/3}
Input
Table 2. Query Parameters
Parameters Description Default value
page number, nth page to retrieve records. 0
size Number of records per page 10
typeId Type of Journey
  • Generic Outbound
  • Generic Inbound
  • Journey Outbound
Output
Table 3. Response Codes
Success 200 Ok
Error 400 Bad Request
Server Error 500 Internal Server Error
Example response: Content-Type: application/json 
{
  
  "content": [
    {
      "id": 0,
      "name": "String",
      "description": "String",
      "icId": 0,
      "defaultCellCode": "String",
      "defaultCellID": 0,
      "type": 0,
      "priority": 0,
      "noOfMessages": 0,
      "audienceLevel": "String",
      "effectiveDate": long,
      "expirationDate": long,
      "eventMapping": null,
      "contentMapping": [
        {
          "type": "string",
          "interactFieldName": "String",
          "endpointFieldName": "String",
          "mandatory": true,
          "size": 0,
          "dateFormat": null,
          "defaultValue": "String",
          "custom": false,
          "expression": false
        }
		{...}
      ],
      "createDate": long,
      "createBy": 0,
      "updateDate": long,
      "updateBy": 0
    },
	{...}
  ],
  "page": {
    "pageNumber": 0,
    "totalElements": 0,
    "totalPages": 0,
    "size": 0,
    "hasNext": false,
    "hasPrev": false
  }
}
Update
Input
Body Parameter – Content-Type:application/json
{
  "audienceLevel": "string",
  "contentMapping": [
    {
      "custom": true,
      "dateFormat": "string",
      "defaultValue": {},
      "endpointFieldName": "string",
      "expression": true,
      "interactFieldName": "string",
      "mandatory": true,
      "size": 0,
      "type": "string"
    }
  ],
  "createBy": 0,
  "createDate": "2020-11-27T04:53:39.602Z",
  "defaultCellCode": "string",
  "defaultCellID": 0,
  "description": "string",
  "effectiveDate": 0,
  "eventMapping": [
    {
      "contentMapping": [
        {
          "custom": true,
          "dateFormat": "string",
          "defaultValue": {},
          "endpointFieldName": "string",
          "expression": true,
          "interactFieldName": "string",
          "mandatory": true,
          "size": 0,
          "type": "string"
        }
      ],
      "endpointEvent": "string",
      "interactEvent": "string"
    }
  ],
  "expirationDate": 0,
  "icId": 0,
  "id": 0,
  "name": "string",
  "noOfMessages": 0,
  "priority": 0,
  "type": 0,
  "updateBy": 0,
  "updateDate": "2020-11-27T04:53:39.602Z"
}
Output
Table 4. Response Codes
Accepted 202 Accepted
Error 400 Bad Request
Server Error 500 Internal/Server Error
Example: Content-Type: application/json
{
  {
  "content": [
    {
      "id": 0,
      "name": "String",
      "description": "String",
      "icId": 0,
      "defaultCellCode": "String",
      "defaultCellID": 0,
      "type": 0,
      "priority": 0,
      "noOfMessages": 0,
      "audienceLevel": "String",
      "effectiveDate": long,
      "expirationDate": long,
      "eventMapping": null,
      "contentMapping": [
        {
          "type": "string",
          "interactFieldName": "String",
          "endpointFieldName": "String",
          "mandatory": true,
          "size": 0,
          "dateFormat": null,
          "defaultValue": "String",
          "custom": false,
          "expression": false
        }
		{...}
      ],
      "createDate": long,
      "createBy": 0,
      "updateDate": long,
      "updateBy": 0
    }
  ],
  "page": {
    "pageNumber": 0,
    "totalElements": 0,
    "totalPages": 0,
    "size": 0,
    "hasNext": false,
    "hasPrev": false
  }
}}