API - FlexOffer Rules

Description
These APIs are used to perform CRUD operations on FlexOffer rules.
Get All FlexOffer Rules of FlexOffer Id or Name
GET Campaign/api/interact/rest/v2/channels/ {icIdOrName}/offermappings/ {offermappingIdOrName}/rules?page=0&size=50&OfferName=con;Offer
Output
Table 1. Response Codes
Success 200 Ok
Error 400 Bad Request
Server Error 500 Internal Server Error
Example: Content-Type: application/json
{
"content": [
	{
		"offerMappingRowID": 2269,
		"offerId": 12,
		"offerName": "Offer 000000011 (expired)",
		"offerCode": "000000011",
		"cellId": -1,
		"cellCode": "[Default cell]",
		"zoneId": 0,
		"zoneName": "All zones",
		"score": 50,
		"scorePredicateEnabled": false,
		"scorePredicate": null,
		"enabled": true,
		"eligibilityPredicateEnabled": false,
		"eligibilityPredicateId": 0,
		"eligibilityPredicate": null,
		"effectiveDate": null,
		"expirationDate": null,
		"learningMode": 1,
		"learningModelId": 0,
		"lmName": "",
		"parameterizedOfferAttribute": "",
		"offerAttrExpressions": [],
		"userdefinedFields": null,
		"userdefinedFieldsMap": null,
		"createDate": 1592249123863,
		"createBy": 2,
		"updateDate": null,
		"updateBy": 0,
		"scorePredicateId": 0,
		"salary": 25000
	},
	{
		"offerMappingRowID": 2268,
		"offerId": 6,
		"offerName": "Offer 000000005",
		"offerCode": "pr000000003",
		"cellId": -1,
		"cellCode": "[Default cell]",
		"zoneId": 0,
		"zoneName": "All zones",
		"score": 50,
		"scorePredicateEnabled": false,
		"scorePredicate": null,
		"enabled": true,
		"eligibilityPredicateEnabled": false,
		"eligibilityPredicateId": 0,
		"eligibilityPredicate": null,
		"effectiveDate": null,
		"expirationDate": null,
		"learningMode": 1,
		"learningModelId": 0,
		"lmName": "",
		"parameterizedOfferAttribute": "",
		"offerAttrExpressions": [],
		"userdefinedFields": null,
		"userdefinedFieldsMap": null,
		"createDate": 1592249123863,
		"createBy": 2,
		"updateDate": null,
		"updateBy": 0,
		"scorePredicateId": 0,
		"salary": 15000
	},
	
	],
	"page": {
				"pageNumber": 0,
				"totalElements": 6,
				"totalPages": 1,
				"size": 50,
				"hasNext": false,
				"hasPrev": false
	}
}
Get FlexOffer Rule by Rule ID or Name
GET /Campaign/interact/api/v2/ /channels/{icIdOrName}/offermappings/{offermappingIdOrName}/rules/{ruleIdOrName}
Output
Table 2. Response Codes
Success 200 Ok
Error 400 Bad Request
Server Error 500 Internal Server Error
Example: Content-Type: application/json
{
    "offerMappingRowID": 2264,
    "offerId": 15,
    "offerName": "Offer 000000014",
    "offerCode": "000000014",
    "cellId": -1,
    "cellCode": "[Default cell]",
    "zoneId": 0,
    "zoneName": "All zones",
    "score": 50,
    "scorePredicateEnabled": false,
    "scorePredicate": null,
    "enabled": true,
    "eligibilityPredicateEnabled": false,
    "eligibilityPredicateId": 0,
    "eligibilityPredicate": null,
    "effectiveDate": null,
    "expirationDate": null,
    "learningMode": 1,
    "learningModelId": 0,
    "lmName": "",
    "parameterizedOfferAttribute": "",
    "offerAttrExpressions": [],
    "userdefinedFields": null,
    "userdefinedFieldsMap": null,
    "createDate": 1592249123863,
    "createBy": 2,
    "updateDate": null,
    "updateBy": 0,
    "scorePredicateId": 0,
    "salary": 1000
}
Save FlexOffer Rules
POST /Campaign/interact/api/v2/channels/{icIdOrName}/offermappings/{offermappingIdOrName}/rules
Output
Table 3. Response Codes
Success 202 Accepted
Error 400 Bad Request
Server Error 500 Internal Server Error
Example: Content-Type: application/json
{
"newColumns": [
				{
					"name": "abc",
					"type": "STRING",
					"value": "abc",
					"size": 64,
					"relation": null,
					"dynamic": true
				}
				],
"toAdd": [],
"toUpdate": [
{
	"offerMappingRowID": 2266,
	"offerName": "Offer 000000001 (retired)",
	"offerCode": "pr000000001",
	"zoneName": "All zones",
	"cellCode": "A000000016",
	"score": 50,
	"offerAttrExpressions": [],
	"enabled": true,
	"eligibilityPredicateEnabled": false,
	"effectiveDate": null,
	"expirationDate": null,
	"salary": 30000,
	"offerId": 2,
	"eligibilityPredicate": null,
	"scorePredicateEnabled": false,
	"learningMode": 1,
	"learningModelId": 0,
	"lmName": "",
	"scorePredicate": null,
	"cellId": 17,
	"abc": "abc"
	}
],
"toDelete": [
	2269
	]
}
Preview of database existed table
Get /Campaign/interact/api/v2/channels/5/preview?serverGroup=defaultServerGroup&sourceType=table&source=UACI_OfferMapping765
Output
Table 4. Response Codes
Success 200 Ok
Error 400 Bad Request
Server Error 500 Internal Server Error
Example: Content-Type: application/json
{
    "content": [
        {
            "offerMappingRowID": 0,
            "offerId": 0,
            "offerName": null,
            "offerCode": null,
            "cellId": null,
            "cellCode": null,
            "zoneId": null,
            "zoneName": null,
            "score": 50,
            "scorePredicateEnabled": false,
            "scorePredicate": null,
            "enabled": true,
            "eligibilityPredicateEnabled": false,
            "eligibilityPredicateId": 0,
            "eligibilityPredicate": null,
            "effectiveDate": null,
            "expirationDate": null,
            "learningMode": 1,
            "learningModelId": null,
            "lmName": null,
            "parameterizedOfferAttribute": "",
            "offerAttrExpressions": null,
            "userdefinedFields": null,
            "userdefinedFieldsMap": {
                "ZoneID": 0,
                "EligibilityPredicate": null,
                "CreateBy": 2,
                "CellID": 6,
                "ParameterizedOfferAttribute": "",
                "salary": 1000,
                "CreateDate": 1591187221137,
                "UpdateBy": null,
                "ZoneName": "",
                "UpdateDate": null,
                "predicate": "",
                "OfferCode": "000000007",
                "ScorePredicateEnabled": 0,
                "EligibilityPredicateEnabled": 0,
                "MarketerScore": 50,
                "ScorePredicate": null,
                "LearningModelId": 0,
                "CellCode": "A000000005",
                "OfferID": 8,
                "OfferName": "Offer 000000007",
                "ExpirationDate": null,
                "mybdata": 1,
                "LearningMode": 1,
                "EnableState": 1,
                "EffectiveDate": null
            },
            "createDate": null,
            "createBy": 0,
            "updateDate": null,
            "updateBy": 0,
            "scorePredicateId": 0
        },
        {
            "offerMappingRowID": 0,
            "offerId": 0,
            "offerName": null,
            "offerCode": null,
            "cellId": null,
            "cellCode": null,
            "zoneId": null,
            "zoneName": null,
            "score": 50,
            "scorePredicateEnabled": false,
            "scorePredicate": null,
            "enabled": true,
            "eligibilityPredicateEnabled": false,
            "eligibilityPredicateId": 0,
            "eligibilityPredicate": null,
            "effectiveDate": null,
            "expirationDate": null,
            "learningMode": 1,
            "learningModelId": null,
            "lmName": null,
            "parameterizedOfferAttribute": "",
            "offerAttrExpressions": null,
            "userdefinedFields": null,
            "userdefinedFieldsMap": {
                "ZoneID": 0,
                "EligibilityPredicate": null,
                "CreateBy": 2,
                "CellID": 6,
                "ParameterizedOfferAttribute": "",
                "salary": 10000,
                "CreateDate": 1591187221137,
                "UpdateBy": null,
                "ZoneName": "",
                "UpdateDate": null,
                "predicate": "",
                "OfferCode": "000000009",
                "ScorePredicateEnabled": 0,
                "EligibilityPredicateEnabled": 0,
                "MarketerScore": 50,
                "ScorePredicate": null,
                "LearningModelId": 0,
                "CellCode": "A000000005",
                "OfferID": 10,
                "OfferName": "Offer 000000009",
                "ExpirationDate": null,
                "mybdata": 1,
                "LearningMode": 1,
                "EnableState": 1,
                "EffectiveDate": null
            },
            "createDate": null,
            "createBy": 0,
            "updateDate": null,
            "updateBy": 0,
            "scorePredicateId": 0
        },
        {
            "offerMappingRowID": 0,
            "offerId": 0,
            "offerName": null,
            "offerCode": null,
            "cellId": null,
            "cellCode": null,
            "zoneId": null,
            "zoneName": null,
            "score": 50,
            "scorePredicateEnabled": false,
            "scorePredicate": null,
            "enabled": true,
            "eligibilityPredicateEnabled": false,
            "eligibilityPredicateId": 0,
            "eligibilityPredicate": null,
            "effectiveDate": null,
            "expirationDate": null,
            "learningMode": 1,
            "learningModelId": null,
            "lmName": null,
            "parameterizedOfferAttribute": "",
            "offerAttrExpressions": null,
            "userdefinedFields": null,
            "userdefinedFieldsMap": {
                "ZoneID": 0,
                "EligibilityPredicate": null,
                "CreateBy": 2,
                "CellID": 17,
                "ParameterizedOfferAttribute": "",
                "salary": 30000,
                "CreateDate": 1591187221137,
                "UpdateBy": null,
                "ZoneName": "",
                "UpdateDate": null,
                "predicate": "",
                "OfferCode": "pr000000001",
                "ScorePredicateEnabled": 0,
                "EligibilityPredicateEnabled": 0,
                "MarketerScore": 50,
                "ScorePredicate": null,
                "LearningModelId": 0,
                "CellCode": "A000000016",
                "OfferID": 2,
                "OfferName": "Offer 000000001",
                "ExpirationDate": null,
                "mybdata": 0,
                "LearningMode": 1,
                "EnableState": 1,
                "EffectiveDate": null
            },
            "createDate": null,
            "createBy": 0,
            "updateDate": null,
            "updateBy": 0,
            "scorePredicateId": 0
        },
        {
            "offerMappingRowID": 0,
            "offerId": 0,
            "offerName": null,
            "offerCode": null,
            "cellId": null,
            "cellCode": null,
            "zoneId": null,
            "zoneName": null,
            "score": 50,
            "scorePredicateEnabled": false,
            "scorePredicate": null,
            "enabled": true,
            "eligibilityPredicateEnabled": false,
            "eligibilityPredicateId": 0,
            "eligibilityPredicate": null,
            "effectiveDate": null,
            "expirationDate": null,
            "learningMode": 1,
            "learningModelId": null,
            "lmName": null,
            "parameterizedOfferAttribute": "",
            "offerAttrExpressions": null,
            "userdefinedFields": null,
            "userdefinedFieldsMap": {
                "ZoneID": 0,
                "EligibilityPredicate": null,
                "CreateBy": 2,
                "CellID": 17,
                "ParameterizedOfferAttribute": "",
                "salary": 20000,
                "CreateDate": 1591187221137,
                "UpdateBy": null,
                "ZoneName": "",
                "UpdateDate": null,
                "predicate": "",
                "OfferCode": "pr000000002",
                "ScorePredicateEnabled": 0,
                "EligibilityPredicateEnabled": 0,
                "MarketerScore": 50,
                "ScorePredicate": null,
                "LearningModelId": 0,
                "CellCode": "A000000016",
                "OfferID": 4,
                "OfferName": "Offer 000000003",
                "ExpirationDate": null,
                "mybdata": 0,
                "LearningMode": 1,
                "EnableState": 1,
                "EffectiveDate": null
            },
            "createDate": null,
            "createBy": 0,
            "updateDate": null,
            "updateBy": 0,
            "scorePredicateId": 0
        },
        {
            "offerMappingRowID": 0,
            "offerId": 0,
            "offerName": null,
            "offerCode": null,
            "cellId": null,
            "cellCode": null,
            "zoneId": null,
            "zoneName": null,
            "score": 50,
            "scorePredicateEnabled": false,
            "scorePredicate": null,
            "enabled": true,
            "eligibilityPredicateEnabled": false,
            "eligibilityPredicateId": 0,
            "eligibilityPredicate": null,
            "effectiveDate": null,
            "expirationDate": null,
            "learningMode": 1,
            "learningModelId": null,
            "lmName": null,
            "parameterizedOfferAttribute": "",
            "offerAttrExpressions": null,
            "userdefinedFields": null,
            "userdefinedFieldsMap": {
                "ZoneID": 0,
                "EligibilityPredicate": null,
                "CreateBy": 2,
                "CellID": 17,
                "ParameterizedOfferAttribute": "",
                "salary": 15000,
                "CreateDate": 1591187221137,
                "UpdateBy": null,
                "ZoneName": "",
                "UpdateDate": null,
                "predicate": "",
                "OfferCode": "pr000000003",
                "ScorePredicateEnabled": 0,
                "EligibilityPredicateEnabled": 0,
                "MarketerScore": 50,
                "ScorePredicate": null,
                "LearningModelId": 0,
                "CellCode": "A000000016",
                "OfferID": 6,
                "OfferName": "Offer 000000005",
                "ExpirationDate": null,
                "mybdata": 0,
                "LearningMode": 1,
                "EnableState": 1,
                "EffectiveDate": null
            },
            "createDate": null,
            "createBy": 0,
            "updateDate": null,
            "updateBy": 0,
            "scorePredicateId": 0
        },
        {
            "offerMappingRowID": 0,
            "offerId": 0,
            "offerName": null,
            "offerCode": null,
            "cellId": null,
            "cellCode": null,
            "zoneId": null,
            "zoneName": null,
            "score": 50,
            "scorePredicateEnabled": false,
            "scorePredicate": null,
            "enabled": true,
            "eligibilityPredicateEnabled": false,
            "eligibilityPredicateId": 0,
            "eligibilityPredicate": null,
            "effectiveDate": null,
            "expirationDate": null,
            "learningMode": 1,
            "learningModelId": null,
            "lmName": null,
            "parameterizedOfferAttribute": "",
            "offerAttrExpressions": null,
            "userdefinedFields": null,
            "userdefinedFieldsMap": {
                "ZoneID": 0,
                "EligibilityPredicate": null,
                "CreateBy": 2,
                "CellID": 17,
                "ParameterizedOfferAttribute": "",
                "salary": 25000,
                "CreateDate": 1591187221137,
                "UpdateBy": null,
                "ZoneName": "",
                "UpdateDate": null,
                "predicate": "",
                "OfferCode": "000000011",
                "ScorePredicateEnabled": 0,
                "EligibilityPredicateEnabled": 0,
                "MarketerScore": 50,
                "ScorePredicate": null,
                "LearningModelId": 0,
                "CellCode": "A000000016",
                "OfferID": 12,
                "OfferName": "Offer 000000011",
                "ExpirationDate": null,
                "mybdata": 1,
                "LearningMode": 1,
                "EnableState": 1,
                "EffectiveDate": null
            },
            "createDate": null,
            "createBy": 0,
            "updateDate": null,
            "updateBy": 0,
            "scorePredicateId": 0
        }
    ],
    "page": {
        "pageNumber": 0,
        "totalElements": 30,
        "totalPages": 1,
        "size": 30,
        "hasNext": false,
        "hasPrev": false
    }
}
Delete FlexOffer rules
DELETE /Campaign/api/interact/rest/v2/channels/{icIdOrName}/offermappings/{offermappingIdOrName}/delete
Output
Table 5. Response Codes
No Content 200 Ok
Error 400 Bad Request
Server Error 500 Internal Server Error
Input
Body Parameter – Content-Type: application/json
{"ids":[7040, 7041]}