Create a rule boundary for a territory
post
/crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1
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.
Header Parameters
-
Metadata-Context: string
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: string
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.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
TerrDimensionCode(required): string
Title:
DimensionMaximum Length:5The 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 ValuesThe 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 IDThe unique identifier of the territory rule boundary. -
TerrRuleId(required): integer
(int64)
Title:
Territory NumberThe identifier of the territory rule.
Nested Schema : Rule Boundary Values
Type:
arrayTitle:
Rule Boundary ValuesThe 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 : schema
Type:
Show Source
object-
AddrElementAttribute1: string
Title:
Additional Attribute 1Maximum Length:150Additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Attribute 2Maximum Length:150Additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Attribute 3Maximum Length:150Additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Attribute 4Maximum Length:150Additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Attribute 5Maximum Length:150Additional address element to support flexible address format. -
AddressCity: string
Title:
CityMaximum Length:60City. -
AddressCountry: string
Title:
CountryMaximum Length:2Country. -
AddressCounty: string
Title:
CountyMaximum Length:60County. -
AddressPostalCode: string
Title:
Postal CodeMaximum Length:60Postal Code. -
AddressProvince: string
Title:
ProvinceMaximum Length:60Province. -
AddressState: string
Title:
StateMaximum Length:60State. -
DimensionMember: string
The name of the territory dimension member.
-
IncludeHierarchyFlag: boolean
Title:
Include HierarchyMaximum Length:1Indicates whether the dimension member is included along with its hierarchy or not. The default value is true. -
TerrDimensionCode: string
Title:
DimensionMaximum Length:5The 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 RangeMaximum Length:80The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube with a high sequence number. -
TerrDimIntgId: string
Title:
Dimension ValueMaximum Length:80The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube. -
TerrRuleBndryValueId: integer
(int64)
Title:
Territory Dimension Member IDThe unique identifier of the territory rule boundary value. -
TerrRuleBoundaryId: integer
(int64)
Title:
Territory NumberThe identifier of the territory rule boundary.
Response
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-TerritoryRuleBoundary1-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the territory rule boundary. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date the territory rule boundary was created. -
Dimension: string
Title:
DimensionRead Only:trueMaximum Length:60The name of the dimension. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date the territory rule boundary was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the territory rule boundary. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the territory rule boundary. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TerrDimensionCode: string
Title:
DimensionMaximum Length:5The 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 ValuesThe 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 IDThe unique identifier of the territory rule boundary. -
TerrRuleId: integer
(int64)
Title:
Territory NumberThe identifier of the territory rule.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Rule Boundary Values
Type:
arrayTitle:
Rule Boundary ValuesThe 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 : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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-TerritoryRuleBndryValue1-item-response
Type:
Show Source
object-
AddrElementAttribute1: string
Title:
Additional Attribute 1Maximum Length:150Additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Attribute 2Maximum Length:150Additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Attribute 3Maximum Length:150Additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Attribute 4Maximum Length:150Additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Attribute 5Maximum Length:150Additional address element to support flexible address format. -
AddressCity: string
Title:
CityMaximum Length:60City. -
AddressCountry: string
Title:
CountryMaximum Length:2Country. -
AddressCounty: string
Title:
CountyMaximum Length:60County. -
AddressPostalCode: string
Title:
Postal CodeMaximum Length:60Postal Code. -
AddressProvince: string
Title:
ProvinceMaximum Length:60Province. -
AddressState: string
Title:
StateMaximum Length:60State. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the territory rule boundary value. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date the territory rule boundary value was created. -
DimensionMember: string
The name of the territory dimension member.
-
DimensionMemberHigh: string
Title:
Territory Dimension Member HighRead Only:trueMaximum Length:360The name of the territory dimension member with a high sequence number. -
IncludeHierarchyFlag: boolean
Title:
Include HierarchyMaximum Length:1Indicates whether the dimension member is included along with its hierarchy or not. The default value is true. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date the territory rule boundary value was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the territory rule boundary value. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the territory rule boundary value. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TerrDimensionCode: string
Title:
DimensionMaximum Length:5The 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 RangeMaximum Length:80The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube with a high sequence number. -
TerrDimIntgId: string
Title:
Dimension ValueMaximum Length:80The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube. -
TerrRuleBndryValueId: integer
(int64)
Title:
Territory Dimension Member IDThe unique identifier of the territory rule boundary value. -
TerrRuleBoundaryId: integer
(int64)
Title:
Territory NumberThe identifier of the territory rule boundary.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- TerritoryRuleBndryValue1
-
Parameters:
- TerrRuleBoundaryId:
$request.path.TerrRuleBoundaryId - TerrRuleId:
$request.path.TerrRuleId - TerritoryVersionId:
$request.path.TerritoryVersionId
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: