1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Territories for Sales

Get a territory

get

/crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : salesTerritories-item-response
Type: object
Show Source
Nested Schema : Territory Coverages
Type: array
Title: Territory Coverages
The territory coverages resource is used to view, create, update, and delete the territory dimensions associated with a territory. The coverage identifies the scope of responsibility of the territory team in the market space. The coverage object contains a record for each of the coverage for historical, active, and draft territory versions. A territory version may or may not have a coverage associated with it.
Show Source
Nested Schema : Territory Business
Type: array
Title: Territory Business
The territory line of business resource is used to view, create, update, and delete the lines of business associated with a territory.
Show Source
Nested Schema : Territory Resources
Type: array
Title: Territory Resources
The territory resources or team object is used to view, create, update, and delete the resources allocated to a territory. For example, the sales representative that owns the territory.
Show Source
Nested Schema : salesTerritories-TerritoryCoverage-item-response
Type: object
Show Source
  • Title: Account ID
    The identifier for the customer inclusion or exclusion.
  • Title: Customer Account
    Read Only: true
    Maximum Length: 360
    The name of the customer inclusion.
  • Title: Account Type Code
    Maximum Length: 30
    The code for the account type in the territory coverage.
  • Title: City
    Maximum Length: 60
    The city of the address dimension in the territory coverage.
  • Title: Country
    Maximum Length: 2
    The country of the address dimension in the territory coverage.
  • Title: County
    Maximum Length: 60
    The county of the address dimension in the territory coverage.
  • Title: Additional Attribute 1
    Maximum Length: 150
    The additional attribute 1 of the address dimension in the territory coverage.
  • Title: Additional Attribute 2
    Maximum Length: 150
    The additional attribute 2 of the address dimension in the territory coverage.
  • Title: Additional Attribute 3
    Maximum Length: 150
    The additional attribute 3 of the address dimension in the territory coverage.
  • Title: Additional Attribute 4
    Maximum Length: 150
    The additional attribute 4 of the address dimension in the territory coverage.
  • Title: Additional Attribute 5
    Maximum Length: 150
    The additional attribute 5 of the address dimension in the territory coverage.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the address dimension in the territory coverage.
  • Title: Province
    Maximum Length: 60
    The province of the address dimension in the territory coverage.
  • Title: State
    Maximum Length: 60
    The state of the address dimension in the territory coverage.
  • Title: Auxiliary 1 Code
    Maximum Length: 30
    The auxiliary 1 code in the territory coverage.
  • Title: Auxiliary 2 Code
    Maximum Length: 30
    The auxiliary 2 code in the territory coverage.
  • Title: Auxiliary 3 Code
    Maximum Length: 30
    The auxiliary 3 code in the territory coverage.
  • Title: Auxiliary 1
    Read Only: true
    The auxiliary 1 name in the territory coverage.
  • Title: Auxiliary 2
    Read Only: true
    The auxiliary 2 name in the territory coverage.
  • Title: Auxiliary 3
    Read Only: true
    The auxiliary 3 name in the territory coverage.
  • Title: Business Unit ID
    The identifier for the business unit in the territory coverage.
  • Title: Business Unit
    Maximum Length: 255
    The name for the business unit in the territory coverage.
  • Title: Coverage ID
    The unique identifier of the territory coverage rule.
  • Title: Coverage Number
    Maximum Length: 30
    The public unique identifier of the territory coverage rule.
  • Title: Coverage Type Code
    Maximum Length: 30
    The code for the territory coverage type. If the territory coverage model is sales account centric, the accepted values are: -REGULAR (for coverage based on sales account dimensionality or named accounts) -INCLUSION (for manually included account coverage) -EXCLUSION (for manually excluded account coverage) If the territory coverage model is partner centric, the accepted values are: -PARTNER_REGULAR (for coverage based on partner dimensionality) -PARTNER_INCLUSION (for manually included partner coverage) -PARTNER_EXCLUSION (for manually excluded partner coverage) In case of inheritance, if the coverage is for a recipient territory, then the accepted value is INHERITANCE_OVERRIDE which indicates that the coverage overrides some of the inherited dimensionality.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the territory coverage.
  • Title: Creation Date
    Read Only: true
    The date when the territory coverage was created.
  • Title: Customer Size Code
    Maximum Length: 30
    The code for the customer size in the territory coverage.
  • Title: Dimension Name
    Read Only: true
    Maximum Length: 60
    The name of a dimension used in sales territories to define the area of responsibility for the salesperson. Examples are the Product and Industry dimensions.
  • Title: Extension 1
    Read Only: true
    Maximum Length: 255
    The extension 1 name in the territory coverage.
  • Title: Extension 10
    Read Only: true
    Maximum Length: 255
    The extension 10 name in the territory coverage.
  • Title: Extension 10 Code
    Maximum Length: 30
    The extension 10 code in the territory coverage.
  • Title: Extension 1 Code
    Maximum Length: 30
    The extension 1 code in the territory coverage.
  • Title: Extension 2
    Read Only: true
    Maximum Length: 255
    The extension 2 name in the territory coverage.
  • Title: Extension 2 Code
    Maximum Length: 30
    The extension 2 code in the territory coverage.
  • Title: Extension 3
    Read Only: true
    Maximum Length: 255
    The extension 3 name in the territory coverage.
  • Title: Extension 3 Code
    Maximum Length: 30
    The extension 3 code in the territory coverage.
  • Title: Extension 4
    Read Only: true
    Maximum Length: 255
    The extension 4 name in the territory coverage.
  • Title: Extension 4 Code
    Maximum Length: 30
    The extension 4 code in the territory coverage.
  • Title: Extension 5
    Read Only: true
    Maximum Length: 255
    The extension 5 name in the territory coverage.
  • Title: Extension 5 Code
    Maximum Length: 30
    The extension 5 code in the territory coverage.
  • Title: Extension 6
    Read Only: true
    Maximum Length: 255
    The extension 6 name in the territory coverage.
  • Title: Extension 6 Code
    Maximum Length: 30
    The extension 6 code in the territory coverage.
  • Title: Extension 7
    Read Only: true
    Maximum Length: 255
    The extension 7 name in the territory coverage.
  • Title: Extension 7 Code
    Maximum Length: 30
    The extension 7 code in the territory coverage.
  • Title: Extension 8
    Read Only: true
    Maximum Length: 255
    The extension 8 name in the territory coverage.
  • Title: Extension 8 Code
    Maximum Length: 30
    The extension 8 code in the territory coverage.
  • Title: Extension 9
    Read Only: true
    Maximum Length: 255
    The extension 9 name in the territory coverage.
  • Title: Extension 9 Code
    Maximum Length: 30
    The extension 9 code in the territory coverage.
  • Title: Geography High ID
    The identifier for the higher geography in the range in the territory coverage.
  • Title: Geography High Name
    The name for the higher geography in the range in the territory coverage.
  • Title: Geography ID
    The identifier for the geography in the territory coverage.
  • Title: Geography
    The name of the geography in the territory coverage. This may include the full path of the geography in order to uniquely identify the location, for example; >United States>New Hampshire>Manchester.
  • Title: Include Hierarchy
    Maximum Length: 1
    Indicates whether the dimension member is included along with its hierarchy or not. The default value is true.
  • Title: Industry Code
    Maximum Length: 30
    The code for the industry in the territory coverage.
  • Title: Industry
    Read Only: true
    The name of the industry in the territory coverage.
  • Title: Inventory Item ID
    The identifier for the inventory item in the territory coverage.
  • Title: Inventory Organization ID
    The identifier for the inventory organization in the territory coverage.
  • Title: Item Name
    Read Only: true
    Maximum Length: 240
    The name for the item in the territory coverage.
  • Title: Item Number
    Read Only: true
    Maximum Length: 300
    The number for the item in the territory coverage.
  • Title: Last Updated Date
    Read Only: true
    The date the territory coverage was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the territory coverage.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the territory coverage.
  • Links
  • Title: Organization Type
    Read Only: true
    The name of the organization type in the territory coverage.
  • Title: Organization Type Code
    Maximum Length: 30
    The code for the organization type in the territory coverage.
  • Title: Original Reference
    Maximum Length: 300
    The origin source system reference of the account or contact.
  • Title: Partner ID
    The identifier of the partner inclusion or exclusion.
  • Title: Partner
    Read Only: true
    Maximum Length: 360
    The name of the partner inclusion.
  • Title: Partner Number
    Maximum Length: 30
    The public unique identifier of the partner inclusion or exclusion.
  • Title: Product Group ID
    The identifier for the product group in the territory coverage.
  • Title: Product Group Name
    Read Only: true
    Maximum Length: 250
    The name for the product group in the territory coverage.
  • Title: Product Group Number
    Maximum Length: 50
    The number for the product group in the territory coverage.
  • Title: Registry ID
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the customer inclusion.
  • Title: Sales Channel Code
    Maximum Length: 30
    The code for the sales channel in the territory coverage.
  • Title: Subsales Channel Code
    Maximum Length: 30
    The code for the sub sales channel in the territory coverage.
  • Title: Territory Dimension Code
    Maximum Length: 5
    The code indicating the territory dimension. For example, AcTyp, Acct, Aux1, Aux2, Aux3, BUnit, CSize, Geo, Indst, OrgTp, Prod, Prtnr, or SChnl.
  • Title: Territory Version ID
    The unique identifier of territory version.
  • Title: Unique Territory Number
    Maximum Length: 30
    The public unique identifier of the territory.
Nested Schema : salesTerritories-TerritoryLineOfBusiness-item-response
Type: object
Show Source
Nested Schema : salesTerritories-TerritoryResource-item-response
Type: object
Show Source
  • Title: Team Member Administrator
    Maximum Length: 1
    Indicates whether the resource is an administrator of the territory.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the territory team member.
  • Title: Creation Date
    Read Only: true
    The date the territory team member was created.
  • Title: Email
    Read Only: true
    Maximum Length: 320
    The email address of the resource.
  • Title: Team Member Function
    Maximum Length: 30
    The code for the function of the resource associated with the territory.
  • Title: Last Updated Date
    Read Only: true
    The date the territory team member was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the territory team member.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the territory team member.
  • Links
  • Title: Forecasting Delegate
    Maximum Length: 1
    Indicates whether a territory resource has been given the responsibility to manage the territory forecast on behalf of the owner of the territory.
  • Read Only: true
    Maximum Length: 360
    The name of the manager.
  • Title: Organization
    Read Only: true
    Maximum Length: 240
    The name of the organization of the resource.
  • Title: Owner
    Read Only: true
    Indicates whether the team member is the owner.
  • Title: Resource ID
    The unique identifier of the resource from the resource manager.
  • Title: Resource Name
    Read Only: true
    Maximum Length: 360
    The name of the resource associated with the territory.
  • Title: Resource Registry ID
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the territory resource from the resource manager.
  • Title: Team Member Role
    Read Only: true
    Maximum Length: 60
    The name of the team member role associated with the resource.
  • Title: Territory Version ID
    The unique identifier of the territory version.
  • Title: Territory Resource ID
    The unique identifier of the territory team member.
  • Title: Unique Territory Number
    Maximum Length: 30
    The public unique identifier of the territory.
Links
EnabledTypeCodesViewAccessor
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOT_TERRITORY_TYPE%2CBindLookupCode%3D{TypeCode}
The list of values for the territory type, such as PRIME or OVERLAY.

The following properties are defined on the LOV link relation:
  • Source Attribute: TypeCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
ExtendedResourcePickerViewAccessor
The list of values for the territory owner resource. The territory owner is the person responsible for sales in the territory.

The following properties are defined on the LOV link relation:
  • Source Attribute: Owner; Target Attribute: ResourceName
  • Display Attribute: ResourceName, PrimaryPhoneNumber, EmailAddress, OrganizationName, RoleName, ReportsTo
LookupYesNoViewAccessor
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DYES_NO
The list of values to indicate if the forecast for the territory is made at the parent territory level. The valid values are Yes and No.

The following properties are defined on the LOV link relation:
  • Source Attribute: ForecastedByParentTerritoryFlag; Target Attribute: LookupCode
  • Display Attribute: Meaning
PartnerPickerPVOViewAccessor
The list of values for the name of the territory partner. The territory partner identifies the partner organization associated with the territory when the territory type is Partner.

The following properties are defined on the LOV link relation:
  • Source Attribute: PartnerName; Target Attribute: PartyName
  • Display Attribute: PartyName
TerritoryCoverage
Parameters:
  • UniqueTerritoryNumber: $request.path.UniqueTerritoryNumber
The territory coverages resource is used to view, create, update, and delete the territory dimensions associated with a territory. The coverage identifies the scope of responsibility of the territory team in the market space. The coverage object contains a record for each of the coverage for historical, active, and draft territory versions. A territory version may or may not have a coverage associated with it.
TerritoryFunctionViewAccessor
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOT_TERRITORY_FUNCTION%2CBindLookupCode%3D{TerritoryFunctionCode}
The list of values for the function of the territory, such as Primary or Sales Support.

The following properties are defined on the LOV link relation:
  • Source Attribute: TerritoryFunctionCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
TerritoryLineOfBusiness
Parameters:
  • UniqueTerritoryNumber: $request.path.UniqueTerritoryNumber
The territory line of business resource is used to view, create, update, and delete the lines of business associated with a territory.
TerritoryResource
Parameters:
  • UniqueTerritoryNumber: $request.path.UniqueTerritoryNumber
The territory resources or team object is used to view, create, update, and delete the resources allocated to a territory. For example, the sales representative that owns the territory.
ValidForecastParticipationCodeViewAccessor
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DORA_MOT_TERR_ENABLE_FCASTING
The list of values for the forecast participation, such as Revenue or Nonrevenue. The territory forecast participation indicates whether the territory is being forecasted, and if yes, whether it participates in revenue forecasting, non-revenue forecasting, or both.

The following properties are defined on the LOV link relation:
  • Source Attribute: ForecastParticipationCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
ValidRevisionReasonViewAccessor
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DMOT_QUOTA_REASON
The list of values for the user-defined reason for revising the quota, such as Resource added, Dimension changed, and so on. The territory revision reason explains to the quota administrator the reason for revising the quota for the territory.

The following properties are defined on the LOV link relation:
  • Source Attribute: RevisionReason; Target Attribute: LookupCode
  • Display Attribute: Meaning
ValidStatusCodeViewAccessor
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DMOT_TERRITORY_VERSION_STATUS
The list of values for the territory version status, such as DRAFT or FINALIZED.

The following properties are defined on the LOV link relation:
  • Source Attribute: StatusCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
ValidateCoverageModel
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DMOT_TERR_COVERAGE_MODEL
The list of values to indicate if the dimension of the territory is based on account attributes or partner attributes, such as Customer Centric or Partner Centric.

The following properties are defined on the LOV link relation:
  • Source Attribute: CoverageModel; Target Attribute: LookupCode
  • Display Attribute: Meaning
Back to Top

Examples

The following example shows how to get a territory for sales by submitting a get request on the REST resource using cURL.

cURL Command

curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesTerritories/CDRM_461

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "CreatedBy": "SALES_ADMINISTRATOR",
            "CreationDate": "2009-09-18T12:17:28.981+00:00",
            "Description": null,
            "EffectiveEndDate": "2010-01-18",
            "EffectiveStartDate": "2009-09-18",
            "LastUpdateDate": "2010-10-26T10:33:42.135+00:00",
            "LastUpdateLogin": "9388825E902FEE67E04044987CF065D5",
            "LastUpdatedBy": "SALES_ADMIN",
            "Name": "AMQA Germany Account 2",
            "TerritoryVersionId": 100000054003703,
            "OwnerResourceId": 100010025531586,
            "ParentTerritoryId": 100000013121095,
            "StatusCode": "FINALIZED",
            "TerrProposalId": 100000014936001,
            "TerritoryId": 100000013121165,
            "TerritoryLevel": 6,
            "TypeCode": "PRIME",
            "Owner": "Bob   Bennett",
            "LatestVersionFlag": true,
            "PartnerId": null,
            "PartnerProgramId": null,
            "ForecastParticipationCode": "REVENUE",
            "SourceTerrId": null,
            "RevisionReason": null,
            "RevisionDescription": null,
            "ReviseQuotaFlag": null,
            "EligibleForQuotaFlag": true,
            "SourceTerrVersionId": null,
            "PartnerName": null,
            "ProgramName": null,
            "OrganizationName": null,
            "SourceTerrName": "None",
            "SourceTerrLastUpdateDate": null,
            "CoverageModel": "SALES_ACCOUNT_CENTRIC",
            "ForecastedByParentTerritoryFlag": false,
            "OwnerEmail": "sendmail-test-discard@oracle.com",
            "TerritoryNumber": "CDRM_461",
            "ParentTerritoryLovSwitcher": "LOV_ParentTerritoryId",
            "UpdateFlag": true,
            "DeleteFlag": true,
            "ParentTerritoryNumber": "CDRM_462",
            "OwnerTrans": "Bob   Bennett",
            "TerritoryFunctionCode": null,
            "ParentTerritoryTrans": "AMQA Germany License and Consulting",
            "UniqueTerritoryNumber": "CDRM_461",
            "OwnerResourceNumber": "100010025531586",
            "ProposalNumber": "CDRM_190",
            "PartnerNumber": null,
            "ParentUniqueTerritoryNumber": "CDRM_X_100000054003656",
            "SourceUniqueTerritoryNumber": null,
            "TerritoryHierarchyUniqueTerritoryNumber": null,
            "R10_SalesTerritory_Text_c": null,
            "R10_SalesTerritory_Number_c": null,
            "R10_SalesTerritory_Date_c": null,
            "R10_SalesTerritory_CheckBox_c": null,
            "R10_SalesTerritory_Perc_c": null,
            "R10_SalesTerritory_DateTime_c": null,
            "R10_SalesTerritory_Currency_c": null,
            "R10_SalesTerritory_FixChList_c": null,
            "R10_SalesTerritory_DynChList_Id_c": null,
            "R10_SalesTerritory_DynChList_c": null,
            "R10_SalesTerritory_RecType_c": null,
            "Email_c": null,
            "TMTXT_c": null,
            "TM_Num_c": null,
            "Cust_Owner_c": null,
            "Cust_Assignee_c": null,
            "TestTextForService_c": null,
            "R11_Sales_Territory_Text_Field_c": null,
            "R11_Sales_Terriotry_Number_Fld_c": null,
            "R11_Sales_Territory_Date_c": null,
            "R11_Sales_Territory_Checkbox_c": null,
            "R11_TM_PGCOM_NUM_c": null,
            "R11_TM_Cust_Text_c": null,
            "R11_Cust_Owner1_c": null,
            "R11_Cust__c": null,
            "R11_Cust_email_to_c": null,
            "R10_SalesTerritory_RecType_cMeaning": null,
            "R12R13Upg_Text_c": null,
            "R12R13Upg_Num_c": null,
            "R12R13Upg_Date_c": null,
            "Text_CloneLayout_c": null,
            "ST_Text1_c": null,
            "ST_Text2_c": null,
            "ST_Text3_c": null,
            "links": [

...
}

Note:

You can use any number of coverages for a territory. However, it is recommended that you limit the number of records per query to tens of thousands. For example, a query to get 50000 records can be curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories?limit=50000. Additionally, you can configure an appropriate gateway timeout in your client application when querying tens of thousands of territory coverage records.
Back to Top