Custom Business Object
A service to create, update, delete, or find custom business objects created in the Oracle Fusion CRM application. A custom business object stores extended information for an Oracle Fusion business object.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/apps/custom/extnService/}CustomReferenceService
Service WSDL URL: https://servername/crmService/CustomReferenceService?WSDL
Logical Business Objects
-
CRM : CRM Application Composer : CRM Extensible Object
Operations
getDfltObjAttrHints
An operation 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
An operation 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 last changed in 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 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. |
invokeObjectFunction
invoke custom object row function.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
row |
anyType |
DataObject used to invoke the script |
|
viewName |
string |
Custom Object type name |
|
scriptName |
string |
row function name |
|
params |
anyType |
row function parameters |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
anyType |
DataObject |
createEntity
Create operation for a custom object.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
object |
anyType |
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. |
|
objectName |
string |
Custom object type name. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
anyType |
DataObject created for the custom object. |
getEntity
Get operation for a custom object.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
keyValue |
string |
A list of key values for identifying the custom object. |
|
objectName |
string |
Custom object type name. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
anyType |
DataObject identified by the keyValue. |
updateEntity
Update operation for a custom object.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
object |
anyType |
DataObject to be updated. The DataObject must include key fields for identifying the updated record, as well as the fields to be updated. |
|
objectName |
string |
Custom object type name. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
anyType |
DataObject updated for the custom object. |
deleteEntity
Delete operation for a custom object.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
object |
anyType |
DataObject to be deleted. The DataObject must include key fields for identifying the deleted record. |
|
objectName |
string |
Custom object type name. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
DataObject that is deleted. |
findEntity
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 |
List of DataObjects identified by the findCriteria. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
Search control. |
|
objectName |
string |
Custom object type name. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
anyType |
DataObjects found |
mergeEntity
merge with existing custom object if exist, create new object if does not exist.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
object |
anyType |
DataObject to be merged. The DataObject must include key fields for identifying the record, as well as the fields to be merged. |
|
objectName |
string |
Custom object type name. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
anyType |
DataObject result from the merge |
processEntity
batch process for custom object operation
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
changeOperation |
string |
Operation name |
|
object |
anyType |
DataObjects to be batch processed |
|
processControl |
{http://xmlns.oracle.com/adf/svc/types/}ProcessControl |
process control |
|
objectName |
string |
Custom object type name. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
anyType |
DataObject result list |
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 |
|---|---|---|---|
|
processEntity |
ZCX_UPDATE_CUSTOM_OBJECT_PRIV |
UPDATE custom object resources (WorkArea) |
PermissionSet to UPDATE for custom object WorkArea |
|
getEntityList |
ZCX_READ_CUSTOM_OBJECT_PRIV |
READ custom object resources (WorkArea) |
PermissionSet to READ for custom object WorkArea |
|
updateEntity |
ZCX_UPDATE_CUSTOM_OBJECT_PRIV |
UPDATE custom object resources (WorkArea) |
PermissionSet to UPDATE for custom object WorkArea |
|
getEntity |
ZCX_READ_CUSTOM_OBJECT_PRIV |
READ custom object resources (WorkArea) |
PermissionSet to READ for custom object WorkArea |
|
deleteEntity |
ZCX_DELETE_CUSTOM_OBJECT_PRIV |
DELETE custom object resources (WorkArea) |
PermissionSet to DELETE for custom object WorkArea |
|
findEntity |
ZCX_READ_CUSTOM_OBJECT_PRIV |
READ custom object resources (WorkArea) |
PermissionSet to READ for custom object WorkArea |
|
getDfltObjAttrHints |
ZCX_READ_CUSTOM_OBJECT_PRIV |
READ custom object resources (WorkArea) |
PermissionSet to READ for custom object WorkArea |
|
createEntity |
ZCX_CREATE_CUSTOM_OBJECT_PRIV |
CREATE custom object resources (WorkArea) |
PermissionSet to CREATE for custom object WorkArea |
|
getServiceLastUpdateTime |
ZCX_READ_CUSTOM_OBJECT_PRIV |
READ custom object resources (WorkArea) |
PermissionSet to READ for custom object WorkArea |
|
mergeEntity |
ZCX_UPDATE_CUSTOM_OBJECT_PRIV |
UPDATE custom object resources (WorkArea) |
PermissionSet to UPDATE for custom object WorkArea |