Customer Custom Business Object (Deprecated)

Service to operate on custom Oracle Fusion Customer Center business objects. The supported operations are create, update, get, and find. Some examples of custom objects could be a customer trouble ticket to track customer complaints or a customer tracking event to keep track of customer participation in marketing events.

Life Cycle Status: Deprecated. This service is deprecated and replaced by .

QName: {http://xmlns.oracle.com/apps/crmCommon/salesParties/custExtn/extnService/}CustomerCenterCustomObjectService

Service WSDL URL: https://servername/crmService/CustomerCenterCustomObjectService?WSDL

Logical Business Objects

  • CRM : Customer Center : Sales Party

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

Custom Business Object

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 locale name 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

Retrieves 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 Customer custom object.

Life Cycle Status: Active

Request Payload

Element Name Type Description

object

anyType

A required input parameter of the createEntity web service method. Includes the attribute values that the records will be 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. Includes the full set of attributes and child entities of the record.

getEntity

Queries by ID a single record of an Oracle Fusion Customer custom object.

Life Cycle Status: Active

Request Payload

Element Name Type Description

keyValue

string

A required input parameter of the getEntity Web service method. Includes the row ID of the record you want to query.

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. Includes the full set of attributes and child entities of the record.

updateEntity

Updates a set of records of an Oracle Fusion Customer custom object.

Life Cycle Status: Active

Request Payload

Element Name Type Description

object

anyType

The required input parameter of the updateEntity web service method. The object includes only the IDs and the attribute values you want to update. Records with the matching IDs will be updated with the attribute values in the object.

objectName

string

The 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 Customer 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

findEntity

Retrieves a set of records of an Oracle Fusion Customer 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. 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, as well as the set of search criteria to use on the child entities.

findControl

{http://xmlns.oracle.com/adf/svc/types/}FindControl

This operation is currently not in use.

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. 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