Marketing Custom Business Object (Deprecated)
Service to operate on custom business objects created in the Oracle Fusion Marketing application. The supported operations are create, update, delete, and search. A custom business object stores extended information for an Oracle Fusion business object, for example, related orders for a marketing campaign.
Life Cycle Status: Deprecated. This service is deprecated and replaced by .
QName: {http://xmlns.oracle.com/apps/marketing/custExtn/extnService/}MarketingCustomObjectService
Service WSDL URL: https://servername/crmService/MarketingCustomObjectService?WSDL
Logical Business Objects
-
CRM : Marketing : Marketing Custom Object
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 |
Operations
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
Retrieves 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 last changed 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. |
createEntity
Creates records of an Oracle Fusion marketing custom object.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
object |
anyType |
A required input parameter of the createEntity web service method. It includes the attribute values that the records is created with. |
|
objectName |
string |
A required input parameter of the createEntity web service method. Use the API name of the custom object you want to create. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
anyType |
The return value of the createEntity web service method. It includes the full set of attributes and child entities of the record. |
getEntity
Queries by ID a single record of an Oracle Fusion marketing custom object.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
keyValue |
string |
A required input parameter of the getEntity web service method. It includes the row ID of the record you want to query for. |
|
objectName |
string |
A required input parameter of the getEntity web service method. Use the API name of the custom object you want to query for. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
anyType |
The return value of the getEntity web service method. It includes the full set of attributes and child entities of the record. |
updateEntity
Updates a set of records of an Oracle Fusion marketing custom object.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
object |
anyType |
A required input parameter of the updateEntity method. All records matching the IDs specified in this input Object are updated with the corresponding input attribute values also specified. |
|
objectName |
string |
A required input parameter of the updateEntity web service method. Use the API name of the custom object you want to update. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
anyType |
deleteEntity
Deletes a set of records of an Oracle Fusion marketing custom object.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
object |
anyType |
A required input parameter of the deleteEntity web service method. All records matching the input attribute values specified in this input Object are deleted. |
|
objectName |
string |
A required input parameter of the deleteEntity web service method. Use the API name of the custom object you want to delete. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
Not applicable |
findEntity
Queries for a set of records of an Oracle Fusion marketing custom object.
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 findEntity web service method. It includes optional search criteria, sort filter, and attributes to be excluded when returning the set of records. Also includes the option to return any of the custom object's child entities, |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
Not applicable |
|
objectName |
string |
A required input parameter of the findEntity web service method. Use the API name of the custom object you want to query for. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
anyType |
The return value of the findEntity web service method. It includes the full set of attributes and child entities of the records. |
mergeEntity
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
object |
anyType | |
|
objectName |
string |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
anyType |
processEntity
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
changeOperation |
string | |
|
object |
anyType | |
|
processControl |
{http://xmlns.oracle.com/adf/svc/types/}ProcessControl | |
|
objectName |
string |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
anyType |