Sales Territory Service
Service to operate on territory business objects. It can be used by third-party applications to perform standard and custom operations on territory business objects.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/oracle/apps/sales/territoryMgmt/territories/territoryService/}TerritoryPublicService
Service WSDL URL: https://servername/crmService/TerritoryPublicService?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 |
|---|---|
|
Handles |
|
|
Handles |
|
|
Handles |
|
|
Handles |
|
|
Handles |
|
|
Handles |
|
|
Handles |
Operations
deleteTerritoryFromProposal
Deletes an existing territory from a proposal. This is a private method and is for internal use only.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryId |
long |
The identifier of the territory to be deleted. |
|
territoryProposalId |
long |
The identifier of the proposal from which the territory is deleted. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
The deleteTerritoryFromProposal web service method returns void. |
moveTerritoriesInProposal
Moves a territory from one location in the hierarchy to another.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
mvTerritoryIds |
long |
The list of identifiers for territories being moved. |
|
dstTerritoryId |
long |
The territory identifier of the new parent territory. |
|
proposalId |
long |
The identifier of the proposal in which the territories are moved. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
The moveTerritoriesInProposal web service method returns void. |
transformTerritoryUserKeysToIDs
Transforms the territory user keys to identifiers.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryService |
Sales Territory |
The attributes of the sales territory object. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The attributes of the sales territory object. |
addExistingTerritoryToProposal
Adds an existing territory to a proposal.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryId |
long |
The identifier of the territory to be added. |
|
territoryProposalId |
long |
The identifier of the proposal in which territory is added. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
The addExistingTerritoryToProposal web service method returns void. |
addExistingTerritoryToProposalReturnsTerritory
Adds an existing territory to a proposal and returns the territory information.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryId |
long |
The identifier of the territory to be added. |
|
territoryProposalId |
long |
The identifier of the proposal in which the territory is added. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The attributes of the sales territory object. |
getTerritory
Retrieves the territory by the primary key territory version ID. The Territory object includes all attributes of territory, territory rule, rule boundaries, boundary values, and resources.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryVersionId |
long |
The identifier of the territory version. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The attributes of the sales territory object. |
addNewTerritoryToProposal
Adds a new sales territory to a proposal.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryService |
Sales Territory |
The attributes of the sales territory object. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The attributes of the sales territory object. |
updateTerritoryInProposal
Updates a territory that was added to a proposal.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryService |
Sales Territory |
The attributes of the sales territory object. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The attributes of the sales territory object. |
mergeTerritoryInProposal
Creates territory if it does not exist. Updates the territory if it exists.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryService |
Sales Territory |
Attributes of the sales territory object. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
Attributes of the sales territory object. |
findTerritories
Find territories for a given query criteria. The Territory object includes all attributes of territory, territory rule, rule boundaries, boundary values, and resources.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
findCriteria |
{http://xmlns.oracle.com/adf/svc/types/}FindCriteria |
The criteria values to retrieve the records. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The control value that indicates whether to retrieve translations or not. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The list of the sales territory objects. |
deleteTerritoryInheritedDimension
Deletes a territory inherited dimension record.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryInheritedDimension |
Sales Territory Inherited Dimension |
The attributes of the territory inherited dimension object. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
The deleteTerritoryInheritedDimension web service method returns void. |
deleteTerritoryResource
Deletes a sales territory resource record.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryResource |
Sales Territory Resource |
The attributes of the territory resource object. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
The deleteTerritoryResource web service method returns void. |
createTerritoryRuleBndryValue
Creates a specific member for a specific dimension specified for a territory.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryRuleBndryValue |
Sales Territory Rule Boundary Value |
The attributes of territory rule boundary value object. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The attributes of territory rule boundary value object. |
deleteTerritoryRuleBndryValue
Removes a specific member for a specific dimension specified for a territory.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryRuleBndryValue |
Sales Territory Rule Boundary Value |
The attributes of territory rule boundary value object. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
The deleteTerritoryRuleBndryValue web service method returns void. |
processTerritoryRuleBoundaryValue
Processes a list of territory rule boundary value objects via a CRUD command. This is used to perform bulk processing.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
changeOperation |
string |
The type of CRUD operation to be performed. |
|
territoryRuleBndryValue |
Sales Territory Rule Boundary Value |
The list of rule boundary value objects on which the CRUD operation needs to be performed. |
|
processControl |
{http://xmlns.oracle.com/adf/svc/types/}ProcessControl |
The control for the process. For example, do we continue if there is an error during the process or not. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The list of territory rule boundary value objects. |
deleteTerritoryRuleBoundary
Removes all members for a specific dimension specified for a territory. This implies that the territory covers "any" member for that dimension.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryRuleBoundary |
Sales Territory Rule Boundary |
The attributes of the territory rule boundary object. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
The deleteTerritoryRuleBoundary web service method returns void. |
deleteTerritoryLineOfBusiness
Deletes a territory line of business record.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryLineOfBusiness |
Sales Territory Line of Business |
The territory line of business attributes. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
The deleteTerritoryLineOfBusiness web service method returns void. |
deleteTerritoryRule
Deletes the specified territory rule record.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryRule |
Sales Territory Rule |
The attributes of the territory rule object. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
The deleteTerritoryRule web service method returns void. |
getDfltObjAttrHints
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 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 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
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 |
The 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. |
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 |
|---|---|---|---|
|
All Operations |
MOT_MANAGE_SALES_TERRITORY_PRIV |
Manage Sales Territory |
Allows managing of sales territories. A Territory is the jurisdiction of responsibility of a sales representative over a set of sales accounts. |
|
findTerritories |
MOT_VIEW_SALES_TERRITORY_PRIV |
View Sales Territory |
Allows viewing of sales territories. A Territory is the jurisdiction of responsibility of a sales representative over a set of sales accounts. |
|
getTerritory |
MOT_VIEW_SALES_TERRITORY_PRIV |
View Sales Territory |
Allows viewing of sales territories. A Territory is the jurisdiction of responsibility of a sales representative over a set of sales accounts. |
|
transformTerritoryUserKeysToIDs |
MOT_VIEW_SALES_TERRITORY_PRIV |
View Sales Territory |
Allows viewing of sales territories. A Territory is the jurisdiction of responsibility of a sales representative over a set of sales accounts. |
Privileges to Duty Roles Mapping
| Privilege Code | Granted to Duty Role Code | Granted to Duty Role Name | Granted To Duty Role Description |
|---|---|---|---|
|
MOT_VIEW_SALES_TERRITORY_PRIV |
ORA_MOT_TERRITORY_MANAGEMENT_ADMINISTRATION_DUTY |
Territory Management Administration |
Manages sales territories and territory proposals. Additional duties include territory management setup and quota management administration. |
|
MOT_VIEW_SALES_TERRITORY_PRIV |
ORA_MOT_TERRITORY_MANAGEMENT_DUTY |
Territory Management |
Manages sales territories, territory proposals, and quotas. |
|
MOT_VIEW_SALES_TERRITORY_PRIV |
ORA_MOT_TERRITORY_MANAGEMENT_SETUP_DUTY |
Territory Management Setup |
Manages sales territory setup, including lookups, profile options, flexfields, and dimension data. Runs dimension synchronization, and visibility jobs. Additional duties include quota management setup. |
|
MOT_MANAGE_SALES_TERRITORY_PRIV |
ORA_MOT_TERRITORY_MANAGEMENT_ADMINISTRATION_DUTY |
Territory Management Administration |
Manages sales territories and territory proposals. Additional duties include territory management setup and quota management administration. |
|
MOT_MANAGE_SALES_TERRITORY_PRIV |
ORA_MOT_TERRITORY_MANAGEMENT_DUTY |
Territory Management |
Manages sales territories, territory proposals, and quotas. |
|
MOT_MANAGE_SALES_TERRITORY_PRIV |
ORA_MOT_TERRITORY_MANAGEMENT_SETUP_DUTY |
Territory Management Setup |
Manages sales territory setup, including lookups, profile options, flexfields, and dimension data. Runs dimension synchronization, and visibility jobs. Additional duties include quota management setup. |
Duty Roles to Duty or Job Roles Mapping
| Duty Role Code | Granted to Duty or Job Role Code | Granted to Duty or Job Role Name | Granted To Duty or Job Role Description |
|---|---|---|---|
|
ORA_MOT_TERRITORY_MANAGEMENT_SETUP_DUTY |
ORA_MOT_QUOTA_EXPORT_MANAGEMENT_DUTY |
Quota Export Management |
Manages bulk export of all sales territory quota related objects. |
|
ORA_MOT_TERRITORY_MANAGEMENT_DUTY |
ORA_MOT_QUOTA_MANAGEMENT_DUTY |
Quota Management |
Manages sales territory quotas and territory quota formulas. Additional duties include incentive compensation goal management, user and roles management, and party information inquiry. |
|
ORA_MOT_TERRITORY_MANAGEMENT_ADMINISTRATION_DUTY |
ORA_MOT_QUOTA_MANAGEMENT_ADMINISTRATION_DUTY |
Quota Management Administration |
Manages sales territory quotas, quota setups, territory quota formulas, spread formulas, and seasonality groups, and can view quota plans. Additional duties include incentive compensation goal management, user and roles management, and party information inquiry. |
|
ORA_MOT_TERRITORY_MANAGEMENT_SETUP_DUTY |
ORA_MOT_QUOTA_MANAGEMENT_SETUP_DUTY |
Quota Management Setup |
Manages sales territory quota setup, quota plans, prediction and spread formula parameters, and seasonality groups. Runs sales territory quota synchronization and sales quota plan activation and completion processes. Additional duties include party information inquiry. |
|
ORA_MOT_TERRITORY_MANAGEMENT_ADMINISTRATION_DUTY |
ORA_MOT_TERRITORY_MANAGEMENT_EXPORT_IMPORT_DUTY |
Territory Management Export Import |
Manages sales territory export and import. Provides users with the ability to export territory data, modify it offline and import. |
|
ORA_MOT_TERRITORY_MANAGEMENT_DUTY |
ORA_MOT_TERRITORY_MANAGEMENT_EXPORT_IMPORT_DUTY |
Territory Management Export Import |
Manages sales territory export and import. Provides users with the ability to export territory data, modify it offline and import. |
|
ORA_MOT_TERRITORY_MANAGEMENT_SETUP_DUTY |
ORA_MOT_TERRITORY_MANAGEMENT_T2P_MIGRATION_DUTY |
Territory Management T2P Migration |
Manages sales territory export and import. Provides users with the ability to export territory data from a test environment and import into production. |