Get a rule for a territory
get
/crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}
Request
Path Parameters
-
TerrRuleId(required): integer(int64)
The unique identifier of the territory rule.
-
TerritoryVersionId(required): integer(int64)
The unique identifier of the territory version.
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : territories-TerritoryRule-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the territory rule. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the territory rule was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the territory rule was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the territory rule. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:255
The login of the user who last updated the territory rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RuleNumber: integer
(int64)
Title:
Coverage Number
The coverage number for the territory. -
RuleOperatorCode: string
Title:
Customer Coverage Code
Maximum Length:30
Default Value:INCLUSION
The code for identifying whether the coverage adds to or removes from the territory's jurisdiction. The accepted values are: EXCLUSION (for rule type EXCLUSION and PARTNER_EXCLUSION) and INCLUSION (for all other rule types, such as REGULAR, INCLUSION, PARTNER_REGULAR, PARTNER_INCLUSION, and INHERITANCE_OVERRIDE). -
RuleTypeCode: string
Title:
Coverage
Maximum Length:30
Default Value:REGULAR
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. -
TerritoryRuleBoundary1: array
Rule Boundaries
Title:
Rule Boundaries
The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage. -
TerritoryVersionId: integer
(int64)
Title:
Territory Number
The unique identifier of the territory version. -
TerrRuleId: integer
(int64)
Title:
Coverage ID
The unique identifier of the territory rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Rule Boundaries
Type:
array
Title:
Rule Boundaries
The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : territories-TerritoryRule-TerritoryRuleBoundary1-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the territory rule boundary. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the territory rule boundary was created. -
Dimension: string
Title:
Dimension
Read Only:true
Maximum Length:60
The name of the dimension. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the territory rule boundary was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the territory rule boundary. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the territory rule boundary. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TerrDimensionCode: string
Title:
Dimension
Maximum Length:5
The code indicating the territory dimension, such as Geo for Geography Dimension, Prod for Product Dimension, and so on. -
TerritoryRuleBndryValue1: array
Rule Boundary Values
Title:
Rule Boundary Values
The rule boundary values resource is used to view the rule boundary values associated with a sales territory. The equivalent functional term for rule boundary value is coverage dimension member. The rule boundary values object contains records for the dimension members for each coverage dimension. -
TerrRuleBoundaryId: integer
(int64)
Title:
Territory Dimension ID
The unique identifier of the territory rule boundary. -
TerrRuleId: integer
(int64)
Title:
Territory Number
The identifier of the territory rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Rule Boundary Values
Type:
array
Title:
Rule Boundary Values
The rule boundary values resource is used to view the rule boundary values associated with a sales territory. The equivalent functional term for rule boundary value is coverage dimension member. The rule boundary values object contains records for the dimension members for each coverage dimension.
Show Source
Nested Schema : territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-response
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Attribute 1
Maximum Length:150
Additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Attribute 2
Maximum Length:150
Additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Attribute 3
Maximum Length:150
Additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Attribute 4
Maximum Length:150
Additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Attribute 5
Maximum Length:150
Additional address element to support flexible address format. -
AddressCity: string
Title:
City
Maximum Length:60
City. -
AddressCountry: string
Title:
Country
Maximum Length:2
Country. -
AddressCounty: string
Title:
County
Maximum Length:60
County. -
AddressPostalCode: string
Title:
Postal Code
Maximum Length:60
Postal Code. -
AddressProvince: string
Title:
Province
Maximum Length:60
Province. -
AddressState: string
Title:
State
Maximum Length:60
State. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the territory rule boundary value. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the territory rule boundary value was created. -
DimensionMember: string
The name of the territory dimension member.
-
DimensionMemberHigh: string
Title:
Territory Dimension Member High
Read Only:true
Maximum Length:360
The name of the territory dimension member with a high sequence number. -
IncludeHierarchyFlag: boolean
Title:
Include Hierarchy
Maximum Length:1
Indicates whether the dimension member is included along with its hierarchy or not. The default value is true. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the territory rule boundary value was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the territory rule boundary value. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the territory rule boundary value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TerrDimensionCode: string
Title:
Dimension
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. -
TerrDimHighIntgId: string
Title:
Dimension Value Range
Maximum Length:80
The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube with a high sequence number. -
TerrDimIntgId: string
Title:
Dimension Value
Maximum Length:80
The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube. -
TerrRuleBndryValueId: integer
(int64)
Title:
Territory Dimension Member ID
The unique identifier of the territory rule boundary value. -
TerrRuleBoundaryId: integer
(int64)
Title:
Territory Number
The identifier of the territory rule boundary.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- TerritoryRuleBoundary1
-
Parameters:
- TerrRuleId:
$request.path.TerrRuleId
- TerritoryVersionId:
$request.path.TerritoryVersionId
The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage. - TerrRuleId:
Examples
The following example shows how to get a rule for a territory by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100025000830/child/TerritoryRule/300100025000833
Example of Response Body
The following shows an example of the response body in JSON format.
{ TerrRuleId: 300100025000833 TerritoryVersionId: 300100025000830 RuleOperatorCode: "INCLUSION" RuleTypeCode: "REGULAR" ... }