Create a territory
post
/crmRestApi/resources/11.13.18.05/territories
Request
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.
-
Upsert-Mode:
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
-
CoverageModel: string
Title:
Coverage
Maximum Length:30
Default Value:SALES_ACCOUNT_CENTRIC
Indicates if the dimensions of the territory are based on account attributes or partner attributes. -
Description: string
Title:
Description
Maximum Length:240
The description of the territory. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
The date and time when the territory version becomes inactive. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
The date and time when the territory version becomes active. If the StatusCode is DRAFT, then this value should be empty. Else, if the StatusCode is FINALIZED, then this value should be today's date. -
EligibleForQuotaFlag: boolean
Title:
Eligible for Quota
Maximum Length:1
Default Value:false
Indicates whether the territory is going to change during a territory realignment. If the value is True, then the territory is unlikely to change during a major realignment, and therefore a quota can be entered against the proposed definition. The default value is true. -
ForecastedByParentTerritoryFlag: boolean
Title:
Forecast Invisible to Owner
Maximum Length:1
Default Value:false
Indicates if the forecast for the territory is made by its parent territory. The default value is false. -
ForecastParticipationCode: string
Title:
Enable Forecasting
Maximum Length:30
Default Value:REVENUE
The code for the forecast participation. The accepted values are: REVENUE, NONREVENUE, REVENUE_AND_NONREVENUE, and NON_FORECASTING. -
LatestVersionFlag: boolean
Title:
Latest Version
Maximum Length:1
Default Value:true
Indicates whether the territory is the latest active version. If the value is True, then the territory version is the latest active version of the territory. -
Name(required): string
Title:
Territory Name
Maximum Length:60
The name of the territory. -
Owner(required): string
Title:
Owner
Maximum Length:360
The owner of the territory. -
OwnerResourceId(required): integer
(int64)
Title:
Resource ID
The unique identifier of the owner resource. -
OwnerTrans: string
Title:
Owner
Maximum Length:255
The name of the owner. -
ParentTerritoryId: integer
(int64)
Title:
Parent Territory ID
The unique identifier of the parent territory. -
ParentTerritoryLovSwitcher: string
The field controls the display of parent territory list of values on the UI. This attribute is used for an internal purpose.
-
ParentTerritoryTrans: string
The name of the parent territory.
-
ParentUniqueTerritoryNumber: string
Title:
Parent Territory Unique Number
Maximum Length:30
The unique territory number of the parent territory. -
PartnerId: integer
(int64)
Title:
Partner ID
The unique identifier of the partner associated with the territory. -
PartnerName: string
Title:
Partner
Maximum Length:360
The name of the partner associated with the territory. -
PartnerNumber: string
Title:
Partner Number
Maximum Length:30
The number of the partner. -
PartnerProgramId: integer
(int64)
Title:
Partner Program ID
The unique identifier of the partner program in which the partner is enrolled. -
ProgramName: string
Title:
Partner Program
Maximum Length:150
The name of the partner program to which the partner is enrolled. -
ProposalNumber: string
Title:
Proposal Number
Maximum Length:30
The number of the proposal the territory is associated with. -
ReviseQuotaFlag: boolean
Title:
Revise Quota
Maximum Length:1
Indicates whether a submitted quota needs to be revised. -
RevisionDescription: string
Title:
Revision Description
Maximum Length:1000
The description of the reason for revising the quota. -
RevisionReason: string
Title:
Revision Reason
Maximum Length:30
The user-defined reason for revising the quota. -
SourceTerrId: integer
(int64)
Title:
Source Territory ID
The unique identifier of the territory from which the dimensions are inherited. -
SourceTerrLastUpdateDate: string
(date-time)
Title:
Source Territory Last Update Date
The date and time when the source territory was last updated. This attribute is related to the inheritance of dimensions by recipient territories from source territories. -
SourceTerrName: string
Title:
Source Territory
Maximum Length:60
The name of the territory from which the selected dimensions are inherited. -
SourceTerrVersionId: integer
(int64)
Title:
Source Territory Version ID
The unique identifier of the source territory version. -
SourceUniqueTerritoryNumber: string
Title:
Source Unique Territory Number
Maximum Length:30
The unique territory number of the source territory. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The code indicating the status of the territory. The accepted values are DRAFT and FINALIZED. -
TerritoryFunctionCode: string
Title:
Territory Function
Maximum Length:30
Business function associated with the territory -
TerritoryId: integer
(int64)
Title:
Territory ID
The unique identifier of the territory. -
TerritoryLevel: integer
(int64)
Title:
Territory Level
The level of the territory in the territory hierarchy. -
TerritoryLineOfBusiness: array
Line of Business
Title:
Line of Business
The line of business resource is used to view the lines of business associated with a sales territory. A line of business is a general term that describes the products or services offered by the company or organization. The line of business object contains all lines of business for historical, active, and draft territory versions. It is optional for a sales territory to have associated lines of business. -
TerritoryNumber: string
Title:
Territory Number
Maximum Length:30
The unique alternate identification number for the territory. -
TerritoryResource: array
Resources
Title:
Resources
The resources resource is used to view the resources, such as owner or sales people associated with a sales territory. The equivalent functional term for resource is team member. The resources object contains all team members for historical, active, and draft territory versions. Each sales territory must have an owner, so each of the sales territory versions has at least one resource record. -
TerritoryRule: array
Rules
Title:
Rules
The rules resource is used to view the territory rules associated with a sales territory. The equivalent functional term for rule is coverage. The coverage is what identifies the scope of responsibility of the sales territory team in the market space. The rules 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. -
TerritoryVersionId: integer
(int64)
Title:
Territory Version ID
The unique identifier of the territory version. -
TerrProposalId: integer
(int64)
Title:
Territory Proposal ID
The unique identifier of the territory proposal. -
TypeCode: string
Title:
Type
Maximum Length:30
Default Value:PRIME
The code indicating the type of the territory. For example, PRIME or OVERLAY. -
UniqueTerritoryNumber: string
Title:
Unique Territory Number
Maximum Length:30
Unique identification number for this territory
Nested Schema : Line of Business
Type:
array
Title:
Line of Business
The line of business resource is used to view the lines of business associated with a sales territory. A line of business is a general term that describes the products or services offered by the company or organization. The line of business object contains all lines of business for historical, active, and draft territory versions. It is optional for a sales territory to have associated lines of business.
Show Source
Nested Schema : Resources
Type:
array
Title:
Resources
The resources resource is used to view the resources, such as owner or sales people associated with a sales territory. The equivalent functional term for resource is team member. The resources object contains all team members for historical, active, and draft territory versions. Each sales territory must have an owner, so each of the sales territory versions has at least one resource record.
Show Source
Nested Schema : Rules
Type:
array
Title:
Rules
The rules resource is used to view the territory rules associated with a sales territory. The equivalent functional term for rule is coverage. The coverage is what identifies the scope of responsibility of the sales territory team in the market space. The rules 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 : territories-TerritoryLineOfBusiness-item-post-request
Type:
Show Source
object
-
LobCode: string
Title:
Line of Business Code
Maximum Length:30
The code for the line of business. -
TerritoryVersionId: integer
(int64)
Title:
Territory Version ID
The unique identifier of the territory version. -
TerrLobId: integer
(int64)
Title:
Line of Business ID
The unique identifier of the line of business. -
UniqueTerritoryNumber: string
Title:
Unique Territory Number
Maximum Length:30
The unique territory number of the territory line of business.
Nested Schema : territories-TerritoryResource-item-post-request
Type:
Show Source
object
-
AdministratorFlag: boolean
Title:
Team Member Administrator
Maximum Length:1
Indicates whether the resource is an administrator of the territory. -
FunctionCode: string
Title:
Team Member Function
Maximum Length:30
The code for the function of the resource associated with the territory. -
ManageForecastFlag: boolean
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. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the resource from the resource manager. -
TerritoryVersionId: integer
(int64)
Title:
Territory Version ID
The unique identifier of the territory version. -
TerrResourceId: integer
(int64)
Title:
Territory Resource ID
The unique identifier of the territory resource. -
UniqueTerritoryNumber: string
Title:
Unique Territory Number
Maximum Length:30
The unique territory number of the territory team member.
Nested Schema : territories-TerritoryRule-item-post-request
Type:
Show Source
object
-
RuleNumber(required): 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(required): 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 : 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 : territories-TerritoryRule-TerritoryRuleBoundary1-item-post-request
Type:
Show Source
object
-
TerrDimensionCode(required): 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(required): integer
(int64)
Title:
Territory Number
The identifier of the territory rule.
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-post-request
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. -
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.
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-item-response
Type:
Show Source
object
-
CoverageModel: string
Title:
Coverage
Maximum Length:30
Default Value:SALES_ACCOUNT_CENTRIC
Indicates if the dimensions of the territory are based on account attributes or partner attributes. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the territory. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the territory was created. -
DeleteFlag: boolean
Read Only:
true
Indicates if the logged-in user can delete the territory. -
Description: string
Title:
Description
Maximum Length:240
The description of the territory. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
The date and time when the territory version becomes inactive. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
The date and time when the territory version becomes active. If the StatusCode is DRAFT, then this value should be empty. Else, if the StatusCode is FINALIZED, then this value should be today's date. -
EligibleForQuotaFlag: boolean
Title:
Eligible for Quota
Maximum Length:1
Default Value:false
Indicates whether the territory is going to change during a territory realignment. If the value is True, then the territory is unlikely to change during a major realignment, and therefore a quota can be entered against the proposed definition. The default value is true. -
ForecastedByParentTerritoryFlag: boolean
Title:
Forecast Invisible to Owner
Maximum Length:1
Default Value:false
Indicates if the forecast for the territory is made by its parent territory. The default value is false. -
ForecastParticipationCode: string
Title:
Enable Forecasting
Maximum Length:30
Default Value:REVENUE
The code for the forecast participation. The accepted values are: REVENUE, NONREVENUE, REVENUE_AND_NONREVENUE, and NON_FORECASTING. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the territory was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the territory. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the territory. -
LatestVersionFlag: boolean
Title:
Latest Version
Maximum Length:1
Default Value:true
Indicates whether the territory is the latest active version. If the value is True, then the territory version is the latest active version of the territory. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Territory Name
Maximum Length:60
The name of the territory. -
OrganizationName: string
Title:
Organization
Read Only:true
The name of the organization to which the owner belongs. -
Owner: string
Title:
Owner
Maximum Length:360
The owner of the territory. -
OwnerEmail: string
Title:
Owner Email
Read Only:true
Maximum Length:320
The email address of the owner. -
OwnerResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the owner resource. -
OwnerResourceNumber: string
Title:
Owner Registry ID
Read Only:true
Maximum Length:30
The registry ID of the owner. -
OwnerTrans: string
Title:
Owner
Maximum Length:255
The name of the owner. -
ParentTerritoryId: integer
(int64)
Title:
Parent Territory ID
The unique identifier of the parent territory. -
ParentTerritoryLovSwitcher: string
The field controls the display of parent territory list of values on the UI. This attribute is used for an internal purpose.
-
ParentTerritoryNumber: string
Title:
Parent Territory Number
Read Only:true
Maximum Length:30
The number of the parent territory. -
ParentTerritoryTrans: string
The name of the parent territory.
-
ParentUniqueTerritoryNumber: string
Title:
Parent Territory Unique Number
Maximum Length:30
The unique territory number of the parent territory. -
PartnerId: integer
(int64)
Title:
Partner ID
The unique identifier of the partner associated with the territory. -
PartnerName: string
Title:
Partner
Maximum Length:360
The name of the partner associated with the territory. -
PartnerNumber: string
Title:
Partner Number
Maximum Length:30
The number of the partner. -
PartnerProgramId: integer
(int64)
Title:
Partner Program ID
The unique identifier of the partner program in which the partner is enrolled. -
ProgramName: string
Title:
Partner Program
Maximum Length:150
The name of the partner program to which the partner is enrolled. -
ProposalNumber: string
Title:
Proposal Number
Maximum Length:30
The number of the proposal the territory is associated with. -
ReviseQuotaFlag: boolean
Title:
Revise Quota
Maximum Length:1
Indicates whether a submitted quota needs to be revised. -
RevisionDescription: string
Title:
Revision Description
Maximum Length:1000
The description of the reason for revising the quota. -
RevisionReason: string
Title:
Revision Reason
Maximum Length:30
The user-defined reason for revising the quota. -
SourceTerrId: integer
(int64)
Title:
Source Territory ID
The unique identifier of the territory from which the dimensions are inherited. -
SourceTerrLastUpdateDate: string
(date-time)
Title:
Source Territory Last Update Date
The date and time when the source territory was last updated. This attribute is related to the inheritance of dimensions by recipient territories from source territories. -
SourceTerrName: string
Title:
Source Territory
Maximum Length:60
The name of the territory from which the selected dimensions are inherited. -
SourceTerrVersionId: integer
(int64)
Title:
Source Territory Version ID
The unique identifier of the source territory version. -
SourceUniqueTerritoryNumber: string
Title:
Source Unique Territory Number
Maximum Length:30
The unique territory number of the source territory. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The code indicating the status of the territory. The accepted values are DRAFT and FINALIZED. -
TerritoryFunctionCode: string
Title:
Territory Function
Maximum Length:30
Business function associated with the territory -
TerritoryHierarchyUniqueTerritoryNumber: string
Title:
Territory Hierarchy Unique Territory Number
Read Only:true
Maximum Length:30
The unique alternate identifier of the territory at the top of the hierarchy to be exported. -
TerritoryId: integer
(int64)
Title:
Territory ID
The unique identifier of the territory. -
TerritoryLevel: integer
(int64)
Title:
Territory Level
The level of the territory in the territory hierarchy. -
TerritoryLineOfBusiness: array
Line of Business
Title:
Line of Business
The line of business resource is used to view the lines of business associated with a sales territory. A line of business is a general term that describes the products or services offered by the company or organization. The line of business object contains all lines of business for historical, active, and draft territory versions. It is optional for a sales territory to have associated lines of business. -
TerritoryNumber: string
Title:
Territory Number
Maximum Length:30
The unique alternate identification number for the territory. -
TerritoryResource: array
Resources
Title:
Resources
The resources resource is used to view the resources, such as owner or sales people associated with a sales territory. The equivalent functional term for resource is team member. The resources object contains all team members for historical, active, and draft territory versions. Each sales territory must have an owner, so each of the sales territory versions has at least one resource record. -
TerritoryRule: array
Rules
Title:
Rules
The rules resource is used to view the territory rules associated with a sales territory. The equivalent functional term for rule is coverage. The coverage is what identifies the scope of responsibility of the sales territory team in the market space. The rules 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. -
TerritoryVersionId: integer
(int64)
Title:
Territory Version ID
The unique identifier of the territory version. -
TerrProposalId: integer
(int64)
Title:
Territory Proposal ID
The unique identifier of the territory proposal. -
TypeCode: string
Title:
Type
Maximum Length:30
Default Value:PRIME
The code indicating the type of the territory. For example, PRIME or OVERLAY. -
UniqueTerritoryNumber: string
Title:
Unique Territory Number
Maximum Length:30
Unique identification number for this territory -
UpdateFlag: boolean
Read Only:
true
Indicates if the logged-in user can update the territory.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Line of Business
Type:
array
Title:
Line of Business
The line of business resource is used to view the lines of business associated with a sales territory. A line of business is a general term that describes the products or services offered by the company or organization. The line of business object contains all lines of business for historical, active, and draft territory versions. It is optional for a sales territory to have associated lines of business.
Show Source
Nested Schema : Resources
Type:
array
Title:
Resources
The resources resource is used to view the resources, such as owner or sales people associated with a sales territory. The equivalent functional term for resource is team member. The resources object contains all team members for historical, active, and draft territory versions. Each sales territory must have an owner, so each of the sales territory versions has at least one resource record.
Show Source
Nested Schema : Rules
Type:
array
Title:
Rules
The rules resource is used to view the territory rules associated with a sales territory. The equivalent functional term for rule is coverage. The coverage is what identifies the scope of responsibility of the sales territory team in the market space. The rules 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 : 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-TerritoryLineOfBusiness-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the territory line of business. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the territory line of business was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the territory line of business was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the territory line of business. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the territory line of business. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LobCode: string
Title:
Line of Business Code
Maximum Length:30
The code for the line of business. -
Meaning: string
Title:
Line of Business
Read Only:true
Maximum Length:80
The meaning of the line of business. -
TerritoryVersionId: integer
(int64)
Title:
Territory Version ID
The unique identifier of the territory version. -
TerrLobId: integer
(int64)
Title:
Line of Business ID
The unique identifier of the line of business. -
UniqueTerritoryNumber: string
Title:
Unique Territory Number
Maximum Length:30
The unique territory number of the territory line of business.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : territories-TerritoryResource-item-response
Type:
Show Source
object
-
AdministratorFlag: boolean
Title:
Team Member Administrator
Maximum Length:1
Indicates whether the resource is an administrator of the territory. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the territory team member. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the territory team member was created. -
Email: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the territory team member. -
FunctionCode: string
Title:
Team Member Function
Maximum Length:30
The code for the function of the resource associated with the territory. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the territory team member was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the territory team member. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the territory team member. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManageForecastFlag: boolean
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. -
Manager: string
Read Only:
true
Maximum Length:360
The name of the manager. -
OrganizationName: string
Title:
Organization
Read Only:true
Maximum Length:240
The name of the organization. -
OwnerFlag: boolean
Title:
Owner
Read Only:true
Indicates whether the territory team member is the owner. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the resource from the resource manager. -
ResourceName: string
Title:
Resource Name
Read Only:true
Maximum Length:360
The name of the resource associated with the territory. -
ResourceNumber: string
Title:
Resource Registry ID
Read Only:true
Maximum Length:30
The registry ID of the territory team member. -
RoleName: string
Title:
Team Member Role
Read Only:true
Maximum Length:60
The name of the team member role associated with the resource. -
TerritoryVersionId: integer
(int64)
Title:
Territory Version ID
The unique identifier of the territory version. -
TerrResourceId: integer
(int64)
Title:
Territory Resource ID
The unique identifier of the territory resource. -
UniqueTerritoryNumber: string
Title:
Unique Territory Number
Maximum Length:30
The unique territory number of the territory team member.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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 : 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
- 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
- finder:
- ExtendedResourcePickerViewAccessor
-
Operation: /crmRestApi/resources/11.13.18.05/resourcesThe name of the territory owner.
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
- finder:
- 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
- TerritoryFunctionViewAccessor
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOT_TERRITORY_FUNCTION%2CBindLookupCode%3D{TerritoryFunctionCode}
The list of values for the territory function. The territory function represents the purpose or role of the territory.
The following properties are defined on the LOV link relation:- Source Attribute: TerritoryFunctionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TerritoryLineOfBusiness
-
Operation: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryLineOfBusinessParameters:
- TerritoryVersionId:
$request.path.TerritoryVersionId
The line of business resource is used to view the lines of business associated with a sales territory. A line of business is a general term that describes the products or services offered by the company or organization. The line of business object contains all lines of business for historical, active, and draft territory versions. It is optional for a sales territory to have associated lines of business. - TerritoryVersionId:
- TerritoryResource
-
Operation: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryResourceParameters:
- TerritoryVersionId:
$request.path.TerritoryVersionId
The resources resource is used to view the resources, such as owner or sales people associated with a sales territory. The equivalent functional term for resource is team member. The resources object contains all team members for historical, active, and draft territory versions. Each sales territory must have an owner, so each of the sales territory versions has at least one resource record. - TerritoryVersionId:
- TerritoryRule
-
Parameters:
- TerritoryVersionId:
$request.path.TerritoryVersionId
The rules resource is used to view the territory rules associated with a sales territory. The equivalent functional term for rule is coverage. The coverage is what identifies the scope of responsibility of the sales territory team in the market space. The rules 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. - TerritoryVersionId:
- 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
- finder:
- 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
- finder:
- ValidStatusCodeViewAccessor
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DMOT_TERRITORY_VERSION_STATUS
The list of values for the territory version status, such as Unpublished or Finalized.
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- 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
- finder:
Examples
The following example shows how to create a territory by submitting a POST request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X
-X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "Name":"Rest_Terr", "OwnerResourceId" : "100010025532672", "ParentTerritoryId" : "1000", "StatusCode" :"DRAFT", "TerrProposalId":"300100128873872" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "Description": null, "EffectiveEndDate": null, "EffectiveStartDate": null, "Name": "Rest_Terr", "TerritoryVersionId": 300100128873880, "OwnerResourceId": 100010025532672, "ParentTerritoryId": 1000, "StatusCode": "DRAFT", "TerrProposalId": 300100128873872, "TerritoryId": 300100128873879, "TerritoryLevel": 2, "TypeCode": "PRIME", "Owner": "Gabrielle Lee", "LatestVersionFlag": true, "PartnerId": null, "PartnerProgramId": null, "ForecastParticipationCode": "REVENUE", "SourceTerrId": null, "RevisionReason": null, "RevisionDescription": null, "ReviseQuotaFlag": null, "EligibleForQuotaFlag": false, "SourceTerrVersionId": null, "PartnerName": null, "ProgramName": null, "OrganizationName": "Global Sales and Marketing", "SourceTerrName": null, "SourceTerrLastUpdateDate": null, "CoverageModel": "SALES_ACCOUNT_CENTRIC", "ForecastedByParentTerritoryFlag": false, "TerritoryNumber": "CDRM_927351", "ParentTerritoryLovSwitcher": "LOV_RootParentTerritoryId", "UpdateFlag": true, "DeleteFlag": true, "ParentTerritoryNumber": null, "links":[ {"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100128873880",...}, {"rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100128873880",…}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100128873880/lov/PartnerPickerPVOViewAccessor",...}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100128873880/lov/ParentTerritoryLovViewAccessor",...}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100128873880/lov/EnabledTypeCodesViewAccessor",...}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100128873880/lov/ExtendedResourcePickerViewAccessor",...}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100128873880/lov/LookupYesNoViewAccessor",...}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100128873880/lov/ValidateCoverageModel",...}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100128873880/lov/ValidForecastParticipationCodeViewAccessor",...}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100128873880/lov/ValidStatusCodeViewAccessor",...}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100128873880/lov/ValidRevisionReasonViewAccessor",...}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100128873880/lov/LovTerritoryResourceVO",...}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100128873880/lov/PartnerProgramsPVOViewAccessor",...}, {"rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100128873880/child/TerritoryRule",...}, {"rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100128873880/child/TerritoryResource",...}, {"rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100128873880/child/TerritoryLineOfBusiness",...} ] }