Jump to

• Request
• Response

Get all territory coverages

get

/crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryCoverage

Request

Path Parameters

• UniqueTerritoryNumber(required): string
  The unique identification number for the territory.

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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • CoverageNumberFinder: Finds the territory coverage rule by the specified public unique identifier.
    Finder Variables:
    • CoverageNumber; string; The public unique identifier of the territory coverage rule.
  • PrimaryKey: Finds the territory coverage rule by the specified primary key.
    Finder Variables:
    • CoverageId; integer; The unique identifier of the territory coverage rule.
  • TerritoryCoverageAltKeyFinder: Finds the territory coverage rule with the specified alternate key.
    Finder Variables:
    • CoverageNumber; string; The public unique identifier of the territory coverage rule.
    • UniqueTerritoryNumber; string; The public unique identifier of the territory.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AccountId; integer; The identifier for the customer inclusion or exclusion.
  • AccountName; string; The name of the customer inclusion.
  • AccountTypeCode; string; The code for the account type in the territory coverage.
  • AddressCity; string; The city of the address dimension in the territory coverage.
  • AddressCountry; string; The country of the address dimension in the territory coverage.
  • AddressCounty; string; The county of the address dimension in the territory coverage.
  • AddressElementAttribute1; string; The additional attribute 1 of the address dimension in the territory coverage.
  • AddressElementAttribute2; string; The additional attribute 2 of the address dimension in the territory coverage.
  • AddressElementAttribute3; string; The additional attribute 3 of the address dimension in the territory coverage.
  • AddressElementAttribute4; string; The additional attribute 4 of the address dimension in the territory coverage.
  • AddressElementAttribute5; string; The additional attribute 5 of the address dimension in the territory coverage.
  • AddressPostalCode; string; The postal code of the address dimension in the territory coverage.
  • AddressProvince; string; The province of the address dimension in the territory coverage.
  • AddressState; string; The state of the address dimension in the territory coverage.
  • Auxiliary1Code; string; The auxiliary 1 code in the territory coverage.
  • Auxiliary2Code; string; The auxiliary 2 code in the territory coverage.
  • Auxiliary3Code; string; The auxiliary 3 code in the territory coverage.
  • AuxiliaryDimension1; string; The auxiliary 1 name in the territory coverage.
  • AuxiliaryDimension2; string; The auxiliary 2 name in the territory coverage.
  • AuxiliaryDimension3; string; The auxiliary 3 name in the territory coverage.
  • BusinessUnitId; integer; The identifier for the business unit in the territory coverage.
  • BusinessUnitName; string; The name for the business unit in the territory coverage.
  • CoverageId; integer; The unique identifier of the territory coverage rule.
  • CoverageNumber; string; The public unique identifier of the territory coverage rule.
  • CoverageTypeCode; string; 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.
  • CreatedBy; string; The user who created the territory coverage.
  • CreationDate; string; The date when the territory coverage was created.
  • CustomerSizeCode; string; The code for the customer size in the territory coverage.
  • DimensionName; string; The name of a dimension used in sales territories to define the area of responsibility for the salesperson. Examples are the Product and Industry dimensions.
  • Extension1; string; The extension 1 name in the territory coverage.
  • Extension10; string; The extension 10 name in the territory coverage.
  • Extension10Code; string; The extension 10 code in the territory coverage.
  • Extension1Code; string; The extension 1 code in the territory coverage.
  • Extension2; string; The extension 2 name in the territory coverage.
  • Extension2Code; string; The extension 2 code in the territory coverage.
  • Extension3; string; The extension 3 name in the territory coverage.
  • Extension3Code; string; The extension 3 code in the territory coverage.
  • Extension4; string; The extension 4 name in the territory coverage.
  • Extension4Code; string; The extension 4 code in the territory coverage.
  • Extension5; string; The extension 5 name in the territory coverage.
  • Extension5Code; string; The extension 5 code in the territory coverage.
  • Extension6; string; The extension 6 name in the territory coverage.
  • Extension6Code; string; The extension 6 code in the territory coverage.
  • Extension7; string; The extension 7 name in the territory coverage.
  • Extension7Code; string; The extension 7 code in the territory coverage.
  • Extension8; string; The extension 8 name in the territory coverage.
  • Extension8Code; string; The extension 8 code in the territory coverage.
  • Extension9; string; The extension 9 name in the territory coverage.
  • Extension9Code; string; The extension 9 code in the territory coverage.
  • GeographyHighId; integer; The identifier for the higher geography in the range in the territory coverage.
  • GeographyHighName; string; The name for the higher geography in the range in the territory coverage.
  • GeographyId; integer; The identifier for the geography in the territory coverage.
  • GeographyName; string; The name of the geography in the territory coverage. This may include the full path of the geography in order to uniquely identify the location, for example; >United States>New Hampshire>Manchester.
  • IncludeHierarchyFlag; boolean; Indicates whether the dimension member is included along with its hierarchy or not. The default value is true.
  • IndustryCode; string; The code for the industry in the territory coverage.
  • IndustryName; string; The name of the industry in the territory coverage.
  • InventoryItemId; integer; The identifier for the inventory item in the territory coverage.
  • InventoryOrgId; integer; The identifier for the inventory organization in the territory coverage.
  • ItemName; string; The name for the item in the territory coverage.
  • ItemNumber; string; The number for the item in the territory coverage.
  • LastUpdateDate; string; The date the territory coverage was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the territory coverage.
  • LastUpdatedBy; string; The user who last updated the territory coverage.
  • OrganizationType; string; The name of the organization type in the territory coverage.
  • OrganizationTypeCode; string; The code for the organization type in the territory coverage.
  • OriginalReference; string; The origin source system reference of the account or contact.
  • PartnerId; integer; The identifier of the partner inclusion or exclusion.
  • PartnerName; string; The name of the partner inclusion.
  • PartnerNumber; string; The public unique identifier of the partner inclusion or exclusion.
  • ProductGroupId; integer; The identifier for the product group in the territory coverage.
  • ProductGroupName; string; The name for the product group in the territory coverage.
  • ProductGroupNumber; string; The number for the product group in the territory coverage.
  • RegistryId; string; The public unique identifier of the customer inclusion.
  • SalesChannelCode; string; The code for the sales channel in the territory coverage.
  • SubSalesChannelCode; string; The code for the sub sales channel in the territory coverage.
  • TerrDimensionCode; string; The code indicating the territory dimension. For example, AcTyp, Acct, Aux1, Aux2, Aux3, BUnit, CSize, Geo, Indst, OrgTp, Prod, Prtnr, or SChnl.
  • TerritoryVersionId; integer; The unique identifier of territory version.
  • UniqueTerritoryNumber; string; The public unique identifier of the territory.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 : salesTerritories-TerritoryCoverage

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/salesTerritories-TerritoryCoverage-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object salesTerritories-TerritoryCoverage-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/salesTerritories-TerritoryCoverage-item-response"
    }
}

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 : salesTerritories-TerritoryCoverage-item-response

Type: object

Show Source

• AccountId: integer (int64)
  Title: Account ID

  The identifier for the customer inclusion or exclusion.
• AccountName: string
  Title: Customer Account

  Read Only: true

  Maximum Length: 360

  The name of the customer inclusion.
• AccountTypeCode: string
  Title: Account Type Code

  Maximum Length: 30

  The code for the account type in the territory coverage.
• AddressCity: string
  Title: City

  Maximum Length: 60

  The city of the address dimension in the territory coverage.
• AddressCountry: string
  Title: Country

  Maximum Length: 2

  The country of the address dimension in the territory coverage.
• AddressCounty: string
  Title: County

  Maximum Length: 60

  The county of the address dimension in the territory coverage.
• AddressElementAttribute1: string
  Title: Additional Attribute 1

  Maximum Length: 150

  The additional attribute 1 of the address dimension in the territory coverage.
• AddressElementAttribute2: string
  Title: Additional Attribute 2

  Maximum Length: 150

  The additional attribute 2 of the address dimension in the territory coverage.
• AddressElementAttribute3: string
  Title: Additional Attribute 3

  Maximum Length: 150

  The additional attribute 3 of the address dimension in the territory coverage.
• AddressElementAttribute4: string
  Title: Additional Attribute 4

  Maximum Length: 150

  The additional attribute 4 of the address dimension in the territory coverage.
• AddressElementAttribute5: string
  Title: Additional Attribute 5

  Maximum Length: 150

  The additional attribute 5 of the address dimension in the territory coverage.
• AddressPostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the address dimension in the territory coverage.
• AddressProvince: string
  Title: Province

  Maximum Length: 60

  The province of the address dimension in the territory coverage.
• AddressState: string
  Title: State

  Maximum Length: 60

  The state of the address dimension in the territory coverage.
• Auxiliary1Code: string
  Title: Auxiliary 1 Code

  Maximum Length: 30

  The auxiliary 1 code in the territory coverage.
• Auxiliary2Code: string
  Title: Auxiliary 2 Code

  Maximum Length: 30

  The auxiliary 2 code in the territory coverage.
• Auxiliary3Code: string
  Title: Auxiliary 3 Code

  Maximum Length: 30

  The auxiliary 3 code in the territory coverage.
• AuxiliaryDimension1: string
  Title: Auxiliary 1

  Read Only: true

  The auxiliary 1 name in the territory coverage.
• AuxiliaryDimension2: string
  Title: Auxiliary 2

  Read Only: true

  The auxiliary 2 name in the territory coverage.
• AuxiliaryDimension3: string
  Title: Auxiliary 3

  Read Only: true

  The auxiliary 3 name in the territory coverage.
• BusinessUnitId: integer (int64)
  Title: Business Unit ID

  The identifier for the business unit in the territory coverage.
• BusinessUnitName: string
  Title: Business Unit

  Maximum Length: 255

  The name for the business unit in the territory coverage.
• CoverageId: integer (int64)
  Title: Coverage ID

  The unique identifier of the territory coverage rule.
• CoverageNumber: string
  Title: Coverage Number

  Maximum Length: 30

  The public unique identifier of the territory coverage rule.
• CoverageTypeCode: string
  Title: Coverage Type Code

  Maximum Length: 30

  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.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the territory coverage.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the territory coverage was created.
• CustomerSizeCode: string
  Title: Customer Size Code

  Maximum Length: 30

  The code for the customer size in the territory coverage.
• DimensionName: string
  Title: Dimension Name

  Read Only: true

  Maximum Length: 60

  The name of a dimension used in sales territories to define the area of responsibility for the salesperson. Examples are the Product and Industry dimensions.
• Extension1: string
  Title: Extension 1

  Read Only: true

  Maximum Length: 255

  The extension 1 name in the territory coverage.
• Extension10: string
  Title: Extension 10

  Read Only: true

  Maximum Length: 255

  The extension 10 name in the territory coverage.
• Extension10Code: string
  Title: Extension 10 Code

  Maximum Length: 30

  The extension 10 code in the territory coverage.
• Extension1Code: string
  Title: Extension 1 Code

  Maximum Length: 30

  The extension 1 code in the territory coverage.
• Extension2: string
  Title: Extension 2

  Read Only: true

  Maximum Length: 255

  The extension 2 name in the territory coverage.
• Extension2Code: string
  Title: Extension 2 Code

  Maximum Length: 30

  The extension 2 code in the territory coverage.
• Extension3: string
  Title: Extension 3

  Read Only: true

  Maximum Length: 255

  The extension 3 name in the territory coverage.
• Extension3Code: string
  Title: Extension 3 Code

  Maximum Length: 30

  The extension 3 code in the territory coverage.
• Extension4: string
  Title: Extension 4

  Read Only: true

  Maximum Length: 255

  The extension 4 name in the territory coverage.
• Extension4Code: string
  Title: Extension 4 Code

  Maximum Length: 30

  The extension 4 code in the territory coverage.
• Extension5: string
  Title: Extension 5

  Read Only: true

  Maximum Length: 255

  The extension 5 name in the territory coverage.
• Extension5Code: string
  Title: Extension 5 Code

  Maximum Length: 30

  The extension 5 code in the territory coverage.
• Extension6: string
  Title: Extension 6

  Read Only: true

  Maximum Length: 255

  The extension 6 name in the territory coverage.
• Extension6Code: string
  Title: Extension 6 Code

  Maximum Length: 30

  The extension 6 code in the territory coverage.
• Extension7: string
  Title: Extension 7

  Read Only: true

  Maximum Length: 255

  The extension 7 name in the territory coverage.
• Extension7Code: string
  Title: Extension 7 Code

  Maximum Length: 30

  The extension 7 code in the territory coverage.
• Extension8: string
  Title: Extension 8

  Read Only: true

  Maximum Length: 255

  The extension 8 name in the territory coverage.
• Extension8Code: string
  Title: Extension 8 Code

  Maximum Length: 30

  The extension 8 code in the territory coverage.
• Extension9: string
  Title: Extension 9

  Read Only: true

  Maximum Length: 255

  The extension 9 name in the territory coverage.
• Extension9Code: string
  Title: Extension 9 Code

  Maximum Length: 30

  The extension 9 code in the territory coverage.
• GeographyHighId: integer (int64)
  Title: Geography High ID

  The identifier for the higher geography in the range in the territory coverage.
• GeographyHighName: string
  Title: Geography High Name

  The name for the higher geography in the range in the territory coverage.
• GeographyId: integer (int64)
  Title: Geography ID

  The identifier for the geography in the territory coverage.
• GeographyName: string
  Title: Geography

  The name of the geography in the territory coverage. This may include the full path of the geography in order to uniquely identify the location, for example; >United States>New Hampshire>Manchester.
• 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.
• IndustryCode: string
  Title: Industry Code

  Maximum Length: 30

  The code for the industry in the territory coverage.
• IndustryName: string
  Title: Industry

  Read Only: true

  The name of the industry in the territory coverage.
• InventoryItemId: integer (int64)
  Title: Inventory Item ID

  The identifier for the inventory item in the territory coverage.
• InventoryOrgId: integer (int64)
  Title: Inventory Organization ID

  The identifier for the inventory organization in the territory coverage.
• ItemName: string
  Title: Item Name

  Read Only: true

  Maximum Length: 240

  The name for the item in the territory coverage.
• ItemNumber: string
  Title: Item Number

  Read Only: true

  Maximum Length: 300

  The number for the item in the territory coverage.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the territory coverage was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the territory coverage.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the territory coverage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationType: string
  Title: Organization Type

  Read Only: true

  The name of the organization type in the territory coverage.
• OrganizationTypeCode: string
  Title: Organization Type Code

  Maximum Length: 30

  The code for the organization type in the territory coverage.
• OriginalReference: string
  Title: Original Reference

  Maximum Length: 300

  The origin source system reference of the account or contact.
• PartnerId: integer (int64)
  Title: Partner ID

  The identifier of the partner inclusion or exclusion.
• PartnerName: string
  Title: Partner

  Read Only: true

  Maximum Length: 360

  The name of the partner inclusion.
• PartnerNumber: string
  Title: Partner Number

  Maximum Length: 30

  The public unique identifier of the partner inclusion or exclusion.
• ProductGroupId: integer (int64)
  Title: Product Group ID

  The identifier for the product group in the territory coverage.
• ProductGroupName: string
  Title: Product Group Name

  Read Only: true

  Maximum Length: 250

  The name for the product group in the territory coverage.
• ProductGroupNumber: string
  Title: Product Group Number

  Maximum Length: 50

  The number for the product group in the territory coverage.
• RegistryId: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the customer inclusion.
• SalesChannelCode: string
  Title: Sales Channel Code

  Maximum Length: 30

  The code for the sales channel in the territory coverage.
• SubSalesChannelCode: string
  Title: Subsales Channel Code

  Maximum Length: 30

  The code for the sub sales channel in the territory coverage.
• TerrDimensionCode: string
  Title: Territory Dimension Code

  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.
• TerritoryVersionId: integer (int64)
  Title: Territory Version ID

  The unique identifier of territory version.
• UniqueTerritoryNumber: string
  Title: Unique Territory Number

  Maximum Length: 30

  The public unique identifier of the territory.

{
    "type":"object",
    "properties":{
        "Extension7":{
            "title":"Extension 7",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 7 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the territory coverage was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension8":{
            "title":"Extension 8",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 8 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UniqueTerritoryNumber":{
            "title":"Unique Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the territory.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension9":{
            "title":"Extension 9",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 9 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The identifier for the customer inclusion or exclusion.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GeographyId":{
            "title":"Geography ID",
            "type":"integer",
            "description":"The identifier for the geography in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The identifier of the partner inclusion or exclusion.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Extension1":{
            "title":"Extension 1",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 1 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension3Code":{
            "title":"Extension 3 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 3 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension2":{
            "title":"Extension 2",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 2 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Product Group Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name for the product group in the territory coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension3":{
            "title":"Extension 3",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 3 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubSalesChannelCode":{
            "title":"Subsales Channel Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the sub sales channel in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension4":{
            "title":"Extension 4",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 4 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension5":{
            "title":"Extension 5",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 5 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension6":{
            "title":"Extension 6",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 6 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Extension1Code":{
            "title":"Extension 1 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 1 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCity":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AuxiliaryDimension1":{
            "title":"Auxiliary 1",
            "type":"string",
            "description":"The auxiliary 1 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Auxiliary1Code"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AuxiliaryDimension3":{
            "title":"Auxiliary 3",
            "type":"string",
            "description":"The auxiliary 3 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuxiliaryDimension2":{
            "title":"Auxiliary 2",
            "type":"string",
            "description":"The auxiliary 2 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyHighName":{
            "title":"Geography High Name",
            "type":"string",
            "description":"The name for the higher geography in the range in the territory coverage.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "GeographyHighId"
                ]
            },
            "x-queryable":true
        },
        "Extension4Code":{
            "title":"Extension 4 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 4 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "IndustryName":{
            "title":"Industry",
            "type":"string",
            "description":"The name of the industry in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the territory coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the territory coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IndustryCode":{
            "title":"Industry Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the industry in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension5Code":{
            "title":"Extension 5 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 5 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The identifier for the inventory item in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The identifier for the business unit in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InventoryOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The identifier for the inventory organization in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerName":{
            "title":"Partner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the partner inclusion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Auxiliary1Code":{
            "title":"Auxiliary 1 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary 1 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSizeCode":{
            "title":"Customer Size Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the customer size in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension6Code":{
            "title":"Extension 6 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 6 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "TerritoryVersionId":{
            "title":"Territory Version ID",
            "type":"integer",
            "description":"The unique identifier of territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AccountTypeCode":{
            "title":"Account Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the account type in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesChannelCode":{
            "title":"Sales Channel Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the sales channel in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressProvince":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageNumber":{
            "title":"Coverage Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the territory coverage rule.",
            "nullable":false,
            "x-queryable":true
        },
        "GeographyHighId":{
            "title":"Geography High ID",
            "type":"integer",
            "description":"The identifier for the higher geography in the range in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AddressElementAttribute1":{
            "title":"Additional Attribute 1",
            "maxLength":"150",
            "type":"string",
            "description":"The additional attribute 1 of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "RegistryId":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the customer inclusion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressElementAttribute2":{
            "title":"Additional Attribute 2",
            "maxLength":"150",
            "type":"string",
            "description":"The additional attribute 2 of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute3":{
            "title":"Additional Attribute 3",
            "maxLength":"150",
            "type":"string",
            "description":"The additional attribute 3 of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "TerrDimensionCode":{
            "title":"Territory Dimension Code",
            "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":true,
            "x-queryable":true
        },
        "ProductGroupNumber":{
            "title":"Product Group Number",
            "maxLength":"50",
            "type":"string",
            "description":"The number for the product group in the territory coverage.",
            "nullable":false,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Customer Account",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the customer inclusion.",
            "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 coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressElementAttribute4":{
            "title":"Additional Attribute 4",
            "maxLength":"150",
            "type":"string",
            "description":"The additional attribute 4 of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalReference":{
            "title":"Original Reference",
            "maxLength":"300",
            "type":"string",
            "description":"The origin source system reference of the account or contact.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute5":{
            "title":"Additional Attribute 5",
            "maxLength":"150",
            "type":"string",
            "description":"The additional attribute 5 of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension7Code":{
            "title":"Extension 7 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 7 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationTypeCode":{
            "title":"Organization Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the organization type in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Auxiliary3Code":{
            "title":"Auxiliary 3 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary 3 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCountry":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressPostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCounty":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county of the address dimension in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":"300",
            "type":"string",
            "description":"The number for the item in the territory coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CoverageId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"The unique identifier of the territory coverage rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Extension8Code":{
            "title":"Extension 8 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 8 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension9Code":{
            "title":"Extension 9 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 9 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemName":{
            "title":"Item Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name for the item in the territory coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":"255",
            "type":"string",
            "description":"The name for the business unit in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Auxiliary2Code":{
            "title":"Auxiliary 2 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary 2 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "Extension10Code":{
            "title":"Extension 10 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 10 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageTypeCode":{
            "title":"Coverage Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the territory coverage type.\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)\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)\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":false,
            "x-queryable":true
        },
        "ProductGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The identifier for the product group in the territory coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GeographyName":{
            "title":"Geography",
            "type":"string",
            "description":"The name of the geography in the territory coverage. This may include the full path of the geography in order to uniquely identify the location, for example; >United States>New Hampshire>Manchester.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "GeographyId"
                ]
            },
            "x-queryable":true
        },
        "OrganizationType":{
            "title":"Organization Type",
            "type":"string",
            "description":"The name of the organization type in the territory coverage.",
            "nullable":true,
            "readOnly":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
        },
        "Extension10":{
            "title":"Extension 10",
            "maxLength":"255",
            "type":"string",
            "description":"The extension 10 name in the territory coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DimensionName":{
            "title":"Dimension Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of a dimension used in sales territories to define the area of responsibility for the salesperson. Examples are the Product and Industry dimensions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerNumber":{
            "title":"Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the partner inclusion or exclusion.",
            "nullable":false,
            "x-queryable":true
        },
        "Extension2Code":{
            "title":"Extension 2 Code",
            "maxLength":"30",
            "type":"string",
            "description":"The extension 2 code in the territory coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory coverage was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressState":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the address dimension in the territory coverage.",
            "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"
    }
}

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."
        }
    }
}

Back to Top