Sales Territory Proposal Service
Service to operate on territory proposal business objects. It can be used by third-party applications to perform standard and custom operations on the territory proposal business objects.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/oracle/apps/sales/territoryMgmt/territories/territoryService/}TerritoryProposalPublicService
Service WSDL URL: https://servername/crmService/TerritoryProposalPublicService?WSDL
Logical Business Objects
-
CRM : Territory Management : Sales Territory Proposal
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 |
|
|
Handles |
Operations
reopenProposal
Reopens a territory proposal and changes the proposal status to 'DRAFT'.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
terrProposalId |
long |
The identifier of the proposal that needs to be reopened. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
The reopenProposal web service method returns void. |
requestProposalActivation
Puts the proposal activation in the activation queue by date and changes the proposal status to 'PENDING ACTIVATION'.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
terrProposalId |
long |
The identifier of the proposal that needs to be activated. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
The requestProposalActivation web service method returns void. |
getProposal
Retrieves territory proposal by the specified territory proposal ID (only Proposal attributes are returned).
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
terrProposalId |
long |
Identifier of the proposal to be retrieved. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The proposal object retrieved by the getProposal method. |
createProposal
Creates a new territory proposal record.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryProposalService |
Sales Territory Proposal |
The attributes of the territory proposal. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
Returns the new territory proposal record. |
updateProposal
Updates an existing territory proposal record.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryProposalService |
Sales Territory Proposal |
The attributes of the territory proposal. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
Returns the updated territory proposal record. |
deleteProposal
Deletes a territory proposal record. It also deletes territories added to or created in the proposal being deleted. This is a private method and is for internal use only.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
territoryProposalService |
Sales Territory Proposal |
The attributes of the territory proposal. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
The deleteProposal web service method returns void. |
findProposals
Retrieves only proposals for a given query criteria.
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 proposal objects for a given query criteria. |
getDfltObjAttrHints
Retrieves the user interface hints, such as the service data object label and the 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 |
A 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. |
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_PROPOSAL_PRIV |
Manage Sales Territory Proposal |
Allows managing of sales territory proposals, for example proposal name, description, and activation date. |
|
findProposals |
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. |
|
getProposal |
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_PROPOSAL_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_PROPOSAL_PRIV |
ORA_MOT_TERRITORY_MANAGEMENT_DUTY |
Territory Management |
Manages sales territories, territory proposals, and quotas. |
|
MOT_MANAGE_SALES_TERRITORY_PROPOSAL_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_PROPOSAL_PRIV |
ORA_MOT_TERRITORY_MANAGEMENT_ENTERPRISE_ADMINISTRATION_DUTY |
Territory Management Enterprise Administration |
Manages sales territories and territory proposals. Additional duties include territory management setup and quota management administration. |
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_ENTERPRISE_ADMINISTRATION_DUTY |
ORA_MOT_QUOTA_MANAGEMENT_ENTERPRISE_ADMINISTRATION_DUTY |
Quota Management Enterprise Administration |
Manages sales territory quotas and territory quota formulas. Additional duties include incentive compensation goal management, user and roles management, and quota management setup. |
|
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_ENTERPRISE_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_ENTERPRISE_ADMINISTRATION_DUTY |
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. |
|
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. |