Marketing Budget Service
Service to operate on marketing budgets including market development funds. The supported operations are create, update, delete, and search. WARNING: This service has been deprecated and is being replaced with Marketing Budget Service Version 2 (oracle.apps.marketing.commonMarketing.budgets.budgetService.MarketingBudgetService).
Life Cycle Status: Deprecated. This service is deprecated and replaced by .
QName: {http://xmlns.oracle.com/oracle/apps/marketing/commonMarketing/budgets/budgetPublicService/}BudgetPublicService
Service WSDL URL: https://servername/crmService/BudgetPublicService?WSDL
Logical Business Objects
-
CRM : Marketing : Marketing Budget
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 |
---|---|
Next version is |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
Operations
getBudgetEntry
A web service method for Get operation of the Marketing Budget Entry.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
budgetEntryId |
long |
Returns a uniquely identified budget entry associated to a marketing budget. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The service returns the Marketing Budget Entry that matches the inbound key attributes. |
createBudgetEntry
A web service method for Create operation of the Marketing Budget Entry.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
budgetEntry |
Marketing Budget Entry |
The service for the Marketing Budget Entry to be created. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The service returns the created Marketing Budget Entry. |
updateBudgetEntry
A web service method for Update operation of the Marketing Budget Entry.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
budgetEntry |
Marketing Budget Entry |
The service for the Marketing Budget Entry to be updated. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The service returns the updated Marketing Budget Entry. |
findBudgetEntry
A web service method that queries a single record of Marketing Budget Entry by ID.
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 findBudgetEntry web service method. The filter criteria are a cumulative set of attribute criteria that identifies Marketing Budget Entry records. |
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The parameter is not applicable for the method findBudgetEntry. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The return value of the findBudgetEntry web service method. It includes the full set of attributes of the record. |
getClaim
A web service method for Get operation of the Marketing Claim.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
claimId |
long |
Returns a uniquely identified claim associated to a marketing budget or fund request. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Marketing Claim that matches the inbound key attributes. |
createClaim
A web service method for Create operation of the Marketing Claim.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
claim |
Marketing Claim |
The service for the Marketing Claim to be created. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The service returns the created Marketing Claim. |
updateClaim
A web service method for Update operation of the Marketing Claim.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
claim |
Marketing Claim |
The service for the Marketing Claim to be updated. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The service returns the updated Marketing Claim. |
deleteClaim
A web service method for Delete operation of the Marketing Claim.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
claim |
Marketing Claim |
The service for the Marketing Claim to be deleted. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
void |
The parameter is not applicable for the method deleteClaim. |
findClaim
A web service method that queries a single record of Marketing Claim by ID.
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 findBudgetEntry web service method. The filter criteria are a cumulative set of attribute criteria that identifies Marketing Claim records. |
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The parameter is not applicable for the method findClaim. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The return value of the findClaim web service method. It includes the full set of attributes of the record. |
getClaimSettlement
A web service method for Get operation of the Marketing Claim Settlements.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
claimSettlementId |
long |
Returns a uniquely identified claim settlement associated to a marketing claim. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The service returns a Marketing Claim Settlement that matches the inbound key attributes. |
createClaimSettlement
A web service method for Create operation of the Marketing Claim Settlement.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
claimSettlement |
Marketing Claim Settlement |
The service for the Marketing Claim Settlement to be created. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The service returns the created Marketing Claim Settlement. |
updateClaimSettlement
A web service method for Update operation of the Marketing Claim Settlement.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
claimSettlement |
Marketing Claim Settlement |
The service for the Marketing Claim Settlement to be updated. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The service returns the updated Marketing Claim Settlement. |
findClaimSettlement
A web service method that queries a single record of Marketing Claim Settlement by ID.
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 findBudgetEntry web service method. The filter criteria are a cumulative set of attribute criteria that identifies marketing claim settlement records. |
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The parameter is not applicable for the method findClaimSettlements. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The return value of the findClaimSettlement web service method. It includes the full set of attributes of the record. |
getFundRequest
A web service method for Get operation of the Marketing Fund Request.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
fundRequestId |
long |
Returns a uniquely identified fund request associated to a marketing budget. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The service returns Marketing Fund Request that matches the inbound key attributes. |
createFundRequest
A web service method for Create operation of the Marketing Fund Request.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
fundRequest |
Marketing Fund Request |
The service for the Marketing Fund Request to be created. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The service returns the created Marketing Fund Request. |
updateFundRequest
A web service method for Update operation of the Marketing Fund Request.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
fundRequest |
Marketing Fund Request |
The service for the Marketing Fund Request to be updated. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The service returns the updated Marketing Fund Request. |
deleteFundRequest
A web service method for Delete operation of the Marketing Fund Request.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
fundRequest |
Marketing Fund Request |
The service for the Marketing Fund Request to be deleted. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
void |
The parameter is not applicable for the method deleteFundRequest. |
findFundRequest
A web service method that queries a single record of Marketing Fund Request by ID.
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 findFundRequest web service method. The filter criteria are a cumulative set of attribute criteria that identifies marketing fund request records. |
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The parameter is not applicable for the method findFundRequest. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The return value of the findFundRequest web service method. It includes the full set of attributes of the record. |
getBudget
A web service method for Get operation of the Marketing Budget.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
budgetId |
long |
The unique identifier of the Marketing Budget. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The service returns a Marketing Budget that matches the inbound key attributes. |
createBudget
A web service method for Create operation of the Marketing Budget.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
budget1 |
Marketing Budget |
The service for the Marketing Budget to be created. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The service returns the created Marketing Budget. |
updateBudget
A web service method for Update operation of the Marketing Budget.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
budget1 |
Marketing Budget |
The service for the Marketing Budget to be updated. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The service returns the updated Marketing Budget. |
deleteBudget
A web service method for Delete operation of the Marketing Budget.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
budget1 |
Marketing Budget |
The service for the Marketing Budget to be deleted. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
void |
The parameter is not applicable for the method deleteBudget. |
findBudget
A web service method that queries a single record of Marketing Budget by ID.
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 findBudgetEntry web service method. The filter criteria are a cumulative set of attribute criteria that identifies the Marketing Budget records. |
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The parameter is not applicable for the method findBudget. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
The return value of the findBudget web service method. It includes the full set of attributes of the record. |
getDfltObjAttrHints
Retrieves 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_MANAGE_BUDGETS_WORK_AREA_PRIV |
Manage Budgets Work Area |
Allows managing marketing budgets from the work area. A work area is a landing page for frequent tasks and reports useful for managing budgets. |
Privileges to Duty Roles Mapping
Privilege Code | Granted to Duty Role Code | Granted to Duty Role Name | Granted To Duty Role Description |
---|---|---|---|
MKT_MANAGE_BUDGETS_WORK_AREA_PRIV |
ORA_MKT_MARKETING_BUDGET_MAINTENANCE_DUTY |
MDF Budget Maintenance |
Manages MDF budgets including import, export, and viewing budget fund requests and claims that use budgeted funds for marketing activities. |
MKT_MANAGE_BUDGETS_WORK_AREA_PRIV |
ORA_MKT_MARKETING_FUND_REQUEST_AND_CLAIM_PROCESSING_DUTY |
Marketing Fund Request and Claim Processing |
Reviews and approves budget fund requests and claims to use budgeted funds for marketing activities. Includes reviewing and exporting budget information. |
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_MKT_MARKETING_BUDGET_MAINTENANCE_DUTY |
ORA_MKT_MARKETING_BUDGET_UTILIZATION_DUTY |
MDF Utilization |
Creates and manages MDF requests and claims for marketing activities. |