Program Territories
The Program Territory object is a many-to-many intersection entity object between Sales Territory and Account. Use the program territory resource to view, create, modify, and delete program territories.
|
Resource Plural Label |
Program Territories |
|
Resource Name |
__ORACO__ProgramTerritory_c |
Get All Program Territories
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ProgramTerritory_c
Request Path Parameters
There are no required path parameters for this task.
Request Query Parameters
Use the following finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
PrimaryKey |
The unique identifier of the Program Territory. You can get the Program Territory ID by examining the response payload of a Get All Program Territories request. Finder Variables:
|
Request Body
There are no elements in the request body for this task.
Response Body
The following table summarizes the supported response body content types:
|
Media Type |
application/json |
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Example
This example gets all program territories.
Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORACO__ProgramTerritory_c
Get a Program Territory
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ProgramTerritory_c/{Id}
Request Path Parameters
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Program Territory. You can get the Program Territory Id by examining the response payload of a Get All Program Territories request. |
Request Body
There are no elements in the request body for this task.
Response Body
The following table summarizes the supported response body content types:
|
Media Type |
application/json |
|
Media Type |
application/vnd.oracle.adf.resourceitem+json |
Example
This example gets a program territory with the ID 300000000875131.
Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORACO__ProgramTerritory_c/300000000875131
Create a Program Territory
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ProgramTerritory_c
Request Path Parameters
There are no required path parameters for this task.
Request Body
The following table summarizes the supported request body content type:
|
Media Type |
application/vnd.oracle.adf.resourceitem+json |
Response Body
The following table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourceitem+json |
Update a Program Territory
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ProgramTerritory_c/{Id}
Request Path Parameters
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Program Territory. You can get the Program Territory Id by examining the response payload of a Get All Program Territories request. |
Request Body
The following table summarizes the supported request body content type:
|
Media Type |
application/vnd.oracle.adf.resourceitem+json |
Response Body
The following table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourceitem+json |
Delete a Program Territory
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ProgramTerritory_c/{Id}
Request Path Parameters
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Program Territory. You can get the Program Territory Id by examining the response payload of a Get All Program Territories request. |
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.
Example
This example deletes an existing program territory with the Id 300000000875131.
Example Command: curl --user sales_cloud_user -X DELETE https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORACO__ProgramTerritory_c/300000000875131
List of Values
This resource defines the following list of values (LOV):
| LOV Name | Source Attribute in LOV | Target Attribute in Resource |
|---|---|---|
|
ViewAccessor_CurrencyCode |
CurrencyCode |
Currency |
Resource Attributes
This resource has the following attributes:
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
integer |
A system-generated read-only attribute used by the application framework. UI Label Record ID |
|
RowType |
string |
A system-generated read-only attribute used by the application framework. Properties The maximum length is 80. |
|
RecordName |
string |
A system-generated read-only attribute used by the application framework. Properties The maximum length is 80. UI Label Audit History Name |
|
CreatedBy |
string |
The user who created the program territory. Properties The maximum length is 32. UI Label Created By |
|
CreationDate |
string |
The date when the record was created. UI Label Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the record. Properties The maximum length is 32. UI Label Last Updated By |
|
LastUpdateDate |
string |
The date when the record was last updated. UI Label Last Update Date |
|
LastUpdateLogin |
string |
The login of the user who last updated the record. Properties The maximum length is 32. |
|
CpdrfVerSor |
integer |
A system-generated read-only attribute used by the application framework. |
|
UserLastUpdateDate |
string |
Not for external use. This attribute is used by the Extensibility framework.Disconnected Mobile: The date and time when the record was last updated from mobile. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database (That is, a different mobile database or the server). |
|
CpdrfLastUpd |
string |
A system-generated read-only attribute used by the application framework. Properties The maximum length is 15. |
|
CpdrfVerPillar |
integer |
A system-generated read-only attribute used by the application framework. |
|
JobDefinitionPackage |
string |
Not for external use. This attribute is used by the Extensibility framework. Enterprise Service Scheduler: The name of the package running the job that created or last updated the row. Properties The maximum length is 900. |
|
RequestId |
integer |
Not for external use. This attribute is used by the Extensibility framework. Enterprise Service Scheduler: The request identifier of the job that created or last updated the row. |
|
JobDefinitionName |
string |
Not for external use. This attribute is used by the Extensibility framework. Enterprise Service Scheduler: The short name of the job that created or last updated the row. Properties The maximum length is 100. |
|
CurrencyCode |
string |
The currency code associated with the program territory. Properties The maximum length is 15. UI Label Currency |
|
CurcyConvRateType |
string |
The currency conversion rate type associated with the program territory. Properties The maximum length is 15. |
|
CorpCurrencyCode |
string |
The corporate currency code associated with the program territory. Properties The maximum length is 15. |
|
IsOwner |
string |
A system-generated read-only attribute used by the application framework. |
|
PromotionProgram_Id___ORACO__Src___ORACO_ _PromotionProgram_cTo__ORACO__ProgramTerritory_c |
Integer |
Foreign Key |
|
SalesTerritory_Id___ORACO__Tgt_SalesTerritoryTo_ _ORACO__ProgramTerritory_c |
integer |
Foreign Key |