Marketing Campaign Service
Service to operate on marketing campaigns. The supported operations are create, update, delete, and search.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/oracle/apps/marketing/coreMarketing/campaigns/campaignPublicService/}CampaignPublicService
Service WSDL URL: https://servername/crmService/CampaignPublicService?WSDL
Logical Business Objects
-
CRM
-
CRM
-
CRM
Relationships
The following table describes how this service data object is related to other service data objects or business object services.
| Relationship Type | Object or Service |
|---|---|
|
Handles |
|
|
Handles |
|
|
Handles |
|
|
Handles |
Operations
getCampaign
A web service method that queries a single record of an Oracle Fusion Marketing Campaign Object by ID.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
campaignId |
long |
A required input parameter of the getCampaign web service method. It is the row ID of the record you want to query for. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The return value of the getCampaign web service method. It includes the full set of attributes and child entities of the record. |
createCampaign
A web service method that creates Oracle Fusion Marketing Campaign Object records.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
campaign |
Marketing Campaign |
A required input parameter of the createCampaign web service method. The input campaign Object includes the attribute values that the record is created with. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The return value of the createCampaign web service method. It includes the full set of attributes and child entities of the record. |
updateCampaign
A web service method that updates an Oracle Fusion Marketing Campaign Object record.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
campaign |
Marketing Campaign |
An input parameter of the updateCampaign web service method. The record matching the ID specified in this input campaign Object is updated with the corresponding input attribute values also. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The return value of the updateCampaign web service method. It includes the full set of attributes and child entities of the record. |
deleteCampaign
A web service method that delete an Oracle Fusion Marketing Campaign Object record.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
campaign |
Marketing Campaign |
A required input parameter of the deleteCampaign web service method. The record matching the input Object's attribute values specified in the campaign are deleted. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
The parameter is not applicable for the method deleteCampaign. |
findCampaignNew
A web service method that queries list of records of matching Oracle Fusion Marketing Campaign Object by criteria.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
findCriteria |
{http://xmlns.oracle.com/adf/svc/types/}FindCriteria |
A required input parameter of the findCampaignNew web service method. The filter criteria are a cumulative set of attribute criteria that identifies records queried for. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The parameter is not used for the method findCampaignNew. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The return value of the findCampaignNew web service method. It includes the full set of attributes of records queried. |
findCampaign
A web service method that queries a single record of an Oracle Fusion Marketing Campaign Object by criteria.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
findCriteria |
{http://xmlns.oracle.com/adf/svc/types/}FindCriteria |
A required input parameter of the findCampaign web service method. The filter criteria are a cumulative set of attribute criteria that identifies records queried for. |
|
BindLastUpdateDate |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The input parameter of the findCampaign web service method that identifies the last update date on the campaign. |
|
BindCampaignName |
string |
The input parameter of the findCampaign web service method that identifies the campaign name. |
|
BindCampaignStartDate |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The input parameter of the findCampaign web service method that identifies the campaign start date. |
|
BindCampaignEndDate |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The input parameter of the findCampaign web service method that identifies the campaign end date. |
|
BindExecutionStatus |
string |
The input parameter of the findCampaign web service method that identifies the campaign execution status code. |
|
BindSourceCode |
string |
The input parameter of the findCampaign web service method that identifies the source code. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The parameter is not used for the method findCampaign. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The return value of the findCampaign web service method. It includes the full set of attributes of records queried. |
findCampaigns
A web service method that queries records of matching Oracle Fusion Marketing Campaign Object by criteria.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
findCriteria |
{http://xmlns.oracle.com/adf/svc/types/}FindCriteria |
A required input parameter of the findCampaigns web service method. The filter criteria are a cumulative set of attribute criteria that identifies records queried for. |
|
BindCreationDate |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The input parameter of the findCampaigns web service method that identifies the creation date. |
|
BindCampaignName |
string |
The input parameter of the findCampaigns web service method that identifies the campaign name. |
|
BindCampaignType |
string |
The input parameter of the findCampaigns web service method that identifies the campaign type. |
|
BindCampaignStartDate |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The input parameter of the findCampaigns web service method that identifies the campaign start date. |
|
BindCampaignEndDate |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The input parameter of the findCampaigns web service method that identifies the campaign end date. |
|
BindExecutionStatus |
string |
The input parameter of the findCampaigns web service method that identifies the campaign execution status code. |
|
BindSourceCode |
string |
The input parameter of the findCampaigns web service method that identifies the source code. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The parameter is not used for the method findCampaigns. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The return value of the findCampaigns web service method. It includes the full set of attributes of records queried. |
getDfltObjAttrHints
A web service method to retrieve user interface hints, such as the service data object label and Object attribute labels, for the specified service data object and locale. As a prerequisite, invoke the getEntityList operation defined on this service to get the list of possible values for the viewName request payload element.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
viewName |
string |
The service view usage name, an internal name for the service data object. Specify the value of the <name> element from the getEntityList operation response payload. |
|
localeName |
string |
The locale to use when evaluating locale-based user interface hints. The localeName is in ISO 639-1 format. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}ObjAttrHints |
The label and user interface hints for the specified service data object and its attributes in a name-value pair format. |
getServiceLastUpdateTime
A web service method that returns the date and time when the schema files referenced in the service definition last changed.
Life Cycle Status: Active
Request Payload
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The date and time when the service definition was last updated. The parameter is present in ISO 8601 format. |
getEntityList
A web service method to get the list of service data objects defined on this service.
Life Cycle Status: Active
Request Payload
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo |
A list of service data objects defined on this service. For each service data object, the result includes the QName, internal name, and Boolean values indicating whether create, update, merge, and delete operations can be performed on the Object. |
Security
The following tables list the privileges required to perform the service operations, and the duty roles that each privilege is granted to.
Service Operations to Privileges Mapping
| Operation Name | Privilege Code | Privilege Name | Privilege Description |
|---|---|---|---|
|
All Operations |
MKT_UPDATE_MARKETING_CAMPAIGN_PRIV |
Update Marketing Campaign |
Allows updating simple campaigns and the plans, design, and execution of complex marketing campaigns. |
|
All Operations |
MKT_MANAGE_MARKETING_CAMPAIGN_PRIV |
Manage Marketing Campaign |
Allows web services management of simple campaigns and the plan, design, and execution of complex marketing campaigns. |
|
All Operations |
MKT_MANAGE_SALES_CAMPAIGN_PRIV |
Manage Sales Campaign |
For internal use only. Allows web services management of sales campaigns. |
|
All Operations |
MKT_VIEW_SALES_CAMPAIGN_PRIV |
View Sales Campaign |
Allows viewing sales campaigns and tracking of customer responses. A sales campaign is an e-mail promoting products or events to specific customers, that can include personalized information and links where the customer can respond. |
|
All Operations |
MKT_VIEW_MARKETING_CAMPAIGN_PRIV |
View Marketing Campaign |
Allows viewing simple campaigns and the plans, design, execution, and results of complex marketing campaigns. |
Privileges to Duty Roles Mapping
| Privilege Code | Granted to Duty Role Code | Granted to Duty Role Name | Granted To Duty Role Description |
|---|---|---|---|
|
MKT_MANAGE_MARKETING_CAMPAIGN_PRIV |
ORA_MKT_MARKETING_CAMPAIGN_MANAGEMENT_DUTY |
Marketing Campaign Management |
Manages secured marketing campaigns from planning to design and execution. Defines and maintains secured marketing treatments, lists, segments, and content. |
|
MKT_UPDATE_MARKETING_CAMPAIGN_PRIV |
ORA_MKT_MARKETING_APPROVAL_DUTY |
Marketing Approval |
Reviews and approves secured marketing campaigns by viewing detailed campaign, list, segment, and treatment information from the campaign, audience, and treatment work areas. |
|
MKT_UPDATE_MARKETING_CAMPAIGN_PRIV |
ORA_MKT_MARKETING_CAMPAIGN_MANAGEMENT_DUTY |
Marketing Campaign Management |
Manages secured marketing campaigns from planning to design and execution. Defines and maintains secured marketing treatments, lists, segments, and content. |
|
MKT_MANAGE_SALES_CAMPAIGN_PRIV |
ORA_MKT_PERSONAL_CAMPAIGN_MANAGEMENT_DUTY |
Personal Campaign Management |
Manages secured personal campaigns used to promote products or events to specific customers. |
|
MKT_VIEW_SALES_CAMPAIGN_PRIV |
ORA_MKT_PERSONAL_CAMPAIGN_MANAGEMENT_DUTY |
Personal Campaign Management |
Manages secured personal campaigns used to promote products or events to specific customers. |
|
MKT_VIEW_SALES_CAMPAIGN_PRIV |
ORA_MKT_MARKETING_EXECUTION_MANAGEMENT_DUTY |
Marketing Execution Management |
Manages the execution of secured marketing campaigns. Manages secured marketing responses including response import and converting responses to sales leads and opportunities. Schedules and monitors processes to record response interactions and create trading community members from suspects.Manages the execution of secured marketing campaigns. Manages secured marketing responses including response import and converting responses to sales leads and opportunities. Schedules and monitors processes to record response interactions and create trading community members from suspects. |
|
MKT_VIEW_SALES_CAMPAIGN_PRIV |
ORA_MKT_PERSONAL_CAMPAIGN_MANAGEMENT_READ_ONLY_DUTY |
Personal Campaign Management Read Only |
Read Only role for Personal Campaign Management Duty. |
|
MKT_VIEW_MARKETING_CAMPAIGN_PRIV |
ORA_MKL_SALES_LEAD_QUALIFIER_JOB |
Sales Lead Qualifier |
Identifies, generates and qualifies sales leads and ensures that they are successfully closed within established time objectives. Includes the ability to deliver reports, ensure a healthy sales pipeline volume, help shorten sales cycles, shape lead generation strategies, and provide effective guidance to the rest of the lead qualification team. Other supporting roles include territory development, event and webinar strategies. |
|
MKT_VIEW_MARKETING_CAMPAIGN_PRIV |
ORA_MKT_MARKETING_APPROVAL_DUTY |
Marketing Approval |
Reviews and approves secured marketing campaigns by viewing detailed campaign, list, segment, and treatment information from the campaign, audience, and treatment work areas. |
|
MKT_VIEW_MARKETING_CAMPAIGN_PRIV |
ORA_MKT_MARKETING_EXECUTION_MANAGEMENT_DUTY |
Marketing Execution Management |
Manages the execution of secured marketing campaigns. Manages secured marketing responses including response import and converting responses to sales leads and opportunities. Schedules and monitors processes to record response interactions and create trading community members from suspects.Manages the execution of secured marketing campaigns. Manages secured marketing responses including response import and converting responses to sales leads and opportunities. Schedules and monitors processes to record response interactions and create trading community members from suspects. |
|
MKT_VIEW_MARKETING_CAMPAIGN_PRIV |
ORA_MKT_MARKETING_ANALYSIS_DUTY |
Marketing Analysis |
Analyzes marketing effectiveness across the enterprise by viewing detailed marketing campaign, list, segment, and treatment information from the audience and campaign work areas. |
|
MKT_VIEW_MARKETING_CAMPAIGN_PRIV |
ORA_MKT_MARKETING_CAMPAIGN_MANAGEMENT_DUTY |
Marketing Campaign Management |
Manages secured marketing campaigns from planning to design and execution. Defines and maintains secured marketing treatments, lists, segments, and content. |
Duty Roles to Duty or Job Roles Mapping
| Duty Role Code | Granted to Duty or Job Role Code | Granted to Duty or Job Role Name | Granted To Duty or Job Role Description |
|---|---|---|---|
|
ORA_MKL_SALES_LEAD_QUALIFIER_JOB |
ORA_ZCA_ACCESS_GROUPS_ENABLEMENT_DUTY |
Access Groups Enablement |
Enables the Access Groups functionality. |
|
ORA_MKL_SALES_LEAD_QUALIFIER_JOB |
ORA_MKL_LEAD_REGISTRATION_PROCESSING_DUTY |
Lead Registration Processing |
Reviews, accepts, and rejects sales lead registrations. Includes the ability to view sales lead details and update internal attributes. |
|
ORA_MKL_SALES_LEAD_QUALIFIER_JOB |
ORA_ZCM_MKTG_SALES_PARTY_MANAGEMENT_DUTY |
Marketing Sales Party Management |
Manages creation and maintenance of the sales organizations and consumers for internal marketing users. Additional duties include viewing of appointments, interactions, and customer contacts. |
|
ORA_MKL_SALES_LEAD_QUALIFIER_JOB |
ORA_HZ_RESOURCE_ABSTRACT |
Resource |
Identifies the person as front office personnel. |
|
ORA_MKL_SALES_LEAD_QUALIFIER_JOB |
ORA_MKL_SALES_LEAD_QUALIFICATION_DUTY |
Sales Lead Qualification |
Qualifies sales leads to determine the sales readiness of the lead. |
|
ORA_MKL_SALES_LEAD_QUALIFIER_JOB |
ORA_ZCM_SALES_PARTY_ADMINISTRATION_DUTY |
Sales Party Administration |
Manages named sales accounts, sales account import scheduler and the flagging of existing accounts. Additional duties include managing sales parties, functional setups, customer center objects, and relationship information inquiries. |