Update a rule boundary value for a territory
patch
/crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}/child/TerritoryRuleBndryValue1/{TerrRuleBndryValueId}
Request
Path Parameters
-
TerrRuleBndryValueId(required): integer(int64)
The unique identifier of the territory rule boundary value.
-
TerrRuleBoundaryId(required): integer(int64)
The unique identifier of the territory rule boundary.
-
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:
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.
Supported Media Types
- application/json
Root Schema : schema
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. -
DimensionMember: string
The name of the territory dimension member.
-
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. -
TerrRuleBoundaryId: integer
(int64)
Title:
Territory Number
The 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-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
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.