The Activity noun is used to model a marketing activity. Marketing activities allow you to define the marketing messages to deliver to customers when a given activity is triggered.
| BOD | Action Code / Access Profile | Action Expression | Service Provided | Sample XML Message | Client Library / Expression Builder |
|---|---|---|---|---|---|
| GetActivity | IBM_Admin_Details | /Activity[ActivityIdentifier[(UniqueID=)]] | Finds activities by activity IDs. |
Request
Response |
findByUniqueIDs |
| IBM_Admin_Details | /Activity | Finds all activities in a store. |
Request
Response |
findAll | |
| IBM_Admin_Details | /Activity[search(ActivityIdentifier/ExternalIdentifier/Name='$searchText$' or Description='$searchText$')] | Finds activities in a store by name or description. |
Request
Response |
findByNameOrDescription | |
| IBM_Admin_Details | /Activity[ActivityType=$activityType$] | Finds all activities in a store by activity type. |
Request
Response |
findByType | |
| IBM_Admin_Details | /Activity[ActivityType=$activityType$ and search(ActivityIdentifier/ExternalIdentifier/Name='$searchText$' or Description='$searchText$')] | Finds activities in a store by activity type and name or description. |
Request
Response |
findByTypeAndNameOrDescription | |
| IBM_Admin_Details | /Activity[CampaignIdentifier[UniqueID=$campaignId$]] | Finds activities in a store by the owning campaign ID. |
Request
Response |
findByCampaignID | |
| IBM_Admin_Details | /Activity[ActivityType=$activityType$ and CampaignIdentifier[UniqueID=$campaignId$]] | Finds activities in a store by activity type and owning campaign ID. |
Request
Response |
findByTypeAndCampaignID | |
| IBM_Admin_Details | /Activity[FamilyIdentifier[UniqueID=$familyId$]] | Finds related activities by the same activity family ID. |
Request
Response |
findByFamilyID | |
| IBM_Admin_Details, IBM_Admin_ActivityName | /Activity[CampaignElement[Name='emsId' and Value=$emspotId$]] | Finds activities in a store that are associated with an e-Marketing Spot ID. |
Request
Response |
findByMarketingSpotID | |
| IBM_Admin_Details, IBM_Admin_ActivityName | /Activity[CampaignElement[Name='categoryIdList' and Value=$categoryId$]] | Finds activities in a store associated with a category ID. |
Request
Response |
findByCategoryID | |
| IBM_Admin_Details, IBM_Admin_ActivityName | /Activity[CampaignElement[Name='catalogEntryIdList' and Value=$catalogEntryId$]] | Finds all activities in a store by catalog entry ID. |
Request
Response |
findByCatalogEntryID | |
| IBM_Admin_Details, IBM_Admin_ActivityName | /Activity[CampaignElement[Name='collateralIdList' and Value=$collateralId$]] | Finds activities in a store associated with a marketing content ID. |
Request
Response |
findByMarketingContentID | |
| IBM_Admin_Details, IBM_Admin_ActivityName | /Activity[CampaignElement[Name='segmentIdList' and Value=$segmentId$]] | Finds activities in a store associated with a customer segment ID. |
Request
Response |
findByCustomerSegmentID | |
| IBM_Admin_Details, IBM_Admin_ActivityName | /Activity[CampaignElement[Name='emailMessageId' and Value=$emailMessageId$]] | Finds activities in a store associated with a marketing e-mail template ID. |
Request
Response |
findByMarketingEmailTemplateID | |
| IBM_Admin_Details, IBM_Admin_ActivityName | /Activity[CampaignElement[Name='emailPromotionId' and Value=$emailPromotionId$]] | Finds activities in a store associated with a e-mail promotion ID. |
Request
Response |
findByEmailPromotionID | |
| IBM_Admin_Details | /Activity[CampaignElement[CampaignElementVariable[Name=]]] | Finds activities in a store associated with the name of an element name-value pair. |
Request
Response |
MarketingFacadeClient.getActivity | |
| IBM_Admin_TemplateDetails | /Activity | Finds all activity templates in a store. |
Request
Response |
findAll | |
| IBM_Admin_TemplateDetails | /Activity[ActivityType=$activityType$] | Finds all activity templates in a store by activity type. |
Request
Response |
findByType | |
| IBM_Admin_TemplateDetails | /Activity[TemplateFormat and search(ActivityIdentifier/ExternalIdentifier/Name='$searchText$' or Description='$searchText$')] | Finds activity templates in a store by name or description. |
Request
Response |
findTemplateByNameOrDescription | |
| IBM_Admin_TemplateDetails | /Activity[ActivityType=$activityType$ and TemplateFormat and search(ActivityIdentifier/ExternalIdentifier/Name='$searchText$' or Description='$searchText$')] | Finds activity templates in a store by activity type and name or description. |
Request
Response |
findTemplateByTypeAndNameOrDescription | |
| IBM_Admin_CampaignElements | /Activity[CampaignElement[CampaignElementIdentifier[(UniqueID=$elementId$)]]] | Finds campaign elements by element IDs. |
Request
Response |
findCampaignElementByUniqueIDs | |
| IBM_Admin_CampaignElements | /Activity[ActivityIdentifier[UniqueID=$activityId$]] | Finds campaign elements by the owning activity ID. |
Request
Response |
findCampaignElementsByActivityID | |
| ProcessActivity | Add | Creates a new activity. |
Request
Response |
MarketingFacadeClient.createActivity | |
| Delete | Deletes an existing activity. |
Request
Response |
MarketingFacadeClient.deleteActivity | ||
| Activate | Activates an activity. The activity will be available in the store. |
Request
Response |
MarketingFacadeClient.activateActivity | ||
| Deactivate | Deactivates an activity. The activity will be unavailable in the store. |
Request
Response |
MarketingFacadeClient.deactivateActivity | ||
| ChangeActivity | Change | /Activity | Updates an existing activity. |
Request
Response |
MarketingFacadeClient.updateActivity |
| Add | /Activity/CampaignElement | Creates a new campaign element. |
Request
Response |
MarketingFacadeClient.createElement | |
| Change | /Activity/CampaignElement | Updates an existing campaign element. |
Request
Response |
MarketingFacadeClient.updateElement | |
| Delete | /Activity/CampaignElement | Deletes an existing campaign element. |
Request
Response |
MarketingFacadeClient.deleteElement |
Some sample XML request and response web service messages are provided for each noun. These sample messages might not include all properties or attributes. To view a sample message that includes other properties or attributes, enable logging and tracing for the appropriate component and then call the web service to set or change the properties or attributes. Review the corresponding log file to see the request or response information.
| Access Profile | Data Returned |
|---|---|
| IBM_Admin_Details |
|
| IBM_Admin_ActivityName |
|
| IBM_Admin_TemplateDetails |
|
| IBM_Admin_CampaignElements |
|