Route Allocations
Subcategories: Attachments, Notes
The route Allocation resource is used to view, create, and update route assignments. A route Allocation is the default sales representative assigned to a route. A route can have more than one default sales representatives assigned, but only one of them is the primary. A sales representative can only be assigned to one route.
|
Resource Plural Label |
Route Allocations |
|
Resource Name |
__ORACO__RouteAllocation_c |
Get All Route Allocations
Request: GET
URI: crmRestApi/resources/11.13.18.05/__ORACO__RouteAllocation_c
Request Path Parameters
There are no request path parameters for this task.
Request Query Parameters
Use the listed finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
PrimaryKey |
Finds a Route Assignment with the specified primary key. Finder Variables:
|
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Create a Route Allocation
Request: POST
URI: crmRestApi/resources/11.13.18.05/__ORACO__RouteAllocation_c
Request Path Parameters
There are no request path parameters for this task.
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Get a Route Allocation
Request: GET
URI: crmRestApi/resources/11.13.18.05/__ORACO__RouteAllocation_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
Integer |
The unique identifier of the Route Assignment. |
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Update a Route Allocation
Request: PATCH
URI: crmRestApi/resources/11.13.18.05/__ORACO__RouteAllocation_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
Integer |
The unique identifier of the Route Assignment. |
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Replace a Route Allocation
Request: PUT
URI: crmRestApi/resources/11.13.18.05/__ORACO__RouteAllocation_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
Integer |
The unique identifier of the Route Assignment. |
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Delete a Route Allocation
Request: DELETE
URI: crmRestApi/resources/11.13.18.05/__ORACO__RouteAllocation_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
Integer |
The unique identifier of the Route Assignment. |
Request Body
There are no elements in the request body for this task.
Response Body
There are no elements in the response body for this task.
List of Values
This table lists all the list of values of the resource.
| LOV Name | Source Attribute in LOV | Target Attribute in Resource |
|---|---|---|
|
ViewAccessor_CurrencyCode |
CurrencyCode |
CurrencyCode |
|
LOVVA_For___ORACO__Primary_c |
value |
__ORACO__Primary_c |
|
FK_LOVVA_For___ORACO__Resource_c |
ResourceProfileId |
__ORACO__Resource_Id_c |
|
LOVVA_For___ORACO__Resource_c |
PartyName |
__ORACO__Resource_c |
|
LOVVA_For___ORACO__Resource_c |
ResourceProfileId |
__ORACO__Resource_Id_c |
|
FK_LOVVA_For___ORACO__Route_c |
Id |
__ORACO__Route_Id_c |
|
LOVVA_For___ORACO__Route_c |
RecordName |
__ORACO__Route_c |
|
LOVVA_For___ORACO__Route_c |
Id |
__ORACO__Route_Id_c |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the route assignment. UI Label: Record ID |
|
RowType |
string |
The type field for the categorization of the records. The default value is __ORACO__ProductAssortment_c. Properties: The maximum length is 80. |
|
RecordName |
string |
The name of the route assignment. Properties: The maximum length is 80. UI Label: Route Allocation Number |
|
CreatedBy |
string |
The user who created the Route Assignment. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
The date when the Route Assignment was created. UI Label: Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the Route Assignment. Properties: The maximum length is 32. UI Label: Last Updated By |
|
LastUpdateDate |
datetime |
The date when the Route Assignment was last updated. UI Label: Last Update Date |
|
LastUpdateLogin |
string |
The login of the user who last updated the Route Assignment. Properties: The maximum length is 32. |
|
UserLastUpdateDate |
datetime |
The date and time of the last user update made from a personal device. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database (That is, a different mobile database or the server). |
|
CurrencyCode |
string |
The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. UI Label: Currency Code |
|
CurcyConvRateType |
string |
The currency conversion rate type. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. |
|
CorpCurrencyCode |
string |
The corporate currency code associated with the assortment. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. Properties: The maximum length is 15. |
|
SourceType |
string |
The type of the source object as defined in the object metadata. |
|
__ORACO__Primary_c |
boolean |
Indicates if the resource is the primary assignee of the Route. Properties: The maximum length is 10. UI Label: Primary |
|
__ORACO__Resource_Id_c |
integer |
The Internal unique identifier of the resource assigned to the Route. UI Label: Resource |
|
__ORACO__Resource_c |
string |
The name of the resource assigned to the Route. Properties: The maximum length is 1500. UI Label: Resource |
|
__ORACO__ResourceDCId_c |
integer |
The unique identifier of the Distribution Centre associated with the resource. UI Label: ResourceDCId |
|
__ORACO__RouteDCId_c |
integer |
The unique identifier of the Distribution Centre associated with the Route. UI Label: RouteDCId |
|
__ORACO__Route_Id_c |
integer |
The internal unique identifier of the Route to which the resource is assigned. UI Label: Route |
|
__ORACO__Route_c |
string |
The name of the Route to which the resource is assigned. Properties: The maximum length is 1500. UI Label: Route |
|
__ORACO__AuxiliaryAttribute01_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 01 |
|
__ORACO__AuxiliaryAttribute02_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 02 |
|
__ORACO__AuxiliaryAttribute03_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 03 |
|
__ORACO__AuxiliaryAttribute04_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 04 |
|
__ORACO__AuxiliaryAttribute05_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 05 |
|
__ORACO__AuxiliaryAttribute06_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 06 |
|
__ORACO__AuxiliaryAttribute07_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 07 |
|
__ORACO__AuxiliaryAttribute08_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 08 |
|
__ORACO__AuxiliaryAttribute09_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 09 |
|
__ORACO__AuxiliaryAttribute10_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 10 |
|
__ORACO__AuxiliaryAttribute11_c |
date |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 11 |
|
__ORACO__AuxiliaryAttribute12_c |
date |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 12 |
|
__ORACO__AuxiliaryAttribute13_c |
datetime |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 13 |
|
__ORACO__AuxiliaryAttribute14_c |
datetime |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 14 |