Jump to

• Request
• Response
• Examples

Get a territory

get

/crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}

Request

Path Parameters

• 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 Top

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.

Body ()

Root Schema : territories-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the territory was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UniqueTerritoryNumber":{
            "title":"Unique Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"Unique identification number for this territory",
            "nullable":true,
            "x-queryable":true
        },
        "Owner":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The owner of the territory.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SourceTerrVersionId":{
            "title":"Source Territory Version ID",
            "type":"integer",
            "description":"The unique identifier of the source territory version.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The unique identifier of the partner associated with the territory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the territory. The accepted values are DRAFT and FINALIZED.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Territory Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the territory.",
            "nullable":false,
            "x-queryable":true
        },
        "RevisionDescription":{
            "title":"Revision Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the reason for revising the quota.",
            "nullable":true,
            "x-queryable":true
        },
        "TerritoryResource":{
            "title":"Resources",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/territories-TerritoryResource-item-response"
            }
        },
        "SourceTerrLastUpdateDate":{
            "title":"Source Territory Last Update Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OwnerResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the owner resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentTerritoryTrans":{
            "type":"string",
            "description":"The name of the parent territory.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The date and time when the territory version becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TerritoryLevel":{
            "title":"Territory Level",
            "type":"integer",
            "description":"The level of the territory in the territory hierarchy.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerProgramId":{
            "title":"Partner Program ID",
            "type":"integer",
            "description":"The unique identifier of the partner program in which the partner is enrolled.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceTerrName":{
            "title":"Source Territory",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the territory from which the selected dimensions are inherited.",
            "nullable":true,
            "x-queryable":true
        },
        "RevisionReason":{
            "title":"Revision Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The user-defined reason for revising the quota.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartnerName":{
            "title":"Partner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the partner associated with the territory.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Partner Program",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the partner program to which the partner is enrolled.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the logged-in user can delete the territory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ForecastedByParentTerritoryFlag":{
            "title":"Forecast Invisible to Owner",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the forecast for the territory is made by its parent territory. The default value is false.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "ForecastParticipationCode":{
            "title":"Enable Forecasting",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the forecast participation. The accepted values are: REVENUE, NONREVENUE, REVENUE_AND_NONREVENUE, and NON_FORECASTING.",
            "nullable":true,
            "default":"REVENUE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TerritoryVersionId":{
            "title":"Territory Version ID",
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentTerritoryLovSwitcher":{
            "type":"string",
            "description":"The field controls the display of parent territory list of values on the UI. This attribute is used for an internal purpose.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerTrans":{
            "title":"Owner",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "TerrProposalId":{
            "title":"Territory Proposal ID",
            "type":"integer",
            "description":"The unique identifier of the territory proposal.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the territory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Organization",
            "type":"string",
            "description":"The name of the organization to which the owner belongs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TerritoryId":{
            "title":"Territory ID",
            "type":"integer",
            "description":"The unique identifier of the territory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentUniqueTerritoryNumber":{
            "title":"Parent Territory Unique Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique territory number of the parent territory.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the territory.",
            "nullable":true,
            "x-queryable":true
        },
        "ReviseQuotaFlag":{
            "title":"Revise Quota",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a submitted quota needs to be revised.",
            "nullable":true,
            "x-queryable":true
        },
        "LatestVersionFlag":{
            "title":"Latest Version",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "EligibleForQuotaFlag":{
            "title":"Eligible for Quota",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the logged-in user can update the territory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceTerrId":{
            "title":"Source Territory ID",
            "type":"integer",
            "description":"The unique identifier of the territory from which the dimensions are inherited.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TerritoryFunctionCode":{
            "title":"Territory Function",
            "maxLength":"30",
            "type":"string",
            "description":"Business function associated with the territory",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerEmail":{
            "title":"Owner Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the owner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "OwnerResourceNumber":{
            "title":"Owner Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The registry ID of the owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the territory. For example, PRIME or OVERLAY.",
            "nullable":false,
            "default":"PRIME",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TerritoryHierarchyUniqueTerritoryNumber":{
            "title":"Territory Hierarchy Unique Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier of the territory at the top of the hierarchy to be exported.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryNumber":{
            "title":"Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identification number for the territory.",
            "nullable":false,
            "x-queryable":true
        },
        "CoverageModel":{
            "title":"Coverage",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the dimensions of the territory are based on account attributes or partner attributes.",
            "nullable":true,
            "default":"SALES_ACCOUNT_CENTRIC",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TerritoryRule":{
            "title":"Rules",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/territories-TerritoryRule-item-response"
            }
        },
        "PartnerNumber":{
            "title":"Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the partner.",
            "nullable":false,
            "x-queryable":true
        },
        "TerritoryLineOfBusiness":{
            "title":"Line of Business",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/territories-TerritoryLineOfBusiness-item-response"
            }
        },
        "ParentTerritoryNumber":{
            "title":"Parent Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the parent territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProposalNumber":{
            "title":"Proposal Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the proposal the territory is associated with.",
            "nullable":false,
            "x-queryable":true
        },
        "ParentTerritoryId":{
            "title":"Parent Territory ID",
            "type":"integer",
            "description":"The unique identifier of the parent territory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceUniqueTerritoryNumber":{
            "title":"Source Unique Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique territory number of the source territory.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object territories-TerritoryLineOfBusiness-item-response

{
    "title":"Line of Business",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/territories-TerritoryLineOfBusiness-item-response"
    }
}

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

• Array of: object territories-TerritoryResource-item-response

{
    "title":"Resources",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/territories-TerritoryResource-item-response"
    }
}

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

• Array of: object territories-TerritoryRule-item-response

{
    "title":"Rules",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/territories-TerritoryRule-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : territories-TerritoryLineOfBusiness-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the territory line of business.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the territory line of business was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UniqueTerritoryNumber":{
            "title":"Unique Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique territory number of the territory line of business.",
            "nullable":true,
            "x-queryable":true
        },
        "TerritoryVersionId":{
            "title":"Territory Version ID",
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the territory line of business.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LobCode":{
            "title":"Line of Business Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the line of business.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TerrLobId":{
            "title":"Line of Business ID",
            "type":"integer",
            "description":"The unique identifier of the line of business.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Meaning":{
            "title":"Line of Business",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the line of business.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory line of business was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the territory line of business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : territories-TerritoryResource-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the territory team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Organization",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the territory team member was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UniqueTerritoryNumber":{
            "title":"Unique Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique territory number of the territory team member.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the territory team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Email":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the territory team member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "AdministratorFlag":{
            "title":"Team Member Administrator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the resource is an administrator of the territory.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the resource associated with the territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the territory team member is the owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FunctionCode":{
            "title":"Team Member Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the function of the resource associated with the territory.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Manager":{
            "maxLength":"360",
            "type":"string",
            "description":"The name of the manager.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Team Member Role",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the team member role associated with the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TerritoryVersionId":{
            "title":"Territory Version ID",
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceNumber":{
            "title":"Resource Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The registry ID of the territory team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManageForecastFlag":{
            "title":"Forecasting Delegate",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a territory resource has been given the responsibility to manage the territory forecast on behalf of the owner of the territory.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource from the resource manager.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TerrResourceId":{
            "title":"Territory Resource ID",
            "type":"integer",
            "description":"The unique identifier of the territory resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory team member was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the territory team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : territories-TerritoryRule-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the territory rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the territory rule was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryVersionId":{
            "title":"Territory Number",
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the territory rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryRuleBoundary1":{
            "title":"Rule Boundaries",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-item-response"
            }
        },
        "RuleOperatorCode":{
            "title":"Customer Coverage Code",
            "maxLength":"30",
            "type":"string",
            "description":"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).",
            "nullable":true,
            "default":"INCLUSION",
            "x-queryable":true
        },
        "RuleTypeCode":{
            "title":"Coverage",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the territory coverage type.\n\nIf the territory coverage model is sales account centric, the accepted values are:\n-REGULAR (for coverage based on sales account dimensionality or named accounts)\n-INCLUSION (for manually included account coverage)\n-EXCLUSION (for manually excluded account coverage)\n\nIf the territory coverage model is partner centric, the accepted values are:\n-PARTNER_REGULAR (for coverage based on partner dimensionality)\n-PARTNER_INCLUSION (for manually included partner coverage)\n-PARTNER_EXCLUSION (for manually excluded partner coverage)\n\nIn 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.",
            "nullable":true,
            "default":"REGULAR",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleNumber":{
            "title":"Coverage Number",
            "type":"integer",
            "description":"The coverage number for the territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TerrRuleId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"The unique identifier of the territory rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory rule was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"255",
            "type":"string",
            "description":"The login of the user who last updated the territory rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object territories-TerritoryRule-TerritoryRuleBoundary1-item-response

{
    "title":"Rule Boundaries",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-item-response"
    }
}

Nested Schema : territories-TerritoryRule-TerritoryRuleBoundary1-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the territory rule boundary.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the territory rule boundary was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the territory rule boundary.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryRuleBndryValue1":{
            "title":"Rule Boundary Values",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Dimension":{
            "title":"Dimension",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the dimension.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerrRuleBoundaryId":{
            "title":"Territory Dimension ID",
            "type":"integer",
            "description":"The unique identifier of the territory rule boundary.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TerrDimensionCode":{
            "title":"Dimension",
            "maxLength":"5",
            "type":"string",
            "description":"The code indicating the territory dimension, such as Geo for Geography Dimension, Prod for Product Dimension, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "TerrRuleId":{
            "title":"Territory Number",
            "type":"integer",
            "description":"The identifier of the territory rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory rule boundary was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the territory rule boundary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-response

{
    "title":"Rule Boundary Values",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-response"
    }
}

Nested Schema : territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the territory rule boundary value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DimensionMemberHigh":{
            "title":"Territory Dimension Member High",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the territory dimension member with a high sequence number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressCountry":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"Country.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressPostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"Postal Code.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCounty":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"County.",
            "nullable":true,
            "x-queryable":true
        },
        "TerrDimHighIntgId":{
            "title":"Dimension Value Range",
            "maxLength":"80",
            "type":"string",
            "description":"The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube with a high sequence number.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCity":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"City.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the territory rule boundary value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the territory rule boundary value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddrElementAttribute5":{
            "title":"Additional Attribute 5",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "DimensionMember":{
            "type":"string",
            "description":"The name of the territory dimension member.",
            "nullable":true,
            "x-queryable":true
        },
        "TerrDimIntgId":{
            "title":"Dimension Value",
            "maxLength":"80",
            "type":"string",
            "description":"The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludeHierarchyFlag":{
            "title":"Include Hierarchy",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the dimension member is included along with its hierarchy or not. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute1":{
            "title":"Additional Attribute 1",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Attribute 2",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute3":{
            "title":"Additional Attribute 3",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute4":{
            "title":"Additional Attribute 4",
            "maxLength":"150",
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressProvince":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"Province.",
            "nullable":true,
            "x-queryable":true
        },
        "TerrRuleBndryValueId":{
            "title":"Territory Dimension Member ID",
            "type":"integer",
            "description":"The unique identifier of the territory rule boundary value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TerrRuleBoundaryId":{
            "title":"Territory Number",
            "type":"integer",
            "description":"The identifier of the territory rule boundary.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TerrDimensionCode":{
            "title":"Dimension",
            "maxLength":"5",
            "type":"string",
            "description":"The code indicating the territory dimension. For example, AcTyp, Acct, Aux1, Aux2, Aux3, BUnit, CSize, Geo, Indst, OrgTp, Prod, Prtnr, or SChnl.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory rule boundary value was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the territory rule boundary value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressState":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"State.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

EnabledTypeCodesViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

Operation: /crmRestApi/resources/11.13.18.05/resources

The 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

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

Operation: /crmRestApi/resources/11.13.18.05/partnersLOV

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

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

TerritoryLineOfBusiness

Operation: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryLineOfBusiness

Parameters:

• 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.

TerritoryResource

Operation: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryResource

Parameters:

• 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.

TerritoryRule

Operation: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/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.

ValidForecastParticipationCodeViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

ValidateCoverageModel

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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 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/territories/100000015312131

Example of Response Body

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

{
  EffectiveEndDate: "4713-01-31"
  EffectiveStartDate: "2010-01-13"
  Name: "APAC Sales QA Organization Type"
  TerritoryVersionId: 100000015312131
  OwnerResourceId: 100010032635399
  ParentTerritoryId: 100000015312038
  StatusCode: "FINALIZED"
  TerrProposalId: 100000015312024
  TerritoryId: 100000015312130
  TerritoryLevel: 3
  TypeCode: "PRIME"
  LatestVersionFlag: true
  ...
}

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