Custom Common Business Object (Deprecated)

A service used to create, update, delete, or find custom Oracle Fusion CRM Common business objects. A custom business object stores extended information for an Oracle Fusion business object.

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

QName: {http://xmlns.oracle.com/apps/cdm/foundation/custextn/extnService/}CrmCommonReferenceService

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

Logical Business Objects

  • CRM : CRM Application Composer : CRM Extensible 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

Custom Business Object

Operations

getDfltObjAttrHints

An operation to retrieve the 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 used to evaluate the locale-based user interface hints. The locale name is in the 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

An operation that returns the date and time when the schema files were referenced in the service definition that was last updated.

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 in the ISO 8601 format.

getEntityList

An operation 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 for the 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

The Create operation for a custom object.

Life Cycle Status: Active

Request Payload

Element Name Type Description

object

anyType

The data object to be created. The data object must include key fields for identifying the created record and the required fields.

objectName

string

The name of the custom object type.

Response Payload

Element Name Type Description

result

anyType

The data object created for the custom object.

getEntity

The Get operation for a custom object.

Life Cycle Status: Active

Request Payload

Element Name Type Description

keyValue

string

A list of key values to identify the custom object.

objectName

string

The name of the custom object type.

Response Payload

Element Name Type Description

result

anyType

The data object identified by the key value.

updateEntity

The Update operation for a custom object.

Life Cycle Status: Active

Request Payload

Element Name Type Description

object

anyType

The data object to be updated. The data object must include key fields for identifying the updated record and the fields to be updated.

objectName

string

The name of the custom object type.

Response Payload

Element Name Type Description

result

anyType

The data object created for the custom object.

deleteEntity

The Delete operation for a custom object.

Life Cycle Status: Active

Request Payload

Element Name Type Description

object

anyType

The data object to be deleted. The data object must include key fields for identifying the deleted record.

objectName

string

The name of the custom object type.

Response Payload

Element Name Type Description

result

void

The data object deleted for the custom object.

findEntity

The Find operation for a custom object.

Life Cycle Status: Active

Request Payload

Element Name Type Description

findCriteria

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

The list of data objects identified by the findCriteria operation.

findControl

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

The list of data objects identified by the findCriteria operation.

objectName

string

The search criteria for looking up custom object records.

Response Payload

Element Name Type Description

result

anyType

The name of the custom object type.

mergeEntity

Updates a row if it exists; otherwise, creates a new one.

Life Cycle Status: Active

Request Payload

Element Name Type Description

object

anyType

The data object to be merged.

objectName

string

The name of the custom object type.

Response Payload

Element Name Type Description

result

anyType

The data object created for the custom object.

processEntity

Performs a Create, Update, Delete, or Merge operation on a list of rows. The specified operation is applied to all rows in the given list.

Life Cycle Status: Active

Request Payload

Element Name Type Description

changeOperation

string

Indicates what action to perform, such as create, update, merge, or delete.

object

anyType

The data object to be processed.

processControl

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

Controls the bulk operation behavior, such as whether valid data is committed if there are other invalid data in the same batch, and whether the outbound contains the key attributes only or the full object.

objectName

string

The name of the custom object type.

Response Payload

Element Name Type Description

result

anyType

The custom data object having the processed rows.