Sales Territory Custom Business Object (Deprecated)
Service to operate on custom business objects created in the Oracle Sales Cloud Territory Management application. The supported operations are create, update, delete, and find. A custom business object stores the 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/sales/territoryMgmt/custExtn/territories/territoryService/}SalesTerrMgmtCustomObjectService
Service WSDL URL: https://servername/crmService/SalesTerrMgmtCustomObjectService?WSDL
Logical Business Objects
-
CRM : Territory Management : Sales Territory
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 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 the 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 which is the 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
Retrieves the list of service data objects defined on the service.
Life Cycle Status: Active
Request Payload
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo |
The list of service data objects defined on 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
Creates an Oracle Fusion territory management custom object record.
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 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 full set of attributes and child entities of the record. |
getEntity
Retrieves a single record of an Oracle Fusion territory management custom object based on the unique identifier.
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 identifier 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 full set of attributes and child entities of the record. |
updateEntity
Updates a set of records of the Oracle Fusion territory management 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 the input object are updated with the corresponding input attribute values that are 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 |
Returns the updated set of records. |
deleteEntity
Deletes a set of records of an Oracle Fusion territory management 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 |
The deleteEntity web service method returns void. |
findEntity
Retrieves a set of Oracle Fusion territory management custom object records based on a specified criteria.
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. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
This input parameter is not applicable to the findEntity web service method. |
|
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
Method not available.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
object |
anyType |
Parameter not available. |
|
objectName |
string |
Parameter not available. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
anyType |
Parameter not available. |
processEntity
Method not available.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
changeOperation |
string |
Parameter not available. |
|
object |
anyType |
Parameter not available. |
|
processControl |
{http://xmlns.oracle.com/adf/svc/types/}ProcessControl |
Parameter not available. |
|
objectName |
string |
Parameter not available. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
anyType |
Parameter not available. |