REST API for Unica Campaign target cell objects

Description

APIs for target cell objects in Unica Campaign.

Methods

get: /v1/targetcells
getTCSList Returns the list of targetcells for the specified Unica Campaignid.

Parameters

campaignid (required)
Query Parameter — Identifier of the campaign for which the targetcells are returned.

Return type

array[TargetCellInfo]

Example result

Content-Type: application/json
[ {
  "controlCellReference" : "",
  "isControlCell" : true,
  "isCellReadOnly" : true,
  "cellCode" : "aeiou",
  "offerInfo" : [ {
    "reference" : "",
    "offerCode" : "aeiou",
    "name" : "aeiou",
    "description" : "aeiou",
    "attributes" : "",
    "retired" : true
  } ],
  "description" : "aeiou",
  "flowchartName" : "aeiou",
  "controlCellDispOrder" : 123456789,
  "controlCellCode" : "aeiou",
  "cellStatus" : true,
  "cellDisplayOrder" : 123456789,
  "controlCellName" : "aeiou",
  "reference" : "",
  "isCellTopDown" : true,
  "flowChart" : {
    "componentTypeEnum" : "",
    "id" : 123456789
  },
  "name" : "aeiou",
  "attributes" : "",
  "cellApproved" : 123456789
} ]

post: /v1/targetcells
createTargetCells Creates a targetcell with the provided information.

Parameters

campaignid (required)
Form Parameter — Identifier of the campaign in which the targetcells are created.
targetcell (required)
Form Parameter — The TargetCellInfo object, in the form of JSON data.

Return type

String

Example result

Content-Type: application/json
"aeiou"

post: /v1/targetcells/delete
deleteTargetCells Bulk deletes the specified targetcells.

Parameters

cellid (required)
Form Parameter — Identifiers of the targetcells to be deleted, in the form of cellid='abc'&cellid='def'. This action deletes multiple targetcells. To delete single targetcells, use DELETE /Campaign/rest/v1/targetcells/{cellid}.

Return type

String

Example result

Content-Type: application/json
"aeiou"

get: /v1/targetcells/runresults
getRunResults Returns the run results for the specified targetcells.

Parameters

cellid (required)
Query Parameter — Identifiers of the targetcells, in the form of cellid='abc'&cellid='def', for which the run results are returned. This action accepts multiple targetcells.

Return type

array[RunResults]

Example result

Content-Type: application/json
[ {
  "endDate" : "",
  "runTypeEnum" : "",
  "count" : 123456789,
  "retired" : true,
  "flowchartName" : "aeiou",
  "source" : {
    "componentTypeEnum" : "",
    "id" : 123456789
  },
  "runId" : 123456789,
  "flowchartId" : 123456789,
  "startDate" : {
    "firstDayOfWeek" : 123,
    "minimalDaysInFirstWeek" : 123,
    "timeZone" : {
      "displayName" : "aeiou",
      "rawOffset" : 123,
      "dSTSavings" : 123,
      "iD" : "aeiou"
    },
    "time" : "2015-07-20T11:21:04.699+0000",
    "timeInMillis" : 123456789,
    "lenient" : true
  },
  "statusCode" : 123,
  "runStatusEnum" : ""
} ]

put: /v1/targetcells/update
updateTargetCells Updates an existing targetcell with the provided information.

Parameters

campaignid (required)
Form Parameter — Identifier of the campaign where the specified targetcell resides.
targetcell (required)
Form Parameter — The TargetCellInfo object, in the form of JSON data.

Return type

String

Example result

Content-Type: application/json
"aeiou"

delete: /v1/targetcells/{cellid}
deleteTargetCell Deletes the specified targetcell.

Parameters

cellid (required)
Path Parameter — Identifier for the targetcell to be deleted. This action deletes only one targetcell. To delete multiple targetcells, use POST /Campaign/rest/v1/targetcells/delete.

Return type

String

Example result

Content-Type: application/json
"aeiou"

Return types

TimeZone

displayName
String
rawOffset
Integer
dSTSavings
Integer
iD
String

Reference

componentTypeEnum
ComponentTypeEnum
id
Long

Calendar

lenient
Boolean
firstDayOfWeek
Integer
minimalDaysInFirstWeek
Integer
time
Date
timeZone
TimeZone
timeInMillis
Long

RunResults

source
Reference
count
Long
statusCode
Integer
retired
Boolean
runId
Long
startDate
Calendar
endDate
Calendar
flowchartName
String
flowchartId
Long
runStatusEnum
RunStatusEnum
runTypeEnum
RunTypeEnum

TargetCellInfo

cellStatus
Boolean
cellApproved
Long
isCellReadOnly
Boolean
isCellTopDown
Boolean
cellDisplayOrder
Long
flowChart
Reference
flowchartName
String
isControlCell
Boolean
controlCellDispOrder
Long
reference
Reference
name
String
description
String
cellCode
String
controlCellReference
Reference
controlCellName
String
controlCellCode
String
attributes
Map[string,IAttribute]
offerInfo
array[OfferInfo]

OfferInfo

reference
Reference
name
String
description
String
offerCode
String
attributes
Map[string,IAttribute]
retired
Boolean