API - Event Pattern

Description

These APIs are used to perform CRUD operations on event patterns.

Get All

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

Parameters

Parameters	Description	Values
page	number, nth page to retrieve records.	0
size	number of records per page.	10

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": { 
				"async": true, 
				"enabled": true, 
				"endTime": 0, 
				"itemEvent": [ { 
					"attribute": { 
						"dataType": 0, 
						"name": "string", 
						"value": "string" 
					}, 
					"id": 0, 
					"name": "string", 
					"value": 0 
				} ], 
				"matchTotal": 0, 
				"reset": { 
					"id": 0, 
					"idSelected": 0, 
					"idToRemove": 0, 
					"interval": 0, 
					"intervalType": "string", 
					"startTime": 0, 
					"type": 0 
				}, 
				"resetDuration": 0,
				"startTime": 0, 
				"timeDuration": 0, 
				"type": 0 
			}, 
			"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}/eventpatterns/{ eventpatternsIdOrName}

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": {
    "async": true,
    "enabled": true,
    "endTime": 0,
    "itemEvent": [
      {
        "attribute": {
          "dataType": 0,
          "name": "string",
          "value": "string"
        },
        "id": 0,
        "name": "string",
        "value": 0
      }
    ],
    "matchTotal": 0,
    "reset": {
      "id": 0,
      "idSelected": 0,
      "idToRemove": 0,
      "interval": 0,
      "intervalType": "string",
      "startTime": 0,
      "type": 0
    },
    "resetDuration": 0,
    "startTime": 0,
    "timeDuration": 0,
    "type": 0
  },
  "triggerResegmentation": {
    "conditions": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "enabled": true,
    "eventActionID": 0
  },
  "updateBy": 0,
  "updateDate": 0
}

Create

POST /Campaign/api/interact/rest/v2/channels/{icIdOrName}/eventpatterns

Input

Body Parameter – Content-Type: application/json

{
  "eventPatterns": [
    {
      "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": {
        "async": true,
        "enabled": true,
        "endTime": 0,
        "itemEvent": [
          {
            "attribute": {
              "dataType": 0,
              "name": "string",
              "value": "string"
            },
            "id": 0,
            "name": "string",
            "value": 0
          }
        ],
        "matchTotal": 0,
        "reset": {
          "id": 0,
          "idSelected": 0,
          "idToRemove": 0,
          "interval": 0,
          "intervalType": "string",
          "startTime": 0,
          "type": 0
        },
        "resetDuration": 0,
        "startTime": 0,
        "timeDuration": 0,
        "type": 0
      },
      "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}/eventpatterns/{evtpatternIdOrName}

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": {
    "async": true,
    "enabled": true,
    "endTime": 0,
    "itemEvent": [
      {
        "attribute": {
          "dataType": 0,
          "name": "string",
          "value": "string"
        },
        "id": 0,
        "name": "string",
        "value": 0
      }
    ],
    "matchTotal": 0,
    "reset": {
      "id": 0,
      "idSelected": 0,
      "idToRemove": 0,
      "interval": 0,
      "intervalType": "string",
      "startTime": 0,
      "type": 0
    },
    "resetDuration": 0,
    "startTime": 0,
    "timeDuration": 0,
    "type": 0
  },
  "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 response: 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": {
    "async": true,
    "enabled": true,
    "endTime": 0,
    "itemEvent": [
      {
        "attribute": {
          "dataType": 0,
          "name": "string",
          "value": "string"
        },
        "id": 0,
        "name": "string",
        "value": 0
      }
    ],
    "matchTotal": 0,
    "reset": {
      "id": 0,
      "idSelected": 0,
      "idToRemove": 0,
      "interval": 0,
      "intervalType": "string",
      "startTime": 0,
      "type": 0
    },
    "resetDuration": 0,
    "startTime": 0,
    "timeDuration": 0,
    "type": 0
  },
  "triggerResegmentation": {
    "conditions": [
      {
        "id": 0,
        "name": "string",
        "value": "string"
      }
    ],
    "enabled": true,
    "eventActionID": 0
  },
  "updateBy": 0,
  "updateDate": 0
}

Delete

DELETE /Campaign/api/interact/rest/v2/{icIdOrName}/eventpatterns/{evtpatternIdOrName}

Output

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

Delete Multiple

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

Request Parameters


Parameters	Description
ids	Comma separated event pattern IDs to be deleted.

Output

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