API - Event

Description

These APIs are used to perform CRUD operations on Events.

Get All

GET /Campaign/api/interact/rest/v2/channels/{icIdOrName}/events?page=0&size=10

Parameters

	Description	Default Values
page	number, nth page to retrieve records.	0
size	number of records per page.	10
	Optional, if mode = recent, API will retrieve 5 strategies that are most recently updated

Output

Table 1. Response Codes
Success	200	Ok
Error	400	Bad Request
Server Error	500	Internal/Server Error

Example: Content-Type: application/json

{
	"content": [ 
		{ 
			"category": { 
				"description": "string", 
				"id": 0, 
				"name": "string", 
				"systemDefined": true 
			}, 
			"createBy": 0, 
			"createDate": 0, 
			"description": "string", 
			"eventActions": [ { 
				"actionID": 0, 
				"actionValue": 0,
				"async": true, 
				"condition": [ { 
					"id": 0, 
					"name": "string", 
					"value": "string" 
				} ],
				"details": "string", 
				"eventActionID": 0, 
				"eventType": 0, 
				"executionOrder": 0, 
				"inferredEvents": [0] 
			}],
			"eventType": 0, 
			"executeExpression": { 
				"conditions": [ { 
					"id": 0, 
					"name": "string", 
					"value": "string" 
				} ], 
				"enabled": true, 
				"eventActionID": 0
				}, 
			"expression": { 
				"audienceLevel": "string", 
				"expression": "string", 
				"fieldName": "string" 
			},
			"id": 0, 
			"logOfferAcceptance": { 
				"conditions": [ { 
					"id": 0, 
					"name": "string", 
					"value": "string" 
				} ],
				"enabled": true, 
				"eventActionID": 0 
			}, 
			"logOfferContact": { 
				"conditions": [ { 
				"id": 0, 
				"name": "string", 
				"value": "string" 
				} ],
				"enabled": true, 
				"eventActionID": 0 
			},
			"logOfferRejection": { 
				"conditions": [ { 
					"id": 0, 
					"name": "string", 
					"value": "string" 
				} ], 
				"enabled": true,
				"eventActionID": 0 
			}, 
			"name": "string", 
			"pattern": null, 
			"triggerResegmentation": { 
				"conditions": [ { 
					"id": 0, 
					"name": "string", 
					"value": "string" 
				} ], 
				"enabled": true, 
				"eventActionID": 0 
			}, 
			"updateBy": 0, 
			"updateDate": 0
	    }
	],
	"page": { 
		"hasNext": true, 
		"hasPrev": true, 
		"pageNumber": 0, 
		"size": 0, 
		"totalElements": 0, 
		"totalPages": 0 
	}
}

Get

GET /Campaign/api/interact/rest/v2/channels/{icIdOrName}/events/{eventName}

Output

Table 2. Response Codes
Success	200	Ok
Error	400	Bad Request
Server Error	500	Internal/Server Error

Example: Content-Type: application/json

{
  "category": {
    "description": "string",
    "id": 0,
    "name": "string",
    "systemDefined": true
  },
  "createBy": 0,
  "createDate": 0,
  "description": "string",
  "eventActions": [
    {
      "actionID": 0,
      "actionValue": 0,
      "async": true,
      "condition": [
        {
          "id": 0,
          "name": "string",
          "value": "string"
        }
      ],
      "details": "string",
      "eventActionID": 0,
      "eventType": 0,
      "executionOrder": 0,
      "inferredEvents": [0]
    }
  ],
  "eventType": 0,
  "executeExpression": {
    "conditions": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "enabled": true,
    "eventActionID": 0
  },
  "expression": {
    "audienceLevel": "string",
    "expression": "string",
    "fieldName": "string"
  },
  "id": 0,
  "logOfferAcceptance": {
    "conditions": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "enabled": true,
    "eventActionID": 0
  },
  "logOfferContact": {
    "conditions": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "enabled": true,
    "eventActionID": 0
  },
  "logOfferRejection": {
    "conditions": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "enabled": true,
    "eventActionID": 0
  },
  "name": "string",
  "pattern": null,
  "triggerResegmentation": {
    "conditions": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "enabled": true,
    "eventActionID": 0
  },
  "updateBy": 0,
  "updateDate": 0
}

Create

POST /Campaign/api/interact/rest/v2/{icIdOrName}/events

Input

Body Parameter – Content-Type: application/json

{
  "events": [
    {
      "category": {
        "description": "string",
        "id": 0,
        "name": "string",
        "systemDefined": true
      },
      "createBy": 0,
      "createDate": 0,
      "description": "string",
      "eventActions": [
        {
          "actionID": 0,
          "actionValue": 0,
          "async": true,
          "condition": [
            {
              "id": 0,
              "name": "string",
              "value": "string"
            }
          ],
          "details": "string",
          "eventActionID": 0,
          "eventType": 0,
          "executionOrder": 0,
          "inferredEvents": [0]
        }
      ],
      "eventType": 0,
      "executeExpression": {
        "conditions": [
          {
            "id": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "enabled": true,
        "eventActionID": 0
      },
      "expression": {
        "audienceLevel": "string",
        "expression": "string",
        "fieldName": "string"
      },
      "id": 0,
      "logOfferAcceptance": {
        "conditions": [
          {
            "id": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "enabled": true,
        "eventActionID": 0
      },
      "logOfferContact": {
        "conditions": [
          {
            "id": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "enabled": true,
        "eventActionID": 0
      },
      "logOfferRejection": {
        "conditions": [
          {
            "id": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "enabled": true,
        "eventActionID": 0
      },
      "name": "string",
      "pattern": null,
      "triggerResegmentation": {
        "conditions": [
          {
            "id": 0,
            "name": "string",
            "value": "string"
          }
        ],
        "enabled": true,
        "eventActionID": 0
      },
      "updateBy": 0,
      "updateDate": 0
    }
  ]
}

Output

Table 3. Response Codes
Success	201	Created
Miscellaneous	207	Status code for batch request
Error	400	Bad Request
Server Error	500	Internal/Server Error

Example: Content-Type: application/json

[
    {
        "headers": {},
        "body": <entity>/<error-msg>,
        "status": 201/400/500
    }
]

Update

PUT /Campaign/api/interact/rest/v2/channels/{icIdOrName}/events/{eventIdOrName}

Input

Body Parameter – Content-Type: application/json

{
  "category": {
    "description": "string",
    "id": 0,
    "name": "string",
    "systemDefined": true
  },
  "createBy": 0,
  "createDate": 0,
  "description": "string",
  "eventActions": [
    {
      "actionID": 0,
      "actionValue": 0,
      "async": true,
      "condition": [
        {
          "id": 0,
          "name": "string",
          "value": "string"
        }
      ],
      "details": "string",
      "eventActionID": 0,
      "eventType": 0,
      "executionOrder": 0,
      "inferredEvents": [
        0
      ]
    }
  ],
  "eventType": 0,
  "executeExpression": {
    "conditions": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "enabled": true,
    "eventActionID": 0
  },
  "expression": {
    "audienceLevel": "string",
    "expression": "string",
    "fieldName": "string"
  },
  "id": 0,
  "logOfferAcceptance": {
    "conditions": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "enabled": true,
    "eventActionID": 0
  },
  "logOfferContact": {
    "conditions": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "enabled": true,
    "eventActionID": 0
  },
  "logOfferRejection": {
    "conditions": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "enabled": true,
    "eventActionID": 0
  },
  "name": "string",
  "pattern": null,
  "triggerResegmentation": {
    "conditions": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "enabled": true,
    "eventActionID": 0
  },
  "updateBy": 0,
  "updateDate": 0
}

Output

Table 4. Response Codes
Success	202	Accepted
Error	400	Bad Request
Server Error	500	Internal/Server Error

Example: Content-Type: application/json

{
  "category": {
    "description": "string",
    "id": 0,
    "name": "string",
    "systemDefined": true
  },
  "createBy": 0,
  "createDate": 0,
  "description": "string",
  "eventActions": [
    {
      "actionID": 0,
      "actionValue": 0,
      "async": true,
      "condition": [
        {
          "id": 0,
          "name": "string",
          "value": "string"
        }
      ],
      "details": "string",
      "eventActionID": 0,
      "eventType": 0,
      "executionOrder": 0,
      "inferredEvents": [
        0
      ]
    }
  ],
  "eventType": 0,
  "executeExpression": {
    "conditions": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "enabled": true,
    "eventActionID": 0
  },
  "expression": {
    "audienceLevel": "string",
    "expression": "string",
    "fieldName": "string"
  },
  "id": 0,
  "logOfferAcceptance": {
    "conditions": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "enabled": true,
    "eventActionID": 0
  },
  "logOfferContact": {
    "conditions": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "enabled": true,
    "eventActionID": 0
  },
  "logOfferRejection": {
    "conditions": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "enabled": true,
    "eventActionID": 0
  },
  "name": "string",
  "pattern": null,
  "triggerResegmentation": {
    "conditions": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "enabled": true,
    "eventActionID": 0
  },
  "updateBy": 0,
  "updateDate": 0
}

Delete An Event by Id or Name

DELETE /Campaign/api/interact/rest/v2/channels/{icIdOrName}/events/{eventIdOrName}

Output

Table 5. Response Codes
Success	200	Ok
Error	400	Bad Request
Server Error	500	Internal/Server Error

Delete Multiple Events

DELETE /Campaign/api/interact/rest/v2/channels/{icIdOrName}/events

Input

Request Parameters


Parameters	Description
ids	Comma separated Event IDs to be deleted.

Output

Table 6. Response Codes
Success	200	Ok
Error	400	Bad Request
Server Error	500	Internal/Server Error